Blame - docs/dyn/games_v1.achievements.html - platform/external/python/google-api-python-client

blob: 8080e3f3ddf19ac61b6b3e1a7e26379f813890f1 [file] [log] [blame]

John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	75	<h1><a href="games_v1.html">Google Play Game Services</a> . <a href="games_v1.achievements.html">achievements</a></h1>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	80	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	81	<code><a href="#increment">increment(achievementId, stepsToIncrement, requestId=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Increments the steps of the achievement with the given ID for the currently authenticated player.</p>
				83	<p class="toc_element">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	84	<code><a href="#list">list(playerId, language=None, state=None, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	85	<p class="firstline">Lists the progress for all your application's achievements for the currently authenticated player.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	86	<p class="toc_element">
				87	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				88	<p class="firstline">Retrieves the next page of results.</p>
				89	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	90	<code><a href="#reveal">reveal(achievementId, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<p class="firstline">Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	92	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	93	<code><a href="#setStepsAtLeast">setStepsAtLeast(achievementId, steps, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<p class="firstline">Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified.</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	95	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	96	<code><a href="#unlock">unlock(achievementId, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	97	<p class="firstline">Unlocks this achievement for the currently authenticated player.</p>
				98	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	99	<code><a href="#updateMultiple">updateMultiple(body=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	100	<p class="firstline">Updates multiple achievements for the currently authenticated player.</p>
				101	<h3>Method Details</h3>
				102	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	<code class="details" id="close">close()</code>
				104	<pre>Close httplib2 connections.</pre>
				105	</div>
				106
				107	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	108	<code class="details" id="increment">increment(achievementId, stepsToIncrement, requestId=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	109	<pre>Increments the steps of the achievement with the given ID for the currently authenticated player.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	110
				111	Args:
				112	achievementId: string, The ID of the achievement used by this method. (required)
				113	stepsToIncrement: integer, The number of steps to increment. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	114	requestId: string, A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	115	x__xgafv: string, V1 error format.
				116	Allowed values
				117	1 - v1 error format
				118	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	119
				120	Returns:
				121	An object of the form:
				122
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	123	{ # An achievement increment response
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	124	"newlyUnlocked": True or False, # Whether the current steps for the achievement has reached the number of steps required to unlock.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	125	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementIncrementResponse`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	126	"currentSteps": 42, # The current steps recorded for this incremental achievement.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	127	}</pre>
				128	</div>
				129
				130	<div class="method">
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	131	<code class="details" id="list">list(playerId, language=None, state=None, pageToken=None, maxResults=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	132	<pre>Lists the progress for all your application's achievements for the currently authenticated player.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	133
				134	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	135	playerId: string, A player ID. A value of `me` may be used in place of the authenticated player's ID. (required)
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	136	language: string, The preferred language to use for strings returned by this method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	137	state: string, Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned.
				138	Allowed values
				139	ALL - List all achievements. This is the default.
				140	HIDDEN - List only hidden achievements.
				141	REVEALED - List only revealed achievements.
				142	UNLOCKED - List only unlocked achievements.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	143	pageToken: string, The token returned by the previous request.
				144	maxResults: integer, The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified `maxResults`.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	145	x__xgafv: string, V1 error format.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	146	Allowed values
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	147	1 - v1 error format
				148	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	149
				150	Returns:
				151	An object of the form:
				152
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	153	{ # A list of achievement objects.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	154	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievementListResponse`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	155	"nextPageToken": "A String", # Token corresponding to the next page of results.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	156	"items": [ # The achievements.
				157	{ # An achievement object.
				158	"achievementState": "A String", # The state of the achievement.
				159	"experiencePoints": "A String", # Experience points earned for the achievement. This field is absent for achievements that have not yet been unlocked and 0 for achievements that have been unlocked by testers but that are unpublished.
				160	"id": "A String", # The ID of the achievement.
				161	"currentSteps": 42, # The current steps for an incremental achievement.
				162	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievement`.
				163	"lastUpdatedTimestamp": "A String", # The timestamp of the last modification to this achievement's state.
				164	"formattedCurrentStepsString": "A String", # The current steps for an incremental achievement as a string.
				165	},
				166	],
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	167	}</pre>
				168	</div>
				169
				170	<div class="method">
				171	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				172	<pre>Retrieves the next page of results.
				173
				174	Args:
				175	previous_request: The request for the previous page. (required)
				176	previous_response: The response from the request for the previous page. (required)
				177
				178	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	179	A request object that you can call 'execute()' on to request the next
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	180	page. Returns None if there are no more items in the collection.
				181	</pre>
				182	</div>
				183
				184	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	185	<code class="details" id="reveal">reveal(achievementId, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	186	<pre>Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	187
				188	Args:
				189	achievementId: string, The ID of the achievement used by this method. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	190	x__xgafv: string, V1 error format.
				191	Allowed values
				192	1 - v1 error format
				193	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	194
				195	Returns:
				196	An object of the form:
				197
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	198	{ # An achievement reveal response
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	199	"currentState": "A String", # The current state of the achievement for which a reveal was attempted. This might be `UNLOCKED` if the achievement was already unlocked.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	200	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementRevealResponse`.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	201	}</pre>
				202	</div>
				203
				204	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	205	<code class="details" id="setStepsAtLeast">setStepsAtLeast(achievementId, steps, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	206	<pre>Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	207
				208	Args:
				209	achievementId: string, The ID of the achievement used by this method. (required)
				210	steps: integer, The minimum value to set the steps to. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	211	x__xgafv: string, V1 error format.
				212	Allowed values
				213	1 - v1 error format
				214	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	215
				216	Returns:
				217	An object of the form:
				218
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	219	{ # An achievement set steps at least response.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	220	"newlyUnlocked": True or False, # Whether the current steps for the achievement has reached the number of steps required to unlock.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	221	"currentSteps": 42, # The current steps recorded for this incremental achievement.
				222	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementSetStepsAtLeastResponse`.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	223	}</pre>
				224	</div>
				225
				226	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	227	<code class="details" id="unlock">unlock(achievementId, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	228	<pre>Unlocks this achievement for the currently authenticated player.
				229
				230	Args:
				231	achievementId: string, The ID of the achievement used by this method. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	232	x__xgafv: string, V1 error format.
				233	Allowed values
				234	1 - v1 error format
				235	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	236
				237	Returns:
				238	An object of the form:
				239
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	240	{ # An achievement unlock response
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	241	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUnlockResponse`.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	242	"newlyUnlocked": True or False, # Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	243	}</pre>
				244	</div>
				245
				246	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	247	<code class="details" id="updateMultiple">updateMultiple(body=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	248	<pre>Updates multiple achievements for the currently authenticated player.
				249
				250	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	251	body: object, The request body.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	252	The object takes the form of:
				253
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	254	{ # A list of achievement update requests.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	255	"updates": [ # The individual achievement update requests.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	256	{ # A request to update an achievement.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	257	"setStepsAtLeastPayload": { # The payload to request to increment an achievement. # The payload if an update of type `SET_STEPS_AT_LEAST` was requested for the achievement.
				258	"steps": 42, # The minimum number of steps for the achievement to be set to.
				259	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#GamesAchievementSetStepsAtLeast`.
				260	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	261	"achievementId": "A String", # The achievement this update is being applied to.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	262	"incrementPayload": { # The payload to request to increment an achievement. # The payload if an update of type `INCREMENT` was requested for the achievement.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	263	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#GamesAchievementIncrement`.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	264	"steps": 42, # The number of steps to be incremented.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	265	"requestId": "A String", # The requestId associated with an increment to an achievement.
				266	},
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	267	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateRequest`.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	268	"updateType": "A String", # The type of update being applied.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	269	},
				270	],
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	271	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateMultipleRequest`.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	272	}
				273
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	274	x__xgafv: string, V1 error format.
				275	Allowed values
				276	1 - v1 error format
				277	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	278
				279	Returns:
				280	An object of the form:
				281
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	282	{ # Response message for UpdateMultipleAchievements rpc.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	283	"updatedAchievements": [ # The updated state of the achievements.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	284	{ # An updated achievement.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	285	"updateOccurred": True or False, # Whether the requested updates actually affected the achievement.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	286	"achievementId": "A String", # The achievement this update is was applied to.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	287	"newlyUnlocked": True or False, # Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player).
				288	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateResponse`.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	289	"currentSteps": 42, # The current steps recorded for this achievement if it is incremental.
				290	"currentState": "A String", # The current state of the achievement.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	291	},
				292	],
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	293	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateMultipleResponse`.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	294	}</pre>
				295	</div>
				296
				297	</body></html>