Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 09e644719166aecb21a01b6d5ee9898843e7cd58 / . / docs / dyn / gamesManagement_v1management.achievements.html
blob: 9f6505ca2a1075ac2eadaccc069bab13863af7c9 [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
75<h1><a href="gamesManagement_v1management.html">Google Play Game Services Management API</a> . <a href="gamesManagement_v1management.achievements.html">achievements</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#reset">reset(achievementId)</a></code></p>
79<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>
80<p class="toc_element">
81 <code><a href="#resetAll">resetAll()</a></code></p>
82<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>
83<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]84 <code><a href="#resetAllForAllPlayers">resetAllForAllPlayers()</a></code></p>
85<p class="firstline">Resets all draft achievements for all players. This method is only available to user accounts for your developer console.</p>
86<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]87 <code><a href="#resetForAllPlayers">resetForAllPlayers(achievementId)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]88<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>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#resetMultipleForAllPlayers">resetMultipleForAllPlayers(body=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]91<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]92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="reset">reset(achievementId)</code>
95 <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.
96
97Args:
98 achievementId: string, The ID of the achievement used by this method. (required)
99
100Returns:
101 An object of the form:
102
103 { # This is a JSON template for an achievement reset response.
104 "definitionId": "A String", # The ID of an achievement for which player state has been updated.
105 "kind": "gamesManagement#achievementResetResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse.
106 "updateOccurred": True or False, # Flag to indicate if the requested update actually occurred.
107 "currentState": "A String", # The current state of the achievement. This is the same as the initial state of the achievement.
108 # Possible values are:
109 # - "HIDDEN"- Achievement is hidden.
110 # - "REVEALED" - Achievement is revealed.
111 # - "UNLOCKED" - Achievement is unlocked.
112 }</pre>
113</div>
114
115<div class="method">
116 <code class="details" id="resetAll">resetAll()</code>
117 <pre>Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.
118
119Args:
120
121Returns:
122 An object of the form:
123
124 { # This is a JSON template for achievement reset all response.
125 "kind": "gamesManagement#achievementResetAllResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetAllResponse.
126 "results": [ # The achievement reset results.
127 { # This is a JSON template for an achievement reset response.
128 "definitionId": "A String", # The ID of an achievement for which player state has been updated.
129 "kind": "gamesManagement#achievementResetResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse.
130 "updateOccurred": True or False, # Flag to indicate if the requested update actually occurred.
131 "currentState": "A String", # The current state of the achievement. This is the same as the initial state of the achievement.
132 # Possible values are:
133 # - "HIDDEN"- Achievement is hidden.
134 # - "REVEALED" - Achievement is revealed.
135 # - "UNLOCKED" - Achievement is unlocked.
136 },
137 ],
138 }</pre>
139</div>
140
141<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]142 <code class="details" id="resetAllForAllPlayers">resetAllForAllPlayers()</code>
143 <pre>Resets all draft achievements for all players. This method is only available to user accounts for your developer console.
144
145Args:
146</pre>
147</div>
148
149<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]150 <code class="details" id="resetForAllPlayers">resetForAllPlayers(achievementId)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]151 <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]152
153Args:
154 achievementId: string, The ID of the achievement used by this method. (required)
155</pre>
156</div>
157
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]158<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]159 <code class="details" id="resetMultipleForAllPlayers">resetMultipleForAllPlayers(body=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]160 <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]161
162Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]163 body: object, The request body.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]164 The object takes the form of:
165
166{ # This is a JSON template for multiple achievements reset all request.
167 "achievement_ids": [ # The IDs of achievements to reset.
168 "A String",
169 ],
170 "kind": "gamesManagement#achievementResetMultipleForAllRequest", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetMultipleForAllRequest.
171 }
172
173</pre>
174</div>
175
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]176</body></html>