Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / androidpublisher_v3.edits.images.html
blob: 92163cde7d16cc17328a5601ea9e3a97fd466ba5 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]75<h1><a href="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.edits.html">edits</a> . <a href="androidpublisher_v3.edits.images.html">images</a></h1>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#delete">delete(packageName, editId, language, imageType, imageId, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Deletes the image (specified by id) from the edit.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#deleteall">deleteall(packageName, editId, language, imageType, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Deletes all images for the specified language and image type. Returns an empty response if no images are found.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#list">list(packageName, editId, language, imageType, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists all images. The response may be empty.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]90 <code><a href="#upload">upload(packageName, editId, language, imageType, media_body=None, media_mime_type=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">Uploads an image of the specified language and image type, and adds to the edit.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 <code class="details" id="delete">delete(packageName, editId, language, imageType, imageId, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100 <pre>Deletes the image (specified by id) from the edit.
101
102Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]103 packageName: string, Package name of the app. (required)
104 editId: string, Identifier of the edit. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]105 language: string, Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German). (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]106 imageType: string, Type of the Image. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107 Allowed values
108 appImageTypeUnspecified - Unspecified type. Do not use.
109 phoneScreenshots - Phone screenshot.
110 sevenInchScreenshots - Seven inch screenshot.
111 tenInchScreenshots - Ten inch screenshot.
112 tvScreenshots - TV screenshot.
113 wearScreenshots - Wear screenshot.
114 icon - Icon.
115 featureGraphic - Feature graphic.
116 tvBanner - TV banner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]117 imageId: string, Unique identifier an image within the set of images attached to this edit. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122</pre>
123</div>
124
125<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 <code class="details" id="deleteall">deleteall(packageName, editId, language, imageType, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]127 <pre>Deletes all images for the specified language and image type. Returns an empty response if no images are found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128
129Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]130 packageName: string, Package name of the app. (required)
131 editId: string, Identifier of the edit. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]132 language: string, Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German). Providing a language that is not supported by the App is a no-op. (required)
133 imageType: string, Type of the Image. Providing an image type that refers to no images is a no-op. (required)
134 Allowed values
135 appImageTypeUnspecified - Unspecified type. Do not use.
136 phoneScreenshots - Phone screenshot.
137 sevenInchScreenshots - Seven inch screenshot.
138 tenInchScreenshots - Ten inch screenshot.
139 tvScreenshots - TV screenshot.
140 wearScreenshots - Wear screenshot.
141 icon - Icon.
142 featureGraphic - Feature graphic.
143 tvBanner - TV banner.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]144 x__xgafv: string, V1 error format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]146 1 - v1 error format
147 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148
149Returns:
150 An object of the form:
151
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]152 { # Response for deleting all images.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]153 &quot;deleted&quot;: [ # The deleted images.
154 { # An uploaded image. The resource for ImagesService.
155 &quot;id&quot;: &quot;A String&quot;, # A unique id representing this image.
156 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the image.
157 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the image.
158 &quot;url&quot;: &quot;A String&quot;, # A URL that will serve a preview of the image.
159 },
160 ],
161}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162</div>
163
164<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]165 <code class="details" id="list">list(packageName, editId, language, imageType, x__xgafv=None)</code>
166 <pre>Lists all images. The response may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167
168Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]169 packageName: string, Package name of the app. (required)
170 editId: string, Identifier of the edit. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]171 language: string, Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German). There must be a store listing for the specified language. (required)
172 imageType: string, Type of the Image. Providing an image type that refers to no images will return an empty response. (required)
173 Allowed values
174 appImageTypeUnspecified - Unspecified type. Do not use.
175 phoneScreenshots - Phone screenshot.
176 sevenInchScreenshots - Seven inch screenshot.
177 tenInchScreenshots - Ten inch screenshot.
178 tvScreenshots - TV screenshot.
179 wearScreenshots - Wear screenshot.
180 icon - Icon.
181 featureGraphic - Feature graphic.
182 tvBanner - TV banner.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]183 x__xgafv: string, V1 error format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]185 1 - v1 error format
186 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]187
188Returns:
189 An object of the form:
190
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]191 { # Response listing all images.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]192 &quot;images&quot;: [ # All listed Images.
193 { # An uploaded image. The resource for ImagesService.
194 &quot;id&quot;: &quot;A String&quot;, # A unique id representing this image.
195 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the image.
196 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the image.
197 &quot;url&quot;: &quot;A String&quot;, # A URL that will serve a preview of the image.
198 },
199 ],
200}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201</div>
202
203<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]204 <code class="details" id="upload">upload(packageName, editId, language, imageType, media_body=None, media_mime_type=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]205 <pre>Uploads an image of the specified language and image type, and adds to the edit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]206
207Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]208 packageName: string, Package name of the app. (required)
209 editId: string, Identifier of the edit. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]210 language: string, Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot; for Austrian German). Providing a language that is not supported by the App is a no-op. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]211 imageType: string, Type of the Image. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]212 Allowed values
213 appImageTypeUnspecified - Unspecified type. Do not use.
214 phoneScreenshots - Phone screenshot.
215 sevenInchScreenshots - Seven inch screenshot.
216 tenInchScreenshots - Ten inch screenshot.
217 tvScreenshots - TV screenshot.
218 wearScreenshots - Wear screenshot.
219 icon - Icon.
220 featureGraphic - Feature graphic.
221 tvBanner - TV banner.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]222 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
223 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]224 x__xgafv: string, V1 error format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]226 1 - v1 error format
227 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228
229Returns:
230 An object of the form:
231
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]232 { # Response for uploading an image.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]233 &quot;image&quot;: { # An uploaded image. The resource for ImagesService. # The uploaded image.
234 &quot;id&quot;: &quot;A String&quot;, # A unique id representing this image.
235 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the image.
236 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the image.
237 &quot;url&quot;: &quot;A String&quot;, # A URL that will serve a preview of the image.
238 },
239}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240</div>
241
242</body></html>