blob: 204ef088e76e37cd0b4a74b8846e76d0abb91629 [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
Nathaniel Manista4f877e52015-06-15 16:44:50 +000075<h1><a href="androidpublisher_v2.html">Google Play Developer API</a> . <a href="androidpublisher_v2.edits.html">edits</a></h1>
Craig Citro065b5302014-08-14 00:47:23 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="androidpublisher_v2.edits.apklistings.html">apklistings()</a></code>
79</p>
80<p class="firstline">Returns the apklistings Resource.</p>
81
82<p class="toc_element">
83 <code><a href="androidpublisher_v2.edits.apks.html">apks()</a></code>
84</p>
85<p class="firstline">Returns the apks Resource.</p>
86
87<p class="toc_element">
88 <code><a href="androidpublisher_v2.edits.details.html">details()</a></code>
89</p>
90<p class="firstline">Returns the details Resource.</p>
91
92<p class="toc_element">
93 <code><a href="androidpublisher_v2.edits.expansionfiles.html">expansionfiles()</a></code>
94</p>
95<p class="firstline">Returns the expansionfiles Resource.</p>
96
97<p class="toc_element">
98 <code><a href="androidpublisher_v2.edits.images.html">images()</a></code>
99</p>
100<p class="firstline">Returns the images Resource.</p>
101
102<p class="toc_element">
103 <code><a href="androidpublisher_v2.edits.listings.html">listings()</a></code>
104</p>
105<p class="firstline">Returns the listings Resource.</p>
106
107<p class="toc_element">
108 <code><a href="androidpublisher_v2.edits.testers.html">testers()</a></code>
109</p>
110<p class="firstline">Returns the testers Resource.</p>
111
112<p class="toc_element">
113 <code><a href="androidpublisher_v2.edits.tracks.html">tracks()</a></code>
114</p>
115<p class="firstline">Returns the tracks Resource.</p>
116
117<p class="toc_element">
118 <code><a href="#commit">commit(packageName, editId)</a></code></p>
119<p class="firstline">Commits/applies the changes made in this edit back to the app.</p>
120<p class="toc_element">
121 <code><a href="#delete">delete(packageName, editId)</a></code></p>
122<p class="firstline">Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.</p>
123<p class="toc_element">
124 <code><a href="#get">get(packageName, editId)</a></code></p>
125<p class="firstline">Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).</p>
126<p class="toc_element">
127 <code><a href="#insert">insert(packageName, body)</a></code></p>
128<p class="firstline">Creates a new edit for an app, populated with the app's current state.</p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700129<p class="toc_element">
130 <code><a href="#validate">validate(packageName, editId)</a></code></p>
131<p class="firstline">Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700132<h3>Method Details</h3>
133<div class="method">
134 <code class="details" id="commit">commit(packageName, editId)</code>
135 <pre>Commits/applies the changes made in this edit back to the app.
136
137Args:
138 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
139 editId: string, Unique identifier for this edit. (required)
140
141Returns:
142 An object of the form:
143
144 { # Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
145 "expiryTimeSeconds": "A String", # The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
146 "id": "A String", # The ID of the edit that can be used in subsequent API calls.
147 }</pre>
148</div>
149
150<div class="method">
151 <code class="details" id="delete">delete(packageName, editId)</code>
152 <pre>Deletes an edit for an app. Creating a new edit will automatically delete any of your previous edits so this method need only be called if you want to preemptively abandon an edit.
153
154Args:
155 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
156 editId: string, Unique identifier for this edit. (required)
157</pre>
158</div>
159
160<div class="method">
161 <code class="details" id="get">get(packageName, editId)</code>
162 <pre>Returns information about the edit specified. Calls will fail if the edit is no long active (e.g. has been deleted, superseded or expired).
163
164Args:
165 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
166 editId: string, Unique identifier for this edit. (required)
167
168Returns:
169 An object of the form:
170
171 { # Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
172 "expiryTimeSeconds": "A String", # The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
173 "id": "A String", # The ID of the edit that can be used in subsequent API calls.
174 }</pre>
175</div>
176
177<div class="method">
178 <code class="details" id="insert">insert(packageName, body)</code>
179 <pre>Creates a new edit for an app, populated with the app's current state.
180
181Args:
182 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
183 body: object, The request body. (required)
184 The object takes the form of:
185
186{ # Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
187 "expiryTimeSeconds": "A String", # The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
188 "id": "A String", # The ID of the edit that can be used in subsequent API calls.
189}
190
191
192Returns:
193 An object of the form:
194
195 { # Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
196 "expiryTimeSeconds": "A String", # The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
197 "id": "A String", # The ID of the edit that can be used in subsequent API calls.
198 }</pre>
199</div>
200
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700201<div class="method">
202 <code class="details" id="validate">validate(packageName, editId)</code>
203 <pre>Checks that the edit can be successfully committed. The edit's changes are not applied to the live app.
204
205Args:
206 packageName: string, Unique identifier for the Android app that is being updated; for example, "com.spiffygame". (required)
207 editId: string, Unique identifier for this edit. (required)
208
209Returns:
210 An object of the form:
211
212 { # Represents an edit of an app. An edit allows clients to make multiple changes before committing them in one operation.
213 "expiryTimeSeconds": "A String", # The time at which the edit will expire and will be no longer valid for use in any subsequent API calls (encoded as seconds since the Epoch).
214 "id": "A String", # The ID of the edit that can be used in subsequent API calls.
215 }</pre>
216</div>
217
Craig Citro065b5302014-08-14 00:47:23 -0700218</body></html>