UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 104 kB
{"openapi":"3.0.0","servers":[{"url":"https://games.googleapis.com/"}],"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"The Google Play games service allows developers to enhance games with social leaderboards, achievements, game state, sign-in with Google, and more.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Google Play Game Services","version":"v1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"format":"google","url":"https://games.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-providerName":"googleapis.com","x-serviceName":"games"},"externalDocs":{"url":"https://developers.google.com/games/"},"tags":[{"name":"achievementDefinitions"},{"name":"achievements"},{"name":"applications"},{"name":"events"},{"name":"leaderboards"},{"name":"metagame"},{"name":"players"},{"name":"recall"},{"name":"revisions"},{"name":"scores"},{"name":"snapshots"},{"name":"stats"}],"paths":{"/games/v1/achievements":{"get":{"description":"Lists all the achievement definitions for your application.","operationId":"games.achievementDefinitions.list","parameters":[{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified `maxResults`.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchievementDefinitionsListResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["achievementDefinitions"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/achievements/updateMultiple":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Updates multiple achievements for the currently authenticated player.","operationId":"games.achievements.updateMultiple","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchievementUpdateMultipleRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchievementUpdateMultipleResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["achievements"]}},"/games/v1/achievements/{achievementId}/increment":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Increments the steps of the achievement with the given ID for the currently authenticated player.","operationId":"games.achievements.increment","parameters":[{"description":"The ID of the achievement used by this method.","in":"path","name":"achievementId","required":true,"schema":{"type":"string"}},{"description":"Required. The number of steps to increment.","in":"query","name":"stepsToIncrement","required":true,"schema":{"type":"integer"}},{"description":"A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries.","in":"query","name":"requestId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchievementIncrementResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["achievements"]}},"/games/v1/achievements/{achievementId}/reveal":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player.","operationId":"games.achievements.reveal","parameters":[{"description":"The ID of the achievement used by this method.","in":"path","name":"achievementId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchievementRevealResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["achievements"]}},"/games/v1/achievements/{achievementId}/setStepsAtLeast":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified.","operationId":"games.achievements.setStepsAtLeast","parameters":[{"description":"The ID of the achievement used by this method.","in":"path","name":"achievementId","required":true,"schema":{"type":"string"}},{"description":"Required. The minimum value to set the steps to.","in":"query","name":"steps","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchievementSetStepsAtLeastResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["achievements"]}},"/games/v1/achievements/{achievementId}/unlock":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Unlocks this achievement for the currently authenticated player.","operationId":"games.achievements.unlock","parameters":[{"description":"The ID of the achievement used by this method.","in":"path","name":"achievementId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchievementUnlockResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["achievements"]}},"/games/v1/applications/getEndPoint":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Returns a URL for the requested end point type.","operationId":"games.applications.getEndPoint","parameters":[{"description":"The application ID from the Google Play developer console.","in":"query","name":"applicationId","schema":{"type":"string"}},{"description":"Type of endpoint being requested.","in":"query","name":"endPointType","schema":{"enum":["PROFILE_CREATION","PROFILE_SETTINGS"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EndPoint"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["applications"]}},"/games/v1/applications/played":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Indicate that the currently authenticated user is playing your application.","operationId":"games.applications.played","responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["applications"]}},"/games/v1/applications/{applicationId}":{"get":{"description":"Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified `platformType`, the returned response will not include any instance data.","operationId":"games.applications.get","parameters":[{"description":"The application ID from the Google Play developer console.","in":"path","name":"applicationId","required":true,"schema":{"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"Restrict application details returned to the specific platform.","in":"query","name":"platformType","schema":{"enum":["ANDROID","IOS","WEB_APP"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["applications"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/applications/{applicationId}/verify":{"get":{"description":"Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.","operationId":"games.applications.verify","parameters":[{"description":"The application ID from the Google Play developer console.","in":"path","name":"applicationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationVerifyResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["applications"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/eventDefinitions":{"get":{"description":"Returns a list of the event definitions in this application.","operationId":"games.events.listDefinitions","parameters":[{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified `maxResults`.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventDefinitionListResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["events"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/events":{"get":{"description":"Returns a list showing the current progress on events in this application for the currently authenticated user.","operationId":"games.events.listByPlayer","parameters":[{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of events to return in the response, used for paging. For any response, the actual number of events to return may be less than the specified maxResults.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayerEventListResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["events"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.","operationId":"games.events.record","parameters":[{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventRecordRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventUpdateResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["events"]}},"/games/v1/leaderboards":{"get":{"description":"Lists all the leaderboard metadata for your application.","operationId":"games.leaderboards.list","parameters":[{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards returned may be less than the specified `maxResults`.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardListResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["leaderboards"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/leaderboards/scores":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Submits multiple scores to leaderboards.","operationId":"games.scores.submitMultiple","parameters":[{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayerScoreSubmissionList"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayerScoreListResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["scores"]}},"/games/v1/leaderboards/{leaderboardId}":{"get":{"description":"Retrieves the metadata of the leaderboard with the given ID.","operationId":"games.leaderboards.get","parameters":[{"description":"The ID of the leaderboard.","in":"path","name":"leaderboardId","required":true,"schema":{"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Leaderboard"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["leaderboards"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/leaderboards/{leaderboardId}/scores":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Submits a score to the specified leaderboard.","operationId":"games.scores.submit","parameters":[{"description":"The ID of the leaderboard.","in":"path","name":"leaderboardId","required":true,"schema":{"type":"string"}},{"description":"Required. The score you're submitting. The submitted 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 depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units.","in":"query","name":"score","required":true,"schema":{"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"Additional information about the score you're submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.","in":"query","name":"scoreTag","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayerScoreResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["scores"]}},"/games/v1/leaderboards/{leaderboardId}/scores/{collection}":{"get":{"description":"Lists the scores in a leaderboard, starting from the top.","operationId":"games.scores.list","parameters":[{"description":"The ID of the leaderboard.","in":"path","name":"leaderboardId","required":true,"schema":{"type":"string"}},{"description":"The collection of scores you're requesting.","in":"path","name":"collection","required":true,"schema":{"enum":["PUBLIC","SOCIAL","FRIENDS"],"type":"string"}},{"description":"Required. The time span for the scores and ranks you're requesting.","in":"query","name":"timeSpan","required":true,"schema":{"enum":["ALL_TIME","WEEKLY","DAILY"],"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified `maxResults`.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardScores"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["scores"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/leaderboards/{leaderboardId}/window/{collection}":{"get":{"description":"Lists the scores in a leaderboard around (and including) a player's score.","operationId":"games.scores.listWindow","parameters":[{"description":"The ID of the leaderboard.","in":"path","name":"leaderboardId","required":true,"schema":{"type":"string"}},{"description":"The collection of scores you're requesting.","in":"path","name":"collection","required":true,"schema":{"enum":["PUBLIC","SOCIAL","FRIENDS"],"type":"string"}},{"description":"Required. The time span for the scores and ranks you're requesting.","in":"query","name":"timeSpan","required":true,"schema":{"enum":["ALL_TIME","WEEKLY","DAILY"],"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified `maxResults`.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.","in":"query","name":"resultsAbove","schema":{"type":"integer"}},{"description":"True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.","in":"query","name":"returnTopIfAbsent","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardScores"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["scores"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/metagameConfig":{"get":{"description":"Return the metagame configuration data for the calling application.","operationId":"games.metagame.getMetagameConfig","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetagameConfig"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["metagame"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/players/me/multipleApplicationPlayerIds":{"get":{"description":"Get the application player ids for the currently authenticated player across all requested games by the same developer as the calling application. This will only return ids for players that actually have an id (scoped or otherwise) with that game.","operationId":"games.players.getMultipleApplicationPlayerIds","parameters":[{"description":"Required. The application IDs from the Google Play developer console for the games to return scoped ids for.","explode":true,"in":"query","name":"applicationIds","schema":{"items":{"type":"string"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMultipleApplicationPlayerIdsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["players"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/players/me/players/{collection}":{"get":{"description":"Get the collection of players for the currently authenticated user.","operationId":"games.players.list","parameters":[{"description":"Collection of players being retrieved","in":"path","name":"collection","required":true,"schema":{"enum":["CONNECTED","VISIBLE","FRIENDS_ALL"],"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified `maxResults`.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayerListResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["players"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/players/me/scopedIds":{"get":{"description":"Retrieves scoped player identifiers for currently authenticated user.","operationId":"games.players.getScopedPlayerIds","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScopedPlayerIds"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["players"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/players/{playerId}":{"get":{"description":"Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set `playerId` to `me`.","operationId":"games.players.get","parameters":[{"description":"A player ID. A value of `me` may be used in place of the authenticated player's ID.","in":"path","name":"playerId","required":true,"schema":{"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"Consistency token of the player id. The call returns a 'not found' result when the token is present and invalid. Empty value is ignored. See also GlobalPlayerIdConsistencyTokenProto","in":"query","name":"playerIdConsistencyToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Player"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["players"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/players/{playerId}/achievements":{"get":{"description":"Lists the progress for all your application's achievements for the currently authenticated player.","operationId":"games.achievements.list","parameters":[{"description":"A player ID. A value of `me` may be used in place of the authenticated player's ID.","in":"path","name":"playerId","required":true,"schema":{"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources returned may be less than the specified `maxResults`.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned.","in":"query","name":"state","schema":{"enum":["ALL","HIDDEN","REVEALED","UNLOCKED"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayerAchievementListResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["achievements"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/players/{playerId}/categories/{collection}":{"get":{"description":"List play data aggregated per category for the player corresponding to `playerId`.","operationId":"games.metagame.listCategoriesByPlayer","parameters":[{"description":"A player ID. A value of `me` may be used in place of the authenticated player's ID.","in":"path","name":"playerId","required":true,"schema":{"type":"string"}},{"description":"The collection of categories for which data will be returned.","in":"path","name":"collection","required":true,"schema":{"enum":["ALL"],"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of category resources to return in the response, used for paging. For any response, the actual number of category resources returned may be less than the specified `maxResults`.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryListResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["metagame"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}":{"get":{"description":"Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, `leaderboardId` can be set to `ALL` to retrieve data for all leaderboards in a given time span. `NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'.","operationId":"games.scores.get","parameters":[{"description":"A player ID. A value of `me` may be used in place of the authenticated player's ID.","in":"path","name":"playerId","required":true,"schema":{"type":"string"}},{"description":"The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application.","in":"path","name":"leaderboardId","required":true,"schema":{"type":"string"}},{"description":"The time span for the scores and ranks you're requesting.","in":"path","name":"timeSpan","required":true,"schema":{"enum":["ALL","ALL_TIME","WEEKLY","DAILY"],"type":"string"}},{"description":"The types of ranks to return. If the parameter is omitted, no ranks will be returned.","in":"query","name":"includeRankType","schema":{"enum":["ALL","PUBLIC","SOCIAL","FRIENDS"],"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified `maxResults`.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayerLeaderboardScoreListResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["scores"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/players/{playerId}/snapshots":{"get":{"description":"Retrieves a list of snapshots created by your application for the player corresponding to the player ID.","operationId":"games.snapshots.list","parameters":[{"description":"A player ID. A value of `me` may be used in place of the authenticated player's ID.","in":"path","name":"playerId","required":true,"schema":{"type":"string"}},{"description":"The preferred language to use for strings returned by this method.","in":"query","name":"language","schema":{"type":"string"}},{"description":"The maximum number of snapshot resources to return in the response, used for paging. For any response, the actual number of snapshot resources returned may be less than the specified `maxResults`.","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnapshotListResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/drive.appdata"],"Oauth2c":["https://www.googleapis.com/auth/drive.appdata"]},{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["snapshots"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/recall/tokens/{sessionId}":{"get":{"description":"Retrieve all Recall tokens associated with the PGS Player principal encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.","operationId":"games.recall.retrieveTokens","parameters":[{"description":"Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.","in":"path","name":"sessionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievePlayerTokensResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidpublisher"],"Oauth2c":["https://www.googleapis.com/auth/androidpublisher"]}],"tags":["recall"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/recall:linkPersona":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Associate the PGS Player principal encoded in the provided recall session id with an in-game account","operationId":"games.recall.linkPersona","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkPersonaRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkPersonaResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidpublisher"],"Oauth2c":["https://www.googleapis.com/auth/androidpublisher"]}],"tags":["recall"]}},"/games/v1/recall:resetPersona":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Delete all Recall tokens linking the given persona to any player (with or without a profile).","operationId":"games.recall.resetPersona","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPersonaRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPersonaResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidpublisher"],"Oauth2c":["https://www.googleapis.com/auth/androidpublisher"]}],"tags":["recall"]}},"/games/v1/recall:unlinkPersona":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Delete a Recall token linking the PGS Player principal identified by the Recall session and an in-game account identified either by the 'persona' or by the token value.","operationId":"games.recall.unlinkPersona","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlinkPersonaRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlinkPersonaResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/androidpublisher"],"Oauth2c":["https://www.googleapis.com/auth/androidpublisher"]}],"tags":["recall"]}},"/games/v1/revisions/check":{"get":{"description":"Checks whether the games client is out of date.","operationId":"games.revisions.check","parameters":[{"description":"Required. The revision of the client SDK used by your application. Format: `[PLATFORM_TYPE]:[VERSION_NUMBER]`. Possible values of `PLATFORM_TYPE` are: * `ANDROID` - Client is running the Android SDK. * `IOS` - Client is running the iOS SDK. * `WEB_APP` - Client is running as a Web App.","in":"query","name":"clientRevision","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevisionCheckResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/games"],"Oauth2c":["https://www.googleapis.com/auth/games"]}],"tags":["revisions"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/games/v1/snapshots/{snapshotId}":{"get":{"description":"Retrieves the metadata for a given snapshot ID.","operationId":"games.snapshots.get","parameters":[{"description":"The ID of the snapshot.","in":"path","nam