Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0b400f97be45808ade211ca8291b2e1d9476bde1 / . / docs / dyn / gamesManagement_v1management.achievements.html
blob: 7d7e76e830e665169ffab414684191c73200dac9 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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
Bu Sun Kim65020912020-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 Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-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>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#reset">reset(achievementId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Resets the achievement with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]84 <code><a href="#resetAll">resetAll(x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#resetAllForAllPlayers">resetAllForAllPlayers(x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Resets all draft achievements for all players. This method is only available to user accounts for your developer console.</p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]89<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]90 <code><a href="#resetForAllPlayers">resetForAllPlayers(achievementId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">Resets the achievement with the given ID for all players. This method is only available to user accounts for your developer console. Only draft achievements can be reset.</p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]92<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]93 <code><a href="#resetMultipleForAllPlayers">resetMultipleForAllPlayers(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94<p class="firstline">Resets achievements with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft achievements may be reset.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 <code class="details" id="reset">reset(achievementId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <pre>Resets the achievement with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104
105Args:
106 achievementId: string, The ID of the achievement used by this method. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111
112Returns:
113 An object of the form:
114
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 { # An achievement reset response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]116 &quot;currentState&quot;: &quot;A String&quot;, # The current state of the achievement. This is the same as the initial state of the achievement. Possible values are: - &quot;`HIDDEN`&quot;- Achievement is hidden. - &quot;`REVEALED`&quot; - Achievement is revealed. - &quot;`UNLOCKED`&quot; - Achievement is unlocked.
117 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of an achievement for which player state has been updated.
118 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#achievementResetResponse`.
119 &quot;updateOccurred&quot;: True or False, # Flag to indicate if the requested update actually occurred.
120}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]121</div>
122
123<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]124 <code class="details" id="resetAll">resetAll(x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]125 <pre>Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]126
127Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 x__xgafv: string, V1 error format.
129 Allowed values
130 1 - v1 error format
131 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]132
133Returns:
134 An object of the form:
135
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136 { # Achievement reset all response.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]137 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#achievementResetAllResponse`.
138 &quot;results&quot;: [ # The achievement reset results.
139 { # An achievement reset response.
140 &quot;currentState&quot;: &quot;A String&quot;, # The current state of the achievement. This is the same as the initial state of the achievement. Possible values are: - &quot;`HIDDEN`&quot;- Achievement is hidden. - &quot;`REVEALED`&quot; - Achievement is revealed. - &quot;`UNLOCKED`&quot; - Achievement is unlocked.
141 &quot;definitionId&quot;: &quot;A String&quot;, # The ID of an achievement for which player state has been updated.
142 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#achievementResetResponse`.
143 &quot;updateOccurred&quot;: True or False, # Flag to indicate if the requested update actually occurred.
144 },
145 ],
146}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]147</div>
148
149<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 <code class="details" id="resetAllForAllPlayers">resetAllForAllPlayers(x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]151 <pre>Resets all draft achievements for all players. This method is only available to user accounts for your developer console.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]152
153Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]158</pre>
159</div>
160
161<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 <code class="details" id="resetForAllPlayers">resetForAllPlayers(achievementId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]163 <pre>Resets the achievement with the given ID for all players. This method is only available to user accounts for your developer console. Only draft achievements can be reset.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]164
165Args:
166 achievementId: string, The ID of the achievement used by this method. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]171</pre>
172</div>
173
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]174<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]175 <code class="details" id="resetMultipleForAllPlayers">resetMultipleForAllPlayers(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]176 <pre>Resets achievements with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft achievements may be reset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]177
178Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]179 body: object, The request body.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]180 The object takes the form of:
181
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]183 &quot;achievement_ids&quot;: [ # The IDs of achievements to reset.
184 &quot;A String&quot;,
185 ],
186 &quot;kind&quot;: &quot;A String&quot;, # Uniquely identifies the type of this resource. Value is always the fixed string `gamesManagement#achievementResetMultipleForAllRequest`.
187}
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]188
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]189 x__xgafv: string, V1 error format.
190 Allowed values
191 1 - v1 error format
192 2 - v2 error format
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]193</pre>
194</div>
195
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]196</body></html>