blob: 72bcb7b0b727d869638fd787640d98571affc9c7 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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">
84 <code><a href="#resetForAllPlayers">resetForAllPlayers(achievementId)</a></code></p>
85<p class="firstline">Resets the achievement with the given ID for the all players. This method is only available to user accounts for your developer console. Only draft achievements can be reset.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="reset">reset(achievementId)</code>
89 <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.
90
91Args:
92 achievementId: string, The ID of the achievement used by this method. (required)
93
94Returns:
95 An object of the form:
96
97 { # This is a JSON template for an achievement reset response.
98 "definitionId": "A String", # The ID of an achievement for which player state has been updated.
99 "kind": "gamesManagement#achievementResetResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse.
100 "updateOccurred": True or False, # Flag to indicate if the requested update actually occurred.
101 "currentState": "A String", # The current state of the achievement. This is the same as the initial state of the achievement.
102 # Possible values are:
103 # - "HIDDEN"- Achievement is hidden.
104 # - "REVEALED" - Achievement is revealed.
105 # - "UNLOCKED" - Achievement is unlocked.
106 }</pre>
107</div>
108
109<div class="method">
110 <code class="details" id="resetAll">resetAll()</code>
111 <pre>Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.
112
113Args:
114
115Returns:
116 An object of the form:
117
118 { # This is a JSON template for achievement reset all response.
119 "kind": "gamesManagement#achievementResetAllResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetAllResponse.
120 "results": [ # The achievement reset results.
121 { # This is a JSON template for an achievement reset response.
122 "definitionId": "A String", # The ID of an achievement for which player state has been updated.
123 "kind": "gamesManagement#achievementResetResponse", # Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#achievementResetResponse.
124 "updateOccurred": True or False, # Flag to indicate if the requested update actually occurred.
125 "currentState": "A String", # The current state of the achievement. This is the same as 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 },
131 ],
132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="resetForAllPlayers">resetForAllPlayers(achievementId)</code>
137 <pre>Resets the achievement with the given ID for the all players. This method is only available to user accounts for your developer console. Only draft achievements can be reset.
138
139Args:
140 achievementId: string, The ID of the achievement used by this method. (required)
141</pre>
142</div>
143
144</body></html>