blob: 057bea801e9dd1a42d3cb06b9ff6089204adbd58 [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 -
106 imageId: string, Unique identifier an image within the set of images attached to this edit. (required)
107</pre>
108</div>
109
110<div class="method">
111 <code class="details" id="deleteall">deleteall(packageName, editId, language, imageType)</code>
112 <pre>Deletes all images for the specified language and image type.
113
114Args:
115 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
116 editId: string, Unique identifier for this edit. (required)
117 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)
118 imageType: string, A parameter (required)
119 Allowed values
120 featureGraphic -
121 icon -
122 phoneScreenshots -
123 promoGraphic -
124 sevenInchScreenshots -
125 tenInchScreenshots -
126
127Returns:
128 An object of the form:
129
130 {
131 "deleted": [
132 {
133 "url": "A String", # A URL that will serve a preview of the image.
134 "sha1": "A String", # A sha1 hash of the image that was uploaded.
135 "id": "A String", # A unique id representing this image.
136 },
137 ],
138 }</pre>
139</div>
140
141<div class="method">
142 <code class="details" id="list">list(packageName, editId, language, imageType)</code>
143 <pre>Lists all images for the specified language and image type.
144
145Args:
146 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
147 editId: string, Unique identifier for this edit. (required)
148 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)
149 imageType: string, A parameter (required)
150 Allowed values
151 featureGraphic -
152 icon -
153 phoneScreenshots -
154 promoGraphic -
155 sevenInchScreenshots -
156 tenInchScreenshots -
157
158Returns:
159 An object of the form:
160
161 {
162 "images": [
163 {
164 "url": "A String", # A URL that will serve a preview of the image.
165 "sha1": "A String", # A sha1 hash of the image that was uploaded.
166 "id": "A String", # A unique id representing this image.
167 },
168 ],
169 }</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="upload">upload(packageName, editId, language, imageType, media_body=None)</code>
174 <pre>Uploads a new image and adds it to the list of images for the specified language and image type.
175
176Args:
177 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
178 editId: string, Unique identifier for this edit. (required)
179 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)
180 imageType: string, A parameter (required)
181 Allowed values
182 featureGraphic -
183 icon -
184 phoneScreenshots -
185 promoGraphic -
186 sevenInchScreenshots -
187 tenInchScreenshots -
188 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
189
190Returns:
191 An object of the form:
192
193 {
194 "image": {
195 "url": "A String", # A URL that will serve a preview of the image.
196 "sha1": "A String", # A sha1 hash of the image that was uploaded.
197 "id": "A String", # A unique id representing this image.
198 },
199 }</pre>
200</div>
201
202</body></html>