Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / androidpublisher_v3.edits.images.html
blob: 28bf2924a6c24063ad2f598807b328a85f7b2ced [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
75<h1><a href="androidpublisher_v3.html">Google Play Developer API</a> . <a href="androidpublisher_v3.edits.html">edits</a> . <a href="androidpublisher_v3.edits.images.html">images</a></h1>
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">
87 <code><a href="#upload">upload(packageName, editId, language, imageType, media_body=None, media_mime_type=None)</a></code></p>
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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]95 packageName: string, Unique identifier for the Android app that is being updated; for example, &quot;com.spiffygame&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96 editId: string, Unique identifier for this edit. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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 &quot;de-AT&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 imageType: string, A parameter (required)
99 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100 automotiveScreenshots -
101 daydreamStereoImage -
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102 featureGraphic -
103 icon -
104 phoneScreenshots -
105 promoGraphic -
106 sevenInchScreenshots -
107 tenInchScreenshots -
108 tvBanner -
109 tvScreenshots -
110 wearScreenshots -
111 imageId: string, Unique identifier an image within the set of images attached to this edit. (required)
112</pre>
113</div>
114
115<div class="method">
116 <code class="details" id="deleteall">deleteall(packageName, editId, language, imageType)</code>
117 <pre>Deletes all images for the specified language and image type.
118
119Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 packageName: string, Unique identifier for the Android app that is being updated; for example, &quot;com.spiffygame&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 editId: string, Unique identifier for this edit. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 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 &quot;de-AT&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 imageType: string, A parameter (required)
124 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]125 automotiveScreenshots -
126 daydreamStereoImage -
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 featureGraphic -
128 icon -
129 phoneScreenshots -
130 promoGraphic -
131 sevenInchScreenshots -
132 tenInchScreenshots -
133 tvBanner -
134 tvScreenshots -
135 wearScreenshots -
136
137Returns:
138 An object of the form:
139
140 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 &quot;deleted&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;id&quot;: &quot;A String&quot;, # A unique id representing this image.
144 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the image that was uploaded.
145 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the image that was uploaded.
146 &quot;url&quot;: &quot;A String&quot;, # A URL that will serve a preview of the image.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 },
148 ],
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="list">list(packageName, editId, language, imageType)</code>
154 <pre>Lists all images for the specified language and image type.
155
156Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 packageName: string, Unique identifier for the Android app that is being updated; for example, &quot;com.spiffygame&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 editId: string, Unique identifier for this edit. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 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 &quot;de-AT&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]160 imageType: string, A parameter (required)
161 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]162 automotiveScreenshots -
163 daydreamStereoImage -
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 featureGraphic -
165 icon -
166 phoneScreenshots -
167 promoGraphic -
168 sevenInchScreenshots -
169 tenInchScreenshots -
170 tvBanner -
171 tvScreenshots -
172 wearScreenshots -
173
174Returns:
175 An object of the form:
176
177 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]178 &quot;images&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]180 &quot;id&quot;: &quot;A String&quot;, # A unique id representing this image.
181 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the image that was uploaded.
182 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the image that was uploaded.
183 &quot;url&quot;: &quot;A String&quot;, # A URL that will serve a preview of the image.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 },
185 ],
186 }</pre>
187</div>
188
189<div class="method">
190 <code class="details" id="upload">upload(packageName, editId, language, imageType, media_body=None, media_mime_type=None)</code>
191 <pre>Uploads a new image and adds it to the list of images for the specified language and image type.
192
193Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]194 packageName: string, Unique identifier for the Android app that is being updated; for example, &quot;com.spiffygame&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195 editId: string, Unique identifier for this edit. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]196 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 &quot;de-AT&quot;. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 imageType: string, A parameter (required)
198 Allowed values
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]199 automotiveScreenshots -
200 daydreamStereoImage -
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 featureGraphic -
202 icon -
203 phoneScreenshots -
204 promoGraphic -
205 sevenInchScreenshots -
206 tenInchScreenshots -
207 tvBanner -
208 tvScreenshots -
209 wearScreenshots -
210 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
211 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
212
213Returns:
214 An object of the form:
215
216 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]217 &quot;image&quot;: {
218 &quot;id&quot;: &quot;A String&quot;, # A unique id representing this image.
219 &quot;sha1&quot;: &quot;A String&quot;, # A sha1 hash of the image that was uploaded.
220 &quot;sha256&quot;: &quot;A String&quot;, # A sha256 hash of the image that was uploaded.
221 &quot;url&quot;: &quot;A String&quot;, # A URL that will serve a preview of the image.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 },
223 }</pre>
224</div>
225
226</body></html>