Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / gamesConfiguration_v1configuration.achievementConfigurations.html
blob: 3519bf45b4d6db31ec88cb872b6261970721f91e [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[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="gamesConfiguration_v1configuration.html">Google Play Game Services Publishing API</a> . <a href="gamesConfiguration_v1configuration.achievementConfigurations.html">achievementConfigurations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(achievementId)</a></code></p>
79<p class="firstline">Delete the achievement configuration with the given ID.</p>
80<p class="toc_element">
81 <code><a href="#get">get(achievementId)</a></code></p>
82<p class="firstline">Retrieves the metadata of the achievement configuration with the given ID.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(applicationId, body)</a></code></p>
85<p class="firstline">Insert a new achievement configuration in this application.</p>
86<p class="toc_element">
87 <code><a href="#list">list(applicationId, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Returns a list of the achievement configurations in this application.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(achievementId, body)</a></code></p>
94<p class="firstline">Update the metadata of the achievement configuration with the given ID. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(achievementId, body)</a></code></p>
97<p class="firstline">Update the metadata of the achievement configuration with the given ID.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(achievementId)</code>
101 <pre>Delete the achievement configuration with the given ID.
102
103Args:
104 achievementId: string, The ID of the achievement used by this method. (required)
105</pre>
106</div>
107
108<div class="method">
109 <code class="details" id="get">get(achievementId)</code>
110 <pre>Retrieves the metadata of the achievement configuration with the given ID.
111
112Args:
113 achievementId: string, The ID of the achievement used by this method. (required)
114
115Returns:
116 An object of the form:
117
118 { # This is a JSON template for an achievement configuration resource.
119 "achievementType": "A String", # The type of the achievement.
120 # Possible values are:
121 # - "STANDARD" - Achievement is either locked or unlocked.
122 # - "INCREMENTAL" - Achievement is incremental.
123 "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
124 "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
125 "initialState": "A String", # The initial state of the achievement.
126 # Possible values are:
127 # - "HIDDEN" - Achievement is hidden.
128 # - "REVEALED" - Achievement is revealed.
129 # - "UNLOCKED" - Achievement is unlocked.
130 "token": "A String", # The token for this resource.
131 "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
132 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
133 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
134 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
135 "translations": [ # The locale strings.
136 { # This is a JSON template for a localized string resource.
137 "locale": "A String", # The locale string.
138 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
139 "value": "A String", # The string value.
140 },
141 ],
142 },
143 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
144 "pointValue": 42, # Point value for the achievement.
145 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
146 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
147 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
148 "translations": [ # The locale strings.
149 { # This is a JSON template for a localized string resource.
150 "locale": "A String", # The locale string.
151 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
152 "value": "A String", # The string value.
153 },
154 ],
155 },
156 },
157 "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
158 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
159 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
160 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
161 "translations": [ # The locale strings.
162 { # This is a JSON template for a localized string resource.
163 "locale": "A String", # The locale string.
164 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
165 "value": "A String", # The string value.
166 },
167 ],
168 },
169 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
170 "pointValue": 42, # Point value for the achievement.
171 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
172 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
173 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
174 "translations": [ # The locale strings.
175 { # This is a JSON template for a localized string resource.
176 "locale": "A String", # The locale string.
177 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
178 "value": "A String", # The string value.
179 },
180 ],
181 },
182 },
183 "id": "A String", # The ID of the achievement.
184 }</pre>
185</div>
186
187<div class="method">
188 <code class="details" id="insert">insert(applicationId, body)</code>
189 <pre>Insert a new achievement configuration in this application.
190
191Args:
192 applicationId: string, The application ID from the Google Play developer console. (required)
193 body: object, The request body. (required)
194 The object takes the form of:
195
196{ # This is a JSON template for an achievement configuration resource.
197 "achievementType": "A String", # The type of the achievement.
198 # Possible values are:
199 # - "STANDARD" - Achievement is either locked or unlocked.
200 # - "INCREMENTAL" - Achievement is incremental.
201 "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
202 "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
203 "initialState": "A String", # The initial state of the achievement.
204 # Possible values are:
205 # - "HIDDEN" - Achievement is hidden.
206 # - "REVEALED" - Achievement is revealed.
207 # - "UNLOCKED" - Achievement is unlocked.
208 "token": "A String", # The token for this resource.
209 "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
210 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
211 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
212 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
213 "translations": [ # The locale strings.
214 { # This is a JSON template for a localized string resource.
215 "locale": "A String", # The locale string.
216 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
217 "value": "A String", # The string value.
218 },
219 ],
220 },
221 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
222 "pointValue": 42, # Point value for the achievement.
223 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
224 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
225 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
226 "translations": [ # The locale strings.
227 { # This is a JSON template for a localized string resource.
228 "locale": "A String", # The locale string.
229 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
230 "value": "A String", # The string value.
231 },
232 ],
233 },
234 },
235 "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
236 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
237 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
238 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
239 "translations": [ # The locale strings.
240 { # This is a JSON template for a localized string resource.
241 "locale": "A String", # The locale string.
242 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
243 "value": "A String", # The string value.
244 },
245 ],
246 },
247 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
248 "pointValue": 42, # Point value for the achievement.
249 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
250 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
251 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
252 "translations": [ # The locale strings.
253 { # This is a JSON template for a localized string resource.
254 "locale": "A String", # The locale string.
255 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
256 "value": "A String", # The string value.
257 },
258 ],
259 },
260 },
261 "id": "A String", # The ID of the achievement.
262 }
263
264
265Returns:
266 An object of the form:
267
268 { # This is a JSON template for an achievement configuration resource.
269 "achievementType": "A String", # The type of the achievement.
270 # Possible values are:
271 # - "STANDARD" - Achievement is either locked or unlocked.
272 # - "INCREMENTAL" - Achievement is incremental.
273 "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
274 "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
275 "initialState": "A String", # The initial state of the achievement.
276 # Possible values are:
277 # - "HIDDEN" - Achievement is hidden.
278 # - "REVEALED" - Achievement is revealed.
279 # - "UNLOCKED" - Achievement is unlocked.
280 "token": "A String", # The token for this resource.
281 "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
282 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
283 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
284 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
285 "translations": [ # The locale strings.
286 { # This is a JSON template for a localized string resource.
287 "locale": "A String", # The locale string.
288 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
289 "value": "A String", # The string value.
290 },
291 ],
292 },
293 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
294 "pointValue": 42, # Point value for the achievement.
295 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
296 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
297 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
298 "translations": [ # The locale strings.
299 { # This is a JSON template for a localized string resource.
300 "locale": "A String", # The locale string.
301 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
302 "value": "A String", # The string value.
303 },
304 ],
305 },
306 },
307 "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
308 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
309 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
310 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
311 "translations": [ # The locale strings.
312 { # This is a JSON template for a localized string resource.
313 "locale": "A String", # The locale string.
314 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
315 "value": "A String", # The string value.
316 },
317 ],
318 },
319 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
320 "pointValue": 42, # Point value for the achievement.
321 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
322 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
323 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
324 "translations": [ # The locale strings.
325 { # This is a JSON template for a localized string resource.
326 "locale": "A String", # The locale string.
327 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
328 "value": "A String", # The string value.
329 },
330 ],
331 },
332 },
333 "id": "A String", # The ID of the achievement.
334 }</pre>
335</div>
336
337<div class="method">
338 <code class="details" id="list">list(applicationId, pageToken=None, maxResults=None)</code>
339 <pre>Returns a list of the achievement configurations in this application.
340
341Args:
342 applicationId: string, The application ID from the Google Play developer console. (required)
343 pageToken: string, The token returned by the previous request.
344 maxResults: integer, The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults.
345
346Returns:
347 An object of the form:
348
349 { # This is a JSON template for a ListConfigurations response.
350 "nextPageToken": "A String", # The pagination token for the next page of results.
351 "items": [ # The achievement configurations.
352 { # This is a JSON template for an achievement configuration resource.
353 "achievementType": "A String", # The type of the achievement.
354 # Possible values are:
355 # - "STANDARD" - Achievement is either locked or unlocked.
356 # - "INCREMENTAL" - Achievement is incremental.
357 "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
358 "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
359 "initialState": "A String", # The initial state of the achievement.
360 # Possible values are:
361 # - "HIDDEN" - Achievement is hidden.
362 # - "REVEALED" - Achievement is revealed.
363 # - "UNLOCKED" - Achievement is unlocked.
364 "token": "A String", # The token for this resource.
365 "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
366 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
367 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
368 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
369 "translations": [ # The locale strings.
370 { # This is a JSON template for a localized string resource.
371 "locale": "A String", # The locale string.
372 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
373 "value": "A String", # The string value.
374 },
375 ],
376 },
377 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
378 "pointValue": 42, # Point value for the achievement.
379 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
380 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
381 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
382 "translations": [ # The locale strings.
383 { # This is a JSON template for a localized string resource.
384 "locale": "A String", # The locale string.
385 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
386 "value": "A String", # The string value.
387 },
388 ],
389 },
390 },
391 "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
392 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
393 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
394 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
395 "translations": [ # The locale strings.
396 { # This is a JSON template for a localized string resource.
397 "locale": "A String", # The locale string.
398 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
399 "value": "A String", # The string value.
400 },
401 ],
402 },
403 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
404 "pointValue": 42, # Point value for the achievement.
405 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
406 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
407 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
408 "translations": [ # The locale strings.
409 { # This is a JSON template for a localized string resource.
410 "locale": "A String", # The locale string.
411 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
412 "value": "A String", # The string value.
413 },
414 ],
415 },
416 },
417 "id": "A String", # The ID of the achievement.
418 },
419 ],
420 "kind": "gamesConfiguration#achievementConfigurationListResponse", # Uniquely identifies the type of this resource. Value is always the fixed string games#achievementConfigurationListResponse.
421 }</pre>
422</div>
423
424<div class="method">
425 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
426 <pre>Retrieves the next page of results.
427
428Args:
429 previous_request: The request for the previous page. (required)
430 previous_response: The response from the request for the previous page. (required)
431
432Returns:
433 A request object that you can call 'execute()' on to request the next
434 page. Returns None if there are no more items in the collection.
435 </pre>
436</div>
437
438<div class="method">
439 <code class="details" id="patch">patch(achievementId, body)</code>
440 <pre>Update the metadata of the achievement configuration with the given ID. This method supports patch semantics.
441
442Args:
443 achievementId: string, The ID of the achievement used by this method. (required)
444 body: object, The request body. (required)
445 The object takes the form of:
446
447{ # This is a JSON template for an achievement configuration resource.
448 "achievementType": "A String", # The type of the achievement.
449 # Possible values are:
450 # - "STANDARD" - Achievement is either locked or unlocked.
451 # - "INCREMENTAL" - Achievement is incremental.
452 "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
453 "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
454 "initialState": "A String", # The initial state of the achievement.
455 # Possible values are:
456 # - "HIDDEN" - Achievement is hidden.
457 # - "REVEALED" - Achievement is revealed.
458 # - "UNLOCKED" - Achievement is unlocked.
459 "token": "A String", # The token for this resource.
460 "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
461 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
462 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
463 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
464 "translations": [ # The locale strings.
465 { # This is a JSON template for a localized string resource.
466 "locale": "A String", # The locale string.
467 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
468 "value": "A String", # The string value.
469 },
470 ],
471 },
472 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
473 "pointValue": 42, # Point value for the achievement.
474 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
475 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
476 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
477 "translations": [ # The locale strings.
478 { # This is a JSON template for a localized string resource.
479 "locale": "A String", # The locale string.
480 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
481 "value": "A String", # The string value.
482 },
483 ],
484 },
485 },
486 "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
487 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
488 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
489 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
490 "translations": [ # The locale strings.
491 { # This is a JSON template for a localized string resource.
492 "locale": "A String", # The locale string.
493 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
494 "value": "A String", # The string value.
495 },
496 ],
497 },
498 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
499 "pointValue": 42, # Point value for the achievement.
500 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
501 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
502 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
503 "translations": [ # The locale strings.
504 { # This is a JSON template for a localized string resource.
505 "locale": "A String", # The locale string.
506 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
507 "value": "A String", # The string value.
508 },
509 ],
510 },
511 },
512 "id": "A String", # The ID of the achievement.
513 }
514
515
516Returns:
517 An object of the form:
518
519 { # This is a JSON template for an achievement configuration resource.
520 "achievementType": "A String", # The type of the achievement.
521 # Possible values are:
522 # - "STANDARD" - Achievement is either locked or unlocked.
523 # - "INCREMENTAL" - Achievement is incremental.
524 "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
525 "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
526 "initialState": "A String", # The initial state of the achievement.
527 # Possible values are:
528 # - "HIDDEN" - Achievement is hidden.
529 # - "REVEALED" - Achievement is revealed.
530 # - "UNLOCKED" - Achievement is unlocked.
531 "token": "A String", # The token for this resource.
532 "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
533 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
534 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
535 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
536 "translations": [ # The locale strings.
537 { # This is a JSON template for a localized string resource.
538 "locale": "A String", # The locale string.
539 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
540 "value": "A String", # The string value.
541 },
542 ],
543 },
544 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
545 "pointValue": 42, # Point value for the achievement.
546 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
547 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
548 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
549 "translations": [ # The locale strings.
550 { # This is a JSON template for a localized string resource.
551 "locale": "A String", # The locale string.
552 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
553 "value": "A String", # The string value.
554 },
555 ],
556 },
557 },
558 "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
559 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
560 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
561 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
562 "translations": [ # The locale strings.
563 { # This is a JSON template for a localized string resource.
564 "locale": "A String", # The locale string.
565 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
566 "value": "A String", # The string value.
567 },
568 ],
569 },
570 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
571 "pointValue": 42, # Point value for the achievement.
572 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
573 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
574 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
575 "translations": [ # The locale strings.
576 { # This is a JSON template for a localized string resource.
577 "locale": "A String", # The locale string.
578 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
579 "value": "A String", # The string value.
580 },
581 ],
582 },
583 },
584 "id": "A String", # The ID of the achievement.
585 }</pre>
586</div>
587
588<div class="method">
589 <code class="details" id="update">update(achievementId, body)</code>
590 <pre>Update the metadata of the achievement configuration with the given ID.
591
592Args:
593 achievementId: string, The ID of the achievement used by this method. (required)
594 body: object, The request body. (required)
595 The object takes the form of:
596
597{ # This is a JSON template for an achievement configuration resource.
598 "achievementType": "A String", # The type of the achievement.
599 # Possible values are:
600 # - "STANDARD" - Achievement is either locked or unlocked.
601 # - "INCREMENTAL" - Achievement is incremental.
602 "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
603 "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
604 "initialState": "A String", # The initial state of the achievement.
605 # Possible values are:
606 # - "HIDDEN" - Achievement is hidden.
607 # - "REVEALED" - Achievement is revealed.
608 # - "UNLOCKED" - Achievement is unlocked.
609 "token": "A String", # The token for this resource.
610 "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
611 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
612 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
613 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
614 "translations": [ # The locale strings.
615 { # This is a JSON template for a localized string resource.
616 "locale": "A String", # The locale string.
617 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
618 "value": "A String", # The string value.
619 },
620 ],
621 },
622 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
623 "pointValue": 42, # Point value for the achievement.
624 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
625 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
626 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
627 "translations": [ # The locale strings.
628 { # This is a JSON template for a localized string resource.
629 "locale": "A String", # The locale string.
630 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
631 "value": "A String", # The string value.
632 },
633 ],
634 },
635 },
636 "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
637 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
638 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
639 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
640 "translations": [ # The locale strings.
641 { # This is a JSON template for a localized string resource.
642 "locale": "A String", # The locale string.
643 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
644 "value": "A String", # The string value.
645 },
646 ],
647 },
648 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
649 "pointValue": 42, # Point value for the achievement.
650 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
651 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
652 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
653 "translations": [ # The locale strings.
654 { # This is a JSON template for a localized string resource.
655 "locale": "A String", # The locale string.
656 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
657 "value": "A String", # The string value.
658 },
659 ],
660 },
661 },
662 "id": "A String", # The ID of the achievement.
663 }
664
665
666Returns:
667 An object of the form:
668
669 { # This is a JSON template for an achievement configuration resource.
670 "achievementType": "A String", # The type of the achievement.
671 # Possible values are:
672 # - "STANDARD" - Achievement is either locked or unlocked.
673 # - "INCREMENTAL" - Achievement is incremental.
674 "stepsToUnlock": 42, # Steps to unlock. Only applicable to incremental achievements.
675 "kind": "gamesConfiguration#achievementConfiguration", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration.
676 "initialState": "A String", # The initial state of the achievement.
677 # Possible values are:
678 # - "HIDDEN" - Achievement is hidden.
679 # - "REVEALED" - Achievement is revealed.
680 # - "UNLOCKED" - Achievement is unlocked.
681 "token": "A String", # The token for this resource.
682 "draft": { # This is a JSON template for an achievement configuration detail. # The draft data of the achievement.
683 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
684 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
685 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
686 "translations": [ # The locale strings.
687 { # This is a JSON template for a localized string resource.
688 "locale": "A String", # The locale string.
689 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
690 "value": "A String", # The string value.
691 },
692 ],
693 },
694 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
695 "pointValue": 42, # Point value for the achievement.
696 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
697 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
698 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
699 "translations": [ # The locale strings.
700 { # This is a JSON template for a localized string resource.
701 "locale": "A String", # The locale string.
702 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
703 "value": "A String", # The string value.
704 },
705 ],
706 },
707 },
708 "published": { # This is a JSON template for an achievement configuration detail. # The read-only published data of the achievement.
709 "kind": "gamesConfiguration#achievementConfigurationDetail", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail.
710 "description": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement description.
711 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
712 "translations": [ # The locale strings.
713 { # This is a JSON template for a localized string resource.
714 "locale": "A String", # The locale string.
715 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
716 "value": "A String", # The string value.
717 },
718 ],
719 },
720 "iconUrl": "A String", # The icon url of this achievement. Writes to this field are ignored.
721 "pointValue": 42, # Point value for the achievement.
722 "sortRank": 42, # The sort rank of this achievement. Writes to this field are ignored.
723 "name": { # This is a JSON template for a localized string bundle resource. # Localized strings for the achievement name.
724 "kind": "gamesConfiguration#localizedStringBundle", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle.
725 "translations": [ # The locale strings.
726 { # This is a JSON template for a localized string resource.
727 "locale": "A String", # The locale string.
728 "kind": "gamesConfiguration#localizedString", # Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString.
729 "value": "A String", # The string value.
730 },
731 ],
732 },
733 },
734 "id": "A String", # The ID of the achievement.
735 }</pre>
736</div>
737
738</body></html>