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="games_v1.html">Google Play Game Services</a> . <a href="games_v1.achievements.html">achievements</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 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"> 84 <code><a href="#list">list(playerId, language=None, maxResults=None, pageToken=None, state=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists the progress for all your application's achievements for the currently authenticated player.</p> 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"> 90 <code><a href="#reveal">reveal(achievementId, x__xgafv=None)</a></code></p> 91<p class="firstline">Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player.</p> 92<p class="toc_element"> 93 <code><a href="#setStepsAtLeast">setStepsAtLeast(achievementId, steps, x__xgafv=None)</a></code></p> 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> 95<p class="toc_element"> 96 <code><a href="#unlock">unlock(achievementId, x__xgafv=None)</a></code></p> 97<p class="firstline">Unlocks this achievement for the currently authenticated player.</p> 98<p class="toc_element"> 99 <code><a href="#updateMultiple">updateMultiple(body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates multiple achievements for the currently authenticated player.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="increment">increment(achievementId, stepsToIncrement, requestId=None, x__xgafv=None)</code> 109 <pre>Increments the steps of the achievement with the given ID for the currently authenticated player. 110 111Args: 112 achievementId: string, The ID of the achievement used by this method. (required) 113 stepsToIncrement: integer, The number of steps to increment. (required) 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. 115 x__xgafv: string, V1 error format. 116 Allowed values 117 1 - v1 error format 118 2 - v2 error format 119 120Returns: 121 An object of the form: 122 123 { # An achievement increment response 124 "currentSteps": 42, # The current steps recorded for this incremental achievement. 125 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementIncrementResponse`. 126 "newlyUnlocked": True or False, # Whether the current steps for the achievement has reached the number of steps required to unlock. 127}</pre> 128</div> 129 130<div class="method"> 131 <code class="details" id="list">list(playerId, language=None, maxResults=None, pageToken=None, state=None, x__xgafv=None)</code> 132 <pre>Lists the progress for all your application's achievements for the currently authenticated player. 133 134Args: 135 playerId: string, A player ID. A value of `me` may be used in place of the authenticated player's ID. (required) 136 language: string, The preferred language to use for strings returned by this method. 137 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`. 138 pageToken: string, The token returned by the previous request. 139 state: string, Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned. 140 Allowed values 141 ALL - List all achievements. This is the default. 142 HIDDEN - List only hidden achievements. 143 REVEALED - List only revealed achievements. 144 UNLOCKED - List only unlocked achievements. 145 x__xgafv: string, V1 error format. 146 Allowed values 147 1 - v1 error format 148 2 - v2 error format 149 150Returns: 151 An object of the form: 152 153 { # A list of achievement objects. 154 "items": [ # The achievements. 155 { # An achievement object. 156 "achievementState": "A String", # The state of the achievement. 157 "currentSteps": 42, # The current steps for an incremental achievement. 158 "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. 159 "formattedCurrentStepsString": "A String", # The current steps for an incremental achievement as a string. 160 "id": "A String", # The ID of the achievement. 161 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievement`. 162 "lastUpdatedTimestamp": "A String", # The timestamp of the last modification to this achievement's state. 163 }, 164 ], 165 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievementListResponse`. 166 "nextPageToken": "A String", # Token corresponding to the next page of results. 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 174Args: 175 previous_request: The request for the previous page. (required) 176 previous_response: The response from the request for the previous page. (required) 177 178Returns: 179 A request object that you can call 'execute()' on to request the next 180 page. Returns None if there are no more items in the collection. 181 </pre> 182</div> 183 184<div class="method"> 185 <code class="details" id="reveal">reveal(achievementId, x__xgafv=None)</code> 186 <pre>Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player. 187 188Args: 189 achievementId: string, The ID of the achievement used by this method. (required) 190 x__xgafv: string, V1 error format. 191 Allowed values 192 1 - v1 error format 193 2 - v2 error format 194 195Returns: 196 An object of the form: 197 198 { # An achievement reveal response 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. 200 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementRevealResponse`. 201}</pre> 202</div> 203 204<div class="method"> 205 <code class="details" id="setStepsAtLeast">setStepsAtLeast(achievementId, steps, x__xgafv=None)</code> 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. 207 208Args: 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) 211 x__xgafv: string, V1 error format. 212 Allowed values 213 1 - v1 error format 214 2 - v2 error format 215 216Returns: 217 An object of the form: 218 219 { # An achievement set steps at least response. 220 "currentSteps": 42, # The current steps recorded for this incremental achievement. 221 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementSetStepsAtLeastResponse`. 222 "newlyUnlocked": True or False, # Whether the current steps for the achievement has reached the number of steps required to unlock. 223}</pre> 224</div> 225 226<div class="method"> 227 <code class="details" id="unlock">unlock(achievementId, x__xgafv=None)</code> 228 <pre>Unlocks this achievement for the currently authenticated player. 229 230Args: 231 achievementId: string, The ID of the achievement used by this method. (required) 232 x__xgafv: string, V1 error format. 233 Allowed values 234 1 - v1 error format 235 2 - v2 error format 236 237Returns: 238 An object of the form: 239 240 { # An achievement unlock response 241 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUnlockResponse`. 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). 243}</pre> 244</div> 245 246<div class="method"> 247 <code class="details" id="updateMultiple">updateMultiple(body=None, x__xgafv=None)</code> 248 <pre>Updates multiple achievements for the currently authenticated player. 249 250Args: 251 body: object, The request body. 252 The object takes the form of: 253 254{ # A list of achievement update requests. 255 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateMultipleRequest`. 256 "updates": [ # The individual achievement update requests. 257 { # A request to update an achievement. 258 "achievementId": "A String", # The achievement this update is being applied to. 259 "incrementPayload": { # The payload to request to increment an achievement. # The payload if an update of type `INCREMENT` was requested for the achievement. 260 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#GamesAchievementIncrement`. 261 "requestId": "A String", # The requestId associated with an increment to an achievement. 262 "steps": 42, # The number of steps to be incremented. 263 }, 264 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateRequest`. 265 "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. 266 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#GamesAchievementSetStepsAtLeast`. 267 "steps": 42, # The minimum number of steps for the achievement to be set to. 268 }, 269 "updateType": "A String", # The type of update being applied. 270 }, 271 ], 272} 273 274 x__xgafv: string, V1 error format. 275 Allowed values 276 1 - v1 error format 277 2 - v2 error format 278 279Returns: 280 An object of the form: 281 282 { # Response message for UpdateMultipleAchievements rpc. 283 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateMultipleResponse`. 284 "updatedAchievements": [ # The updated state of the achievements. 285 { # An updated achievement. 286 "achievementId": "A String", # The achievement this update is was applied to. 287 "currentState": "A String", # The current state of the achievement. 288 "currentSteps": 42, # The current steps recorded for this achievement if it is incremental. 289 "kind": "A String", # Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateResponse`. 290 "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). 291 "updateOccurred": True or False, # Whether the requested updates actually affected the achievement. 292 }, 293 ], 294}</pre> 295</div> 296 297</body></html>