| OLD | NEW |
|---|
| (Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/drive.appdata": { |
| 6 "description": "View and manage its own configuration data i
n your Google Drive" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/games": { |
| 9 "description": "Share your Google+ profile information and v
iew and manage your game activity" |
| 10 }, |
| 11 "https://www.googleapis.com/auth/plus.login": { |
| 12 "description": "Know your basic profile info and list of peo
ple in your circles." |
| 13 } |
| 14 } |
| 15 } |
| 16 }, |
| 17 "basePath": "/games/v1/", |
| 18 "baseUrl": "https://www.googleapis.com/games/v1/", |
| 19 "batchPath": "batch", |
| 20 "canonicalName": "Games", |
| 21 "description": "The API for Google Play Game Services.", |
| 22 "discoveryVersion": "v1", |
| 23 "documentationLink": "https://developers.google.com/games/services/", |
| 24 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/1fGA1cCjRff4tjdq9wXB3UvbVW8\"", |
| 25 "icons": { |
| 26 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 27 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 28 }, |
| 29 "id": "games:v1", |
| 30 "kind": "discovery#restDescription", |
| 31 "name": "games", |
| 32 "ownerDomain": "google.com", |
| 33 "ownerName": "Google", |
| 34 "parameters": { |
| 35 "alt": { |
| 36 "default": "json", |
| 37 "description": "Data format for the response.", |
| 38 "enum": [ |
| 39 "json" |
| 40 ], |
| 41 "enumDescriptions": [ |
| 42 "Responses with Content-Type of application/json" |
| 43 ], |
| 44 "location": "query", |
| 45 "type": "string" |
| 46 }, |
| 47 "fields": { |
| 48 "description": "Selector specifying which fields to include in a par
tial response.", |
| 49 "location": "query", |
| 50 "type": "string" |
| 51 }, |
| 52 "key": { |
| 53 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 54 "location": "query", |
| 55 "type": "string" |
| 56 }, |
| 57 "oauth_token": { |
| 58 "description": "OAuth 2.0 token for the current user.", |
| 59 "location": "query", |
| 60 "type": "string" |
| 61 }, |
| 62 "prettyPrint": { |
| 63 "default": "true", |
| 64 "description": "Returns response with indentations and line breaks."
, |
| 65 "location": "query", |
| 66 "type": "boolean" |
| 67 }, |
| 68 "quotaUser": { |
| 69 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters. Overrides userIp if both are provided.", |
| 70 "location": "query", |
| 71 "type": "string" |
| 72 }, |
| 73 "userIp": { |
| 74 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 75 "location": "query", |
| 76 "type": "string" |
| 77 } |
| 78 }, |
| 79 "protocol": "rest", |
| 80 "resources": { |
| 81 "achievementDefinitions": { |
| 82 "methods": { |
| 83 "list": { |
| 84 "description": "Lists all the achievement definitions for yo
ur application.", |
| 85 "httpMethod": "GET", |
| 86 "id": "games.achievementDefinitions.list", |
| 87 "parameters": { |
| 88 "language": { |
| 89 "description": "The preferred language to use for st
rings returned by this method.", |
| 90 "location": "query", |
| 91 "type": "string" |
| 92 }, |
| 93 "maxResults": { |
| 94 "description": "The maximum number of achievement re
sources to return in the response, used for paging. For any response, the actual
number of achievement resources returned may be less than the specified maxResu
lts.", |
| 95 "format": "int32", |
| 96 "location": "query", |
| 97 "maximum": "200", |
| 98 "minimum": "1", |
| 99 "type": "integer" |
| 100 }, |
| 101 "pageToken": { |
| 102 "description": "The token returned by the previous r
equest.", |
| 103 "location": "query", |
| 104 "type": "string" |
| 105 } |
| 106 }, |
| 107 "path": "achievements", |
| 108 "response": { |
| 109 "$ref": "AchievementDefinitionsListResponse" |
| 110 }, |
| 111 "scopes": [ |
| 112 "https://www.googleapis.com/auth/games", |
| 113 "https://www.googleapis.com/auth/plus.login" |
| 114 ] |
| 115 } |
| 116 } |
| 117 }, |
| 118 "achievements": { |
| 119 "methods": { |
| 120 "increment": { |
| 121 "description": "Increments the steps of the achievement with
the given ID for the currently authenticated player.", |
| 122 "httpMethod": "POST", |
| 123 "id": "games.achievements.increment", |
| 124 "parameterOrder": [ |
| 125 "achievementId", |
| 126 "stepsToIncrement" |
| 127 ], |
| 128 "parameters": { |
| 129 "achievementId": { |
| 130 "description": "The ID of the achievement used by th
is method.", |
| 131 "location": "path", |
| 132 "required": true, |
| 133 "type": "string" |
| 134 }, |
| 135 "requestId": { |
| 136 "description": "A randomly generated numeric ID for
each request specified by the caller. This number is used at the server to ensur
e that the request is handled correctly across retries.", |
| 137 "format": "int64", |
| 138 "location": "query", |
| 139 "type": "string" |
| 140 }, |
| 141 "stepsToIncrement": { |
| 142 "description": "The number of steps to increment.", |
| 143 "format": "int32", |
| 144 "location": "query", |
| 145 "minimum": "1", |
| 146 "required": true, |
| 147 "type": "integer" |
| 148 } |
| 149 }, |
| 150 "path": "achievements/{achievementId}/increment", |
| 151 "response": { |
| 152 "$ref": "AchievementIncrementResponse" |
| 153 }, |
| 154 "scopes": [ |
| 155 "https://www.googleapis.com/auth/games", |
| 156 "https://www.googleapis.com/auth/plus.login" |
| 157 ] |
| 158 }, |
| 159 "list": { |
| 160 "description": "Lists the progress for all your application'
s achievements for the currently authenticated player.", |
| 161 "httpMethod": "GET", |
| 162 "id": "games.achievements.list", |
| 163 "parameterOrder": [ |
| 164 "playerId" |
| 165 ], |
| 166 "parameters": { |
| 167 "language": { |
| 168 "description": "The preferred language to use for st
rings returned by this method.", |
| 169 "location": "query", |
| 170 "type": "string" |
| 171 }, |
| 172 "maxResults": { |
| 173 "description": "The maximum number of achievement re
sources to return in the response, used for paging. For any response, the actual
number of achievement resources returned may be less than the specified maxResu
lts.", |
| 174 "format": "int32", |
| 175 "location": "query", |
| 176 "maximum": "200", |
| 177 "minimum": "1", |
| 178 "type": "integer" |
| 179 }, |
| 180 "pageToken": { |
| 181 "description": "The token returned by the previous r
equest.", |
| 182 "location": "query", |
| 183 "type": "string" |
| 184 }, |
| 185 "playerId": { |
| 186 "description": "A player ID. A value of me may be us
ed in place of the authenticated player's ID.", |
| 187 "location": "path", |
| 188 "required": true, |
| 189 "type": "string" |
| 190 }, |
| 191 "state": { |
| 192 "description": "Tells the server to return only achi
evements with the specified state. If this parameter isn't specified, all achiev
ements are returned.", |
| 193 "enum": [ |
| 194 "ALL", |
| 195 "HIDDEN", |
| 196 "REVEALED", |
| 197 "UNLOCKED" |
| 198 ], |
| 199 "enumDescriptions": [ |
| 200 "List all achievements. This is the default.", |
| 201 "List only hidden achievements.", |
| 202 "List only revealed achievements.", |
| 203 "List only unlocked achievements." |
| 204 ], |
| 205 "location": "query", |
| 206 "type": "string" |
| 207 } |
| 208 }, |
| 209 "path": "players/{playerId}/achievements", |
| 210 "response": { |
| 211 "$ref": "PlayerAchievementListResponse" |
| 212 }, |
| 213 "scopes": [ |
| 214 "https://www.googleapis.com/auth/games", |
| 215 "https://www.googleapis.com/auth/plus.login" |
| 216 ] |
| 217 }, |
| 218 "reveal": { |
| 219 "description": "Sets the state of the achievement with the g
iven ID to REVEALED for the currently authenticated player.", |
| 220 "httpMethod": "POST", |
| 221 "id": "games.achievements.reveal", |
| 222 "parameterOrder": [ |
| 223 "achievementId" |
| 224 ], |
| 225 "parameters": { |
| 226 "achievementId": { |
| 227 "description": "The ID of the achievement used by th
is method.", |
| 228 "location": "path", |
| 229 "required": true, |
| 230 "type": "string" |
| 231 } |
| 232 }, |
| 233 "path": "achievements/{achievementId}/reveal", |
| 234 "response": { |
| 235 "$ref": "AchievementRevealResponse" |
| 236 }, |
| 237 "scopes": [ |
| 238 "https://www.googleapis.com/auth/games", |
| 239 "https://www.googleapis.com/auth/plus.login" |
| 240 ] |
| 241 }, |
| 242 "setStepsAtLeast": { |
| 243 "description": "Sets the steps for the currently authenticat
ed 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.", |
| 244 "httpMethod": "POST", |
| 245 "id": "games.achievements.setStepsAtLeast", |
| 246 "parameterOrder": [ |
| 247 "achievementId", |
| 248 "steps" |
| 249 ], |
| 250 "parameters": { |
| 251 "achievementId": { |
| 252 "description": "The ID of the achievement used by th
is method.", |
| 253 "location": "path", |
| 254 "required": true, |
| 255 "type": "string" |
| 256 }, |
| 257 "steps": { |
| 258 "description": "The minimum value to set the steps t
o.", |
| 259 "format": "int32", |
| 260 "location": "query", |
| 261 "minimum": "1", |
| 262 "required": true, |
| 263 "type": "integer" |
| 264 } |
| 265 }, |
| 266 "path": "achievements/{achievementId}/setStepsAtLeast", |
| 267 "response": { |
| 268 "$ref": "AchievementSetStepsAtLeastResponse" |
| 269 }, |
| 270 "scopes": [ |
| 271 "https://www.googleapis.com/auth/games", |
| 272 "https://www.googleapis.com/auth/plus.login" |
| 273 ] |
| 274 }, |
| 275 "unlock": { |
| 276 "description": "Unlocks this achievement for the currently a
uthenticated player.", |
| 277 "httpMethod": "POST", |
| 278 "id": "games.achievements.unlock", |
| 279 "parameterOrder": [ |
| 280 "achievementId" |
| 281 ], |
| 282 "parameters": { |
| 283 "achievementId": { |
| 284 "description": "The ID of the achievement used by th
is method.", |
| 285 "location": "path", |
| 286 "required": true, |
| 287 "type": "string" |
| 288 } |
| 289 }, |
| 290 "path": "achievements/{achievementId}/unlock", |
| 291 "response": { |
| 292 "$ref": "AchievementUnlockResponse" |
| 293 }, |
| 294 "scopes": [ |
| 295 "https://www.googleapis.com/auth/games", |
| 296 "https://www.googleapis.com/auth/plus.login" |
| 297 ] |
| 298 }, |
| 299 "updateMultiple": { |
| 300 "description": "Updates multiple achievements for the curren
tly authenticated player.", |
| 301 "httpMethod": "POST", |
| 302 "id": "games.achievements.updateMultiple", |
| 303 "path": "achievements/updateMultiple", |
| 304 "request": { |
| 305 "$ref": "AchievementUpdateMultipleRequest" |
| 306 }, |
| 307 "response": { |
| 308 "$ref": "AchievementUpdateMultipleResponse" |
| 309 }, |
| 310 "scopes": [ |
| 311 "https://www.googleapis.com/auth/games", |
| 312 "https://www.googleapis.com/auth/plus.login" |
| 313 ] |
| 314 } |
| 315 } |
| 316 }, |
| 317 "applications": { |
| 318 "methods": { |
| 319 "get": { |
| 320 "description": "Retrieves the metadata of the application wi
th the given ID. If the requested application is not available for the specified
platformType, the returned response will not include any instance data.", |
| 321 "httpMethod": "GET", |
| 322 "id": "games.applications.get", |
| 323 "parameterOrder": [ |
| 324 "applicationId" |
| 325 ], |
| 326 "parameters": { |
| 327 "applicationId": { |
| 328 "description": "The application being requested.", |
| 329 "location": "path", |
| 330 "required": true, |
| 331 "type": "string" |
| 332 }, |
| 333 "language": { |
| 334 "description": "The preferred language to use for st
rings returned by this method.", |
| 335 "location": "query", |
| 336 "type": "string" |
| 337 }, |
| 338 "platformType": { |
| 339 "description": "Restrict application details returne
d to the specific platform.", |
| 340 "enum": [ |
| 341 "ANDROID", |
| 342 "IOS", |
| 343 "WEB_APP" |
| 344 ], |
| 345 "enumDescriptions": [ |
| 346 "Retrieve applications that can be played on And
roid.", |
| 347 "Retrieve applications that can be played on iOS
.", |
| 348 "Retrieve applications that can be played on des
ktop web." |
| 349 ], |
| 350 "location": "query", |
| 351 "type": "string" |
| 352 } |
| 353 }, |
| 354 "path": "applications/{applicationId}", |
| 355 "response": { |
| 356 "$ref": "Application" |
| 357 }, |
| 358 "scopes": [ |
| 359 "https://www.googleapis.com/auth/games", |
| 360 "https://www.googleapis.com/auth/plus.login" |
| 361 ] |
| 362 }, |
| 363 "played": { |
| 364 "description": "Indicate that the the currently authenticate
d user is playing your application.", |
| 365 "httpMethod": "POST", |
| 366 "id": "games.applications.played", |
| 367 "path": "applications/played", |
| 368 "scopes": [ |
| 369 "https://www.googleapis.com/auth/games", |
| 370 "https://www.googleapis.com/auth/plus.login" |
| 371 ] |
| 372 } |
| 373 } |
| 374 }, |
| 375 "events": { |
| 376 "methods": { |
| 377 "listByPlayer": { |
| 378 "description": "Returns a list showing the current progress
on events in this application for the currently authenticated user.", |
| 379 "httpMethod": "GET", |
| 380 "id": "games.events.listByPlayer", |
| 381 "parameters": { |
| 382 "language": { |
| 383 "description": "The preferred language to use for st
rings returned by this method.", |
| 384 "location": "query", |
| 385 "type": "string" |
| 386 }, |
| 387 "maxResults": { |
| 388 "description": "The maximum number of events to retu
rn in the response, used for paging. For any response, the actual number of even
ts to return may be less than the specified maxResults.", |
| 389 "format": "int32", |
| 390 "location": "query", |
| 391 "maximum": "100", |
| 392 "minimum": "1", |
| 393 "type": "integer" |
| 394 }, |
| 395 "pageToken": { |
| 396 "description": "The token returned by the previous r
equest.", |
| 397 "location": "query", |
| 398 "type": "string" |
| 399 } |
| 400 }, |
| 401 "path": "events", |
| 402 "response": { |
| 403 "$ref": "PlayerEventListResponse" |
| 404 }, |
| 405 "scopes": [ |
| 406 "https://www.googleapis.com/auth/games", |
| 407 "https://www.googleapis.com/auth/plus.login" |
| 408 ] |
| 409 }, |
| 410 "listDefinitions": { |
| 411 "description": "Returns a list of the event definitions in t
his application.", |
| 412 "httpMethod": "GET", |
| 413 "id": "games.events.listDefinitions", |
| 414 "parameters": { |
| 415 "language": { |
| 416 "description": "The preferred language to use for st
rings returned by this method.", |
| 417 "location": "query", |
| 418 "type": "string" |
| 419 }, |
| 420 "maxResults": { |
| 421 "description": "The maximum number of event definiti
ons to return in the response, used for paging. For any response, the actual num
ber of event definitions to return may be less than the specified maxResults.", |
| 422 "format": "int32", |
| 423 "location": "query", |
| 424 "maximum": "100", |
| 425 "minimum": "1", |
| 426 "type": "integer" |
| 427 }, |
| 428 "pageToken": { |
| 429 "description": "The token returned by the previous r
equest.", |
| 430 "location": "query", |
| 431 "type": "string" |
| 432 } |
| 433 }, |
| 434 "path": "eventDefinitions", |
| 435 "response": { |
| 436 "$ref": "EventDefinitionListResponse" |
| 437 }, |
| 438 "scopes": [ |
| 439 "https://www.googleapis.com/auth/games", |
| 440 "https://www.googleapis.com/auth/plus.login" |
| 441 ] |
| 442 }, |
| 443 "record": { |
| 444 "description": "Records a batch of changes to the number of
times events have occurred for the currently authenticated user of this applicat
ion.", |
| 445 "httpMethod": "POST", |
| 446 "id": "games.events.record", |
| 447 "parameters": { |
| 448 "language": { |
| 449 "description": "The preferred language to use for st
rings returned by this method.", |
| 450 "location": "query", |
| 451 "type": "string" |
| 452 } |
| 453 }, |
| 454 "path": "events", |
| 455 "request": { |
| 456 "$ref": "EventRecordRequest" |
| 457 }, |
| 458 "response": { |
| 459 "$ref": "EventUpdateResponse" |
| 460 }, |
| 461 "scopes": [ |
| 462 "https://www.googleapis.com/auth/games", |
| 463 "https://www.googleapis.com/auth/plus.login" |
| 464 ] |
| 465 } |
| 466 } |
| 467 }, |
| 468 "leaderboards": { |
| 469 "methods": { |
| 470 "get": { |
| 471 "description": "Retrieves the metadata of the leaderboard wi
th the given ID.", |
| 472 "httpMethod": "GET", |
| 473 "id": "games.leaderboards.get", |
| 474 "parameterOrder": [ |
| 475 "leaderboardId" |
| 476 ], |
| 477 "parameters": { |
| 478 "language": { |
| 479 "description": "The preferred language to use for st
rings returned by this method.", |
| 480 "location": "query", |
| 481 "type": "string" |
| 482 }, |
| 483 "leaderboardId": { |
| 484 "description": "The ID of the leaderboard.", |
| 485 "location": "path", |
| 486 "required": true, |
| 487 "type": "string" |
| 488 } |
| 489 }, |
| 490 "path": "leaderboards/{leaderboardId}", |
| 491 "response": { |
| 492 "$ref": "Leaderboard" |
| 493 }, |
| 494 "scopes": [ |
| 495 "https://www.googleapis.com/auth/games", |
| 496 "https://www.googleapis.com/auth/plus.login" |
| 497 ] |
| 498 }, |
| 499 "list": { |
| 500 "description": "Lists all the leaderboard metadata for your
application.", |
| 501 "httpMethod": "GET", |
| 502 "id": "games.leaderboards.list", |
| 503 "parameters": { |
| 504 "language": { |
| 505 "description": "The preferred language to use for st
rings returned by this method.", |
| 506 "location": "query", |
| 507 "type": "string" |
| 508 }, |
| 509 "maxResults": { |
| 510 "description": "The maximum number of leaderboards t
o return in the response. For any response, the actual number of leaderboards re
turned may be less than the specified maxResults.", |
| 511 "format": "int32", |
| 512 "location": "query", |
| 513 "maximum": "200", |
| 514 "minimum": "1", |
| 515 "type": "integer" |
| 516 }, |
| 517 "pageToken": { |
| 518 "description": "The token returned by the previous r
equest.", |
| 519 "location": "query", |
| 520 "type": "string" |
| 521 } |
| 522 }, |
| 523 "path": "leaderboards", |
| 524 "response": { |
| 525 "$ref": "LeaderboardListResponse" |
| 526 }, |
| 527 "scopes": [ |
| 528 "https://www.googleapis.com/auth/games", |
| 529 "https://www.googleapis.com/auth/plus.login" |
| 530 ] |
| 531 } |
| 532 } |
| 533 }, |
| 534 "metagame": { |
| 535 "methods": { |
| 536 "getMetagameConfig": { |
| 537 "description": "Return the metagame configuration data for t
he calling application.", |
| 538 "httpMethod": "GET", |
| 539 "id": "games.metagame.getMetagameConfig", |
| 540 "path": "metagameConfig", |
| 541 "response": { |
| 542 "$ref": "MetagameConfig" |
| 543 }, |
| 544 "scopes": [ |
| 545 "https://www.googleapis.com/auth/games", |
| 546 "https://www.googleapis.com/auth/plus.login" |
| 547 ] |
| 548 }, |
| 549 "listCategoriesByPlayer": { |
| 550 "description": "List play data aggregated per category for t
he player corresponding to playerId.", |
| 551 "httpMethod": "GET", |
| 552 "id": "games.metagame.listCategoriesByPlayer", |
| 553 "parameterOrder": [ |
| 554 "playerId", |
| 555 "collection" |
| 556 ], |
| 557 "parameters": { |
| 558 "collection": { |
| 559 "description": "The collection of categories for whi
ch data will be returned.", |
| 560 "enum": [ |
| 561 "all" |
| 562 ], |
| 563 "enumDescriptions": [ |
| 564 "Retrieve data for all categories. This is the d
efault." |
| 565 ], |
| 566 "location": "path", |
| 567 "required": true, |
| 568 "type": "string" |
| 569 }, |
| 570 "language": { |
| 571 "description": "The preferred language to use for st
rings returned by this method.", |
| 572 "location": "query", |
| 573 "type": "string" |
| 574 }, |
| 575 "maxResults": { |
| 576 "description": "The maximum number of category resou
rces to return in the response, used for paging. For any response, the actual nu
mber of category resources returned may be less than the specified maxResults.", |
| 577 "format": "int32", |
| 578 "location": "query", |
| 579 "maximum": "100", |
| 580 "minimum": "1", |
| 581 "type": "integer" |
| 582 }, |
| 583 "pageToken": { |
| 584 "description": "The token returned by the previous r
equest.", |
| 585 "location": "query", |
| 586 "type": "string" |
| 587 }, |
| 588 "playerId": { |
| 589 "description": "A player ID. A value of me may be us
ed in place of the authenticated player's ID.", |
| 590 "location": "path", |
| 591 "required": true, |
| 592 "type": "string" |
| 593 } |
| 594 }, |
| 595 "path": "players/{playerId}/categories/{collection}", |
| 596 "response": { |
| 597 "$ref": "CategoryListResponse" |
| 598 }, |
| 599 "scopes": [ |
| 600 "https://www.googleapis.com/auth/games", |
| 601 "https://www.googleapis.com/auth/plus.login" |
| 602 ] |
| 603 } |
| 604 } |
| 605 }, |
| 606 "players": { |
| 607 "methods": { |
| 608 "get": { |
| 609 "description": "Retrieves the Player resource with the given
ID. To retrieve the player for the currently authenticated user, set playerId t
o me.", |
| 610 "httpMethod": "GET", |
| 611 "id": "games.players.get", |
| 612 "parameterOrder": [ |
| 613 "playerId" |
| 614 ], |
| 615 "parameters": { |
| 616 "language": { |
| 617 "description": "The preferred language to use for st
rings returned by this method.", |
| 618 "location": "query", |
| 619 "type": "string" |
| 620 }, |
| 621 "playerId": { |
| 622 "description": "A player ID. A value of me may be us
ed in place of the authenticated player's ID.", |
| 623 "location": "path", |
| 624 "required": true, |
| 625 "type": "string" |
| 626 } |
| 627 }, |
| 628 "path": "players/{playerId}", |
| 629 "response": { |
| 630 "$ref": "Player" |
| 631 }, |
| 632 "scopes": [ |
| 633 "https://www.googleapis.com/auth/games", |
| 634 "https://www.googleapis.com/auth/plus.login" |
| 635 ] |
| 636 }, |
| 637 "list": { |
| 638 "description": "Get the collection of players for the curren
tly authenticated user.", |
| 639 "httpMethod": "GET", |
| 640 "id": "games.players.list", |
| 641 "parameterOrder": [ |
| 642 "collection" |
| 643 ], |
| 644 "parameters": { |
| 645 "collection": { |
| 646 "description": "Collection of players being retrieve
d", |
| 647 "enum": [ |
| 648 "playedWith", |
| 649 "played_with" |
| 650 ], |
| 651 "enumDescriptions": [ |
| 652 "(DEPRECATED: please use played_with!) Retrieve
a list of players you have played a multiplayer game (realtime or turn-based) wi
th recently.", |
| 653 "Retrieve a list of players you have played a mu
ltiplayer game (realtime or turn-based) with recently." |
| 654 ], |
| 655 "location": "path", |
| 656 "required": true, |
| 657 "type": "string" |
| 658 }, |
| 659 "language": { |
| 660 "description": "The preferred language to use for st
rings returned by this method.", |
| 661 "location": "query", |
| 662 "type": "string" |
| 663 }, |
| 664 "maxResults": { |
| 665 "description": "The maximum number of player resourc
es to return in the response, used for paging. For any response, the actual numb
er of player resources returned may be less than the specified maxResults.", |
| 666 "format": "int32", |
| 667 "location": "query", |
| 668 "maximum": "15", |
| 669 "minimum": "1", |
| 670 "type": "integer" |
| 671 }, |
| 672 "pageToken": { |
| 673 "description": "The token returned by the previous r
equest.", |
| 674 "location": "query", |
| 675 "type": "string" |
| 676 } |
| 677 }, |
| 678 "path": "players/me/players/{collection}", |
| 679 "response": { |
| 680 "$ref": "PlayerListResponse" |
| 681 }, |
| 682 "scopes": [ |
| 683 "https://www.googleapis.com/auth/games", |
| 684 "https://www.googleapis.com/auth/plus.login" |
| 685 ] |
| 686 } |
| 687 } |
| 688 }, |
| 689 "pushtokens": { |
| 690 "methods": { |
| 691 "remove": { |
| 692 "description": "Removes a push token for the current user an
d application. Removing a non-existent push token will report success.", |
| 693 "httpMethod": "POST", |
| 694 "id": "games.pushtokens.remove", |
| 695 "path": "pushtokens/remove", |
| 696 "request": { |
| 697 "$ref": "PushTokenId" |
| 698 }, |
| 699 "scopes": [ |
| 700 "https://www.googleapis.com/auth/games", |
| 701 "https://www.googleapis.com/auth/plus.login" |
| 702 ] |
| 703 }, |
| 704 "update": { |
| 705 "description": "Registers a push token for the current user
and application.", |
| 706 "httpMethod": "PUT", |
| 707 "id": "games.pushtokens.update", |
| 708 "path": "pushtokens", |
| 709 "request": { |
| 710 "$ref": "PushToken" |
| 711 }, |
| 712 "scopes": [ |
| 713 "https://www.googleapis.com/auth/games", |
| 714 "https://www.googleapis.com/auth/plus.login" |
| 715 ] |
| 716 } |
| 717 } |
| 718 }, |
| 719 "questMilestones": { |
| 720 "methods": { |
| 721 "claim": { |
| 722 "description": "Report that a reward for the milestone corre
sponding to milestoneId for the quest corresponding to questId has been claimed
by the currently authorized user.", |
| 723 "httpMethod": "PUT", |
| 724 "id": "games.questMilestones.claim", |
| 725 "parameterOrder": [ |
| 726 "questId", |
| 727 "milestoneId", |
| 728 "requestId" |
| 729 ], |
| 730 "parameters": { |
| 731 "milestoneId": { |
| 732 "description": "The ID of the milestone.", |
| 733 "location": "path", |
| 734 "required": true, |
| 735 "type": "string" |
| 736 }, |
| 737 "questId": { |
| 738 "description": "The ID of the quest.", |
| 739 "location": "path", |
| 740 "required": true, |
| 741 "type": "string" |
| 742 }, |
| 743 "requestId": { |
| 744 "description": "A numeric ID to ensure that the requ
est is handled correctly across retries. Your client application must generate t
his ID randomly.", |
| 745 "format": "int64", |
| 746 "location": "query", |
| 747 "required": true, |
| 748 "type": "string" |
| 749 } |
| 750 }, |
| 751 "path": "quests/{questId}/milestones/{milestoneId}/claim", |
| 752 "scopes": [ |
| 753 "https://www.googleapis.com/auth/games", |
| 754 "https://www.googleapis.com/auth/plus.login" |
| 755 ] |
| 756 } |
| 757 } |
| 758 }, |
| 759 "quests": { |
| 760 "methods": { |
| 761 "accept": { |
| 762 "description": "Indicates that the currently authorized user
will participate in the quest.", |
| 763 "httpMethod": "POST", |
| 764 "id": "games.quests.accept", |
| 765 "parameterOrder": [ |
| 766 "questId" |
| 767 ], |
| 768 "parameters": { |
| 769 "language": { |
| 770 "description": "The preferred language to use for st
rings returned by this method.", |
| 771 "location": "query", |
| 772 "type": "string" |
| 773 }, |
| 774 "questId": { |
| 775 "description": "The ID of the quest.", |
| 776 "location": "path", |
| 777 "required": true, |
| 778 "type": "string" |
| 779 } |
| 780 }, |
| 781 "path": "quests/{questId}/accept", |
| 782 "response": { |
| 783 "$ref": "Quest" |
| 784 }, |
| 785 "scopes": [ |
| 786 "https://www.googleapis.com/auth/games", |
| 787 "https://www.googleapis.com/auth/plus.login" |
| 788 ] |
| 789 }, |
| 790 "list": { |
| 791 "description": "Get a list of quests for your application an
d the currently authenticated player.", |
| 792 "httpMethod": "GET", |
| 793 "id": "games.quests.list", |
| 794 "parameterOrder": [ |
| 795 "playerId" |
| 796 ], |
| 797 "parameters": { |
| 798 "language": { |
| 799 "description": "The preferred language to use for st
rings returned by this method.", |
| 800 "location": "query", |
| 801 "type": "string" |
| 802 }, |
| 803 "maxResults": { |
| 804 "description": "The maximum number of quest resource
s to return in the response, used for paging. For any response, the actual numbe
r of quest resources returned may be less than the specified maxResults. Accepta
ble values are 1 to 50, inclusive. (Default: 50).", |
| 805 "format": "int32", |
| 806 "location": "query", |
| 807 "maximum": "50", |
| 808 "minimum": "1", |
| 809 "type": "integer" |
| 810 }, |
| 811 "pageToken": { |
| 812 "description": "The token returned by the previous r
equest.", |
| 813 "location": "query", |
| 814 "type": "string" |
| 815 }, |
| 816 "playerId": { |
| 817 "description": "A player ID. A value of me may be us
ed in place of the authenticated player's ID.", |
| 818 "location": "path", |
| 819 "required": true, |
| 820 "type": "string" |
| 821 } |
| 822 }, |
| 823 "path": "players/{playerId}/quests", |
| 824 "response": { |
| 825 "$ref": "QuestListResponse" |
| 826 }, |
| 827 "scopes": [ |
| 828 "https://www.googleapis.com/auth/games", |
| 829 "https://www.googleapis.com/auth/plus.login" |
| 830 ] |
| 831 } |
| 832 } |
| 833 }, |
| 834 "revisions": { |
| 835 "methods": { |
| 836 "check": { |
| 837 "description": "Checks whether the games client is out of da
te.", |
| 838 "httpMethod": "GET", |
| 839 "id": "games.revisions.check", |
| 840 "parameterOrder": [ |
| 841 "clientRevision" |
| 842 ], |
| 843 "parameters": { |
| 844 "clientRevision": { |
| 845 "description": "The revision of the client SDK used
by your application. Format:\n[PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values
of PLATFORM_TYPE are:\n \n- \"ANDROID\" - Client is running the Android SDK. \n-
\"IOS\" - Client is running the iOS SDK. \n- \"WEB_APP\" - Client is running as
a Web App.", |
| 846 "location": "query", |
| 847 "required": true, |
| 848 "type": "string" |
| 849 } |
| 850 }, |
| 851 "path": "revisions/check", |
| 852 "response": { |
| 853 "$ref": "RevisionCheckResponse" |
| 854 }, |
| 855 "scopes": [ |
| 856 "https://www.googleapis.com/auth/games", |
| 857 "https://www.googleapis.com/auth/plus.login" |
| 858 ] |
| 859 } |
| 860 } |
| 861 }, |
| 862 "rooms": { |
| 863 "methods": { |
| 864 "create": { |
| 865 "description": "Create a room. For internal use by the Games
SDK only. Calling this method directly is unsupported.", |
| 866 "httpMethod": "POST", |
| 867 "id": "games.rooms.create", |
| 868 "parameters": { |
| 869 "language": { |
| 870 "description": "The preferred language to use for st
rings returned by this method.", |
| 871 "location": "query", |
| 872 "type": "string" |
| 873 } |
| 874 }, |
| 875 "path": "rooms/create", |
| 876 "request": { |
| 877 "$ref": "RoomCreateRequest" |
| 878 }, |
| 879 "response": { |
| 880 "$ref": "Room" |
| 881 }, |
| 882 "scopes": [ |
| 883 "https://www.googleapis.com/auth/games", |
| 884 "https://www.googleapis.com/auth/plus.login" |
| 885 ] |
| 886 }, |
| 887 "decline": { |
| 888 "description": "Decline an invitation to join a room. For in
ternal use by the Games SDK only. Calling this method directly is unsupported.", |
| 889 "httpMethod": "POST", |
| 890 "id": "games.rooms.decline", |
| 891 "parameterOrder": [ |
| 892 "roomId" |
| 893 ], |
| 894 "parameters": { |
| 895 "language": { |
| 896 "description": "The preferred language to use for st
rings returned by this method.", |
| 897 "location": "query", |
| 898 "type": "string" |
| 899 }, |
| 900 "roomId": { |
| 901 "description": "The ID of the room.", |
| 902 "location": "path", |
| 903 "required": true, |
| 904 "type": "string" |
| 905 } |
| 906 }, |
| 907 "path": "rooms/{roomId}/decline", |
| 908 "response": { |
| 909 "$ref": "Room" |
| 910 }, |
| 911 "scopes": [ |
| 912 "https://www.googleapis.com/auth/games", |
| 913 "https://www.googleapis.com/auth/plus.login" |
| 914 ] |
| 915 }, |
| 916 "dismiss": { |
| 917 "description": "Dismiss an invitation to join a room. For in
ternal use by the Games SDK only. Calling this method directly is unsupported.", |
| 918 "httpMethod": "POST", |
| 919 "id": "games.rooms.dismiss", |
| 920 "parameterOrder": [ |
| 921 "roomId" |
| 922 ], |
| 923 "parameters": { |
| 924 "roomId": { |
| 925 "description": "The ID of the room.", |
| 926 "location": "path", |
| 927 "required": true, |
| 928 "type": "string" |
| 929 } |
| 930 }, |
| 931 "path": "rooms/{roomId}/dismiss", |
| 932 "scopes": [ |
| 933 "https://www.googleapis.com/auth/games", |
| 934 "https://www.googleapis.com/auth/plus.login" |
| 935 ] |
| 936 }, |
| 937 "get": { |
| 938 "description": "Get the data for a room.", |
| 939 "httpMethod": "GET", |
| 940 "id": "games.rooms.get", |
| 941 "parameterOrder": [ |
| 942 "roomId" |
| 943 ], |
| 944 "parameters": { |
| 945 "language": { |
| 946 "description": "The preferred language to use for st
rings returned by this method.", |
| 947 "location": "query", |
| 948 "type": "string" |
| 949 }, |
| 950 "roomId": { |
| 951 "description": "The ID of the room.", |
| 952 "location": "path", |
| 953 "required": true, |
| 954 "type": "string" |
| 955 } |
| 956 }, |
| 957 "path": "rooms/{roomId}", |
| 958 "response": { |
| 959 "$ref": "Room" |
| 960 }, |
| 961 "scopes": [ |
| 962 "https://www.googleapis.com/auth/games", |
| 963 "https://www.googleapis.com/auth/plus.login" |
| 964 ] |
| 965 }, |
| 966 "join": { |
| 967 "description": "Join a room. For internal use by the Games S
DK only. Calling this method directly is unsupported.", |
| 968 "httpMethod": "POST", |
| 969 "id": "games.rooms.join", |
| 970 "parameterOrder": [ |
| 971 "roomId" |
| 972 ], |
| 973 "parameters": { |
| 974 "language": { |
| 975 "description": "The preferred language to use for st
rings returned by this method.", |
| 976 "location": "query", |
| 977 "type": "string" |
| 978 }, |
| 979 "roomId": { |
| 980 "description": "The ID of the room.", |
| 981 "location": "path", |
| 982 "required": true, |
| 983 "type": "string" |
| 984 } |
| 985 }, |
| 986 "path": "rooms/{roomId}/join", |
| 987 "request": { |
| 988 "$ref": "RoomJoinRequest" |
| 989 }, |
| 990 "response": { |
| 991 "$ref": "Room" |
| 992 }, |
| 993 "scopes": [ |
| 994 "https://www.googleapis.com/auth/games", |
| 995 "https://www.googleapis.com/auth/plus.login" |
| 996 ] |
| 997 }, |
| 998 "leave": { |
| 999 "description": "Leave a room. For internal use by the Games
SDK only. Calling this method directly is unsupported.", |
| 1000 "httpMethod": "POST", |
| 1001 "id": "games.rooms.leave", |
| 1002 "parameterOrder": [ |
| 1003 "roomId" |
| 1004 ], |
| 1005 "parameters": { |
| 1006 "language": { |
| 1007 "description": "The preferred language to use for st
rings returned by this method.", |
| 1008 "location": "query", |
| 1009 "type": "string" |
| 1010 }, |
| 1011 "roomId": { |
| 1012 "description": "The ID of the room.", |
| 1013 "location": "path", |
| 1014 "required": true, |
| 1015 "type": "string" |
| 1016 } |
| 1017 }, |
| 1018 "path": "rooms/{roomId}/leave", |
| 1019 "request": { |
| 1020 "$ref": "RoomLeaveRequest" |
| 1021 }, |
| 1022 "response": { |
| 1023 "$ref": "Room" |
| 1024 }, |
| 1025 "scopes": [ |
| 1026 "https://www.googleapis.com/auth/games", |
| 1027 "https://www.googleapis.com/auth/plus.login" |
| 1028 ] |
| 1029 }, |
| 1030 "list": { |
| 1031 "description": "Returns invitations to join rooms.", |
| 1032 "httpMethod": "GET", |
| 1033 "id": "games.rooms.list", |
| 1034 "parameters": { |
| 1035 "language": { |
| 1036 "description": "The preferred language to use for st
rings returned by this method.", |
| 1037 "location": "query", |
| 1038 "type": "string" |
| 1039 }, |
| 1040 "maxResults": { |
| 1041 "description": "The maximum number of rooms to retur
n in the response, used for paging. For any response, the actual number of rooms
to return may be less than the specified maxResults.", |
| 1042 "format": "int32", |
| 1043 "location": "query", |
| 1044 "maximum": "500", |
| 1045 "minimum": "1", |
| 1046 "type": "integer" |
| 1047 }, |
| 1048 "pageToken": { |
| 1049 "description": "The token returned by the previous r
equest.", |
| 1050 "location": "query", |
| 1051 "type": "string" |
| 1052 } |
| 1053 }, |
| 1054 "path": "rooms", |
| 1055 "response": { |
| 1056 "$ref": "RoomList" |
| 1057 }, |
| 1058 "scopes": [ |
| 1059 "https://www.googleapis.com/auth/games", |
| 1060 "https://www.googleapis.com/auth/plus.login" |
| 1061 ] |
| 1062 }, |
| 1063 "reportStatus": { |
| 1064 "description": "Updates sent by a client reporting the statu
s of peers in a room. For internal use by the Games SDK only. Calling this metho
d directly is unsupported.", |
| 1065 "httpMethod": "POST", |
| 1066 "id": "games.rooms.reportStatus", |
| 1067 "parameterOrder": [ |
| 1068 "roomId" |
| 1069 ], |
| 1070 "parameters": { |
| 1071 "language": { |
| 1072 "description": "The preferred language to use for st
rings returned by this method.", |
| 1073 "location": "query", |
| 1074 "type": "string" |
| 1075 }, |
| 1076 "roomId": { |
| 1077 "description": "The ID of the room.", |
| 1078 "location": "path", |
| 1079 "required": true, |
| 1080 "type": "string" |
| 1081 } |
| 1082 }, |
| 1083 "path": "rooms/{roomId}/reportstatus", |
| 1084 "request": { |
| 1085 "$ref": "RoomP2PStatuses" |
| 1086 }, |
| 1087 "response": { |
| 1088 "$ref": "RoomStatus" |
| 1089 }, |
| 1090 "scopes": [ |
| 1091 "https://www.googleapis.com/auth/games", |
| 1092 "https://www.googleapis.com/auth/plus.login" |
| 1093 ] |
| 1094 } |
| 1095 } |
| 1096 }, |
| 1097 "scores": { |
| 1098 "methods": { |
| 1099 "get": { |
| 1100 "description": "Get high scores, and optionally ranks, in le
aderboards for the currently authenticated player. For a specific time span, lea
derboardId can be set to ALL to retrieve data for all leaderboards in a given ti
me span.\nNOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the
same request; only one parameter may be set to 'ALL'.", |
| 1101 "httpMethod": "GET", |
| 1102 "id": "games.scores.get", |
| 1103 "parameterOrder": [ |
| 1104 "playerId", |
| 1105 "leaderboardId", |
| 1106 "timeSpan" |
| 1107 ], |
| 1108 "parameters": { |
| 1109 "includeRankType": { |
| 1110 "description": "The types of ranks to return. If the
parameter is omitted, no ranks will be returned.", |
| 1111 "enum": [ |
| 1112 "ALL", |
| 1113 "PUBLIC", |
| 1114 "SOCIAL" |
| 1115 ], |
| 1116 "enumDescriptions": [ |
| 1117 "Retrieve public and social ranks.", |
| 1118 "Retrieve public ranks, if the player is sharing
their gameplay activity publicly.", |
| 1119 "Retrieve the social rank." |
| 1120 ], |
| 1121 "location": "query", |
| 1122 "type": "string" |
| 1123 }, |
| 1124 "language": { |
| 1125 "description": "The preferred language to use for st
rings returned by this method.", |
| 1126 "location": "query", |
| 1127 "type": "string" |
| 1128 }, |
| 1129 "leaderboardId": { |
| 1130 "description": "The ID of the leaderboard. Can be se
t to 'ALL' to retrieve data for all leaderboards for this application.", |
| 1131 "location": "path", |
| 1132 "required": true, |
| 1133 "type": "string" |
| 1134 }, |
| 1135 "maxResults": { |
| 1136 "description": "The maximum number of leaderboard sc
ores to return in the response. For any response, the actual number of leaderboa
rd scores returned may be less than the specified maxResults.", |
| 1137 "format": "int32", |
| 1138 "location": "query", |
| 1139 "maximum": "25", |
| 1140 "minimum": "1", |
| 1141 "type": "integer" |
| 1142 }, |
| 1143 "pageToken": { |
| 1144 "description": "The token returned by the previous r
equest.", |
| 1145 "location": "query", |
| 1146 "type": "string" |
| 1147 }, |
| 1148 "playerId": { |
| 1149 "description": "A player ID. A value of me may be us
ed in place of the authenticated player's ID.", |
| 1150 "location": "path", |
| 1151 "required": true, |
| 1152 "type": "string" |
| 1153 }, |
| 1154 "timeSpan": { |
| 1155 "description": "The time span for the scores and ran
ks you're requesting.", |
| 1156 "enum": [ |
| 1157 "ALL", |
| 1158 "ALL_TIME", |
| 1159 "DAILY", |
| 1160 "WEEKLY" |
| 1161 ], |
| 1162 "enumDescriptions": [ |
| 1163 "Get the high scores for all time spans. If this
is used, maxResults values will be ignored.", |
| 1164 "Get the all time high score.", |
| 1165 "List the top scores for the current day.", |
| 1166 "List the top scores for the current week." |
| 1167 ], |
| 1168 "location": "path", |
| 1169 "required": true, |
| 1170 "type": "string" |
| 1171 } |
| 1172 }, |
| 1173 "path": "players/{playerId}/leaderboards/{leaderboardId}/sco
res/{timeSpan}", |
| 1174 "response": { |
| 1175 "$ref": "PlayerLeaderboardScoreListResponse" |
| 1176 }, |
| 1177 "scopes": [ |
| 1178 "https://www.googleapis.com/auth/games", |
| 1179 "https://www.googleapis.com/auth/plus.login" |
| 1180 ] |
| 1181 }, |
| 1182 "list": { |
| 1183 "description": "Lists the scores in a leaderboard, starting
from the top.", |
| 1184 "httpMethod": "GET", |
| 1185 "id": "games.scores.list", |
| 1186 "parameterOrder": [ |
| 1187 "leaderboardId", |
| 1188 "collection", |
| 1189 "timeSpan" |
| 1190 ], |
| 1191 "parameters": { |
| 1192 "collection": { |
| 1193 "description": "The collection of scores you're requ
esting.", |
| 1194 "enum": [ |
| 1195 "PUBLIC", |
| 1196 "SOCIAL" |
| 1197 ], |
| 1198 "enumDescriptions": [ |
| 1199 "List all scores in the public leaderboard.", |
| 1200 "List only social scores." |
| 1201 ], |
| 1202 "location": "path", |
| 1203 "required": true, |
| 1204 "type": "string" |
| 1205 }, |
| 1206 "language": { |
| 1207 "description": "The preferred language to use for st
rings returned by this method.", |
| 1208 "location": "query", |
| 1209 "type": "string" |
| 1210 }, |
| 1211 "leaderboardId": { |
| 1212 "description": "The ID of the leaderboard.", |
| 1213 "location": "path", |
| 1214 "required": true, |
| 1215 "type": "string" |
| 1216 }, |
| 1217 "maxResults": { |
| 1218 "description": "The maximum number of leaderboard sc
ores to return in the response. For any response, the actual number of leaderboa
rd scores returned may be less than the specified maxResults.", |
| 1219 "format": "int32", |
| 1220 "location": "query", |
| 1221 "maximum": "25", |
| 1222 "minimum": "1", |
| 1223 "type": "integer" |
| 1224 }, |
| 1225 "pageToken": { |
| 1226 "description": "The token returned by the previous r
equest.", |
| 1227 "location": "query", |
| 1228 "type": "string" |
| 1229 }, |
| 1230 "timeSpan": { |
| 1231 "description": "The time span for the scores and ran
ks you're requesting.", |
| 1232 "enum": [ |
| 1233 "ALL_TIME", |
| 1234 "DAILY", |
| 1235 "WEEKLY" |
| 1236 ], |
| 1237 "enumDescriptions": [ |
| 1238 "List the all-time top scores.", |
| 1239 "List the top scores for the current day.", |
| 1240 "List the top scores for the current week." |
| 1241 ], |
| 1242 "location": "query", |
| 1243 "required": true, |
| 1244 "type": "string" |
| 1245 } |
| 1246 }, |
| 1247 "path": "leaderboards/{leaderboardId}/scores/{collection}", |
| 1248 "response": { |
| 1249 "$ref": "LeaderboardScores" |
| 1250 }, |
| 1251 "scopes": [ |
| 1252 "https://www.googleapis.com/auth/games", |
| 1253 "https://www.googleapis.com/auth/plus.login" |
| 1254 ] |
| 1255 }, |
| 1256 "listWindow": { |
| 1257 "description": "Lists the scores in a leaderboard around (an
d including) a player's score.", |
| 1258 "httpMethod": "GET", |
| 1259 "id": "games.scores.listWindow", |
| 1260 "parameterOrder": [ |
| 1261 "leaderboardId", |
| 1262 "collection", |
| 1263 "timeSpan" |
| 1264 ], |
| 1265 "parameters": { |
| 1266 "collection": { |
| 1267 "description": "The collection of scores you're requ
esting.", |
| 1268 "enum": [ |
| 1269 "PUBLIC", |
| 1270 "SOCIAL" |
| 1271 ], |
| 1272 "enumDescriptions": [ |
| 1273 "List all scores in the public leaderboard.", |
| 1274 "List only social scores." |
| 1275 ], |
| 1276 "location": "path", |
| 1277 "required": true, |
| 1278 "type": "string" |
| 1279 }, |
| 1280 "language": { |
| 1281 "description": "The preferred language to use for st
rings returned by this method.", |
| 1282 "location": "query", |
| 1283 "type": "string" |
| 1284 }, |
| 1285 "leaderboardId": { |
| 1286 "description": "The ID of the leaderboard.", |
| 1287 "location": "path", |
| 1288 "required": true, |
| 1289 "type": "string" |
| 1290 }, |
| 1291 "maxResults": { |
| 1292 "description": "The maximum number of leaderboard sc
ores to return in the response. For any response, the actual number of leaderboa
rd scores returned may be less than the specified maxResults.", |
| 1293 "format": "int32", |
| 1294 "location": "query", |
| 1295 "maximum": "25", |
| 1296 "minimum": "1", |
| 1297 "type": "integer" |
| 1298 }, |
| 1299 "pageToken": { |
| 1300 "description": "The token returned by the previous r
equest.", |
| 1301 "location": "query", |
| 1302 "type": "string" |
| 1303 }, |
| 1304 "resultsAbove": { |
| 1305 "description": "The preferred number of scores to re
turn above the player's score. More scores may be returned if the player is at t
he bottom of the leaderboard; fewer may be returned if the player is at the top.
Must be less than or equal to maxResults.", |
| 1306 "format": "int32", |
| 1307 "location": "query", |
| 1308 "type": "integer" |
| 1309 }, |
| 1310 "returnTopIfAbsent": { |
| 1311 "description": "True if the top scores should be ret
urned when the player is not in the leaderboard. Defaults to true.", |
| 1312 "location": "query", |
| 1313 "type": "boolean" |
| 1314 }, |
| 1315 "timeSpan": { |
| 1316 "description": "The time span for the scores and ran
ks you're requesting.", |
| 1317 "enum": [ |
| 1318 "ALL_TIME", |
| 1319 "DAILY", |
| 1320 "WEEKLY" |
| 1321 ], |
| 1322 "enumDescriptions": [ |
| 1323 "List the all-time top scores.", |
| 1324 "List the top scores for the current day.", |
| 1325 "List the top scores for the current week." |
| 1326 ], |
| 1327 "location": "query", |
| 1328 "required": true, |
| 1329 "type": "string" |
| 1330 } |
| 1331 }, |
| 1332 "path": "leaderboards/{leaderboardId}/window/{collection}", |
| 1333 "response": { |
| 1334 "$ref": "LeaderboardScores" |
| 1335 }, |
| 1336 "scopes": [ |
| 1337 "https://www.googleapis.com/auth/games", |
| 1338 "https://www.googleapis.com/auth/plus.login" |
| 1339 ] |
| 1340 }, |
| 1341 "submit": { |
| 1342 "description": "Submits a score to the specified leaderboard
.", |
| 1343 "httpMethod": "POST", |
| 1344 "id": "games.scores.submit", |
| 1345 "parameterOrder": [ |
| 1346 "leaderboardId", |
| 1347 "score" |
| 1348 ], |
| 1349 "parameters": { |
| 1350 "language": { |
| 1351 "description": "The preferred language to use for st
rings returned by this method.", |
| 1352 "location": "query", |
| 1353 "type": "string" |
| 1354 }, |
| 1355 "leaderboardId": { |
| 1356 "description": "The ID of the leaderboard.", |
| 1357 "location": "path", |
| 1358 "required": true, |
| 1359 "type": "string" |
| 1360 }, |
| 1361 "score": { |
| 1362 "description": "The score you're submitting. The sub
mitted score is ignored if it is worse than a previously submitted score, where
worse depends on the leaderboard sort order. The meaning of the score value depe
nds on the leaderboard format type. For fixed-point, the score represents the ra
w value. For time, the score represents elapsed time in milliseconds. For curren
cy, the score represents a value in micro units.", |
| 1363 "format": "int64", |
| 1364 "location": "query", |
| 1365 "required": true, |
| 1366 "type": "string" |
| 1367 }, |
| 1368 "scoreTag": { |
| 1369 "description": "Additional information about the sco
re you're submitting. Values must contain no more than 64 URI-safe characters as
defined by section 2.3 of RFC 3986.", |
| 1370 "location": "query", |
| 1371 "pattern": "[a-zA-Z0-9-._~]{0,64}", |
| 1372 "type": "string" |
| 1373 } |
| 1374 }, |
| 1375 "path": "leaderboards/{leaderboardId}/scores", |
| 1376 "response": { |
| 1377 "$ref": "PlayerScoreResponse" |
| 1378 }, |
| 1379 "scopes": [ |
| 1380 "https://www.googleapis.com/auth/games", |
| 1381 "https://www.googleapis.com/auth/plus.login" |
| 1382 ] |
| 1383 }, |
| 1384 "submitMultiple": { |
| 1385 "description": "Submits multiple scores to leaderboards.", |
| 1386 "httpMethod": "POST", |
| 1387 "id": "games.scores.submitMultiple", |
| 1388 "parameters": { |
| 1389 "language": { |
| 1390 "description": "The preferred language to use for st
rings returned by this method.", |
| 1391 "location": "query", |
| 1392 "type": "string" |
| 1393 } |
| 1394 }, |
| 1395 "path": "leaderboards/scores", |
| 1396 "request": { |
| 1397 "$ref": "PlayerScoreSubmissionList" |
| 1398 }, |
| 1399 "response": { |
| 1400 "$ref": "PlayerScoreListResponse" |
| 1401 }, |
| 1402 "scopes": [ |
| 1403 "https://www.googleapis.com/auth/games", |
| 1404 "https://www.googleapis.com/auth/plus.login" |
| 1405 ] |
| 1406 } |
| 1407 } |
| 1408 }, |
| 1409 "snapshots": { |
| 1410 "methods": { |
| 1411 "get": { |
| 1412 "description": "Retrieves the metadata for a given snapshot
ID.", |
| 1413 "httpMethod": "GET", |
| 1414 "id": "games.snapshots.get", |
| 1415 "parameterOrder": [ |
| 1416 "snapshotId" |
| 1417 ], |
| 1418 "parameters": { |
| 1419 "language": { |
| 1420 "description": "The preferred language to use for st
rings returned by this method.", |
| 1421 "location": "query", |
| 1422 "type": "string" |
| 1423 }, |
| 1424 "snapshotId": { |
| 1425 "description": "The ID of the snapshot.", |
| 1426 "location": "path", |
| 1427 "required": true, |
| 1428 "type": "string" |
| 1429 } |
| 1430 }, |
| 1431 "path": "snapshots/{snapshotId}", |
| 1432 "response": { |
| 1433 "$ref": "Snapshot" |
| 1434 }, |
| 1435 "scopes": [ |
| 1436 "https://www.googleapis.com/auth/drive.appdata", |
| 1437 "https://www.googleapis.com/auth/games", |
| 1438 "https://www.googleapis.com/auth/plus.login" |
| 1439 ] |
| 1440 }, |
| 1441 "list": { |
| 1442 "description": "Retrieves a list of snapshots created by you
r application for the player corresponding to the player ID.", |
| 1443 "httpMethod": "GET", |
| 1444 "id": "games.snapshots.list", |
| 1445 "parameterOrder": [ |
| 1446 "playerId" |
| 1447 ], |
| 1448 "parameters": { |
| 1449 "language": { |
| 1450 "description": "The preferred language to use for st
rings returned by this method.", |
| 1451 "location": "query", |
| 1452 "type": "string" |
| 1453 }, |
| 1454 "maxResults": { |
| 1455 "description": "The maximum number of snapshot resou
rces to return in the response, used for paging. For any response, the actual nu
mber of snapshot resources returned may be less than the specified maxResults.", |
| 1456 "format": "int32", |
| 1457 "location": "query", |
| 1458 "maximum": "25", |
| 1459 "minimum": "1", |
| 1460 "type": "integer" |
| 1461 }, |
| 1462 "pageToken": { |
| 1463 "description": "The token returned by the previous r
equest.", |
| 1464 "location": "query", |
| 1465 "type": "string" |
| 1466 }, |
| 1467 "playerId": { |
| 1468 "description": "A player ID. A value of me may be us
ed in place of the authenticated player's ID.", |
| 1469 "location": "path", |
| 1470 "required": true, |
| 1471 "type": "string" |
| 1472 } |
| 1473 }, |
| 1474 "path": "players/{playerId}/snapshots", |
| 1475 "response": { |
| 1476 "$ref": "SnapshotListResponse" |
| 1477 }, |
| 1478 "scopes": [ |
| 1479 "https://www.googleapis.com/auth/drive.appdata", |
| 1480 "https://www.googleapis.com/auth/games", |
| 1481 "https://www.googleapis.com/auth/plus.login" |
| 1482 ] |
| 1483 } |
| 1484 } |
| 1485 }, |
| 1486 "turnBasedMatches": { |
| 1487 "methods": { |
| 1488 "cancel": { |
| 1489 "description": "Cancel a turn-based match.", |
| 1490 "httpMethod": "PUT", |
| 1491 "id": "games.turnBasedMatches.cancel", |
| 1492 "parameterOrder": [ |
| 1493 "matchId" |
| 1494 ], |
| 1495 "parameters": { |
| 1496 "matchId": { |
| 1497 "description": "The ID of the match.", |
| 1498 "location": "path", |
| 1499 "required": true, |
| 1500 "type": "string" |
| 1501 } |
| 1502 }, |
| 1503 "path": "turnbasedmatches/{matchId}/cancel", |
| 1504 "scopes": [ |
| 1505 "https://www.googleapis.com/auth/games", |
| 1506 "https://www.googleapis.com/auth/plus.login" |
| 1507 ] |
| 1508 }, |
| 1509 "create": { |
| 1510 "description": "Create a turn-based match.", |
| 1511 "httpMethod": "POST", |
| 1512 "id": "games.turnBasedMatches.create", |
| 1513 "parameters": { |
| 1514 "language": { |
| 1515 "description": "The preferred language to use for st
rings returned by this method.", |
| 1516 "location": "query", |
| 1517 "type": "string" |
| 1518 } |
| 1519 }, |
| 1520 "path": "turnbasedmatches/create", |
| 1521 "request": { |
| 1522 "$ref": "TurnBasedMatchCreateRequest" |
| 1523 }, |
| 1524 "response": { |
| 1525 "$ref": "TurnBasedMatch" |
| 1526 }, |
| 1527 "scopes": [ |
| 1528 "https://www.googleapis.com/auth/games", |
| 1529 "https://www.googleapis.com/auth/plus.login" |
| 1530 ] |
| 1531 }, |
| 1532 "decline": { |
| 1533 "description": "Decline an invitation to play a turn-based m
atch.", |
| 1534 "httpMethod": "PUT", |
| 1535 "id": "games.turnBasedMatches.decline", |
| 1536 "parameterOrder": [ |
| 1537 "matchId" |
| 1538 ], |
| 1539 "parameters": { |
| 1540 "language": { |
| 1541 "description": "The preferred language to use for st
rings returned by this method.", |
| 1542 "location": "query", |
| 1543 "type": "string" |
| 1544 }, |
| 1545 "matchId": { |
| 1546 "description": "The ID of the match.", |
| 1547 "location": "path", |
| 1548 "required": true, |
| 1549 "type": "string" |
| 1550 } |
| 1551 }, |
| 1552 "path": "turnbasedmatches/{matchId}/decline", |
| 1553 "response": { |
| 1554 "$ref": "TurnBasedMatch" |
| 1555 }, |
| 1556 "scopes": [ |
| 1557 "https://www.googleapis.com/auth/games", |
| 1558 "https://www.googleapis.com/auth/plus.login" |
| 1559 ] |
| 1560 }, |
| 1561 "dismiss": { |
| 1562 "description": "Dismiss a turn-based match from the match li
st. The match will no longer show up in the list and will not generate notificat
ions.", |
| 1563 "httpMethod": "PUT", |
| 1564 "id": "games.turnBasedMatches.dismiss", |
| 1565 "parameterOrder": [ |
| 1566 "matchId" |
| 1567 ], |
| 1568 "parameters": { |
| 1569 "matchId": { |
| 1570 "description": "The ID of the match.", |
| 1571 "location": "path", |
| 1572 "required": true, |
| 1573 "type": "string" |
| 1574 } |
| 1575 }, |
| 1576 "path": "turnbasedmatches/{matchId}/dismiss", |
| 1577 "scopes": [ |
| 1578 "https://www.googleapis.com/auth/games", |
| 1579 "https://www.googleapis.com/auth/plus.login" |
| 1580 ] |
| 1581 }, |
| 1582 "finish": { |
| 1583 "description": "Finish a turn-based match. Each player shoul
d make this call once, after all results are in. Only the player whose turn it i
s may make the first call to Finish, and can pass in the final match state.", |
| 1584 "httpMethod": "PUT", |
| 1585 "id": "games.turnBasedMatches.finish", |
| 1586 "parameterOrder": [ |
| 1587 "matchId" |
| 1588 ], |
| 1589 "parameters": { |
| 1590 "language": { |
| 1591 "description": "The preferred language to use for st
rings returned by this method.", |
| 1592 "location": "query", |
| 1593 "type": "string" |
| 1594 }, |
| 1595 "matchId": { |
| 1596 "description": "The ID of the match.", |
| 1597 "location": "path", |
| 1598 "required": true, |
| 1599 "type": "string" |
| 1600 } |
| 1601 }, |
| 1602 "path": "turnbasedmatches/{matchId}/finish", |
| 1603 "request": { |
| 1604 "$ref": "TurnBasedMatchResults" |
| 1605 }, |
| 1606 "response": { |
| 1607 "$ref": "TurnBasedMatch" |
| 1608 }, |
| 1609 "scopes": [ |
| 1610 "https://www.googleapis.com/auth/games", |
| 1611 "https://www.googleapis.com/auth/plus.login" |
| 1612 ] |
| 1613 }, |
| 1614 "get": { |
| 1615 "description": "Get the data for a turn-based match.", |
| 1616 "httpMethod": "GET", |
| 1617 "id": "games.turnBasedMatches.get", |
| 1618 "parameterOrder": [ |
| 1619 "matchId" |
| 1620 ], |
| 1621 "parameters": { |
| 1622 "includeMatchData": { |
| 1623 "description": "Get match data along with metadata."
, |
| 1624 "location": "query", |
| 1625 "type": "boolean" |
| 1626 }, |
| 1627 "language": { |
| 1628 "description": "The preferred language to use for st
rings returned by this method.", |
| 1629 "location": "query", |
| 1630 "type": "string" |
| 1631 }, |
| 1632 "matchId": { |
| 1633 "description": "The ID of the match.", |
| 1634 "location": "path", |
| 1635 "required": true, |
| 1636 "type": "string" |
| 1637 } |
| 1638 }, |
| 1639 "path": "turnbasedmatches/{matchId}", |
| 1640 "response": { |
| 1641 "$ref": "TurnBasedMatch" |
| 1642 }, |
| 1643 "scopes": [ |
| 1644 "https://www.googleapis.com/auth/games", |
| 1645 "https://www.googleapis.com/auth/plus.login" |
| 1646 ] |
| 1647 }, |
| 1648 "join": { |
| 1649 "description": "Join a turn-based match.", |
| 1650 "httpMethod": "PUT", |
| 1651 "id": "games.turnBasedMatches.join", |
| 1652 "parameterOrder": [ |
| 1653 "matchId" |
| 1654 ], |
| 1655 "parameters": { |
| 1656 "language": { |
| 1657 "description": "The preferred language to use for st
rings returned by this method.", |
| 1658 "location": "query", |
| 1659 "type": "string" |
| 1660 }, |
| 1661 "matchId": { |
| 1662 "description": "The ID of the match.", |
| 1663 "location": "path", |
| 1664 "required": true, |
| 1665 "type": "string" |
| 1666 } |
| 1667 }, |
| 1668 "path": "turnbasedmatches/{matchId}/join", |
| 1669 "response": { |
| 1670 "$ref": "TurnBasedMatch" |
| 1671 }, |
| 1672 "scopes": [ |
| 1673 "https://www.googleapis.com/auth/games", |
| 1674 "https://www.googleapis.com/auth/plus.login" |
| 1675 ] |
| 1676 }, |
| 1677 "leave": { |
| 1678 "description": "Leave a turn-based match when it is not the
current player's turn, without canceling the match.", |
| 1679 "httpMethod": "PUT", |
| 1680 "id": "games.turnBasedMatches.leave", |
| 1681 "parameterOrder": [ |
| 1682 "matchId" |
| 1683 ], |
| 1684 "parameters": { |
| 1685 "language": { |
| 1686 "description": "The preferred language to use for st
rings returned by this method.", |
| 1687 "location": "query", |
| 1688 "type": "string" |
| 1689 }, |
| 1690 "matchId": { |
| 1691 "description": "The ID of the match.", |
| 1692 "location": "path", |
| 1693 "required": true, |
| 1694 "type": "string" |
| 1695 } |
| 1696 }, |
| 1697 "path": "turnbasedmatches/{matchId}/leave", |
| 1698 "response": { |
| 1699 "$ref": "TurnBasedMatch" |
| 1700 }, |
| 1701 "scopes": [ |
| 1702 "https://www.googleapis.com/auth/games", |
| 1703 "https://www.googleapis.com/auth/plus.login" |
| 1704 ] |
| 1705 }, |
| 1706 "leaveTurn": { |
| 1707 "description": "Leave a turn-based match during the current
player's turn, without canceling the match.", |
| 1708 "httpMethod": "PUT", |
| 1709 "id": "games.turnBasedMatches.leaveTurn", |
| 1710 "parameterOrder": [ |
| 1711 "matchId", |
| 1712 "matchVersion" |
| 1713 ], |
| 1714 "parameters": { |
| 1715 "language": { |
| 1716 "description": "The preferred language to use for st
rings returned by this method.", |
| 1717 "location": "query", |
| 1718 "type": "string" |
| 1719 }, |
| 1720 "matchId": { |
| 1721 "description": "The ID of the match.", |
| 1722 "location": "path", |
| 1723 "required": true, |
| 1724 "type": "string" |
| 1725 }, |
| 1726 "matchVersion": { |
| 1727 "description": "The version of the match being updat
ed.", |
| 1728 "format": "int32", |
| 1729 "location": "query", |
| 1730 "required": true, |
| 1731 "type": "integer" |
| 1732 }, |
| 1733 "pendingParticipantId": { |
| 1734 "description": "The ID of another participant who sh
ould take their turn next. If not set, the match will wait for other player(s) t
o join via automatching; this is only valid if automatch criteria is set on the
match with remaining slots for automatched players.", |
| 1735 "location": "query", |
| 1736 "type": "string" |
| 1737 } |
| 1738 }, |
| 1739 "path": "turnbasedmatches/{matchId}/leaveTurn", |
| 1740 "response": { |
| 1741 "$ref": "TurnBasedMatch" |
| 1742 }, |
| 1743 "scopes": [ |
| 1744 "https://www.googleapis.com/auth/games", |
| 1745 "https://www.googleapis.com/auth/plus.login" |
| 1746 ] |
| 1747 }, |
| 1748 "list": { |
| 1749 "description": "Returns turn-based matches the player is or
was involved in.", |
| 1750 "httpMethod": "GET", |
| 1751 "id": "games.turnBasedMatches.list", |
| 1752 "parameters": { |
| 1753 "includeMatchData": { |
| 1754 "description": "True if match data should be returne
d in the response. Note that not all data will necessarily be returned if includ
e_match_data is true; the server may decide to only return data for some of the
matches to limit download size for the client. The remainder of the data for the
se matches will be retrievable on request.", |
| 1755 "location": "query", |
| 1756 "type": "boolean" |
| 1757 }, |
| 1758 "language": { |
| 1759 "description": "The preferred language to use for st
rings returned by this method.", |
| 1760 "location": "query", |
| 1761 "type": "string" |
| 1762 }, |
| 1763 "maxCompletedMatches": { |
| 1764 "description": "The maximum number of completed or c
anceled matches to return in the response. If not set, all matches returned coul
d be completed or canceled.", |
| 1765 "format": "int32", |
| 1766 "location": "query", |
| 1767 "maximum": "500", |
| 1768 "minimum": "0", |
| 1769 "type": "integer" |
| 1770 }, |
| 1771 "maxResults": { |
| 1772 "description": "The maximum number of matches to ret
urn in the response, used for paging. For any response, the actual number of mat
ches to return may be less than the specified maxResults.", |
| 1773 "format": "int32", |
| 1774 "location": "query", |
| 1775 "maximum": "500", |
| 1776 "minimum": "1", |
| 1777 "type": "integer" |
| 1778 }, |
| 1779 "pageToken": { |
| 1780 "description": "The token returned by the previous r
equest.", |
| 1781 "location": "query", |
| 1782 "type": "string" |
| 1783 } |
| 1784 }, |
| 1785 "path": "turnbasedmatches", |
| 1786 "response": { |
| 1787 "$ref": "TurnBasedMatchList" |
| 1788 }, |
| 1789 "scopes": [ |
| 1790 "https://www.googleapis.com/auth/games", |
| 1791 "https://www.googleapis.com/auth/plus.login" |
| 1792 ] |
| 1793 }, |
| 1794 "rematch": { |
| 1795 "description": "Create a rematch of a match that was previou
sly completed, with the same participants. This can be called by only one player
on a match still in their list; the player must have called Finish first. Retur
ns the newly created match; it will be the caller's turn.", |
| 1796 "httpMethod": "POST", |
| 1797 "id": "games.turnBasedMatches.rematch", |
| 1798 "parameterOrder": [ |
| 1799 "matchId" |
| 1800 ], |
| 1801 "parameters": { |
| 1802 "language": { |
| 1803 "description": "The preferred language to use for st
rings returned by this method.", |
| 1804 "location": "query", |
| 1805 "type": "string" |
| 1806 }, |
| 1807 "matchId": { |
| 1808 "description": "The ID of the match.", |
| 1809 "location": "path", |
| 1810 "required": true, |
| 1811 "type": "string" |
| 1812 }, |
| 1813 "requestId": { |
| 1814 "description": "A randomly generated numeric ID for
each request specified by the caller. This number is used at the server to ensur
e that the request is handled correctly across retries.", |
| 1815 "format": "int64", |
| 1816 "location": "query", |
| 1817 "type": "string" |
| 1818 } |
| 1819 }, |
| 1820 "path": "turnbasedmatches/{matchId}/rematch", |
| 1821 "response": { |
| 1822 "$ref": "TurnBasedMatchRematch" |
| 1823 }, |
| 1824 "scopes": [ |
| 1825 "https://www.googleapis.com/auth/games", |
| 1826 "https://www.googleapis.com/auth/plus.login" |
| 1827 ] |
| 1828 }, |
| 1829 "sync": { |
| 1830 "description": "Returns turn-based matches the player is or
was involved in that changed since the last sync call, with the least recent cha
nges coming first. Matches that should be removed from the local cache will have
a status of MATCH_DELETED.", |
| 1831 "httpMethod": "GET", |
| 1832 "id": "games.turnBasedMatches.sync", |
| 1833 "parameters": { |
| 1834 "includeMatchData": { |
| 1835 "description": "True if match data should be returne
d in the response. Note that not all data will necessarily be returned if includ
e_match_data is true; the server may decide to only return data for some of the
matches to limit download size for the client. The remainder of the data for the
se matches will be retrievable on request.", |
| 1836 "location": "query", |
| 1837 "type": "boolean" |
| 1838 }, |
| 1839 "language": { |
| 1840 "description": "The preferred language to use for st
rings returned by this method.", |
| 1841 "location": "query", |
| 1842 "type": "string" |
| 1843 }, |
| 1844 "maxCompletedMatches": { |
| 1845 "description": "The maximum number of completed or c
anceled matches to return in the response. If not set, all matches returned coul
d be completed or canceled.", |
| 1846 "format": "int32", |
| 1847 "location": "query", |
| 1848 "maximum": "500", |
| 1849 "minimum": "0", |
| 1850 "type": "integer" |
| 1851 }, |
| 1852 "maxResults": { |
| 1853 "description": "The maximum number of matches to ret
urn in the response, used for paging. For any response, the actual number of mat
ches to return may be less than the specified maxResults.", |
| 1854 "format": "int32", |
| 1855 "location": "query", |
| 1856 "maximum": "500", |
| 1857 "minimum": "1", |
| 1858 "type": "integer" |
| 1859 }, |
| 1860 "pageToken": { |
| 1861 "description": "The token returned by the previous r
equest.", |
| 1862 "location": "query", |
| 1863 "type": "string" |
| 1864 } |
| 1865 }, |
| 1866 "path": "turnbasedmatches/sync", |
| 1867 "response": { |
| 1868 "$ref": "TurnBasedMatchSync" |
| 1869 }, |
| 1870 "scopes": [ |
| 1871 "https://www.googleapis.com/auth/games", |
| 1872 "https://www.googleapis.com/auth/plus.login" |
| 1873 ] |
| 1874 }, |
| 1875 "takeTurn": { |
| 1876 "description": "Commit the results of a player turn.", |
| 1877 "httpMethod": "PUT", |
| 1878 "id": "games.turnBasedMatches.takeTurn", |
| 1879 "parameterOrder": [ |
| 1880 "matchId" |
| 1881 ], |
| 1882 "parameters": { |
| 1883 "language": { |
| 1884 "description": "The preferred language to use for st
rings returned by this method.", |
| 1885 "location": "query", |
| 1886 "type": "string" |
| 1887 }, |
| 1888 "matchId": { |
| 1889 "description": "The ID of the match.", |
| 1890 "location": "path", |
| 1891 "required": true, |
| 1892 "type": "string" |
| 1893 } |
| 1894 }, |
| 1895 "path": "turnbasedmatches/{matchId}/turn", |
| 1896 "request": { |
| 1897 "$ref": "TurnBasedMatchTurn" |
| 1898 }, |
| 1899 "response": { |
| 1900 "$ref": "TurnBasedMatch" |
| 1901 }, |
| 1902 "scopes": [ |
| 1903 "https://www.googleapis.com/auth/games", |
| 1904 "https://www.googleapis.com/auth/plus.login" |
| 1905 ] |
| 1906 } |
| 1907 } |
| 1908 } |
| 1909 }, |
| 1910 "revision": "20140903", |
| 1911 "rootUrl": "https://www.googleapis.com/", |
| 1912 "schemas": { |
| 1913 "AchievementDefinition": { |
| 1914 "description": "This is a JSON template for an achievement definitio
n object.", |
| 1915 "id": "AchievementDefinition", |
| 1916 "properties": { |
| 1917 "achievementType": { |
| 1918 "description": "The type of the achievement.\nPossible value
s are: \n- \"STANDARD\" - Achievement is either locked or unlocked. \n- \"INCRE
MENTAL\" - Achievement is incremental.", |
| 1919 "type": "string" |
| 1920 }, |
| 1921 "description": { |
| 1922 "description": "The description of the achievement.", |
| 1923 "type": "string" |
| 1924 }, |
| 1925 "experiencePoints": { |
| 1926 "description": "Experience points which will be earned when
unlocking this achievement.", |
| 1927 "format": "int64", |
| 1928 "type": "string" |
| 1929 }, |
| 1930 "formattedTotalSteps": { |
| 1931 "description": "The total steps for an incremental achieveme
nt as a string.", |
| 1932 "type": "string" |
| 1933 }, |
| 1934 "id": { |
| 1935 "description": "The ID of the achievement.", |
| 1936 "type": "string" |
| 1937 }, |
| 1938 "initialState": { |
| 1939 "description": "The initial state of the achievement.\nPossi
ble values are: \n- \"HIDDEN\" - Achievement is hidden. \n- \"REVEALED\" - Achi
evement is revealed. \n- \"UNLOCKED\" - Achievement is unlocked.", |
| 1940 "type": "string" |
| 1941 }, |
| 1942 "isRevealedIconUrlDefault": { |
| 1943 "description": "Indicates whether the revealed icon image be
ing returned is a default image, or is provided by the game.", |
| 1944 "type": "boolean" |
| 1945 }, |
| 1946 "isUnlockedIconUrlDefault": { |
| 1947 "description": "Indicates whether the unlocked icon image be
ing returned is a default image, or is game-provided.", |
| 1948 "type": "boolean" |
| 1949 }, |
| 1950 "kind": { |
| 1951 "default": "games#achievementDefinition", |
| 1952 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#achievementDefinition.", |
| 1953 "type": "string" |
| 1954 }, |
| 1955 "name": { |
| 1956 "description": "The name of the achievement.", |
| 1957 "type": "string" |
| 1958 }, |
| 1959 "revealedIconUrl": { |
| 1960 "description": "The image URL for the revealed achievement i
con.", |
| 1961 "type": "string" |
| 1962 }, |
| 1963 "totalSteps": { |
| 1964 "description": "The total steps for an incremental achieveme
nt.", |
| 1965 "format": "int32", |
| 1966 "type": "integer" |
| 1967 }, |
| 1968 "unlockedIconUrl": { |
| 1969 "description": "The image URL for the unlocked achievement i
con.", |
| 1970 "type": "string" |
| 1971 } |
| 1972 }, |
| 1973 "type": "object" |
| 1974 }, |
| 1975 "AchievementDefinitionsListResponse": { |
| 1976 "description": "This is a JSON template for a list of achievement de
finition objects.", |
| 1977 "id": "AchievementDefinitionsListResponse", |
| 1978 "properties": { |
| 1979 "items": { |
| 1980 "description": "The achievement definitions.", |
| 1981 "items": { |
| 1982 "$ref": "AchievementDefinition" |
| 1983 }, |
| 1984 "type": "array" |
| 1985 }, |
| 1986 "kind": { |
| 1987 "default": "games#achievementDefinitionsListResponse", |
| 1988 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#achievementDefinitionsListResponse.", |
| 1989 "type": "string" |
| 1990 }, |
| 1991 "nextPageToken": { |
| 1992 "description": "Token corresponding to the next page of resu
lts.", |
| 1993 "type": "string" |
| 1994 } |
| 1995 }, |
| 1996 "type": "object" |
| 1997 }, |
| 1998 "AchievementIncrementResponse": { |
| 1999 "description": "This is a JSON template for an achievement increment
response", |
| 2000 "id": "AchievementIncrementResponse", |
| 2001 "properties": { |
| 2002 "currentSteps": { |
| 2003 "description": "The current steps recorded for this incremen
tal achievement.", |
| 2004 "format": "int32", |
| 2005 "type": "integer" |
| 2006 }, |
| 2007 "kind": { |
| 2008 "default": "games#achievementIncrementResponse", |
| 2009 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#achievementIncrementResponse.", |
| 2010 "type": "string" |
| 2011 }, |
| 2012 "newlyUnlocked": { |
| 2013 "description": "Whether the the current steps for the achiev
ement has reached the number of steps required to unlock.", |
| 2014 "type": "boolean" |
| 2015 } |
| 2016 }, |
| 2017 "type": "object" |
| 2018 }, |
| 2019 "AchievementRevealResponse": { |
| 2020 "description": "This is a JSON template for an achievement reveal re
sponse", |
| 2021 "id": "AchievementRevealResponse", |
| 2022 "properties": { |
| 2023 "currentState": { |
| 2024 "description": "The current state of the achievement for whi
ch a reveal was attempted. This might be UNLOCKED if the achievement was already
unlocked.\nPossible values are: \n- \"REVEALED\" - Achievement is revealed. \n
- \"UNLOCKED\" - Achievement is unlocked.", |
| 2025 "type": "string" |
| 2026 }, |
| 2027 "kind": { |
| 2028 "default": "games#achievementRevealResponse", |
| 2029 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#achievementRevealResponse.", |
| 2030 "type": "string" |
| 2031 } |
| 2032 }, |
| 2033 "type": "object" |
| 2034 }, |
| 2035 "AchievementSetStepsAtLeastResponse": { |
| 2036 "description": "This is a JSON template for an achievement set steps
at least response.", |
| 2037 "id": "AchievementSetStepsAtLeastResponse", |
| 2038 "properties": { |
| 2039 "currentSteps": { |
| 2040 "description": "The current steps recorded for this incremen
tal achievement.", |
| 2041 "format": "int32", |
| 2042 "type": "integer" |
| 2043 }, |
| 2044 "kind": { |
| 2045 "default": "games#achievementSetStepsAtLeastResponse", |
| 2046 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#achievementSetStepsAtLeastResponse.", |
| 2047 "type": "string" |
| 2048 }, |
| 2049 "newlyUnlocked": { |
| 2050 "description": "Whether the the current steps for the achiev
ement has reached the number of steps required to unlock.", |
| 2051 "type": "boolean" |
| 2052 } |
| 2053 }, |
| 2054 "type": "object" |
| 2055 }, |
| 2056 "AchievementUnlockResponse": { |
| 2057 "description": "This is a JSON template for an achievement unlock re
sponse", |
| 2058 "id": "AchievementUnlockResponse", |
| 2059 "properties": { |
| 2060 "kind": { |
| 2061 "default": "games#achievementUnlockResponse", |
| 2062 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#achievementUnlockResponse.", |
| 2063 "type": "string" |
| 2064 }, |
| 2065 "newlyUnlocked": { |
| 2066 "description": "Whether this achievement was newly unlocked
(that is, whether the unlock request for the achievement was the first for the p
layer).", |
| 2067 "type": "boolean" |
| 2068 } |
| 2069 }, |
| 2070 "type": "object" |
| 2071 }, |
| 2072 "AchievementUpdateMultipleRequest": { |
| 2073 "description": "This is a JSON template for a list of achievement up
date requests.", |
| 2074 "id": "AchievementUpdateMultipleRequest", |
| 2075 "properties": { |
| 2076 "kind": { |
| 2077 "default": "games#achievementUpdateMultipleRequest", |
| 2078 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#achievementUpdateMultipleRequest.", |
| 2079 "type": "string" |
| 2080 }, |
| 2081 "updates": { |
| 2082 "description": "The individual achievement update requests."
, |
| 2083 "items": { |
| 2084 "$ref": "AchievementUpdateRequest" |
| 2085 }, |
| 2086 "type": "array" |
| 2087 } |
| 2088 }, |
| 2089 "type": "object" |
| 2090 }, |
| 2091 "AchievementUpdateMultipleResponse": { |
| 2092 "description": "This is a JSON template for an achievement unlock re
sponse.", |
| 2093 "id": "AchievementUpdateMultipleResponse", |
| 2094 "properties": { |
| 2095 "kind": { |
| 2096 "default": "games#achievementUpdateMultipleResponse", |
| 2097 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#achievementUpdateListResponse.", |
| 2098 "type": "string" |
| 2099 }, |
| 2100 "updatedAchievements": { |
| 2101 "description": "The updated state of the achievements.", |
| 2102 "items": { |
| 2103 "$ref": "AchievementUpdateResponse" |
| 2104 }, |
| 2105 "type": "array" |
| 2106 } |
| 2107 }, |
| 2108 "type": "object" |
| 2109 }, |
| 2110 "AchievementUpdateRequest": { |
| 2111 "description": "This is a JSON template for a request to update an a
chievement.", |
| 2112 "id": "AchievementUpdateRequest", |
| 2113 "properties": { |
| 2114 "achievementId": { |
| 2115 "description": "The achievement this update is being applied
to.", |
| 2116 "type": "string" |
| 2117 }, |
| 2118 "incrementPayload": { |
| 2119 "$ref": "GamesAchievementIncrement", |
| 2120 "description": "The payload if an update of type INCREMENT w
as requested for the achievement." |
| 2121 }, |
| 2122 "kind": { |
| 2123 "default": "games#achievementUpdateRequest", |
| 2124 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#achievementUpdateRequest.", |
| 2125 "type": "string" |
| 2126 }, |
| 2127 "setStepsAtLeastPayload": { |
| 2128 "$ref": "GamesAchievementSetStepsAtLeast", |
| 2129 "description": "The payload if an update of type SET_STEPS_A
T_LEAST was requested for the achievement." |
| 2130 }, |
| 2131 "updateType": { |
| 2132 "description": "The type of update being applied.\nPossible
values are: \n- \"REVEAL\" - Achievement is revealed. \n- \"UNLOCK\" - Achievem
ent is unlocked. \n- \"INCREMENT\" - Achievement is incremented. \n- \"SET_STEPS
_AT_LEAST\" - Achievement progress is set to at least the passed value.", |
| 2133 "type": "string" |
| 2134 } |
| 2135 }, |
| 2136 "type": "object" |
| 2137 }, |
| 2138 "AchievementUpdateResponse": { |
| 2139 "description": "This is a JSON template for an achievement update re
sponse.", |
| 2140 "id": "AchievementUpdateResponse", |
| 2141 "properties": { |
| 2142 "achievementId": { |
| 2143 "description": "The achievement this update is was applied t
o.", |
| 2144 "type": "string" |
| 2145 }, |
| 2146 "currentState": { |
| 2147 "description": "The current state of the achievement.\nPossi
ble values are: \n- \"HIDDEN\" - Achievement is hidden. \n- \"REVEALED\" - Achi
evement is revealed. \n- \"UNLOCKED\" - Achievement is unlocked.", |
| 2148 "type": "string" |
| 2149 }, |
| 2150 "currentSteps": { |
| 2151 "description": "The current steps recorded for this achievem
ent if it is incremental.", |
| 2152 "format": "int32", |
| 2153 "type": "integer" |
| 2154 }, |
| 2155 "kind": { |
| 2156 "default": "games#achievementUpdateResponse", |
| 2157 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#achievementUpdateResponse.", |
| 2158 "type": "string" |
| 2159 }, |
| 2160 "newlyUnlocked": { |
| 2161 "description": "Whether this achievement was newly unlocked
(that is, whether the unlock request for the achievement was the first for the p
layer).", |
| 2162 "type": "boolean" |
| 2163 }, |
| 2164 "updateOccurred": { |
| 2165 "description": "Whether the requested updates actually affec
ted the achievement.", |
| 2166 "type": "boolean" |
| 2167 } |
| 2168 }, |
| 2169 "type": "object" |
| 2170 }, |
| 2171 "AggregateStats": { |
| 2172 "description": "This is a JSON template for aggregate stats.", |
| 2173 "id": "AggregateStats", |
| 2174 "properties": { |
| 2175 "count": { |
| 2176 "description": "The number of messages sent between a pair o
f peers.", |
| 2177 "format": "int64", |
| 2178 "type": "string" |
| 2179 }, |
| 2180 "kind": { |
| 2181 "default": "games#aggregateStats", |
| 2182 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#aggregateStats.", |
| 2183 "type": "string" |
| 2184 }, |
| 2185 "max": { |
| 2186 "description": "The maximum amount.", |
| 2187 "format": "int64", |
| 2188 "type": "string" |
| 2189 }, |
| 2190 "min": { |
| 2191 "description": "The minimum amount.", |
| 2192 "format": "int64", |
| 2193 "type": "string" |
| 2194 }, |
| 2195 "sum": { |
| 2196 "description": "The total number of bytes sent for messages
between a pair of peers.", |
| 2197 "format": "int64", |
| 2198 "type": "string" |
| 2199 } |
| 2200 }, |
| 2201 "type": "object" |
| 2202 }, |
| 2203 "AnonymousPlayer": { |
| 2204 "description": "This is a JSON template for an anonymous player", |
| 2205 "id": "AnonymousPlayer", |
| 2206 "properties": { |
| 2207 "avatarImageUrl": { |
| 2208 "description": "The base URL for the image to display for th
e anonymous player.", |
| 2209 "type": "string" |
| 2210 }, |
| 2211 "displayName": { |
| 2212 "description": "The name to display for the anonymous player
.", |
| 2213 "type": "string" |
| 2214 }, |
| 2215 "kind": { |
| 2216 "default": "games#anonymousPlayer", |
| 2217 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#anonymousPlayer.", |
| 2218 "type": "string" |
| 2219 } |
| 2220 }, |
| 2221 "type": "object" |
| 2222 }, |
| 2223 "Application": { |
| 2224 "description": "This is a JSON template for the Application resource
.", |
| 2225 "id": "Application", |
| 2226 "properties": { |
| 2227 "achievement_count": { |
| 2228 "description": "The number of achievements visible to the cu
rrently authenticated player.", |
| 2229 "format": "int32", |
| 2230 "type": "integer" |
| 2231 }, |
| 2232 "assets": { |
| 2233 "description": "The assets of the application.", |
| 2234 "items": { |
| 2235 "$ref": "ImageAsset" |
| 2236 }, |
| 2237 "type": "array" |
| 2238 }, |
| 2239 "author": { |
| 2240 "description": "The author of the application.", |
| 2241 "type": "string" |
| 2242 }, |
| 2243 "category": { |
| 2244 "$ref": "ApplicationCategory", |
| 2245 "description": "The category of the application." |
| 2246 }, |
| 2247 "description": { |
| 2248 "description": "The description of the application.", |
| 2249 "type": "string" |
| 2250 }, |
| 2251 "enabledFeatures": { |
| 2252 "description": "A list of features that have been enabled fo
r the application.\nPossible values are: \n- \"SNAPSHOTS\" - Snapshots has been
enabled", |
| 2253 "items": { |
| 2254 "type": "string" |
| 2255 }, |
| 2256 "type": "array" |
| 2257 }, |
| 2258 "id": { |
| 2259 "description": "The ID of the application.", |
| 2260 "type": "string" |
| 2261 }, |
| 2262 "instances": { |
| 2263 "description": "The instances of the application.", |
| 2264 "items": { |
| 2265 "$ref": "Instance" |
| 2266 }, |
| 2267 "type": "array" |
| 2268 }, |
| 2269 "kind": { |
| 2270 "default": "games#application", |
| 2271 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#application.", |
| 2272 "type": "string" |
| 2273 }, |
| 2274 "lastUpdatedTimestamp": { |
| 2275 "description": "The last updated timestamp of the applicatio
n.", |
| 2276 "format": "int64", |
| 2277 "type": "string" |
| 2278 }, |
| 2279 "leaderboard_count": { |
| 2280 "description": "The number of leaderboards visible to the cu
rrently authenticated player.", |
| 2281 "format": "int32", |
| 2282 "type": "integer" |
| 2283 }, |
| 2284 "name": { |
| 2285 "description": "The name of the application.", |
| 2286 "type": "string" |
| 2287 } |
| 2288 }, |
| 2289 "type": "object" |
| 2290 }, |
| 2291 "ApplicationCategory": { |
| 2292 "description": "This is a JSON template for an application category
object.", |
| 2293 "id": "ApplicationCategory", |
| 2294 "properties": { |
| 2295 "kind": { |
| 2296 "default": "games#applicationCategory", |
| 2297 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#applicationCategory.", |
| 2298 "type": "string" |
| 2299 }, |
| 2300 "primary": { |
| 2301 "description": "The primary category.", |
| 2302 "type": "string" |
| 2303 }, |
| 2304 "secondary": { |
| 2305 "description": "The secondary category.", |
| 2306 "type": "string" |
| 2307 } |
| 2308 }, |
| 2309 "type": "object" |
| 2310 }, |
| 2311 "Category": { |
| 2312 "description": "This is a JSON template for data related to individu
al game categories.", |
| 2313 "id": "Category", |
| 2314 "properties": { |
| 2315 "category": { |
| 2316 "description": "The category name.", |
| 2317 "type": "string" |
| 2318 }, |
| 2319 "experiencePoints": { |
| 2320 "description": "Experience points earned in this category.", |
| 2321 "format": "int64", |
| 2322 "type": "string" |
| 2323 }, |
| 2324 "kind": { |
| 2325 "default": "games#category", |
| 2326 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#category.", |
| 2327 "type": "string" |
| 2328 } |
| 2329 }, |
| 2330 "type": "object" |
| 2331 }, |
| 2332 "CategoryListResponse": { |
| 2333 "description": "This is a JSON template for a list of category data
objects.", |
| 2334 "id": "CategoryListResponse", |
| 2335 "properties": { |
| 2336 "items": { |
| 2337 "description": "The list of categories with usage data.", |
| 2338 "items": { |
| 2339 "$ref": "Category" |
| 2340 }, |
| 2341 "type": "array" |
| 2342 }, |
| 2343 "kind": { |
| 2344 "default": "games#categoryListResponse", |
| 2345 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#categoryListResponse.", |
| 2346 "type": "string" |
| 2347 }, |
| 2348 "nextPageToken": { |
| 2349 "description": "Token corresponding to the next page of resu
lts.", |
| 2350 "type": "string" |
| 2351 } |
| 2352 }, |
| 2353 "type": "object" |
| 2354 }, |
| 2355 "EventBatchRecordFailure": { |
| 2356 "description": "This is a JSON template for a batch update failure r
esource.", |
| 2357 "id": "EventBatchRecordFailure", |
| 2358 "properties": { |
| 2359 "failureCause": { |
| 2360 "description": "The cause for the update failure.\nPossible
values are: \n- \"TOO_LARGE\": A batch request was issued with more events than
are allowed in a single batch. \n- \"TIME_PERIOD_EXPIRED\": A batch was sent wi
th data too far in the past to record. \n- \"TIME_PERIOD_SHORT\": A batch was se
nt with a time range that was too short. \n- \"TIME_PERIOD_LONG\": A batch was s
ent with a time range that was too long. \n- \"ALREADY_UPDATED\": An attempt was
made to record a batch of data which was already seen. \n- \"RECORD_RATE_HIGH\"
: An attempt was made to record data faster than the server will apply updates."
, |
| 2361 "type": "string" |
| 2362 }, |
| 2363 "kind": { |
| 2364 "default": "games#eventBatchRecordFailure", |
| 2365 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#eventBatchRecordFailure.", |
| 2366 "type": "string" |
| 2367 }, |
| 2368 "range": { |
| 2369 "$ref": "EventPeriodRange", |
| 2370 "description": "The time range which was rejected; empty for
a request-wide failure." |
| 2371 } |
| 2372 }, |
| 2373 "type": "object" |
| 2374 }, |
| 2375 "EventChild": { |
| 2376 "description": "This is a JSON template for an event child relations
hip resource.", |
| 2377 "id": "EventChild", |
| 2378 "properties": { |
| 2379 "childId": { |
| 2380 "description": "The ID of the child event.", |
| 2381 "type": "string" |
| 2382 }, |
| 2383 "kind": { |
| 2384 "default": "games#eventChild", |
| 2385 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#eventChild.", |
| 2386 "type": "string" |
| 2387 } |
| 2388 }, |
| 2389 "type": "object" |
| 2390 }, |
| 2391 "EventDefinition": { |
| 2392 "description": "This is a JSON template for an event definition reso
urce.", |
| 2393 "id": "EventDefinition", |
| 2394 "properties": { |
| 2395 "childEvents": { |
| 2396 "description": "A list of events that are a child of this ev
ent.", |
| 2397 "items": { |
| 2398 "$ref": "EventChild" |
| 2399 }, |
| 2400 "type": "array" |
| 2401 }, |
| 2402 "description": { |
| 2403 "description": "Description of what this event represents.", |
| 2404 "type": "string" |
| 2405 }, |
| 2406 "displayName": { |
| 2407 "description": "The name to display for the event.", |
| 2408 "type": "string" |
| 2409 }, |
| 2410 "id": { |
| 2411 "description": "The ID of the event.", |
| 2412 "type": "string" |
| 2413 }, |
| 2414 "imageUrl": { |
| 2415 "description": "The base URL for the image that represents t
he event.", |
| 2416 "type": "string" |
| 2417 }, |
| 2418 "isDefaultImageUrl": { |
| 2419 "description": "Indicates whether the icon image being retur
ned is a default image, or is game-provided.", |
| 2420 "type": "boolean" |
| 2421 }, |
| 2422 "kind": { |
| 2423 "default": "games#eventDefinition", |
| 2424 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#eventDefinition.", |
| 2425 "type": "string" |
| 2426 }, |
| 2427 "visibility": { |
| 2428 "description": "The visibility of event being tracked in thi
s definition.\nPossible values are: \n- \"REVEALED\": This event should be visi
ble to all users. \n- \"HIDDEN\": This event should only be shown to users that
have recorded this event at least once.", |
| 2429 "type": "string" |
| 2430 } |
| 2431 }, |
| 2432 "type": "object" |
| 2433 }, |
| 2434 "EventDefinitionListResponse": { |
| 2435 "description": "This is a JSON template for a ListDefinitions respon
se.", |
| 2436 "id": "EventDefinitionListResponse", |
| 2437 "properties": { |
| 2438 "items": { |
| 2439 "description": "The event definitions.", |
| 2440 "items": { |
| 2441 "$ref": "EventDefinition" |
| 2442 }, |
| 2443 "type": "array" |
| 2444 }, |
| 2445 "kind": { |
| 2446 "default": "games#eventDefinitionListResponse", |
| 2447 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#eventDefinitionListResponse.", |
| 2448 "type": "string" |
| 2449 }, |
| 2450 "nextPageToken": { |
| 2451 "description": "The pagination token for the next page of re
sults.", |
| 2452 "type": "string" |
| 2453 } |
| 2454 }, |
| 2455 "type": "object" |
| 2456 }, |
| 2457 "EventPeriodRange": { |
| 2458 "description": "This is a JSON template for an event period time ran
ge.", |
| 2459 "id": "EventPeriodRange", |
| 2460 "properties": { |
| 2461 "kind": { |
| 2462 "default": "games#eventPeriodRange", |
| 2463 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#eventPeriodRange.", |
| 2464 "type": "string" |
| 2465 }, |
| 2466 "periodEndMillis": { |
| 2467 "description": "The time when this update period ends, in mi
llis, since 1970 UTC (Unix Epoch).", |
| 2468 "format": "int64", |
| 2469 "type": "string" |
| 2470 }, |
| 2471 "periodStartMillis": { |
| 2472 "description": "The time when this update period begins, in
millis, since 1970 UTC (Unix Epoch).", |
| 2473 "format": "int64", |
| 2474 "type": "string" |
| 2475 } |
| 2476 }, |
| 2477 "type": "object" |
| 2478 }, |
| 2479 "EventPeriodUpdate": { |
| 2480 "description": "This is a JSON template for an event period update r
esource.", |
| 2481 "id": "EventPeriodUpdate", |
| 2482 "properties": { |
| 2483 "kind": { |
| 2484 "default": "games#eventPeriodUpdate", |
| 2485 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#eventPeriodUpdate.", |
| 2486 "type": "string" |
| 2487 }, |
| 2488 "timePeriod": { |
| 2489 "$ref": "EventPeriodRange", |
| 2490 "description": "The time period being covered by this update
." |
| 2491 }, |
| 2492 "updates": { |
| 2493 "description": "The updates being made for this time period.
", |
| 2494 "items": { |
| 2495 "$ref": "EventUpdateRequest" |
| 2496 }, |
| 2497 "type": "array" |
| 2498 } |
| 2499 }, |
| 2500 "type": "object" |
| 2501 }, |
| 2502 "EventRecordFailure": { |
| 2503 "description": "This is a JSON template for an event update failure
resource.", |
| 2504 "id": "EventRecordFailure", |
| 2505 "properties": { |
| 2506 "eventId": { |
| 2507 "description": "The ID of the event that was not updated.", |
| 2508 "type": "string" |
| 2509 }, |
| 2510 "failureCause": { |
| 2511 "description": "The cause for the update failure.\nPossible
values are: \n- \"NOT_FOUND\" - An attempt was made to set an event that was no
t defined. \n- \"INVALID_UPDATE_VALUE\" - An attempt was made to increment an ev
ent by a non-positive value.", |
| 2512 "type": "string" |
| 2513 }, |
| 2514 "kind": { |
| 2515 "default": "games#eventRecordFailure", |
| 2516 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#eventRecordFailure.", |
| 2517 "type": "string" |
| 2518 } |
| 2519 }, |
| 2520 "type": "object" |
| 2521 }, |
| 2522 "EventRecordRequest": { |
| 2523 "description": "This is a JSON template for an event period update r
esource.", |
| 2524 "id": "EventRecordRequest", |
| 2525 "properties": { |
| 2526 "currentTimeMillis": { |
| 2527 "description": "The current time when this update was sent,
in milliseconds, since 1970 UTC (Unix Epoch).", |
| 2528 "format": "int64", |
| 2529 "type": "string" |
| 2530 }, |
| 2531 "kind": { |
| 2532 "default": "games#eventRecordRequest", |
| 2533 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#eventRecordRequest.", |
| 2534 "type": "string" |
| 2535 }, |
| 2536 "requestId": { |
| 2537 "description": "The request ID used to identify this attempt
to record events.", |
| 2538 "format": "int64", |
| 2539 "type": "string" |
| 2540 }, |
| 2541 "timePeriods": { |
| 2542 "description": "A list of the time period updates being made
in this request.", |
| 2543 "items": { |
| 2544 "$ref": "EventPeriodUpdate" |
| 2545 }, |
| 2546 "type": "array" |
| 2547 } |
| 2548 }, |
| 2549 "type": "object" |
| 2550 }, |
| 2551 "EventUpdateRequest": { |
| 2552 "description": "This is a JSON template for an event period update r
esource.", |
| 2553 "id": "EventUpdateRequest", |
| 2554 "properties": { |
| 2555 "definitionId": { |
| 2556 "description": "The ID of the event being modified in this u
pdate.", |
| 2557 "type": "string" |
| 2558 }, |
| 2559 "kind": { |
| 2560 "default": "games#eventUpdateRequest", |
| 2561 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#eventUpdateRequest.", |
| 2562 "type": "string" |
| 2563 }, |
| 2564 "updateCount": { |
| 2565 "description": "The number of times this event occurred in t
his time period.", |
| 2566 "format": "int64", |
| 2567 "type": "string" |
| 2568 } |
| 2569 }, |
| 2570 "type": "object" |
| 2571 }, |
| 2572 "EventUpdateResponse": { |
| 2573 "description": "This is a JSON template for an event period update r
esource.", |
| 2574 "id": "EventUpdateResponse", |
| 2575 "properties": { |
| 2576 "batchFailures": { |
| 2577 "description": "Any batch-wide failures which occurred apply
ing updates.", |
| 2578 "items": { |
| 2579 "$ref": "EventBatchRecordFailure" |
| 2580 }, |
| 2581 "type": "array" |
| 2582 }, |
| 2583 "eventFailures": { |
| 2584 "description": "Any failures updating a particular event.", |
| 2585 "items": { |
| 2586 "$ref": "EventRecordFailure" |
| 2587 }, |
| 2588 "type": "array" |
| 2589 }, |
| 2590 "kind": { |
| 2591 "default": "games#eventUpdateResponse", |
| 2592 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#eventUpdateResponse.", |
| 2593 "type": "string" |
| 2594 }, |
| 2595 "playerEvents": { |
| 2596 "description": "The current status of any updated events", |
| 2597 "items": { |
| 2598 "$ref": "PlayerEvent" |
| 2599 }, |
| 2600 "type": "array" |
| 2601 } |
| 2602 }, |
| 2603 "type": "object" |
| 2604 }, |
| 2605 "GamesAchievementIncrement": { |
| 2606 "description": "This is a JSON template for the payload to request t
o increment an achievement.", |
| 2607 "id": "GamesAchievementIncrement", |
| 2608 "properties": { |
| 2609 "kind": { |
| 2610 "default": "games#GamesAchievementIncrement", |
| 2611 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#GamesAchievementIncrement.", |
| 2612 "type": "string" |
| 2613 }, |
| 2614 "requestId": { |
| 2615 "description": "The requestId associated with an increment t
o an achievement.", |
| 2616 "format": "int64", |
| 2617 "type": "string" |
| 2618 }, |
| 2619 "steps": { |
| 2620 "description": "The number of steps to be incremented.", |
| 2621 "format": "int32", |
| 2622 "type": "integer" |
| 2623 } |
| 2624 }, |
| 2625 "type": "object" |
| 2626 }, |
| 2627 "GamesAchievementSetStepsAtLeast": { |
| 2628 "description": "This is a JSON template for the payload to request t
o increment an achievement.", |
| 2629 "id": "GamesAchievementSetStepsAtLeast", |
| 2630 "properties": { |
| 2631 "kind": { |
| 2632 "default": "games#GamesAchievementSetStepsAtLeast", |
| 2633 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#GamesAchievementSetStepsAtLeast.", |
| 2634 "type": "string" |
| 2635 }, |
| 2636 "steps": { |
| 2637 "description": "The minimum number of steps for the achievem
ent to be set to.", |
| 2638 "format": "int32", |
| 2639 "type": "integer" |
| 2640 } |
| 2641 }, |
| 2642 "type": "object" |
| 2643 }, |
| 2644 "ImageAsset": { |
| 2645 "description": "This is a JSON template for an image asset object.", |
| 2646 "id": "ImageAsset", |
| 2647 "properties": { |
| 2648 "height": { |
| 2649 "description": "The height of the asset.", |
| 2650 "format": "int32", |
| 2651 "type": "integer" |
| 2652 }, |
| 2653 "kind": { |
| 2654 "default": "games#imageAsset", |
| 2655 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#imageAsset.", |
| 2656 "type": "string" |
| 2657 }, |
| 2658 "name": { |
| 2659 "description": "The name of the asset.", |
| 2660 "type": "string" |
| 2661 }, |
| 2662 "url": { |
| 2663 "description": "The URL of the asset.", |
| 2664 "type": "string" |
| 2665 }, |
| 2666 "width": { |
| 2667 "description": "The width of the asset.", |
| 2668 "format": "int32", |
| 2669 "type": "integer" |
| 2670 } |
| 2671 }, |
| 2672 "type": "object" |
| 2673 }, |
| 2674 "Instance": { |
| 2675 "description": "This is a JSON template for the Instance resource.", |
| 2676 "id": "Instance", |
| 2677 "properties": { |
| 2678 "acquisitionUri": { |
| 2679 "description": "URI which shows where a user can acquire thi
s instance.", |
| 2680 "type": "string" |
| 2681 }, |
| 2682 "androidInstance": { |
| 2683 "$ref": "InstanceAndroidDetails", |
| 2684 "description": "Platform dependent details for Android." |
| 2685 }, |
| 2686 "iosInstance": { |
| 2687 "$ref": "InstanceIosDetails", |
| 2688 "description": "Platform dependent details for iOS." |
| 2689 }, |
| 2690 "kind": { |
| 2691 "default": "games#instance", |
| 2692 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#instance.", |
| 2693 "type": "string" |
| 2694 }, |
| 2695 "name": { |
| 2696 "description": "Localized display name.", |
| 2697 "type": "string" |
| 2698 }, |
| 2699 "platformType": { |
| 2700 "description": "The platform type.\nPossible values are: \n
- \"ANDROID\" - Instance is for Android. \n- \"IOS\" - Instance is for iOS \n- \
"WEB_APP\" - Instance is for Web App.", |
| 2701 "type": "string" |
| 2702 }, |
| 2703 "realtimePlay": { |
| 2704 "description": "Flag to show if this game instance supports
realtime play.", |
| 2705 "type": "boolean" |
| 2706 }, |
| 2707 "turnBasedPlay": { |
| 2708 "description": "Flag to show if this game instance supports
turn based play.", |
| 2709 "type": "boolean" |
| 2710 }, |
| 2711 "webInstance": { |
| 2712 "$ref": "InstanceWebDetails", |
| 2713 "description": "Platform dependent details for Web." |
| 2714 } |
| 2715 }, |
| 2716 "type": "object" |
| 2717 }, |
| 2718 "InstanceAndroidDetails": { |
| 2719 "description": "This is a JSON template for the Android instance det
ails resource.", |
| 2720 "id": "InstanceAndroidDetails", |
| 2721 "properties": { |
| 2722 "enablePiracyCheck": { |
| 2723 "description": "Flag indicating whether the anti-piracy chec
k is enabled.", |
| 2724 "type": "boolean" |
| 2725 }, |
| 2726 "kind": { |
| 2727 "default": "games#instanceAndroidDetails", |
| 2728 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#instanceAndroidDetails.", |
| 2729 "type": "string" |
| 2730 }, |
| 2731 "packageName": { |
| 2732 "description": "Android package name which maps to Google Pl
ay URL.", |
| 2733 "type": "string" |
| 2734 }, |
| 2735 "preferred": { |
| 2736 "description": "Indicates that this instance is the default
for new installations.", |
| 2737 "type": "boolean" |
| 2738 } |
| 2739 }, |
| 2740 "type": "object" |
| 2741 }, |
| 2742 "InstanceIosDetails": { |
| 2743 "description": "This is a JSON template for the iOS details resource
.", |
| 2744 "id": "InstanceIosDetails", |
| 2745 "properties": { |
| 2746 "bundleIdentifier": { |
| 2747 "description": "Bundle identifier.", |
| 2748 "type": "string" |
| 2749 }, |
| 2750 "itunesAppId": { |
| 2751 "description": "iTunes App ID.", |
| 2752 "type": "string" |
| 2753 }, |
| 2754 "kind": { |
| 2755 "default": "games#instanceIosDetails", |
| 2756 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#instanceIosDetails.", |
| 2757 "type": "string" |
| 2758 }, |
| 2759 "preferredForIpad": { |
| 2760 "description": "Indicates that this instance is the default
for new installations on iPad devices.", |
| 2761 "type": "boolean" |
| 2762 }, |
| 2763 "preferredForIphone": { |
| 2764 "description": "Indicates that this instance is the default
for new installations on iPhone devices.", |
| 2765 "type": "boolean" |
| 2766 }, |
| 2767 "supportIpad": { |
| 2768 "description": "Flag to indicate if this instance supports i
Pad.", |
| 2769 "type": "boolean" |
| 2770 }, |
| 2771 "supportIphone": { |
| 2772 "description": "Flag to indicate if this instance supports i
Phone.", |
| 2773 "type": "boolean" |
| 2774 } |
| 2775 }, |
| 2776 "type": "object" |
| 2777 }, |
| 2778 "InstanceWebDetails": { |
| 2779 "description": "This is a JSON template for the Web details resource
.", |
| 2780 "id": "InstanceWebDetails", |
| 2781 "properties": { |
| 2782 "kind": { |
| 2783 "default": "games#instanceWebDetails", |
| 2784 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#instanceWebDetails.", |
| 2785 "type": "string" |
| 2786 }, |
| 2787 "launchUrl": { |
| 2788 "description": "Launch URL for the game.", |
| 2789 "type": "string" |
| 2790 }, |
| 2791 "preferred": { |
| 2792 "description": "Indicates that this instance is the default
for new installations.", |
| 2793 "type": "boolean" |
| 2794 } |
| 2795 }, |
| 2796 "type": "object" |
| 2797 }, |
| 2798 "Leaderboard": { |
| 2799 "description": "This is a JSON template for the Leaderboard resource
.", |
| 2800 "id": "Leaderboard", |
| 2801 "properties": { |
| 2802 "iconUrl": { |
| 2803 "description": "The icon for the leaderboard.", |
| 2804 "type": "string" |
| 2805 }, |
| 2806 "id": { |
| 2807 "description": "The leaderboard ID.", |
| 2808 "type": "string" |
| 2809 }, |
| 2810 "isIconUrlDefault": { |
| 2811 "description": "Indicates whether the icon image being retur
ned is a default image, or is game-provided.", |
| 2812 "type": "boolean" |
| 2813 }, |
| 2814 "kind": { |
| 2815 "default": "games#leaderboard", |
| 2816 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#leaderboard.", |
| 2817 "type": "string" |
| 2818 }, |
| 2819 "name": { |
| 2820 "description": "The name of the leaderboard.", |
| 2821 "type": "string" |
| 2822 }, |
| 2823 "order": { |
| 2824 "description": "How scores are ordered.\nPossible values are
: \n- \"LARGER_IS_BETTER\" - Larger values are better; scores are sorted in des
cending order. \n- \"SMALLER_IS_BETTER\" - Smaller values are better; scores are
sorted in ascending order.", |
| 2825 "type": "string" |
| 2826 } |
| 2827 }, |
| 2828 "type": "object" |
| 2829 }, |
| 2830 "LeaderboardEntry": { |
| 2831 "description": "This is a JSON template for the Leaderboard Entry re
source.", |
| 2832 "id": "LeaderboardEntry", |
| 2833 "properties": { |
| 2834 "formattedScore": { |
| 2835 "description": "The localized string for the numerical value
of this score.", |
| 2836 "type": "string" |
| 2837 }, |
| 2838 "formattedScoreRank": { |
| 2839 "description": "The localized string for the rank of this sc
ore for this leaderboard.", |
| 2840 "type": "string" |
| 2841 }, |
| 2842 "kind": { |
| 2843 "default": "games#leaderboardEntry", |
| 2844 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#leaderboardEntry.", |
| 2845 "type": "string" |
| 2846 }, |
| 2847 "player": { |
| 2848 "$ref": "Player", |
| 2849 "description": "The player who holds this score." |
| 2850 }, |
| 2851 "scoreRank": { |
| 2852 "description": "The rank of this score for this leaderboard.
", |
| 2853 "format": "int64", |
| 2854 "type": "string" |
| 2855 }, |
| 2856 "scoreTag": { |
| 2857 "description": "Additional information about the score. Valu
es must contain no more than 64 URI-safe characters as defined by section 2.3 of
RFC 3986.", |
| 2858 "type": "string" |
| 2859 }, |
| 2860 "scoreValue": { |
| 2861 "description": "The numerical value of this score.", |
| 2862 "format": "int64", |
| 2863 "type": "string" |
| 2864 }, |
| 2865 "timeSpan": { |
| 2866 "description": "The time span of this high score.\nPossible
values are: \n- \"ALL_TIME\" - The score is an all-time high score. \n- \"WEEKL
Y\" - The score is a weekly high score. \n- \"DAILY\" - The score is a daily hig
h score.", |
| 2867 "type": "string" |
| 2868 }, |
| 2869 "writeTimestampMillis": { |
| 2870 "description": "The timestamp at which this score was record
ed, in milliseconds since the epoch in UTC.", |
| 2871 "format": "int64", |
| 2872 "type": "string" |
| 2873 } |
| 2874 }, |
| 2875 "type": "object" |
| 2876 }, |
| 2877 "LeaderboardListResponse": { |
| 2878 "description": "This is a JSON template for a list of leaderboard ob
jects.", |
| 2879 "id": "LeaderboardListResponse", |
| 2880 "properties": { |
| 2881 "items": { |
| 2882 "description": "The leaderboards.", |
| 2883 "items": { |
| 2884 "$ref": "Leaderboard" |
| 2885 }, |
| 2886 "type": "array" |
| 2887 }, |
| 2888 "kind": { |
| 2889 "default": "games#leaderboardListResponse", |
| 2890 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#leaderboardListResponse.", |
| 2891 "type": "string" |
| 2892 }, |
| 2893 "nextPageToken": { |
| 2894 "description": "Token corresponding to the next page of resu
lts.", |
| 2895 "type": "string" |
| 2896 } |
| 2897 }, |
| 2898 "type": "object" |
| 2899 }, |
| 2900 "LeaderboardScoreRank": { |
| 2901 "description": "This is a JSON template for a score rank in a leader
board.", |
| 2902 "id": "LeaderboardScoreRank", |
| 2903 "properties": { |
| 2904 "formattedNumScores": { |
| 2905 "description": "The number of scores in the leaderboard as a
string.", |
| 2906 "type": "string" |
| 2907 }, |
| 2908 "formattedRank": { |
| 2909 "description": "The rank in the leaderboard as a string.", |
| 2910 "type": "string" |
| 2911 }, |
| 2912 "kind": { |
| 2913 "default": "games#leaderboardScoreRank", |
| 2914 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#leaderboardScoreRank.", |
| 2915 "type": "string" |
| 2916 }, |
| 2917 "numScores": { |
| 2918 "description": "The number of scores in the leaderboard.", |
| 2919 "format": "int64", |
| 2920 "type": "string" |
| 2921 }, |
| 2922 "rank": { |
| 2923 "description": "The rank in the leaderboard.", |
| 2924 "format": "int64", |
| 2925 "type": "string" |
| 2926 } |
| 2927 }, |
| 2928 "type": "object" |
| 2929 }, |
| 2930 "LeaderboardScores": { |
| 2931 "description": "This is a JSON template for a ListScores response.", |
| 2932 "id": "LeaderboardScores", |
| 2933 "properties": { |
| 2934 "items": { |
| 2935 "description": "The scores in the leaderboard.", |
| 2936 "items": { |
| 2937 "$ref": "LeaderboardEntry" |
| 2938 }, |
| 2939 "type": "array" |
| 2940 }, |
| 2941 "kind": { |
| 2942 "default": "games#leaderboardScores", |
| 2943 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#leaderboardScores.", |
| 2944 "type": "string" |
| 2945 }, |
| 2946 "nextPageToken": { |
| 2947 "description": "The pagination token for the next page of re
sults.", |
| 2948 "type": "string" |
| 2949 }, |
| 2950 "numScores": { |
| 2951 "description": "The total number of scores in the leaderboar
d.", |
| 2952 "format": "int64", |
| 2953 "type": "string" |
| 2954 }, |
| 2955 "playerScore": { |
| 2956 "$ref": "LeaderboardEntry", |
| 2957 "description": "The score of the requesting player on the le
aderboard. The player's score may appear both here and in the list of scores abo
ve. If you are viewing a public leaderboard and the player is not sharing their
gameplay information publicly, the scoreRank and formattedScoreRank values will
not be present." |
| 2958 }, |
| 2959 "prevPageToken": { |
| 2960 "description": "The pagination token for the previous page o
f results.", |
| 2961 "type": "string" |
| 2962 } |
| 2963 }, |
| 2964 "type": "object" |
| 2965 }, |
| 2966 "MetagameConfig": { |
| 2967 "description": "This is a JSON template for the metagame config reso
urce", |
| 2968 "id": "MetagameConfig", |
| 2969 "properties": { |
| 2970 "currentVersion": { |
| 2971 "description": "Current version of the metagame configuratio
n data. When this data is updated, the version number will be increased by one."
, |
| 2972 "format": "int32", |
| 2973 "type": "integer" |
| 2974 }, |
| 2975 "kind": { |
| 2976 "default": "games#metagameConfig", |
| 2977 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#metagameConfig.", |
| 2978 "type": "string" |
| 2979 }, |
| 2980 "playerLevels": { |
| 2981 "description": "The list of player levels.", |
| 2982 "items": { |
| 2983 "$ref": "PlayerLevel" |
| 2984 }, |
| 2985 "type": "array" |
| 2986 } |
| 2987 }, |
| 2988 "type": "object" |
| 2989 }, |
| 2990 "NetworkDiagnostics": { |
| 2991 "description": "This is a JSON template for network diagnostics repo
rted for a client.", |
| 2992 "id": "NetworkDiagnostics", |
| 2993 "properties": { |
| 2994 "androidNetworkSubtype": { |
| 2995 "description": "The Android network subtype.", |
| 2996 "format": "int32", |
| 2997 "type": "integer" |
| 2998 }, |
| 2999 "androidNetworkType": { |
| 3000 "description": "The Android network type.", |
| 3001 "format": "int32", |
| 3002 "type": "integer" |
| 3003 }, |
| 3004 "iosNetworkType": { |
| 3005 "description": "iOS network type as defined in Reachability.
h.", |
| 3006 "format": "int32", |
| 3007 "type": "integer" |
| 3008 }, |
| 3009 "kind": { |
| 3010 "default": "games#networkDiagnostics", |
| 3011 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#networkDiagnostics.", |
| 3012 "type": "string" |
| 3013 }, |
| 3014 "networkOperatorCode": { |
| 3015 "description": "The MCC+MNC code for the client's network co
nnection. On Android: http://developer.android.com/reference/android/telephony/T
elephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.c
om/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Re
ference.html", |
| 3016 "type": "string" |
| 3017 }, |
| 3018 "networkOperatorName": { |
| 3019 "description": "The name of the carrier of the client's netw
ork connection. On Android: http://developer.android.com/reference/android/telep
hony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.ap
ple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Referen
ce/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName", |
| 3020 "type": "string" |
| 3021 }, |
| 3022 "registrationLatencyMillis": { |
| 3023 "description": "The amount of time in milliseconds it took f
or the client to establish a connection with the XMPP server.", |
| 3024 "format": "int32", |
| 3025 "type": "integer" |
| 3026 } |
| 3027 }, |
| 3028 "type": "object" |
| 3029 }, |
| 3030 "ParticipantResult": { |
| 3031 "description": "This is a JSON template for a result for a match par
ticipant.", |
| 3032 "id": "ParticipantResult", |
| 3033 "properties": { |
| 3034 "kind": { |
| 3035 "default": "games#participantResult", |
| 3036 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#participantResult.", |
| 3037 "type": "string" |
| 3038 }, |
| 3039 "participantId": { |
| 3040 "description": "The ID of the participant.", |
| 3041 "type": "string" |
| 3042 }, |
| 3043 "placing": { |
| 3044 "description": "The placement or ranking of the participant
in the match results; a number from one to the number of participants in the mat
ch. Multiple participants may have the same placing value in case of a type.", |
| 3045 "format": "int32", |
| 3046 "type": "integer" |
| 3047 }, |
| 3048 "result": { |
| 3049 "description": "The result of the participant for this match
.\nPossible values are: \n- \"MATCH_RESULT_WIN\" - The participant won the matc
h. \n- \"MATCH_RESULT_LOSS\" - The participant lost the match. \n- \"MATCH_RESUL
T_TIE\" - The participant tied the match. \n- \"MATCH_RESULT_NONE\" - There was
no winner for the match (nobody wins or loses this kind of game.) \n- \"MATCH_RE
SULT_DISCONNECT\" - The participant disconnected / left during the match. \n- \"
MATCH_RESULT_DISAGREED\" - Different clients reported different results for this
participant.", |
| 3050 "type": "string" |
| 3051 } |
| 3052 }, |
| 3053 "type": "object" |
| 3054 }, |
| 3055 "PeerChannelDiagnostics": { |
| 3056 "description": "This is a JSON template for peer channel diagnostics
.", |
| 3057 "id": "PeerChannelDiagnostics", |
| 3058 "properties": { |
| 3059 "bytesReceived": { |
| 3060 "$ref": "AggregateStats", |
| 3061 "description": "Number of bytes received." |
| 3062 }, |
| 3063 "bytesSent": { |
| 3064 "$ref": "AggregateStats", |
| 3065 "description": "Number of bytes sent." |
| 3066 }, |
| 3067 "kind": { |
| 3068 "default": "games#peerChannelDiagnostics", |
| 3069 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#peerChannelDiagnostics.", |
| 3070 "type": "string" |
| 3071 }, |
| 3072 "numMessagesLost": { |
| 3073 "description": "Number of messages lost.", |
| 3074 "format": "int32", |
| 3075 "type": "integer" |
| 3076 }, |
| 3077 "numMessagesReceived": { |
| 3078 "description": "Number of messages received.", |
| 3079 "format": "int32", |
| 3080 "type": "integer" |
| 3081 }, |
| 3082 "numMessagesSent": { |
| 3083 "description": "Number of messages sent.", |
| 3084 "format": "int32", |
| 3085 "type": "integer" |
| 3086 }, |
| 3087 "numSendFailures": { |
| 3088 "description": "Number of send failures.", |
| 3089 "format": "int32", |
| 3090 "type": "integer" |
| 3091 }, |
| 3092 "roundtripLatencyMillis": { |
| 3093 "$ref": "AggregateStats", |
| 3094 "description": "Roundtrip latency stats in milliseconds." |
| 3095 } |
| 3096 }, |
| 3097 "type": "object" |
| 3098 }, |
| 3099 "PeerSessionDiagnostics": { |
| 3100 "description": "This is a JSON template for peer session diagnostics
.", |
| 3101 "id": "PeerSessionDiagnostics", |
| 3102 "properties": { |
| 3103 "connectedTimestampMillis": { |
| 3104 "description": "Connected time in milliseconds.", |
| 3105 "format": "int64", |
| 3106 "type": "string" |
| 3107 }, |
| 3108 "kind": { |
| 3109 "default": "games#peerSessionDiagnostics", |
| 3110 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#peerSessionDiagnostics.", |
| 3111 "type": "string" |
| 3112 }, |
| 3113 "participantId": { |
| 3114 "description": "The participant ID of the peer.", |
| 3115 "type": "string" |
| 3116 }, |
| 3117 "reliableChannel": { |
| 3118 "$ref": "PeerChannelDiagnostics", |
| 3119 "description": "Reliable channel diagnostics." |
| 3120 }, |
| 3121 "unreliableChannel": { |
| 3122 "$ref": "PeerChannelDiagnostics", |
| 3123 "description": "Unreliable channel diagnostics." |
| 3124 } |
| 3125 }, |
| 3126 "type": "object" |
| 3127 }, |
| 3128 "Played": { |
| 3129 "description": "This is a JSON template for metadata about a player
playing a game with the currently authenticated user.", |
| 3130 "id": "Played", |
| 3131 "properties": { |
| 3132 "autoMatched": { |
| 3133 "description": "True if the player was auto-matched with the
currently authenticated user.", |
| 3134 "type": "boolean" |
| 3135 }, |
| 3136 "kind": { |
| 3137 "default": "games#played", |
| 3138 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#played.", |
| 3139 "type": "string" |
| 3140 }, |
| 3141 "timeMillis": { |
| 3142 "description": "The last time the player played the game in
milliseconds since the epoch in UTC.", |
| 3143 "format": "int64", |
| 3144 "type": "string" |
| 3145 } |
| 3146 }, |
| 3147 "type": "object" |
| 3148 }, |
| 3149 "Player": { |
| 3150 "description": "This is a JSON template for a Player resource.", |
| 3151 "id": "Player", |
| 3152 "properties": { |
| 3153 "avatarImageUrl": { |
| 3154 "description": "The base URL for the image that represents t
he player.", |
| 3155 "type": "string" |
| 3156 }, |
| 3157 "displayName": { |
| 3158 "description": "The name to display for the player.", |
| 3159 "type": "string" |
| 3160 }, |
| 3161 "experienceInfo": { |
| 3162 "$ref": "PlayerExperienceInfo", |
| 3163 "description": "An object to represent Play Game experience
information for the player." |
| 3164 }, |
| 3165 "kind": { |
| 3166 "default": "games#player", |
| 3167 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#player.", |
| 3168 "type": "string" |
| 3169 }, |
| 3170 "lastPlayedWith": { |
| 3171 "$ref": "Played", |
| 3172 "description": "Details about the last time this player play
ed a multiplayer game with the currently authenticated player. Populated for PLA
YED_WITH player collection members." |
| 3173 }, |
| 3174 "name": { |
| 3175 "description": "An object representation of the individual c
omponents of the player's name. For some players, these fields may not be presen
t.", |
| 3176 "properties": { |
| 3177 "familyName": { |
| 3178 "description": "The family name of this player. In s
ome places, this is known as the last name.", |
| 3179 "type": "string" |
| 3180 }, |
| 3181 "givenName": { |
| 3182 "description": "The given name of this player. In so
me places, this is known as the first name.", |
| 3183 "type": "string" |
| 3184 } |
| 3185 }, |
| 3186 "type": "object" |
| 3187 }, |
| 3188 "playerId": { |
| 3189 "description": "The ID of the player.", |
| 3190 "type": "string" |
| 3191 }, |
| 3192 "title": { |
| 3193 "description": "The player's title rewarded for their game a
ctivities.", |
| 3194 "type": "string" |
| 3195 } |
| 3196 }, |
| 3197 "type": "object" |
| 3198 }, |
| 3199 "PlayerAchievement": { |
| 3200 "description": "This is a JSON template for an achievement object.", |
| 3201 "id": "PlayerAchievement", |
| 3202 "properties": { |
| 3203 "achievementState": { |
| 3204 "description": "The state of the achievement.\nPossible valu
es are: \n- \"HIDDEN\" - Achievement is hidden. \n- \"REVEALED\" - Achievement
is revealed. \n- \"UNLOCKED\" - Achievement is unlocked.", |
| 3205 "type": "string" |
| 3206 }, |
| 3207 "currentSteps": { |
| 3208 "description": "The current steps for an incremental achieve
ment.", |
| 3209 "format": "int32", |
| 3210 "type": "integer" |
| 3211 }, |
| 3212 "experiencePoints": { |
| 3213 "description": "Experience points earned for the achievement
. This field is absent for achievements that have not yet been unlocked and 0 fo
r achievements that have been unlocked by testers but that are unpublished.", |
| 3214 "format": "int64", |
| 3215 "type": "string" |
| 3216 }, |
| 3217 "formattedCurrentStepsString": { |
| 3218 "description": "The current steps for an incremental achieve
ment as a string.", |
| 3219 "type": "string" |
| 3220 }, |
| 3221 "id": { |
| 3222 "description": "The ID of the achievement.", |
| 3223 "type": "string" |
| 3224 }, |
| 3225 "kind": { |
| 3226 "default": "games#playerAchievement", |
| 3227 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerAchievement.", |
| 3228 "type": "string" |
| 3229 }, |
| 3230 "lastUpdatedTimestamp": { |
| 3231 "description": "The timestamp of the last modification to th
is achievement's state.", |
| 3232 "format": "int64", |
| 3233 "type": "string" |
| 3234 } |
| 3235 }, |
| 3236 "type": "object" |
| 3237 }, |
| 3238 "PlayerAchievementListResponse": { |
| 3239 "description": "This is a JSON template for a list of achievement ob
jects.", |
| 3240 "id": "PlayerAchievementListResponse", |
| 3241 "properties": { |
| 3242 "items": { |
| 3243 "description": "The achievements.", |
| 3244 "items": { |
| 3245 "$ref": "PlayerAchievement" |
| 3246 }, |
| 3247 "type": "array" |
| 3248 }, |
| 3249 "kind": { |
| 3250 "default": "games#playerAchievementListResponse", |
| 3251 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerAchievementListResponse.", |
| 3252 "type": "string" |
| 3253 }, |
| 3254 "nextPageToken": { |
| 3255 "description": "Token corresponding to the next page of resu
lts.", |
| 3256 "type": "string" |
| 3257 } |
| 3258 }, |
| 3259 "type": "object" |
| 3260 }, |
| 3261 "PlayerEvent": { |
| 3262 "description": "This is a JSON template for an event status resource
.", |
| 3263 "id": "PlayerEvent", |
| 3264 "properties": { |
| 3265 "definitionId": { |
| 3266 "description": "The ID of the event definition.", |
| 3267 "type": "string" |
| 3268 }, |
| 3269 "formattedNumEvents": { |
| 3270 "description": "The current number of times this event has o
ccurred, as a string. The formatting of this string depends on the configuration
of your event in the Play Games Developer Console.", |
| 3271 "type": "string" |
| 3272 }, |
| 3273 "kind": { |
| 3274 "default": "games#playerEvent", |
| 3275 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerEvent.", |
| 3276 "type": "string" |
| 3277 }, |
| 3278 "numEvents": { |
| 3279 "description": "The current number of times this event has o
ccurred.", |
| 3280 "format": "int64", |
| 3281 "type": "string" |
| 3282 }, |
| 3283 "playerId": { |
| 3284 "description": "The ID of the player.", |
| 3285 "type": "string" |
| 3286 } |
| 3287 }, |
| 3288 "type": "object" |
| 3289 }, |
| 3290 "PlayerEventListResponse": { |
| 3291 "description": "This is a JSON template for a ListByPlayer response.
", |
| 3292 "id": "PlayerEventListResponse", |
| 3293 "properties": { |
| 3294 "items": { |
| 3295 "description": "The player events.", |
| 3296 "items": { |
| 3297 "$ref": "PlayerEvent" |
| 3298 }, |
| 3299 "type": "array" |
| 3300 }, |
| 3301 "kind": { |
| 3302 "default": "games#playerEventListResponse", |
| 3303 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerEventListResponse.", |
| 3304 "type": "string" |
| 3305 }, |
| 3306 "nextPageToken": { |
| 3307 "description": "The pagination token for the next page of re
sults.", |
| 3308 "type": "string" |
| 3309 } |
| 3310 }, |
| 3311 "type": "object" |
| 3312 }, |
| 3313 "PlayerExperienceInfo": { |
| 3314 "description": "This is a JSON template for 1P/3P metadata about the
player's experience.", |
| 3315 "id": "PlayerExperienceInfo", |
| 3316 "properties": { |
| 3317 "currentExperiencePoints": { |
| 3318 "description": "The current number of experience points for
the player.", |
| 3319 "format": "int64", |
| 3320 "type": "string" |
| 3321 }, |
| 3322 "currentLevel": { |
| 3323 "$ref": "PlayerLevel", |
| 3324 "description": "The current level of the player." |
| 3325 }, |
| 3326 "kind": { |
| 3327 "default": "games#playerExperienceInfo", |
| 3328 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerExperienceInfo.", |
| 3329 "type": "string" |
| 3330 }, |
| 3331 "lastLevelUpTimestampMillis": { |
| 3332 "description": "The timestamp when the player was leveled up
, in millis since Unix epoch UTC.", |
| 3333 "format": "int64", |
| 3334 "type": "string" |
| 3335 }, |
| 3336 "nextLevel": { |
| 3337 "$ref": "PlayerLevel", |
| 3338 "description": "The next level of the player. If the current
level is the maximum level, this should be same as the current level." |
| 3339 } |
| 3340 }, |
| 3341 "type": "object" |
| 3342 }, |
| 3343 "PlayerLeaderboardScore": { |
| 3344 "description": "This is a JSON template for a player leaderboard sco
re object.", |
| 3345 "id": "PlayerLeaderboardScore", |
| 3346 "properties": { |
| 3347 "kind": { |
| 3348 "default": "games#playerLeaderboardScore", |
| 3349 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerLeaderboardScore.", |
| 3350 "type": "string" |
| 3351 }, |
| 3352 "leaderboard_id": { |
| 3353 "description": "The ID of the leaderboard this score is in."
, |
| 3354 "type": "string" |
| 3355 }, |
| 3356 "publicRank": { |
| 3357 "$ref": "LeaderboardScoreRank", |
| 3358 "description": "The public rank of the score in this leaderb
oard. This object will not be present if the user is not sharing their scores pu
blicly." |
| 3359 }, |
| 3360 "scoreString": { |
| 3361 "description": "The formatted value of this score.", |
| 3362 "type": "string" |
| 3363 }, |
| 3364 "scoreTag": { |
| 3365 "description": "Additional information about the score. Valu
es must contain no more than 64 URI-safe characters as defined by section 2.3 of
RFC 3986.", |
| 3366 "type": "string" |
| 3367 }, |
| 3368 "scoreValue": { |
| 3369 "description": "The numerical value of this score.", |
| 3370 "format": "int64", |
| 3371 "type": "string" |
| 3372 }, |
| 3373 "socialRank": { |
| 3374 "$ref": "LeaderboardScoreRank", |
| 3375 "description": "The social rank of the score in this leaderb
oard." |
| 3376 }, |
| 3377 "timeSpan": { |
| 3378 "description": "The time span of this score.\nPossible value
s are: \n- \"ALL_TIME\" - The score is an all-time score. \n- \"WEEKLY\" - The
score is a weekly score. \n- \"DAILY\" - The score is a daily score.", |
| 3379 "type": "string" |
| 3380 }, |
| 3381 "writeTimestamp": { |
| 3382 "description": "The timestamp at which this score was record
ed, in milliseconds since the epoch in UTC.", |
| 3383 "format": "int64", |
| 3384 "type": "string" |
| 3385 } |
| 3386 }, |
| 3387 "type": "object" |
| 3388 }, |
| 3389 "PlayerLeaderboardScoreListResponse": { |
| 3390 "description": "This is a JSON template for a list of player leaderb
oard scores.", |
| 3391 "id": "PlayerLeaderboardScoreListResponse", |
| 3392 "properties": { |
| 3393 "items": { |
| 3394 "description": "The leaderboard scores.", |
| 3395 "items": { |
| 3396 "$ref": "PlayerLeaderboardScore" |
| 3397 }, |
| 3398 "type": "array" |
| 3399 }, |
| 3400 "kind": { |
| 3401 "default": "games#playerLeaderboardScoreListResponse", |
| 3402 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerLeaderboardScoreListResponse.", |
| 3403 "type": "string" |
| 3404 }, |
| 3405 "nextPageToken": { |
| 3406 "description": "The pagination token for the next page of re
sults.", |
| 3407 "type": "string" |
| 3408 }, |
| 3409 "player": { |
| 3410 "$ref": "Player", |
| 3411 "description": "The Player resources for the owner of this s
core." |
| 3412 } |
| 3413 }, |
| 3414 "type": "object" |
| 3415 }, |
| 3416 "PlayerLevel": { |
| 3417 "description": "This is a JSON template for 1P/3P metadata about a u
ser's level.", |
| 3418 "id": "PlayerLevel", |
| 3419 "properties": { |
| 3420 "kind": { |
| 3421 "default": "games#playerLevel", |
| 3422 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerLevel.", |
| 3423 "type": "string" |
| 3424 }, |
| 3425 "level": { |
| 3426 "description": "The level for the user.", |
| 3427 "format": "int32", |
| 3428 "type": "integer" |
| 3429 }, |
| 3430 "maxExperiencePoints": { |
| 3431 "description": "The maximum experience points for this level
.", |
| 3432 "format": "int64", |
| 3433 "type": "string" |
| 3434 }, |
| 3435 "minExperiencePoints": { |
| 3436 "description": "The minimum experience points for this level
.", |
| 3437 "format": "int64", |
| 3438 "type": "string" |
| 3439 } |
| 3440 }, |
| 3441 "type": "object" |
| 3442 }, |
| 3443 "PlayerListResponse": { |
| 3444 "description": "This is a JSON template for a third party player lis
t response.", |
| 3445 "id": "PlayerListResponse", |
| 3446 "properties": { |
| 3447 "items": { |
| 3448 "description": "The players.", |
| 3449 "items": { |
| 3450 "$ref": "Player" |
| 3451 }, |
| 3452 "type": "array" |
| 3453 }, |
| 3454 "kind": { |
| 3455 "default": "games#playerListResponse", |
| 3456 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerListResponse.", |
| 3457 "type": "string" |
| 3458 }, |
| 3459 "nextPageToken": { |
| 3460 "description": "Token corresponding to the next page of resu
lts.", |
| 3461 "type": "string" |
| 3462 } |
| 3463 }, |
| 3464 "type": "object" |
| 3465 }, |
| 3466 "PlayerScore": { |
| 3467 "description": "This is a JSON template for a player score.", |
| 3468 "id": "PlayerScore", |
| 3469 "properties": { |
| 3470 "formattedScore": { |
| 3471 "description": "The formatted score for this player score.", |
| 3472 "type": "string" |
| 3473 }, |
| 3474 "kind": { |
| 3475 "default": "games#playerScore", |
| 3476 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerScore.", |
| 3477 "type": "string" |
| 3478 }, |
| 3479 "score": { |
| 3480 "description": "The numerical value for this player score.", |
| 3481 "format": "int64", |
| 3482 "type": "string" |
| 3483 }, |
| 3484 "scoreTag": { |
| 3485 "description": "Additional information about this score. Val
ues will contain no more than 64 URI-safe characters as defined by section 2.3 o
f RFC 3986.", |
| 3486 "type": "string" |
| 3487 }, |
| 3488 "timeSpan": { |
| 3489 "description": "The time span for this player score.\nPossib
le values are: \n- \"ALL_TIME\" - The score is an all-time score. \n- \"WEEKLY\
" - The score is a weekly score. \n- \"DAILY\" - The score is a daily score.", |
| 3490 "type": "string" |
| 3491 } |
| 3492 }, |
| 3493 "type": "object" |
| 3494 }, |
| 3495 "PlayerScoreListResponse": { |
| 3496 "description": "This is a JSON template for a list of score submissi
on statuses.", |
| 3497 "id": "PlayerScoreListResponse", |
| 3498 "properties": { |
| 3499 "kind": { |
| 3500 "default": "games#playerScoreListResponse", |
| 3501 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerScoreListResponse.", |
| 3502 "type": "string" |
| 3503 }, |
| 3504 "submittedScores": { |
| 3505 "description": "The score submissions statuses.", |
| 3506 "items": { |
| 3507 "$ref": "PlayerScoreResponse" |
| 3508 }, |
| 3509 "type": "array" |
| 3510 } |
| 3511 }, |
| 3512 "type": "object" |
| 3513 }, |
| 3514 "PlayerScoreResponse": { |
| 3515 "description": "This is a JSON template for a list of leaderboard en
try resources.", |
| 3516 "id": "PlayerScoreResponse", |
| 3517 "properties": { |
| 3518 "beatenScoreTimeSpans": { |
| 3519 "description": "The time spans where the submitted score is
better than the existing score for that time span.\nPossible values are: \n- \"
ALL_TIME\" - The score is an all-time score. \n- \"WEEKLY\" - The score is a wee
kly score. \n- \"DAILY\" - The score is a daily score.", |
| 3520 "items": { |
| 3521 "type": "string" |
| 3522 }, |
| 3523 "type": "array" |
| 3524 }, |
| 3525 "formattedScore": { |
| 3526 "description": "The formatted value of the submitted score."
, |
| 3527 "type": "string" |
| 3528 }, |
| 3529 "kind": { |
| 3530 "default": "games#playerScoreResponse", |
| 3531 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerScoreResponse.", |
| 3532 "type": "string" |
| 3533 }, |
| 3534 "leaderboardId": { |
| 3535 "description": "The leaderboard ID that this score was submi
tted to.", |
| 3536 "type": "string" |
| 3537 }, |
| 3538 "scoreTag": { |
| 3539 "description": "Additional information about this score. Val
ues will contain no more than 64 URI-safe characters as defined by section 2.3 o
f RFC 3986.", |
| 3540 "type": "string" |
| 3541 }, |
| 3542 "unbeatenScores": { |
| 3543 "description": "The scores in time spans that have not been
beaten. As an example, the submitted score may be better than the player's DAILY
score, but not better than the player's scores for the WEEKLY or ALL_TIME time
spans.", |
| 3544 "items": { |
| 3545 "$ref": "PlayerScore" |
| 3546 }, |
| 3547 "type": "array" |
| 3548 } |
| 3549 }, |
| 3550 "type": "object" |
| 3551 }, |
| 3552 "PlayerScoreSubmissionList": { |
| 3553 "description": "This is a JSON template for a list of score submissi
on requests", |
| 3554 "id": "PlayerScoreSubmissionList", |
| 3555 "properties": { |
| 3556 "kind": { |
| 3557 "default": "games#playerScoreSubmissionList", |
| 3558 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#playerScoreSubmissionList.", |
| 3559 "type": "string" |
| 3560 }, |
| 3561 "scores": { |
| 3562 "description": "The score submissions.", |
| 3563 "items": { |
| 3564 "$ref": "ScoreSubmission" |
| 3565 }, |
| 3566 "type": "array" |
| 3567 } |
| 3568 }, |
| 3569 "type": "object" |
| 3570 }, |
| 3571 "PushToken": { |
| 3572 "description": "This is a JSON template for a push token resource.", |
| 3573 "id": "PushToken", |
| 3574 "properties": { |
| 3575 "clientRevision": { |
| 3576 "description": "The revision of the client SDK used by your
application, in the same format that's used by revisions.check. Used to send bac
kward compatible messages. Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible va
lues of PLATFORM_TYPE are: \n- IOS - Push token is for iOS", |
| 3577 "type": "string" |
| 3578 }, |
| 3579 "id": { |
| 3580 "$ref": "PushTokenId", |
| 3581 "description": "Unique identifier for this push token." |
| 3582 }, |
| 3583 "kind": { |
| 3584 "default": "games#pushToken", |
| 3585 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#pushToken.", |
| 3586 "type": "string" |
| 3587 }, |
| 3588 "language": { |
| 3589 "description": "The preferred language for notifications tha
t are sent using this token.", |
| 3590 "type": "string" |
| 3591 } |
| 3592 }, |
| 3593 "type": "object" |
| 3594 }, |
| 3595 "PushTokenId": { |
| 3596 "description": "This is a JSON template for a push token ID resource
.", |
| 3597 "id": "PushTokenId", |
| 3598 "properties": { |
| 3599 "ios": { |
| 3600 "description": "A push token ID for iOS devices.", |
| 3601 "properties": { |
| 3602 "apns_device_token": { |
| 3603 "description": "Device token supplied by an iOS syst
em call to register for remote notifications. Encode this field as web-safe base
64.", |
| 3604 "format": "byte", |
| 3605 "type": "string" |
| 3606 }, |
| 3607 "apns_environment": { |
| 3608 "description": "Indicates whether this token should
be used for the production or sandbox APNS server.", |
| 3609 "type": "string" |
| 3610 } |
| 3611 }, |
| 3612 "type": "object" |
| 3613 }, |
| 3614 "kind": { |
| 3615 "default": "games#pushTokenId", |
| 3616 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#pushTokenId.", |
| 3617 "type": "string" |
| 3618 } |
| 3619 }, |
| 3620 "type": "object" |
| 3621 }, |
| 3622 "Quest": { |
| 3623 "description": "This is a JSON template for a Quest resource.", |
| 3624 "id": "Quest", |
| 3625 "properties": { |
| 3626 "acceptedTimestampMillis": { |
| 3627 "description": "The timestamp at which the user accepted the
quest in milliseconds since the epoch in UTC. Only present if the player has ac
cepted the quest.", |
| 3628 "format": "int64", |
| 3629 "type": "string" |
| 3630 }, |
| 3631 "applicationId": { |
| 3632 "description": "The ID of the application this quest is part
of.", |
| 3633 "type": "string" |
| 3634 }, |
| 3635 "bannerUrl": { |
| 3636 "description": "The banner image URL for the quest.", |
| 3637 "type": "string" |
| 3638 }, |
| 3639 "description": { |
| 3640 "description": "The description of the quest.", |
| 3641 "type": "string" |
| 3642 }, |
| 3643 "endTimestampMillis": { |
| 3644 "description": "The timestamp at which the quest ceases to b
e active in milliseconds since the epoch in UTC.", |
| 3645 "format": "int64", |
| 3646 "type": "string" |
| 3647 }, |
| 3648 "iconUrl": { |
| 3649 "description": "The icon image URL for the quest.", |
| 3650 "type": "string" |
| 3651 }, |
| 3652 "id": { |
| 3653 "description": "The ID of the quest.", |
| 3654 "type": "string" |
| 3655 }, |
| 3656 "isDefaultBannerUrl": { |
| 3657 "description": "Indicates whether the banner image being ret
urned is a default image, or is game-provided.", |
| 3658 "type": "boolean" |
| 3659 }, |
| 3660 "isDefaultIconUrl": { |
| 3661 "description": "Indicates whether the icon image being retur
ned is a default image, or is game-provided.", |
| 3662 "type": "boolean" |
| 3663 }, |
| 3664 "kind": { |
| 3665 "default": "games#quest", |
| 3666 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#quest.", |
| 3667 "type": "string" |
| 3668 }, |
| 3669 "lastUpdatedTimestampMillis": { |
| 3670 "description": "The timestamp at which the quest was last up
dated by the user in milliseconds since the epoch in UTC. Only present if the pl
ayer has accepted the quest.", |
| 3671 "format": "int64", |
| 3672 "type": "string" |
| 3673 }, |
| 3674 "milestones": { |
| 3675 "description": "The quest milestones.", |
| 3676 "items": { |
| 3677 "$ref": "QuestMilestone" |
| 3678 }, |
| 3679 "type": "array" |
| 3680 }, |
| 3681 "name": { |
| 3682 "description": "The name of the quest.", |
| 3683 "type": "string" |
| 3684 }, |
| 3685 "notifyTimestampMillis": { |
| 3686 "description": "The timestamp at which the user should be no
tified that the quest will end soon in milliseconds since the epoch in UTC.", |
| 3687 "format": "int64", |
| 3688 "type": "string" |
| 3689 }, |
| 3690 "startTimestampMillis": { |
| 3691 "description": "The timestamp at which the quest becomes act
ive in milliseconds since the epoch in UTC.", |
| 3692 "format": "int64", |
| 3693 "type": "string" |
| 3694 }, |
| 3695 "state": { |
| 3696 "description": "The state of the quest.\nPossible values are
: \n- \"UPCOMING\": The quest is upcoming. The user can see the quest, but cann
ot accept it until it is open. \n- \"OPEN\": The quest is currently open and may
be accepted at this time. \n- \"ACCEPTED\": The user is currently participating
in this quest. \n- \"COMPLETED\": The user has completed the quest. \n- \"FAILE
D\": The quest was attempted but was not completed before the deadline expired.
\n- \"EXPIRED\": The quest has expired and was not accepted. \n- \"DELETED\": Th
e quest should be deleted from the local database.", |
| 3697 "type": "string" |
| 3698 } |
| 3699 }, |
| 3700 "type": "object" |
| 3701 }, |
| 3702 "QuestContribution": { |
| 3703 "description": "This is a JSON template for a Quest Criterion Contri
bution resource.", |
| 3704 "id": "QuestContribution", |
| 3705 "properties": { |
| 3706 "formattedValue": { |
| 3707 "description": "The formatted value of the contribution as a
string. Format depends on the configuration for the associated event definition
in the Play Games Developer Console.", |
| 3708 "type": "string" |
| 3709 }, |
| 3710 "kind": { |
| 3711 "default": "games#questContribution", |
| 3712 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#questContribution.", |
| 3713 "type": "string" |
| 3714 }, |
| 3715 "value": { |
| 3716 "description": "The value of the contribution.", |
| 3717 "format": "int64", |
| 3718 "type": "string" |
| 3719 } |
| 3720 }, |
| 3721 "type": "object" |
| 3722 }, |
| 3723 "QuestCriterion": { |
| 3724 "description": "This is a JSON template for a Quest Criterion resour
ce.", |
| 3725 "id": "QuestCriterion", |
| 3726 "properties": { |
| 3727 "completionContribution": { |
| 3728 "$ref": "QuestContribution", |
| 3729 "description": "The total number of times the associated eve
nt must be incremented for the player to complete this quest." |
| 3730 }, |
| 3731 "currentContribution": { |
| 3732 "$ref": "QuestContribution", |
| 3733 "description": "The number of increments the player has made
toward the completion count event increments required to complete the quest. Th
is value will not exceed the completion contribution.\nThere will be no currentC
ontribution until the player has accepted the quest." |
| 3734 }, |
| 3735 "eventId": { |
| 3736 "description": "The ID of the event the criterion correspond
s to.", |
| 3737 "type": "string" |
| 3738 }, |
| 3739 "initialPlayerProgress": { |
| 3740 "$ref": "QuestContribution", |
| 3741 "description": "The value of the event associated with this
quest at the time that the quest was accepted. This value may change if event in
crements that took place before the start of quest are uploaded after the quest
starts.\nThere will be no initialPlayerProgress until the player has accepted th
e quest." |
| 3742 }, |
| 3743 "kind": { |
| 3744 "default": "games#questCriterion", |
| 3745 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#questCriterion.", |
| 3746 "type": "string" |
| 3747 } |
| 3748 }, |
| 3749 "type": "object" |
| 3750 }, |
| 3751 "QuestListResponse": { |
| 3752 "description": "This is a JSON template for a list of quest objects.
", |
| 3753 "id": "QuestListResponse", |
| 3754 "properties": { |
| 3755 "items": { |
| 3756 "description": "The quests.", |
| 3757 "items": { |
| 3758 "$ref": "Quest" |
| 3759 }, |
| 3760 "type": "array" |
| 3761 }, |
| 3762 "kind": { |
| 3763 "default": "games#questListResponse", |
| 3764 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#questListResponse.", |
| 3765 "type": "string" |
| 3766 }, |
| 3767 "nextPageToken": { |
| 3768 "description": "Token corresponding to the next page of resu
lts.", |
| 3769 "type": "string" |
| 3770 } |
| 3771 }, |
| 3772 "type": "object" |
| 3773 }, |
| 3774 "QuestMilestone": { |
| 3775 "description": "This is a JSON template for a Quest Milestone resour
ce.", |
| 3776 "id": "QuestMilestone", |
| 3777 "properties": { |
| 3778 "completionRewardData": { |
| 3779 "description": "The completion reward data of the milestone,
represented as a Base64-encoded string. This is a developer-specified binary bl
ob with size between 0 and 2 KB before encoding.", |
| 3780 "format": "byte", |
| 3781 "type": "string" |
| 3782 }, |
| 3783 "criteria": { |
| 3784 "description": "The criteria of the milestone.", |
| 3785 "items": { |
| 3786 "$ref": "QuestCriterion" |
| 3787 }, |
| 3788 "type": "array" |
| 3789 }, |
| 3790 "id": { |
| 3791 "description": "The milestone ID.", |
| 3792 "type": "string" |
| 3793 }, |
| 3794 "kind": { |
| 3795 "default": "games#questMilestone", |
| 3796 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#questMilestone.", |
| 3797 "type": "string" |
| 3798 }, |
| 3799 "state": { |
| 3800 "description": "The current state of the milestone.\nPossibl
e values are: \n- \"COMPLETED_NOT_CLAIMED\" - The milestone is complete, but ha
s not yet been claimed. \n- \"CLAIMED\" - The milestone is complete and has been
claimed. \n- \"NOT_COMPLETED\" - The milestone has not yet been completed. \n-
\"NOT_STARTED\" - The milestone is for a quest that has not yet been accepted.", |
| 3801 "type": "string" |
| 3802 } |
| 3803 }, |
| 3804 "type": "object" |
| 3805 }, |
| 3806 "RevisionCheckResponse": { |
| 3807 "description": "This is a JSON template for the result of checking a
revision.", |
| 3808 "id": "RevisionCheckResponse", |
| 3809 "properties": { |
| 3810 "apiVersion": { |
| 3811 "description": "The version of the API this client revision
should use when calling API methods.", |
| 3812 "type": "string" |
| 3813 }, |
| 3814 "kind": { |
| 3815 "default": "games#revisionCheckResponse", |
| 3816 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#revisionCheckResponse.", |
| 3817 "type": "string" |
| 3818 }, |
| 3819 "revisionStatus": { |
| 3820 "description": "The result of the revision check.\nPossible
values are: \n- \"OK\" - The revision being used is current. \n- \"DEPRECATED\"
- There is currently a newer version available, but the revision being used sti
ll works. \n- \"INVALID\" - The revision being used is not supported in any rele
ased version.", |
| 3821 "type": "string" |
| 3822 } |
| 3823 }, |
| 3824 "type": "object" |
| 3825 }, |
| 3826 "Room": { |
| 3827 "description": "This is a JSON template for a room resource object."
, |
| 3828 "id": "Room", |
| 3829 "properties": { |
| 3830 "applicationId": { |
| 3831 "description": "The ID of the application being played.", |
| 3832 "type": "string" |
| 3833 }, |
| 3834 "autoMatchingCriteria": { |
| 3835 "$ref": "RoomAutoMatchingCriteria", |
| 3836 "description": "Criteria for auto-matching players into this
room." |
| 3837 }, |
| 3838 "autoMatchingStatus": { |
| 3839 "$ref": "RoomAutoMatchStatus", |
| 3840 "description": "Auto-matching status for this room. Not set
if the room is not currently in the auto-matching queue." |
| 3841 }, |
| 3842 "creationDetails": { |
| 3843 "$ref": "RoomModification", |
| 3844 "description": "Details about the room creation." |
| 3845 }, |
| 3846 "description": { |
| 3847 "description": "This short description is generated by our s
ervers and worded relative to the player requesting the room. It is intended to
be displayed when the room is shown in a list (that is, an invitation to a room.
)", |
| 3848 "type": "string" |
| 3849 }, |
| 3850 "inviterId": { |
| 3851 "description": "The ID of the participant that invited the u
ser to the room. Not set if the user was not invited to the room.", |
| 3852 "type": "string" |
| 3853 }, |
| 3854 "kind": { |
| 3855 "default": "games#room", |
| 3856 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#room.", |
| 3857 "type": "string" |
| 3858 }, |
| 3859 "lastUpdateDetails": { |
| 3860 "$ref": "RoomModification", |
| 3861 "description": "Details about the last update to the room." |
| 3862 }, |
| 3863 "participants": { |
| 3864 "description": "The participants involved in the room, along
with their statuses. Includes participants who have left or declined invitation
s.", |
| 3865 "items": { |
| 3866 "$ref": "RoomParticipant" |
| 3867 }, |
| 3868 "type": "array" |
| 3869 }, |
| 3870 "roomId": { |
| 3871 "description": "Globally unique ID for a room.", |
| 3872 "type": "string" |
| 3873 }, |
| 3874 "roomStatusVersion": { |
| 3875 "description": "The version of the room status: an increasin
g counter, used by the client to ignore out-of-order updates to room status.", |
| 3876 "format": "int32", |
| 3877 "type": "integer" |
| 3878 }, |
| 3879 "status": { |
| 3880 "description": "The status of the room.\nPossible values are
: \n- \"ROOM_INVITING\" - One or more players have been invited and not respond
ed. \n- \"ROOM_AUTO_MATCHING\" - One or more slots need to be filled by auto-mat
ching. \n- \"ROOM_CONNECTING\" - Players have joined and are connecting to each
other (either before or after auto-matching). \n- \"ROOM_ACTIVE\" - All players
have joined and connected to each other. \n- \"ROOM_DELETED\" - The room should
no longer be shown on the client. Returned in sync calls when a player joins a r
oom (as a tombstone), or for rooms where all joined participants have left.", |
| 3881 "type": "string" |
| 3882 }, |
| 3883 "variant": { |
| 3884 "description": "The variant / mode of the application being
played; can be any integer value, or left blank.", |
| 3885 "format": "int32", |
| 3886 "type": "integer" |
| 3887 } |
| 3888 }, |
| 3889 "type": "object" |
| 3890 }, |
| 3891 "RoomAutoMatchStatus": { |
| 3892 "description": "This is a JSON template for status of room automatch
ing that is in progress.", |
| 3893 "id": "RoomAutoMatchStatus", |
| 3894 "properties": { |
| 3895 "kind": { |
| 3896 "default": "games#roomAutoMatchStatus", |
| 3897 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomAutoMatchStatus.", |
| 3898 "type": "string" |
| 3899 }, |
| 3900 "waitEstimateSeconds": { |
| 3901 "description": "An estimate for the amount of time (in secon
ds) that auto-matching is expected to take to complete.", |
| 3902 "format": "int32", |
| 3903 "type": "integer" |
| 3904 } |
| 3905 }, |
| 3906 "type": "object" |
| 3907 }, |
| 3908 "RoomAutoMatchingCriteria": { |
| 3909 "description": "This is a JSON template for a room auto-match criter
ia object.", |
| 3910 "id": "RoomAutoMatchingCriteria", |
| 3911 "properties": { |
| 3912 "exclusiveBitmask": { |
| 3913 "description": "A bitmask indicating when auto-matches are v
alid. When ANDed with other exclusive bitmasks, the result must be zero. Can be
used to support exclusive roles within a game.", |
| 3914 "format": "int64", |
| 3915 "type": "string" |
| 3916 }, |
| 3917 "kind": { |
| 3918 "default": "games#roomAutoMatchingCriteria", |
| 3919 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomAutoMatchingCriteria.", |
| 3920 "type": "string" |
| 3921 }, |
| 3922 "maxAutoMatchingPlayers": { |
| 3923 "description": "The maximum number of players that should be
added to the room by auto-matching.", |
| 3924 "format": "int32", |
| 3925 "type": "integer" |
| 3926 }, |
| 3927 "minAutoMatchingPlayers": { |
| 3928 "description": "The minimum number of players that should be
added to the room by auto-matching.", |
| 3929 "format": "int32", |
| 3930 "type": "integer" |
| 3931 } |
| 3932 }, |
| 3933 "type": "object" |
| 3934 }, |
| 3935 "RoomClientAddress": { |
| 3936 "description": "This is a JSON template for the client address when
setting up a room.", |
| 3937 "id": "RoomClientAddress", |
| 3938 "properties": { |
| 3939 "kind": { |
| 3940 "default": "games#roomClientAddress", |
| 3941 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomClientAddress.", |
| 3942 "type": "string" |
| 3943 }, |
| 3944 "xmppAddress": { |
| 3945 "description": "The XMPP address of the client on the Google
Games XMPP network.", |
| 3946 "type": "string" |
| 3947 } |
| 3948 }, |
| 3949 "type": "object" |
| 3950 }, |
| 3951 "RoomCreateRequest": { |
| 3952 "description": "This is a JSON template for a room creation request.
", |
| 3953 "id": "RoomCreateRequest", |
| 3954 "properties": { |
| 3955 "autoMatchingCriteria": { |
| 3956 "$ref": "RoomAutoMatchingCriteria", |
| 3957 "description": "Criteria for auto-matching players into this
room." |
| 3958 }, |
| 3959 "capabilities": { |
| 3960 "description": "The capabilities that this client supports f
or realtime communication.", |
| 3961 "items": { |
| 3962 "type": "string" |
| 3963 }, |
| 3964 "type": "array" |
| 3965 }, |
| 3966 "clientAddress": { |
| 3967 "$ref": "RoomClientAddress", |
| 3968 "description": "Client address for the player creating the r
oom." |
| 3969 }, |
| 3970 "invitedPlayerIds": { |
| 3971 "description": "The player IDs to invite to the room.", |
| 3972 "items": { |
| 3973 "type": "string" |
| 3974 }, |
| 3975 "type": "array" |
| 3976 }, |
| 3977 "kind": { |
| 3978 "default": "games#roomCreateRequest", |
| 3979 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomCreateRequest.", |
| 3980 "type": "string" |
| 3981 }, |
| 3982 "networkDiagnostics": { |
| 3983 "$ref": "NetworkDiagnostics", |
| 3984 "description": "Network diagnostics for the client creating
the room." |
| 3985 }, |
| 3986 "requestId": { |
| 3987 "description": "A randomly generated numeric ID. This number
is used at the server to ensure that the request is handled correctly across re
tries.", |
| 3988 "format": "int64", |
| 3989 "type": "string" |
| 3990 }, |
| 3991 "variant": { |
| 3992 "description": "The variant / mode of the application to be
played. This can be any integer value, or left blank. You should use a small num
ber of variants to keep the auto-matching pool as large as possible.", |
| 3993 "format": "int32", |
| 3994 "type": "integer" |
| 3995 } |
| 3996 }, |
| 3997 "type": "object" |
| 3998 }, |
| 3999 "RoomJoinRequest": { |
| 4000 "description": "This is a JSON template for a join room request.", |
| 4001 "id": "RoomJoinRequest", |
| 4002 "properties": { |
| 4003 "capabilities": { |
| 4004 "description": "The capabilities that this client supports f
or realtime communication.", |
| 4005 "items": { |
| 4006 "type": "string" |
| 4007 }, |
| 4008 "type": "array" |
| 4009 }, |
| 4010 "clientAddress": { |
| 4011 "$ref": "RoomClientAddress", |
| 4012 "description": "Client address for the player joining the ro
om." |
| 4013 }, |
| 4014 "kind": { |
| 4015 "default": "games#roomJoinRequest", |
| 4016 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomJoinRequest.", |
| 4017 "type": "string" |
| 4018 }, |
| 4019 "networkDiagnostics": { |
| 4020 "$ref": "NetworkDiagnostics", |
| 4021 "description": "Network diagnostics for the client joining t
he room." |
| 4022 } |
| 4023 }, |
| 4024 "type": "object" |
| 4025 }, |
| 4026 "RoomLeaveDiagnostics": { |
| 4027 "description": "This is a JSON template for room leave diagnostics."
, |
| 4028 "id": "RoomLeaveDiagnostics", |
| 4029 "properties": { |
| 4030 "androidNetworkSubtype": { |
| 4031 "description": "Android network subtype. http://developer.an
droid.com/reference/android/net/NetworkInfo.html#getSubtype()", |
| 4032 "format": "int32", |
| 4033 "type": "integer" |
| 4034 }, |
| 4035 "androidNetworkType": { |
| 4036 "description": "Android network type. http://developer.andro
id.com/reference/android/net/NetworkInfo.html#getType()", |
| 4037 "format": "int32", |
| 4038 "type": "integer" |
| 4039 }, |
| 4040 "iosNetworkType": { |
| 4041 "description": "iOS network type as defined in Reachability.
h.", |
| 4042 "format": "int32", |
| 4043 "type": "integer" |
| 4044 }, |
| 4045 "kind": { |
| 4046 "default": "games#roomLeaveDiagnostics", |
| 4047 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomLeaveDiagnostics.", |
| 4048 "type": "string" |
| 4049 }, |
| 4050 "networkOperatorCode": { |
| 4051 "description": "The MCC+MNC code for the client's network co
nnection. On Android: http://developer.android.com/reference/android/telephony/T
elephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.c
om/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Re
ference.html", |
| 4052 "type": "string" |
| 4053 }, |
| 4054 "networkOperatorName": { |
| 4055 "description": "The name of the carrier of the client's netw
ork connection. On Android: http://developer.android.com/reference/android/telep
hony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.ap
ple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Referen
ce/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName", |
| 4056 "type": "string" |
| 4057 }, |
| 4058 "peerSession": { |
| 4059 "description": "Diagnostics about all peer sessions.", |
| 4060 "items": { |
| 4061 "$ref": "PeerSessionDiagnostics" |
| 4062 }, |
| 4063 "type": "array" |
| 4064 }, |
| 4065 "socketsUsed": { |
| 4066 "description": "Whether or not sockets were used.", |
| 4067 "type": "boolean" |
| 4068 } |
| 4069 }, |
| 4070 "type": "object" |
| 4071 }, |
| 4072 "RoomLeaveRequest": { |
| 4073 "description": "This is a JSON template for a leave room request.", |
| 4074 "id": "RoomLeaveRequest", |
| 4075 "properties": { |
| 4076 "kind": { |
| 4077 "default": "games#roomLeaveRequest", |
| 4078 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomLeaveRequest.", |
| 4079 "type": "string" |
| 4080 }, |
| 4081 "leaveDiagnostics": { |
| 4082 "$ref": "RoomLeaveDiagnostics", |
| 4083 "description": "Diagnostics for a player leaving the room." |
| 4084 }, |
| 4085 "reason": { |
| 4086 "description": "Reason for leaving the match.\nPossible valu
es are: \n- \"PLAYER_LEFT\" - The player chose to leave the room.. \n- \"GAME_L
EFT\" - The game chose to remove the player from the room. \n- \"REALTIME_ABANDO
NED\" - The player switched to another application and abandoned the room. \n- \
"REALTIME_PEER_CONNECTION_FAILURE\" - The client was unable to establish a conne
ction to other peer(s). \n- \"REALTIME_SERVER_CONNECTION_FAILURE\" - The client
was unable to communicate with the server. \n- \"REALTIME_SERVER_ERROR\" - The c
lient received an error response when it tried to communicate with the server. \
n- \"REALTIME_TIMEOUT\" - The client timed out while waiting for a room. \n- \"R
EALTIME_CLIENT_DISCONNECTING\" - The client disconnects without first calling Le
ave. \n- \"REALTIME_SIGN_OUT\" - The user signed out of G+ while in the room. \n
- \"REALTIME_GAME_CRASHED\" - The game crashed. \n- \"REALTIME_ROOM_SERVICE_CRAS
HED\" - RoomAndroidService crashed. \n- \"REALTIME_DIFFERENT_CLIENT_ROOM_OPERATI
ON\" - Another client is trying to enter a room. \n- \"REALTIME_SAME_CLIENT_ROOM
_OPERATION\" - The same client is trying to enter a new room.", |
| 4087 "type": "string" |
| 4088 } |
| 4089 }, |
| 4090 "type": "object" |
| 4091 }, |
| 4092 "RoomList": { |
| 4093 "description": "This is a JSON template for a list of rooms.", |
| 4094 "id": "RoomList", |
| 4095 "properties": { |
| 4096 "items": { |
| 4097 "description": "The rooms.", |
| 4098 "items": { |
| 4099 "$ref": "Room" |
| 4100 }, |
| 4101 "type": "array" |
| 4102 }, |
| 4103 "kind": { |
| 4104 "default": "games#roomList", |
| 4105 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomList.", |
| 4106 "type": "string" |
| 4107 }, |
| 4108 "nextPageToken": { |
| 4109 "description": "The pagination token for the next page of re
sults.", |
| 4110 "type": "string" |
| 4111 } |
| 4112 }, |
| 4113 "type": "object" |
| 4114 }, |
| 4115 "RoomModification": { |
| 4116 "description": "This is a JSON template for room modification metada
ta.", |
| 4117 "id": "RoomModification", |
| 4118 "properties": { |
| 4119 "kind": { |
| 4120 "default": "games#roomModification", |
| 4121 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomModification.", |
| 4122 "type": "string" |
| 4123 }, |
| 4124 "modifiedTimestampMillis": { |
| 4125 "description": "The timestamp at which they modified the roo
m, in milliseconds since the epoch in UTC.", |
| 4126 "format": "int64", |
| 4127 "type": "string" |
| 4128 }, |
| 4129 "participantId": { |
| 4130 "description": "The ID of the participant that modified the
room.", |
| 4131 "type": "string" |
| 4132 } |
| 4133 }, |
| 4134 "type": "object" |
| 4135 }, |
| 4136 "RoomP2PStatus": { |
| 4137 "description": "This is a JSON template for an update on the status
of a peer in a room.", |
| 4138 "id": "RoomP2PStatus", |
| 4139 "properties": { |
| 4140 "connectionSetupLatencyMillis": { |
| 4141 "description": "The amount of time in milliseconds it took t
o establish connections with this peer.", |
| 4142 "format": "int32", |
| 4143 "type": "integer" |
| 4144 }, |
| 4145 "error": { |
| 4146 "description": "The error code in event of a failure.\nPossi
ble values are: \n- \"P2P_FAILED\" - The client failed to establish a P2P conne
ction with the peer. \n- \"PRESENCE_FAILED\" - The client failed to register to
receive P2P connections. \n- \"RELAY_SERVER_FAILED\" - The client received an er
ror when trying to use the relay server to establish a P2P connection with the p
eer.", |
| 4147 "type": "string" |
| 4148 }, |
| 4149 "error_reason": { |
| 4150 "description": "More detailed diagnostic message returned in
event of a failure.", |
| 4151 "type": "string" |
| 4152 }, |
| 4153 "kind": { |
| 4154 "default": "games#roomP2PStatus", |
| 4155 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomP2PStatus.", |
| 4156 "type": "string" |
| 4157 }, |
| 4158 "participantId": { |
| 4159 "description": "The ID of the participant.", |
| 4160 "type": "string" |
| 4161 }, |
| 4162 "status": { |
| 4163 "description": "The status of the peer in the room.\nPossibl
e values are: \n- \"CONNECTION_ESTABLISHED\" - The client established a P2P con
nection with the peer. \n- \"CONNECTION_FAILED\" - The client failed to establis
h directed presence with the peer.", |
| 4164 "type": "string" |
| 4165 }, |
| 4166 "unreliableRoundtripLatencyMillis": { |
| 4167 "description": "The amount of time in milliseconds it took t
o send packets back and forth on the unreliable channel with this peer.", |
| 4168 "format": "int32", |
| 4169 "type": "integer" |
| 4170 } |
| 4171 }, |
| 4172 "type": "object" |
| 4173 }, |
| 4174 "RoomP2PStatuses": { |
| 4175 "description": "This is a JSON template for an update on the status
of peers in a room.", |
| 4176 "id": "RoomP2PStatuses", |
| 4177 "properties": { |
| 4178 "kind": { |
| 4179 "default": "games#roomP2PStatuses", |
| 4180 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomP2PStatuses.", |
| 4181 "type": "string" |
| 4182 }, |
| 4183 "updates": { |
| 4184 "description": "The updates for the peers.", |
| 4185 "items": { |
| 4186 "$ref": "RoomP2PStatus" |
| 4187 }, |
| 4188 "type": "array" |
| 4189 } |
| 4190 }, |
| 4191 "type": "object" |
| 4192 }, |
| 4193 "RoomParticipant": { |
| 4194 "description": "This is a JSON template for a participant in a room.
", |
| 4195 "id": "RoomParticipant", |
| 4196 "properties": { |
| 4197 "autoMatched": { |
| 4198 "description": "True if this participant was auto-matched wi
th the requesting player.", |
| 4199 "type": "boolean" |
| 4200 }, |
| 4201 "autoMatchedPlayer": { |
| 4202 "$ref": "AnonymousPlayer", |
| 4203 "description": "Information about a player that has been ano
nymously auto-matched against the requesting player. (Either player or autoMatch
edPlayer will be set.)" |
| 4204 }, |
| 4205 "capabilities": { |
| 4206 "description": "The capabilities which can be used when comm
unicating with this participant.", |
| 4207 "items": { |
| 4208 "type": "string" |
| 4209 }, |
| 4210 "type": "array" |
| 4211 }, |
| 4212 "clientAddress": { |
| 4213 "$ref": "RoomClientAddress", |
| 4214 "description": "Client address for the participant." |
| 4215 }, |
| 4216 "connected": { |
| 4217 "description": "True if this participant is in the fully con
nected set of peers in the room.", |
| 4218 "type": "boolean" |
| 4219 }, |
| 4220 "id": { |
| 4221 "description": "An identifier for the participant in the sco
pe of the room. Cannot be used to identify a player across rooms or in other con
texts.", |
| 4222 "type": "string" |
| 4223 }, |
| 4224 "kind": { |
| 4225 "default": "games#roomParticipant", |
| 4226 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomParticipant.", |
| 4227 "type": "string" |
| 4228 }, |
| 4229 "leaveReason": { |
| 4230 "description": "The reason the participant left the room; po
pulated if the participant status is PARTICIPANT_LEFT.\nPossible values are: \n
- \"PLAYER_LEFT\" - The player explicitly chose to leave the room. \n- \"GAME_LE
FT\" - The game chose to remove the player from the room. \n- \"ABANDONED\" - Th
e player switched to another application and abandoned the room.\n- \"PEER_CONNE
CTION_FAILURE\" - The client was unable to establish or maintain a connection to
other peer(s) in the room.\n- \"SERVER_ERROR\" - The client received an error r
esponse when it tried to communicate with the server. \n- \"TIMEOUT\" - The clie
nt timed out while waiting for players to join and connect. \n- \"PRESENCE_FAILU
RE\" - The client's XMPP connection ended abruptly.", |
| 4231 "type": "string" |
| 4232 }, |
| 4233 "player": { |
| 4234 "$ref": "Player", |
| 4235 "description": "Information about the player. Not populated
if this player was anonymously auto-matched against the requesting player. (Eith
er player or autoMatchedPlayer will be set.)" |
| 4236 }, |
| 4237 "status": { |
| 4238 "description": "The status of the participant with respect t
o the room.\nPossible values are: \n- \"PARTICIPANT_INVITED\" - The participant
has been invited to join the room, but has not yet responded. \n- \"PARTICIPANT
_JOINED\" - The participant has joined the room (either after creating it or acc
epting an invitation.) \n- \"PARTICIPANT_DECLINED\" - The participant declined a
n invitation to join the room. \n- \"PARTICIPANT_LEFT\" - The participant joined
the room and then left it.", |
| 4239 "type": "string" |
| 4240 } |
| 4241 }, |
| 4242 "type": "object" |
| 4243 }, |
| 4244 "RoomStatus": { |
| 4245 "description": "This is a JSON template for the status of a room tha
t the player has joined.", |
| 4246 "id": "RoomStatus", |
| 4247 "properties": { |
| 4248 "autoMatchingStatus": { |
| 4249 "$ref": "RoomAutoMatchStatus", |
| 4250 "description": "Auto-matching status for this room. Not set
if the room is not currently in the automatching queue." |
| 4251 }, |
| 4252 "kind": { |
| 4253 "default": "games#roomStatus", |
| 4254 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#roomStatus.", |
| 4255 "type": "string" |
| 4256 }, |
| 4257 "participants": { |
| 4258 "description": "The participants involved in the room, along
with their statuses. Includes participants who have left or declined invitation
s.", |
| 4259 "items": { |
| 4260 "$ref": "RoomParticipant" |
| 4261 }, |
| 4262 "type": "array" |
| 4263 }, |
| 4264 "roomId": { |
| 4265 "description": "Globally unique ID for a room.", |
| 4266 "type": "string" |
| 4267 }, |
| 4268 "status": { |
| 4269 "description": "The status of the room.\nPossible values are
: \n- \"ROOM_INVITING\" - One or more players have been invited and not respond
ed. \n- \"ROOM_AUTO_MATCHING\" - One or more slots need to be filled by auto-mat
ching. \n- \"ROOM_CONNECTING\" - Players have joined are connecting to each othe
r (either before or after auto-matching). \n- \"ROOM_ACTIVE\" - All players have
joined and connected to each other. \n- \"ROOM_DELETED\" - All joined players h
ave left.", |
| 4270 "type": "string" |
| 4271 }, |
| 4272 "statusVersion": { |
| 4273 "description": "The version of the status for the room: an i
ncreasing counter, used by the client to ignore out-of-order updates to room sta
tus.", |
| 4274 "format": "int32", |
| 4275 "type": "integer" |
| 4276 } |
| 4277 }, |
| 4278 "type": "object" |
| 4279 }, |
| 4280 "ScoreSubmission": { |
| 4281 "description": "This is a JSON template for a request to submit a sc
ore to leaderboards.", |
| 4282 "id": "ScoreSubmission", |
| 4283 "properties": { |
| 4284 "kind": { |
| 4285 "default": "games#scoreSubmission", |
| 4286 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#scoreSubmission.", |
| 4287 "type": "string" |
| 4288 }, |
| 4289 "leaderboardId": { |
| 4290 "description": "The leaderboard this score is being submitte
d to.", |
| 4291 "type": "string" |
| 4292 }, |
| 4293 "score": { |
| 4294 "description": "The new score being submitted.", |
| 4295 "format": "int64", |
| 4296 "type": "string" |
| 4297 }, |
| 4298 "scoreTag": { |
| 4299 "description": "Additional information about this score. Val
ues will contain no more than 64 URI-safe characters as defined by section 2.3 o
f RFC 3986.", |
| 4300 "pattern": "[a-zA-Z0-9-._~]{0,64}", |
| 4301 "type": "string" |
| 4302 }, |
| 4303 "signature": { |
| 4304 "description": "Signature Values will contain URI-safe chara
cters as defined by section 2.3 of RFC 3986.", |
| 4305 "type": "string" |
| 4306 } |
| 4307 }, |
| 4308 "type": "object" |
| 4309 }, |
| 4310 "Snapshot": { |
| 4311 "description": "This is a JSON template for an snapshot object.", |
| 4312 "id": "Snapshot", |
| 4313 "properties": { |
| 4314 "coverImage": { |
| 4315 "$ref": "SnapshotImage", |
| 4316 "description": "The cover image of this snapshot. May be abs
ent if there is no image." |
| 4317 }, |
| 4318 "description": { |
| 4319 "description": "The description of this snapshot.", |
| 4320 "type": "string" |
| 4321 }, |
| 4322 "driveId": { |
| 4323 "description": "The ID of the file underlying this snapshot
in the Drive API. Only present if the snapshot is a view on a Drive file and the
file is owned by the caller.", |
| 4324 "type": "string" |
| 4325 }, |
| 4326 "durationMillis": { |
| 4327 "description": "The duration associated with this snapshot,
in millis.", |
| 4328 "format": "int64", |
| 4329 "type": "string" |
| 4330 }, |
| 4331 "id": { |
| 4332 "description": "The ID of the snapshot.", |
| 4333 "type": "string" |
| 4334 }, |
| 4335 "kind": { |
| 4336 "default": "games#snapshot", |
| 4337 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#snapshot.", |
| 4338 "type": "string" |
| 4339 }, |
| 4340 "lastModifiedMillis": { |
| 4341 "description": "The timestamp (in millis since Unix epoch) o
f the last modification to this snapshot.", |
| 4342 "format": "int64", |
| 4343 "type": "string" |
| 4344 }, |
| 4345 "title": { |
| 4346 "description": "The title of this snapshot.", |
| 4347 "type": "string" |
| 4348 }, |
| 4349 "type": { |
| 4350 "description": "The type of this snapshot.\nPossible values
are: \n- \"SAVE_GAME\" - A snapshot representing a save game.", |
| 4351 "type": "string" |
| 4352 }, |
| 4353 "uniqueName": { |
| 4354 "description": "The unique name provided when the snapshot w
as created.", |
| 4355 "type": "string" |
| 4356 } |
| 4357 }, |
| 4358 "type": "object" |
| 4359 }, |
| 4360 "SnapshotImage": { |
| 4361 "description": "This is a JSON template for an image of a snapshot."
, |
| 4362 "id": "SnapshotImage", |
| 4363 "properties": { |
| 4364 "height": { |
| 4365 "description": "The height of the image.", |
| 4366 "format": "int32", |
| 4367 "type": "integer" |
| 4368 }, |
| 4369 "kind": { |
| 4370 "default": "games#snapshotImage", |
| 4371 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#snapshotImage.", |
| 4372 "type": "string" |
| 4373 }, |
| 4374 "mime_type": { |
| 4375 "description": "The MIME type of the image.", |
| 4376 "type": "string" |
| 4377 }, |
| 4378 "url": { |
| 4379 "description": "The URL of the image. This URL may be invali
dated at any time and should not be cached.", |
| 4380 "type": "string" |
| 4381 }, |
| 4382 "width": { |
| 4383 "description": "The width of the image.", |
| 4384 "format": "int32", |
| 4385 "type": "integer" |
| 4386 } |
| 4387 }, |
| 4388 "type": "object" |
| 4389 }, |
| 4390 "SnapshotListResponse": { |
| 4391 "description": "This is a JSON template for a list of snapshot objec
ts.", |
| 4392 "id": "SnapshotListResponse", |
| 4393 "properties": { |
| 4394 "items": { |
| 4395 "description": "The snapshots.", |
| 4396 "items": { |
| 4397 "$ref": "Snapshot" |
| 4398 }, |
| 4399 "type": "array" |
| 4400 }, |
| 4401 "kind": { |
| 4402 "default": "games#snapshotListResponse", |
| 4403 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#snapshotListResponse.", |
| 4404 "type": "string" |
| 4405 }, |
| 4406 "nextPageToken": { |
| 4407 "description": "Token corresponding to the next page of resu
lts. If there are no more results, the token is omitted.", |
| 4408 "type": "string" |
| 4409 } |
| 4410 }, |
| 4411 "type": "object" |
| 4412 }, |
| 4413 "TurnBasedAutoMatchingCriteria": { |
| 4414 "description": "This is a JSON template for an turn-based auto-match
criteria object.", |
| 4415 "id": "TurnBasedAutoMatchingCriteria", |
| 4416 "properties": { |
| 4417 "exclusiveBitmask": { |
| 4418 "description": "A bitmask indicating when auto-matches are v
alid. When ANDed with other exclusive bitmasks, the result must be zero. Can be
used to support exclusive roles within a game.", |
| 4419 "format": "int64", |
| 4420 "type": "string" |
| 4421 }, |
| 4422 "kind": { |
| 4423 "default": "games#turnBasedAutoMatchingCriteria", |
| 4424 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedAutoMatchingCriteria.", |
| 4425 "type": "string" |
| 4426 }, |
| 4427 "maxAutoMatchingPlayers": { |
| 4428 "description": "The maximum number of players that should be
added to the match by auto-matching.", |
| 4429 "format": "int32", |
| 4430 "type": "integer" |
| 4431 }, |
| 4432 "minAutoMatchingPlayers": { |
| 4433 "description": "The minimum number of players that should be
added to the match by auto-matching.", |
| 4434 "format": "int32", |
| 4435 "type": "integer" |
| 4436 } |
| 4437 }, |
| 4438 "type": "object" |
| 4439 }, |
| 4440 "TurnBasedMatch": { |
| 4441 "description": "This is a JSON template for a turn-based match resou
rce object.", |
| 4442 "id": "TurnBasedMatch", |
| 4443 "properties": { |
| 4444 "applicationId": { |
| 4445 "description": "The ID of the application being played.", |
| 4446 "type": "string" |
| 4447 }, |
| 4448 "autoMatchingCriteria": { |
| 4449 "$ref": "TurnBasedAutoMatchingCriteria", |
| 4450 "description": "Criteria for auto-matching players into this
match." |
| 4451 }, |
| 4452 "creationDetails": { |
| 4453 "$ref": "TurnBasedMatchModification", |
| 4454 "description": "Details about the match creation." |
| 4455 }, |
| 4456 "data": { |
| 4457 "$ref": "TurnBasedMatchData", |
| 4458 "description": "The data / game state for this match." |
| 4459 }, |
| 4460 "description": { |
| 4461 "description": "This short description is generated by our s
ervers based on turn state and is localized and worded relative to the player re
questing the match. It is intended to be displayed when the match is shown in a
list.", |
| 4462 "type": "string" |
| 4463 }, |
| 4464 "inviterId": { |
| 4465 "description": "The ID of the participant that invited the u
ser to the match. Not set if the user was not invited to the match.", |
| 4466 "type": "string" |
| 4467 }, |
| 4468 "kind": { |
| 4469 "default": "games#turnBasedMatch", |
| 4470 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatch.", |
| 4471 "type": "string" |
| 4472 }, |
| 4473 "lastUpdateDetails": { |
| 4474 "$ref": "TurnBasedMatchModification", |
| 4475 "description": "Details about the last update to the match." |
| 4476 }, |
| 4477 "matchId": { |
| 4478 "description": "Globally unique ID for a turn-based match.", |
| 4479 "type": "string" |
| 4480 }, |
| 4481 "matchNumber": { |
| 4482 "description": "The number of the match in a chain of rematc
hes. Will be set to 1 for the first match and incremented by 1 for each rematch.
", |
| 4483 "format": "int32", |
| 4484 "type": "integer" |
| 4485 }, |
| 4486 "matchVersion": { |
| 4487 "description": "The version of this match: an increasing cou
nter, used to avoid out-of-date updates to the match.", |
| 4488 "format": "int32", |
| 4489 "type": "integer" |
| 4490 }, |
| 4491 "participants": { |
| 4492 "description": "The participants involved in the match, alon
g with their statuses. Includes participants who have left or declined invitatio
ns.", |
| 4493 "items": { |
| 4494 "$ref": "TurnBasedMatchParticipant" |
| 4495 }, |
| 4496 "type": "array" |
| 4497 }, |
| 4498 "pendingParticipantId": { |
| 4499 "description": "The ID of the participant that is taking a t
urn.", |
| 4500 "type": "string" |
| 4501 }, |
| 4502 "previousMatchData": { |
| 4503 "$ref": "TurnBasedMatchData", |
| 4504 "description": "The data / game state for the previous match
; set for the first turn of rematches only." |
| 4505 }, |
| 4506 "rematchId": { |
| 4507 "description": "The ID of a rematch of this match. Only set
for completed matches that have been rematched.", |
| 4508 "type": "string" |
| 4509 }, |
| 4510 "results": { |
| 4511 "description": "The results reported for this match.", |
| 4512 "items": { |
| 4513 "$ref": "ParticipantResult" |
| 4514 }, |
| 4515 "type": "array" |
| 4516 }, |
| 4517 "status": { |
| 4518 "description": "The status of the match.\nPossible values ar
e: \n- \"MATCH_AUTO_MATCHING\" - One or more slots need to be filled by auto-ma
tching; the match cannot be established until they are filled. \n- \"MATCH_ACTIV
E\" - The match has started. \n- \"MATCH_COMPLETE\" - The match has finished. \n
- \"MATCH_CANCELED\" - The match was canceled. \n- \"MATCH_EXPIRED\" - The match
expired due to inactivity. \n- \"MATCH_DELETED\" - The match should no longer b
e shown on the client. Returned only for tombstones for matches when sync is cal
led.", |
| 4519 "type": "string" |
| 4520 }, |
| 4521 "userMatchStatus": { |
| 4522 "description": "The status of the current user in the match.
Derived from the match type, match status, the user's participant status, and t
he pending participant for the match.\nPossible values are: \n- \"USER_INVITED\
" - The user has been invited to join the match and has not responded yet. \n- \
"USER_AWAITING_TURN\" - The user is waiting for their turn. \n- \"USER_TURN\" -
The user has an action to take in the match. \n- \"USER_MATCH_COMPLETED\" - The
match has ended (it is completed, canceled, or expired.)", |
| 4523 "type": "string" |
| 4524 }, |
| 4525 "variant": { |
| 4526 "description": "The variant / mode of the application being
played; can be any integer value, or left blank.", |
| 4527 "format": "int32", |
| 4528 "type": "integer" |
| 4529 }, |
| 4530 "withParticipantId": { |
| 4531 "description": "The ID of another participant in the match t
hat can be used when describing the participants the user is playing with.", |
| 4532 "type": "string" |
| 4533 } |
| 4534 }, |
| 4535 "type": "object" |
| 4536 }, |
| 4537 "TurnBasedMatchCreateRequest": { |
| 4538 "description": "This is a JSON template for a turn-based match creat
ion request.", |
| 4539 "id": "TurnBasedMatchCreateRequest", |
| 4540 "properties": { |
| 4541 "autoMatchingCriteria": { |
| 4542 "$ref": "TurnBasedAutoMatchingCriteria", |
| 4543 "description": "Criteria for auto-matching players into this
match." |
| 4544 }, |
| 4545 "invitedPlayerIds": { |
| 4546 "description": "The player ids to invite to the match.", |
| 4547 "items": { |
| 4548 "type": "string" |
| 4549 }, |
| 4550 "type": "array" |
| 4551 }, |
| 4552 "kind": { |
| 4553 "default": "games#turnBasedMatchCreateRequest", |
| 4554 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatchCreateRequest.", |
| 4555 "type": "string" |
| 4556 }, |
| 4557 "requestId": { |
| 4558 "description": "A randomly generated numeric ID. This number
is used at the server to ensure that the request is handled correctly across re
tries.", |
| 4559 "format": "int64", |
| 4560 "type": "string" |
| 4561 }, |
| 4562 "variant": { |
| 4563 "description": "The variant / mode of the application to be
played. This can be any integer value, or left blank. You should use a small num
ber of variants to keep the auto-matching pool as large as possible.", |
| 4564 "format": "int32", |
| 4565 "type": "integer" |
| 4566 } |
| 4567 }, |
| 4568 "type": "object" |
| 4569 }, |
| 4570 "TurnBasedMatchData": { |
| 4571 "description": "This is a JSON template for a turn-based match data
object.", |
| 4572 "id": "TurnBasedMatchData", |
| 4573 "properties": { |
| 4574 "data": { |
| 4575 "description": "The byte representation of the data (limited
to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.", |
| 4576 "format": "byte", |
| 4577 "type": "string" |
| 4578 }, |
| 4579 "dataAvailable": { |
| 4580 "description": "True if this match has data available but it
wasn't returned in a list response; fetching the match individually will retrie
ve this data.", |
| 4581 "type": "boolean" |
| 4582 }, |
| 4583 "kind": { |
| 4584 "default": "games#turnBasedMatchData", |
| 4585 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatchData.", |
| 4586 "type": "string" |
| 4587 } |
| 4588 }, |
| 4589 "type": "object" |
| 4590 }, |
| 4591 "TurnBasedMatchDataRequest": { |
| 4592 "description": "This is a JSON template for sending a turn-based mat
ch data object.", |
| 4593 "id": "TurnBasedMatchDataRequest", |
| 4594 "properties": { |
| 4595 "data": { |
| 4596 "description": "The byte representation of the data (limited
to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option.", |
| 4597 "format": "byte", |
| 4598 "type": "string" |
| 4599 }, |
| 4600 "kind": { |
| 4601 "default": "games#turnBasedMatchDataRequest", |
| 4602 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatchDataRequest.", |
| 4603 "type": "string" |
| 4604 } |
| 4605 }, |
| 4606 "type": "object" |
| 4607 }, |
| 4608 "TurnBasedMatchList": { |
| 4609 "description": "This is a JSON template for a list of turn-based mat
ches.", |
| 4610 "id": "TurnBasedMatchList", |
| 4611 "properties": { |
| 4612 "items": { |
| 4613 "description": "The matches.", |
| 4614 "items": { |
| 4615 "$ref": "TurnBasedMatch" |
| 4616 }, |
| 4617 "type": "array" |
| 4618 }, |
| 4619 "kind": { |
| 4620 "default": "games#turnBasedMatchList", |
| 4621 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatchList.", |
| 4622 "type": "string" |
| 4623 }, |
| 4624 "nextPageToken": { |
| 4625 "description": "The pagination token for the next page of re
sults.", |
| 4626 "type": "string" |
| 4627 } |
| 4628 }, |
| 4629 "type": "object" |
| 4630 }, |
| 4631 "TurnBasedMatchModification": { |
| 4632 "description": "This is a JSON template for turn-based match modific
ation metadata.", |
| 4633 "id": "TurnBasedMatchModification", |
| 4634 "properties": { |
| 4635 "kind": { |
| 4636 "default": "games#turnBasedMatchModification", |
| 4637 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatchModification.", |
| 4638 "type": "string" |
| 4639 }, |
| 4640 "modifiedTimestampMillis": { |
| 4641 "description": "The timestamp at which they modified the mat
ch, in milliseconds since the epoch in UTC.", |
| 4642 "format": "int64", |
| 4643 "type": "string" |
| 4644 }, |
| 4645 "participantId": { |
| 4646 "description": "The ID of the participant that modified the
match.", |
| 4647 "type": "string" |
| 4648 } |
| 4649 }, |
| 4650 "type": "object" |
| 4651 }, |
| 4652 "TurnBasedMatchParticipant": { |
| 4653 "description": "This is a JSON template for a participant in a turn-
based match.", |
| 4654 "id": "TurnBasedMatchParticipant", |
| 4655 "properties": { |
| 4656 "autoMatched": { |
| 4657 "description": "True if this participant was auto-matched wi
th the requesting player.", |
| 4658 "type": "boolean" |
| 4659 }, |
| 4660 "autoMatchedPlayer": { |
| 4661 "$ref": "AnonymousPlayer", |
| 4662 "description": "Information about a player that has been ano
nymously auto-matched against the requesting player. (Either player or autoMatch
edPlayer will be set.)" |
| 4663 }, |
| 4664 "id": { |
| 4665 "description": "An identifier for the participant in the sco
pe of the match. Cannot be used to identify a player across matches or in other
contexts.", |
| 4666 "type": "string" |
| 4667 }, |
| 4668 "kind": { |
| 4669 "default": "games#turnBasedMatchParticipant", |
| 4670 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatchParticipant.", |
| 4671 "type": "string" |
| 4672 }, |
| 4673 "player": { |
| 4674 "$ref": "Player", |
| 4675 "description": "Information about the player. Not populated
if this player was anonymously auto-matched against the requesting player. (Eith
er player or autoMatchedPlayer will be set.)" |
| 4676 }, |
| 4677 "status": { |
| 4678 "description": "The status of the participant with respect t
o the match.\nPossible values are: \n- \"PARTICIPANT_NOT_INVITED_YET\" - The pa
rticipant is slated to be invited to the match, but the invitation has not been
sent; the invite will be sent when it becomes their turn. \n- \"PARTICIPANT_INVI
TED\" - The participant has been invited to join the match, but has not yet resp
onded. \n- \"PARTICIPANT_JOINED\" - The participant has joined the match (either
after creating it or accepting an invitation.) \n- \"PARTICIPANT_DECLINED\" - T
he participant declined an invitation to join the match. \n- \"PARTICIPANT_LEFT\
" - The participant joined the match and then left it. \n- \"PARTICIPANT_FINISHE
D\" - The participant finished playing in the match. \n- \"PARTICIPANT_UNRESPONS
IVE\" - The participant did not take their turn in the allotted time.", |
| 4679 "type": "string" |
| 4680 } |
| 4681 }, |
| 4682 "type": "object" |
| 4683 }, |
| 4684 "TurnBasedMatchRematch": { |
| 4685 "description": "This is a JSON template for a rematch response.", |
| 4686 "id": "TurnBasedMatchRematch", |
| 4687 "properties": { |
| 4688 "kind": { |
| 4689 "default": "games#turnBasedMatchRematch", |
| 4690 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatchRematch.", |
| 4691 "type": "string" |
| 4692 }, |
| 4693 "previousMatch": { |
| 4694 "$ref": "TurnBasedMatch", |
| 4695 "description": "The old match that the rematch was created f
rom; will be updated such that the rematchId field will point at the new match." |
| 4696 }, |
| 4697 "rematch": { |
| 4698 "$ref": "TurnBasedMatch", |
| 4699 "description": "The newly created match; a rematch of the ol
d match with the same participants." |
| 4700 } |
| 4701 }, |
| 4702 "type": "object" |
| 4703 }, |
| 4704 "TurnBasedMatchResults": { |
| 4705 "description": "This is a JSON template for a turn-based match resul
ts object.", |
| 4706 "id": "TurnBasedMatchResults", |
| 4707 "properties": { |
| 4708 "data": { |
| 4709 "$ref": "TurnBasedMatchDataRequest", |
| 4710 "description": "The final match data." |
| 4711 }, |
| 4712 "kind": { |
| 4713 "default": "games#turnBasedMatchResults", |
| 4714 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatchResults.", |
| 4715 "type": "string" |
| 4716 }, |
| 4717 "matchVersion": { |
| 4718 "description": "The version of the match being updated.", |
| 4719 "format": "int32", |
| 4720 "type": "integer" |
| 4721 }, |
| 4722 "results": { |
| 4723 "description": "The match results for the participants in th
e match.", |
| 4724 "items": { |
| 4725 "$ref": "ParticipantResult" |
| 4726 }, |
| 4727 "type": "array" |
| 4728 } |
| 4729 }, |
| 4730 "type": "object" |
| 4731 }, |
| 4732 "TurnBasedMatchSync": { |
| 4733 "description": "This is a JSON template for a list of turn-based mat
ches returned from a sync.", |
| 4734 "id": "TurnBasedMatchSync", |
| 4735 "properties": { |
| 4736 "items": { |
| 4737 "description": "The matches.", |
| 4738 "items": { |
| 4739 "$ref": "TurnBasedMatch" |
| 4740 }, |
| 4741 "type": "array" |
| 4742 }, |
| 4743 "kind": { |
| 4744 "default": "games#turnBasedMatchSync", |
| 4745 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatchSync.", |
| 4746 "type": "string" |
| 4747 }, |
| 4748 "moreAvailable": { |
| 4749 "description": "True if there were more matches available to
fetch at the time the response was generated (which were not returned due to pa
ge size limits.)", |
| 4750 "type": "boolean" |
| 4751 }, |
| 4752 "nextPageToken": { |
| 4753 "description": "The pagination token for the next page of re
sults.", |
| 4754 "type": "string" |
| 4755 } |
| 4756 }, |
| 4757 "type": "object" |
| 4758 }, |
| 4759 "TurnBasedMatchTurn": { |
| 4760 "description": "This is a JSON template for the object representing
a turn.", |
| 4761 "id": "TurnBasedMatchTurn", |
| 4762 "properties": { |
| 4763 "data": { |
| 4764 "$ref": "TurnBasedMatchDataRequest", |
| 4765 "description": "The shared game state data after the turn is
over." |
| 4766 }, |
| 4767 "kind": { |
| 4768 "default": "games#turnBasedMatchTurn", |
| 4769 "description": "Uniquely identifies the type of this resourc
e. Value is always the fixed string games#turnBasedMatchTurn.", |
| 4770 "type": "string" |
| 4771 }, |
| 4772 "matchVersion": { |
| 4773 "description": "The version of this match: an increasing cou
nter, used to avoid out-of-date updates to the match.", |
| 4774 "format": "int32", |
| 4775 "type": "integer" |
| 4776 }, |
| 4777 "pendingParticipantId": { |
| 4778 "description": "The ID of the participant who should take th
eir turn next. May be set to the current player's participant ID to update match
state without changing the turn. If not set, the match will wait for other play
er(s) to join via automatching; this is only valid if automatch criteria is set
on the match with remaining slots for automatched players.", |
| 4779 "type": "string" |
| 4780 }, |
| 4781 "results": { |
| 4782 "description": "The match results for the participants in th
e match.", |
| 4783 "items": { |
| 4784 "$ref": "ParticipantResult" |
| 4785 }, |
| 4786 "type": "array" |
| 4787 } |
| 4788 }, |
| 4789 "type": "object" |
| 4790 } |
| 4791 }, |
| 4792 "servicePath": "games/v1/", |
| 4793 "title": "Google Play Game Services API", |
| 4794 "version": "v1" |
| 4795 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 559053002:
Generate 0.1.0 version of googleapis/googleapis_beta (Closed)
Base URL: git@github.com:dart-lang/googleapis.git@master