blob: d358cc1e4a9beedab9851cd179584476e1413757 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -07001<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_v2.html">Google Play Android Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a> . <a href="androidpublisher_v2.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)</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:
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 -0800106 tvBanner -
107 tvScreenshots -
Craig Citro065b5302014-08-14 00:47:23 -0700108 imageId: string, Unique identifier an image within the set of images attached to this edit. (required)
109</pre>
110</div>
111
112<div class="method">
113 <code class="details" id="deleteall">deleteall(packageName, editId, language, imageType)</code>
114 <pre>Deletes all images for the specified language and image type.
115
116Args:
117 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
118 editId: string, Unique identifier for this edit. (required)
119 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)
120 imageType: string, A parameter (required)
121 Allowed values
122 featureGraphic -
123 icon -
124 phoneScreenshots -
125 promoGraphic -
126 sevenInchScreenshots -
127 tenInchScreenshots -
Craig Citroe633be12015-03-02 13:40:36 -0800128 tvBanner -
129 tvScreenshots -
Craig Citro065b5302014-08-14 00:47:23 -0700130
131Returns:
132 An object of the form:
133
134 {
135 "deleted": [
136 {
137 "url": "A String", # A URL that will serve a preview of the image.
138 "sha1": "A String", # A sha1 hash of the image that was uploaded.
139 "id": "A String", # A unique id representing this image.
140 },
141 ],
142 }</pre>
143</div>
144
145<div class="method">
146 <code class="details" id="list">list(packageName, editId, language, imageType)</code>
147 <pre>Lists all images for the specified language and image type.
148
149Args:
150 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
151 editId: string, Unique identifier for this edit. (required)
152 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)
153 imageType: string, A parameter (required)
154 Allowed values
155 featureGraphic -
156 icon -
157 phoneScreenshots -
158 promoGraphic -
159 sevenInchScreenshots -
160 tenInchScreenshots -
Craig Citroe633be12015-03-02 13:40:36 -0800161 tvBanner -
162 tvScreenshots -
Craig Citro065b5302014-08-14 00:47:23 -0700163
164Returns:
165 An object of the form:
166
167 {
168 "images": [
169 {
170 "url": "A String", # A URL that will serve a preview of the image.
171 "sha1": "A String", # A sha1 hash of the image that was uploaded.
172 "id": "A String", # A unique id representing this image.
173 },
174 ],
175 }</pre>
176</div>
177
178<div class="method">
179 <code class="details" id="upload">upload(packageName, editId, language, imageType, media_body=None)</code>
180 <pre>Uploads a new image and adds it to the list of images for the specified language and image type.
181
182Args:
183 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
184 editId: string, Unique identifier for this edit. (required)
185 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)
186 imageType: string, A parameter (required)
187 Allowed values
188 featureGraphic -
189 icon -
190 phoneScreenshots -
191 promoGraphic -
192 sevenInchScreenshots -
193 tenInchScreenshots -
Craig Citroe633be12015-03-02 13:40:36 -0800194 tvBanner -
195 tvScreenshots -
Craig Citro065b5302014-08-14 00:47:23 -0700196 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
197
198Returns:
199 An object of the form:
200
201 {
202 "image": {
203 "url": "A String", # A URL that will serve a preview of the image.
204 "sha1": "A String", # A sha1 hash of the image that was uploaded.
205 "id": "A String", # A unique id representing this image.
206 },
207 }</pre>
208</div>
209
210</body></html>