Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / androidpublisher_v3.edits.images.html
blob: 687787ab3310c892c322b06d49d72868d042363a [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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <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]79<p class="firstline">Deletes the image (specified by id) from the edit.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <code><a href="#deleteall">deleteall(packageName, editId, language, imageType, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Deletes all images for the specified language and image type.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]84 <code><a href="#list">list(packageName, editId, language, imageType, x__xgafv=None)</a></code></p>
85<p class="firstline">Lists all images. The response may be empty.</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="#upload">upload(packageName, editId, language, imageType, x__xgafv=None, media_body=None, media_mime_type=None)</a></code></p>
88<p class="firstline">Uploads an image of the specified language and image type, and adds to the</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]91 <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]92 <pre>Deletes the image (specified by id) from the edit.
93
94Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]95 packageName: string, Package name of the app. (required)
96 editId: string, Identifier of the edit. (required)
97 language: string, Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot;
98for Austrian German). (required)
99 imageType: string, Type of the Image. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100 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^]101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105</pre>
106</div>
107
108<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]109 <code class="details" id="deleteall">deleteall(packageName, editId, language, imageType, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 <pre>Deletes all images for the specified language and image type.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]111Returns an empty response if no images are found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112
113Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]114 packageName: string, Package name of the app. (required)
115 editId: string, Identifier of the edit. (required)
116 language: string, Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot;
117for Austrian German).
118Providing a language that is not supported by the App is a no-op. (required)
119 imageType: string, Type of the Image.
120Providing an image type that refers to no images is a no-op. (required)
121 x__xgafv: string, V1 error format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]123 1 - v1 error format
124 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125
126Returns:
127 An object of the form:
128
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]129 { # Response for deleting all images.
130 &quot;deleted&quot;: [ # The deleted images.
131 { # An uploaded image. The resource for ImagesService.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]132 &quot;url&quot;: &quot;A String&quot;, # A URL that will serve a preview of the image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]133 &quot;id&quot;: &quot;A String&quot;, # A unique id representing this image.
134 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the image.
135 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the image.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 },
137 ],
138 }</pre>
139</div>
140
141<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]142 <code class="details" id="list">list(packageName, editId, language, imageType, x__xgafv=None)</code>
143 <pre>Lists all images. The response may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144
145Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]146 packageName: string, Package name of the app. (required)
147 editId: string, Identifier of the edit. (required)
148 language: string, Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot;
149for Austrian German).
150There must be a store listing for the specified language. (required)
151 imageType: string, Type of the Image. Providing an image type that refers to no images will
152return an empty response. (required)
153 x__xgafv: string, V1 error format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]155 1 - v1 error format
156 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]157
158Returns:
159 An object of the form:
160
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]161 { # Response listing all images.
162 &quot;images&quot;: [ # All listed Images.
163 { # An uploaded image. The resource for ImagesService.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 &quot;url&quot;: &quot;A String&quot;, # A URL that will serve a preview of the image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]165 &quot;id&quot;: &quot;A String&quot;, # A unique id representing this image.
166 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the image.
167 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the image.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 },
169 ],
170 }</pre>
171</div>
172
173<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]174 <code class="details" id="upload">upload(packageName, editId, language, imageType, x__xgafv=None, media_body=None, media_mime_type=None)</code>
175 <pre>Uploads an image of the specified language and image type, and adds to the
176edit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177
178Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]179 packageName: string, Package name of the app. (required)
180 editId: string, Identifier of the edit. (required)
181 language: string, Language localization code (a BCP-47 language tag; for example, &quot;de-AT&quot;
182for Austrian German).
183Providing a language that is not supported by the App is a no-op. (required)
184 imageType: string, Type of the Image. (required)
185 x__xgafv: string, V1 error format.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]187 1 - v1 error format
188 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
190 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
191
192Returns:
193 An object of the form:
194
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]195 { # Response for uploading an image.
196 &quot;image&quot;: { # An uploaded image. The resource for ImagesService. # The uploaded image.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197 &quot;url&quot;: &quot;A String&quot;, # A URL that will serve a preview of the image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]198 &quot;id&quot;: &quot;A String&quot;, # A unique id representing this image.
199 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the image.
200 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the image.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 },
202 }</pre>
203</div>
204
205</body></html>