Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / androidpublisher_v2.edits.images.html
blob: c4e25572a4ddffc44a9867f820393d3dc9a9b073 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]75<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.edits.images.html">images</a></h1>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(packageName, editId, language, imageType, imageId)</a></code></p>
79<p class="firstline">Deletes the image (specified by id) from the edit.</p>
80<p class="toc_element">
81 <code><a href="#deleteall">deleteall(packageName, editId, language, imageType)</a></code></p>
82<p class="firstline">Deletes all images for the specified language and image type.</p>
83<p class="toc_element">
84 <code><a href="#list">list(packageName, editId, language, imageType)</a></code></p>
85<p class="firstline">Lists all images for the specified language and image type.</p>
86<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]87 <code><a href="#upload">upload(packageName, editId, language, imageType, media_body=None, media_mime_type=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]88<p class="firstline">Uploads a new image and adds it to the list of images for the specified language and image type.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(packageName, editId, language, imageType, imageId)</code>
92 <pre>Deletes the image (specified by id) from the edit.
93
94Args:
95 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
96 editId: string, Unique identifier for this edit. (required)
97 language: string, The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". (required)
98 imageType: string, A parameter (required)
99 Allowed values
100 featureGraphic -
101 icon -
102 phoneScreenshots -
103 promoGraphic -
104 sevenInchScreenshots -
105 tenInchScreenshots -
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]106 tvBanner -
107 tvScreenshots -
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]108 wearScreenshots -
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]109 imageId: string, Unique identifier an image within the set of images attached to this edit. (required)
110</pre>
111</div>
112
113<div class="method">
114 <code class="details" id="deleteall">deleteall(packageName, editId, language, imageType)</code>
115 <pre>Deletes all images for the specified language and image type.
116
117Args:
118 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
119 editId: string, Unique identifier for this edit. (required)
120 language: string, The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". (required)
121 imageType: string, A parameter (required)
122 Allowed values
123 featureGraphic -
124 icon -
125 phoneScreenshots -
126 promoGraphic -
127 sevenInchScreenshots -
128 tenInchScreenshots -
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]129 tvBanner -
130 tvScreenshots -
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]131 wearScreenshots -
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]132
133Returns:
134 An object of the form:
135
136 {
137 "deleted": [
138 {
139 "url": "A String", # A URL that will serve a preview of the image.
140 "sha1": "A String", # A sha1 hash of the image that was uploaded.
141 "id": "A String", # A unique id representing this image.
142 },
143 ],
144 }</pre>
145</div>
146
147<div class="method">
148 <code class="details" id="list">list(packageName, editId, language, imageType)</code>
149 <pre>Lists all images for the specified language and image type.
150
151Args:
152 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
153 editId: string, Unique identifier for this edit. (required)
154 language: string, The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". (required)
155 imageType: string, A parameter (required)
156 Allowed values
157 featureGraphic -
158 icon -
159 phoneScreenshots -
160 promoGraphic -
161 sevenInchScreenshots -
162 tenInchScreenshots -
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]163 tvBanner -
164 tvScreenshots -
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]165 wearScreenshots -
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]166
167Returns:
168 An object of the form:
169
170 {
171 "images": [
172 {
173 "url": "A String", # A URL that will serve a preview of the image.
174 "sha1": "A String", # A sha1 hash of the image that was uploaded.
175 "id": "A String", # A unique id representing this image.
176 },
177 ],
178 }</pre>
179</div>
180
181<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]182 <code class="details" id="upload">upload(packageName, editId, language, imageType, media_body=None, media_mime_type=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]183 <pre>Uploads a new image and adds it to the list of images for the specified language and image type.
184
185Args:
186 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
187 editId: string, Unique identifier for this edit. (required)
188 language: string, The language code (a BCP-47 language tag) of the localized listing whose images are to read or modified. For example, to select Austrian German, pass "de-AT". (required)
189 imageType: string, A parameter (required)
190 Allowed values
191 featureGraphic -
192 icon -
193 phoneScreenshots -
194 promoGraphic -
195 sevenInchScreenshots -
196 tenInchScreenshots -
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]197 tvBanner -
198 tvScreenshots -
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]199 wearScreenshots -
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]200 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]201 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]202
203Returns:
204 An object of the form:
205
206 {
207 "image": {
208 "url": "A String", # A URL that will serve a preview of the image.
209 "sha1": "A String", # A sha1 hash of the image that was uploaded.
210 "id": "A String", # A unique id representing this image.
211 },
212 }</pre>
213</div>
214
215</body></html>