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

blob: 0109ab6d86d2a71d64f883e1b9df8790c834b2cf [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	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	75	<h1><a href="gamesManagement_v1management.html">Google Play Game Management</a> . <a href="gamesManagement_v1management.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">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	78	<code><a href="#reset">reset(achievementId, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Resets the achievement with the given ID for the currently authenticated</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	80	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	81	<code><a href="#resetAll">resetAll(x__xgafv=None)</a></code></p>
				82	<p class="firstline">Resets all achievements for the currently authenticated player for your</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	83	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	84	<code><a href="#resetAllForAllPlayers">resetAllForAllPlayers(x__xgafv=None)</a></code></p>
				85	<p class="firstline">Resets all draft achievements for all players. This method is only</p>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	86	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	87	<code><a href="#resetForAllPlayers">resetForAllPlayers(achievementId, x__xgafv=None)</a></code></p>
				88	<p class="firstline">Resets the achievement with the given ID for all players. This method is</p>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	89	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	90	<code><a href="#resetMultipleForAllPlayers">resetMultipleForAllPlayers(body=None, x__xgafv=None)</a></code></p>
				91	<p class="firstline">Resets achievements with the given IDs for all players. This method is only</p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	92	<h3>Method Details</h3>
				93	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	94	<code class="details" id="reset">reset(achievementId, x__xgafv=None)</code>
				95	<pre>Resets the achievement with the given ID for the currently authenticated
				96	player. This method is only accessible to whitelisted tester accounts for
				97	your application.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	98
				99	Args:
				100	achievementId: string, The ID of the achievement used by this method. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	101	x__xgafv: string, V1 error format.
				102	Allowed values
				103	1 - v1 error format
				104	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	105
				106	Returns:
				107	An object of the form:
				108
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	109	{ # An achievement reset response.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	110	"currentState": "A String", # The current state of the achievement. This is the same as the initial
				111	# state of the achievement. <br/>Possible values are: <ul>
				112	# <li>"`HIDDEN`"- Achievement is hidden.</li>
				113	# <li>"`REVEALED`" - Achievement is revealed.</li>
				114	# <li>"`UNLOCKED`" - Achievement is unlocked.</li> </ul>
				115	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
				116	# string `gamesManagement#achievementResetResponse`.
				117	"updateOccurred": True or False, # Flag to indicate if the requested update actually occurred.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	118	"definitionId": "A String", # The ID of an achievement for which player state has been updated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	119	}</pre>
				120	</div>
				121
				122	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	123	<code class="details" id="resetAll">resetAll(x__xgafv=None)</code>
				124	<pre>Resets all achievements for the currently authenticated player for your
				125	application. This method is only accessible to whitelisted tester accounts
				126	for your application.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	127
				128	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	129	x__xgafv: string, V1 error format.
				130	Allowed values
				131	1 - v1 error format
				132	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	133
				134	Returns:
				135	An object of the form:
				136
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	137	{ # Achievement reset all response.
				138	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
				139	# string `gamesManagement#achievementResetAllResponse`.
				140	"results": [ # The achievement reset results.
				141	{ # An achievement reset response.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	142	"currentState": "A String", # The current state of the achievement. This is the same as the initial
				143	# state of the achievement. <br/>Possible values are: <ul>
				144	# <li>"`HIDDEN`"- Achievement is hidden.</li>
				145	# <li>"`REVEALED`" - Achievement is revealed.</li>
				146	# <li>"`UNLOCKED`" - Achievement is unlocked.</li> </ul>
				147	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
				148	# string `gamesManagement#achievementResetResponse`.
				149	"updateOccurred": True or False, # Flag to indicate if the requested update actually occurred.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	150	"definitionId": "A String", # The ID of an achievement for which player state has been updated.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	151	},
				152	],
				153	}</pre>
				154	</div>
				155
				156	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	157	<code class="details" id="resetAllForAllPlayers">resetAllForAllPlayers(x__xgafv=None)</code>
				158	<pre>Resets all draft achievements for all players. This method is only
				159	available to user accounts for your developer console.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	160
				161	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	162	x__xgafv: string, V1 error format.
				163	Allowed values
				164	1 - v1 error format
				165	2 - v2 error format
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	166	</pre>
				167	</div>
				168
				169	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	170	<code class="details" id="resetForAllPlayers">resetForAllPlayers(achievementId, x__xgafv=None)</code>
				171	<pre>Resets the achievement with the given ID for all players. This method is
				172	only available to user accounts for your developer console. Only draft
				173	achievements can be reset.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	174
				175	Args:
				176	achievementId: string, The ID of the achievement used by this method. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	177	x__xgafv: string, V1 error format.
				178	Allowed values
				179	1 - v1 error format
				180	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	181	</pre>
				182	</div>
				183
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	184	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	185	<code class="details" id="resetMultipleForAllPlayers">resetMultipleForAllPlayers(body=None, x__xgafv=None)</code>
				186	<pre>Resets achievements with the given IDs for all players. This method is only
				187	available to user accounts for your developer console. Only draft
				188	achievements may be reset.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	189
				190	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	191	body: object, The request body.
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	192	The object takes the form of:
				193
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	194	{
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	195	"kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed
				196	# string `gamesManagement#achievementResetMultipleForAllRequest`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	197	"achievement_ids": [ # The IDs of achievements to reset.
				198	"A String",
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	199	],
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	200	}
				201
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	202	x__xgafv: string, V1 error format.
				203	Allowed values
				204	1 - v1 error format
				205	2 - v2 error format
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	206	</pre>
				207	</div>
				208
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	209	</body></html>