{ "batchPath": "batch", "rootUrl": "https://games.googleapis.com/", "canonicalName": "Games", "discoveryVersion": "v1", "fullyEncodeReservedExpansion": true, "mtlsRootUrl": "https://games.mtls.googleapis.com/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "basePath": "", "description": "The Google Play Games Service allows developers to enhance games with social leaderboards, achievements, game state, sign-in with Google, and more.", "protocol": "rest", "id": "games:v1", "version": "v1", "servicePath": "", "documentationLink": "https://developers.google.com/games/", "parameters": { "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "$.xgafv": { "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "description": "V1 error format.", "type": "string" }, "alt": { "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "type": "string", "description": "Data format for response." }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "quotaUser": { "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" } }, "name": "games", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/androidpublisher": { "description": "View and manage your Google Play Developer account" }, "https://www.googleapis.com/auth/drive.appdata": { "description": "See, create, and delete its own configuration data in your Google Drive" }, "https://www.googleapis.com/auth/games": { "description": "Create, edit, and delete your Google Play Games activity" } } } }, "revision": "20260730", "ownerName": "Google", "resources": { "achievements": { "methods": { "increment": { "description": "Increments the steps of the achievement with the given ID for the currently authenticated player.", "parameterOrder": [ "achievementId", "stepsToIncrement" ], "response": { "$ref": "AchievementIncrementResponse" }, "id": "games.achievements.increment", "httpMethod": "POST", "parameters": { "requestId": { "location": "query", "format": "int64", "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.", "type": "string" }, "stepsToIncrement": { "type": "integer", "description": "Required. The number of steps to increment.", "required": true, "format": "int32", "location": "query" }, "achievementId": { "location": "path", "description": "The ID of the achievement used by this method.", "required": true, "type": "string" } }, "flatPath": "games/v1/achievements/{achievementId}/increment", "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/achievements/{achievementId}/increment" }, "reveal": { "description": "Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player.", "parameterOrder": [ "achievementId" ], "response": { "$ref": "AchievementRevealResponse" }, "parameters": { "achievementId": { "location": "path", "type": "string", "description": "The ID of the achievement used by this method.", "required": true } }, "flatPath": "games/v1/achievements/{achievementId}/reveal", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.achievements.reveal", "httpMethod": "POST", "path": "games/v1/achievements/{achievementId}/reveal" }, "list": { "path": "games/v1/players/{playerId}/achievements", "parameterOrder": [ "playerId" ], "response": { "$ref": "PlayerAchievementListResponse" }, "description": "Lists the progress for all your application's achievements for the currently authenticated player.", "id": "games.achievements.list", "httpMethod": "GET", "flatPath": "games/v1/players/{playerId}/achievements", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "language": { "location": "query", "description": "The preferred language to use for strings returned by this method.", "type": "string" }, "playerId": { "location": "path", "type": "string", "description": "A player ID. A value of `me` may be used in place of the authenticated player's ID.", "required": true }, "pageToken": { "type": "string", "description": "The token returned by the previous request.", "location": "query" }, "state": { "location": "query", "enumDescriptions": [ "List all achievements. This is the default.", "List only hidden achievements.", "List only revealed achievements.", "List only unlocked achievements." ], "enum": [ "ALL", "HIDDEN", "REVEALED", "UNLOCKED" ], "type": "string", "description": "Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned." }, "maxResults": { "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`.", "type": "integer", "location": "query", "format": "int32" } } }, "unlock": { "id": "games.achievements.unlock", "httpMethod": "POST", "flatPath": "games/v1/achievements/{achievementId}/unlock", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "achievementId": { "description": "The ID of the achievement used by this method.", "required": true, "type": "string", "location": "path" } }, "parameterOrder": [ "achievementId" ], "response": { "$ref": "AchievementUnlockResponse" }, "description": "Unlocks this achievement for the currently authenticated player.", "path": "games/v1/achievements/{achievementId}/unlock" }, "updateMultiple": { "request": { "$ref": "AchievementUpdateMultipleRequest" }, "parameterOrder": [], "response": { "$ref": "AchievementUpdateMultipleResponse" }, "description": "Updates multiple achievements for the currently authenticated player.", "flatPath": "games/v1/achievements/updateMultiple", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": {}, "id": "games.achievements.updateMultiple", "httpMethod": "POST", "path": "games/v1/achievements/updateMultiple" }, "setStepsAtLeast": { "parameters": { "achievementId": { "description": "The ID of the achievement used by this method.", "required": true, "type": "string", "location": "path" }, "steps": { "type": "integer", "description": "Required. The minimum value to set the steps to.", "required": true, "format": "int32", "location": "query" } }, "flatPath": "games/v1/achievements/{achievementId}/setStepsAtLeast", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.achievements.setStepsAtLeast", "httpMethod": "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.", "parameterOrder": [ "achievementId", "steps" ], "response": { "$ref": "AchievementSetStepsAtLeastResponse" }, "path": "games/v1/achievements/{achievementId}/setStepsAtLeast" } } }, "stats": { "methods": { "get": { "description": "Returns engagement and spend statistics in this application for the currently authenticated user.", "parameterOrder": [], "response": { "$ref": "StatsResponse" }, "id": "games.stats.get", "httpMethod": "GET", "parameters": {}, "flatPath": "games/v1/stats", "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/stats" } } }, "metagame": { "methods": { "getMetagameConfig": { "path": "games/v1/metagameConfig", "id": "games.metagame.getMetagameConfig", "httpMethod": "GET", "flatPath": "games/v1/metagameConfig", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": {}, "parameterOrder": [], "response": { "$ref": "MetagameConfig" }, "description": "Return the metagame configuration data for the calling application." }, "listCategoriesByPlayer": { "parameterOrder": [ "playerId", "collection" ], "response": { "$ref": "CategoryListResponse" }, "description": "List play data aggregated per category for the player corresponding to `playerId`.", "flatPath": "games/v1/players/{playerId}/categories/{collection}", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "maxResults": { "location": "query", "format": "int32", "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`.", "type": "integer" }, "playerId": { "description": "A player ID. A value of `me` may be used in place of the authenticated player's ID.", "required": true, "type": "string", "location": "path" }, "pageToken": { "location": "query", "description": "The token returned by the previous request.", "type": "string" }, "language": { "location": "query", "type": "string", "description": "The preferred language to use for strings returned by this method." }, "collection": { "location": "path", "enumDescriptions": [ "Retrieve data for all categories. This is the default." ], "enum": [ "ALL" ], "description": "The collection of categories for which data will be returned.", "required": true, "type": "string" } }, "id": "games.metagame.listCategoriesByPlayer", "httpMethod": "GET", "path": "games/v1/players/{playerId}/categories/{collection}" } } }, "leaderboards": { "methods": { "list": { "path": "games/v1/leaderboards", "description": "Lists all the leaderboard metadata for your application.", "parameterOrder": [], "response": { "$ref": "LeaderboardListResponse" }, "parameters": { "maxResults": { "location": "query", "format": "int32", "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`.", "type": "integer" }, "language": { "description": "The preferred language to use for strings returned by this method.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The token returned by the previous request." } }, "flatPath": "games/v1/leaderboards", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.leaderboards.list", "httpMethod": "GET" }, "get": { "description": "Retrieves the metadata of the leaderboard with the given ID.", "parameterOrder": [ "leaderboardId" ], "response": { "$ref": "Leaderboard" }, "id": "games.leaderboards.get", "httpMethod": "GET", "parameters": { "leaderboardId": { "location": "path", "description": "The ID of the leaderboard.", "required": true, "type": "string" }, "language": { "location": "query", "type": "string", "description": "The preferred language to use for strings returned by this method." } }, "flatPath": "games/v1/leaderboards/{leaderboardId}", "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/leaderboards/{leaderboardId}" } } }, "applications": { "methods": { "played": { "id": "games.applications.played", "httpMethod": "POST", "flatPath": "games/v1/applications/played", "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/applications/played", "parameters": {}, "parameterOrder": [], "description": "Indicate that the currently authenticated user is playing your application." }, "get": { "id": "games.applications.get", "httpMethod": "GET", "flatPath": "games/v1/applications/{applicationId}", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "applicationId": { "location": "path", "type": "string", "description": "The application ID from the Google Play developer console.", "required": true }, "language": { "location": "query", "description": "The preferred language to use for strings returned by this method.", "type": "string" }, "platformType": { "description": "Restrict application details returned to the specific platform.", "type": "string", "location": "query", "enumDescriptions": [ "Retrieve applications that can be played on Android.", "Retrieve applications that can be played on iOS.", "Retrieve applications that can be played on desktop web." ], "enum": [ "ANDROID", "IOS", "WEB_APP" ] } }, "parameterOrder": [ "applicationId" ], "response": { "$ref": "Application" }, "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.", "path": "games/v1/applications/{applicationId}" }, "verify": { "path": "games/v1/applications/{applicationId}/verify", "parameterOrder": [ "applicationId" ], "response": { "$ref": "ApplicationVerifyResponse" }, "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.", "flatPath": "games/v1/applications/{applicationId}/verify", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "applicationId": { "type": "string", "description": "The application ID from the Google Play developer console.", "required": true, "location": "path" } }, "id": "games.applications.verify", "httpMethod": "GET" }, "getEndPoint": { "path": "games/v1/applications/getEndPoint", "id": "games.applications.getEndPoint", "httpMethod": "POST", "parameters": { "applicationId": { "type": "string", "description": "The application ID from the Google Play developer console.", "location": "query" }, "endPointType": { "type": "string", "description": "Type of endpoint being requested.", "location": "query", "enumDescriptions": [ "Request a URL to create a new profile.", "Request a URL for the Settings view." ], "enum": [ "PROFILE_CREATION", "PROFILE_SETTINGS" ] } }, "flatPath": "games/v1/applications/getEndPoint", "scopes": [ "https://www.googleapis.com/auth/games" ], "description": "Returns a URL for the requested end point type.", "parameterOrder": [], "response": { "$ref": "EndPoint" } } } }, "revisions": { "methods": { "check": { "parameterOrder": [ "clientRevision" ], "response": { "$ref": "RevisionCheckResponse" }, "description": "Checks whether the games client is out of date.", "id": "games.revisions.check", "httpMethod": "GET", "flatPath": "games/v1/revisions/check", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "clientRevision": { "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.", "required": true, "type": "string", "location": "query" } }, "path": "games/v1/revisions/check" } } }, "events": { "methods": { "listByPlayer": { "description": "Returns a list showing the current progress on events in this application for the currently authenticated user.", "parameterOrder": [], "response": { "$ref": "PlayerEventListResponse" }, "parameters": { "maxResults": { "location": "query", "format": "int32", "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.", "type": "integer" }, "language": { "description": "The preferred language to use for strings returned by this method.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "description": "The token returned by the previous request.", "location": "query" } }, "flatPath": "games/v1/events", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.events.listByPlayer", "httpMethod": "GET", "path": "games/v1/events" }, "record": { "path": "games/v1/events", "flatPath": "games/v1/events", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "language": { "type": "string", "description": "The preferred language to use for strings returned by this method.", "location": "query" } }, "id": "games.events.record", "httpMethod": "POST", "request": { "$ref": "EventRecordRequest" }, "parameterOrder": [], "response": { "$ref": "EventUpdateResponse" }, "description": "Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application." }, "listDefinitions": { "path": "games/v1/eventDefinitions", "parameterOrder": [], "response": { "$ref": "EventDefinitionListResponse" }, "description": "Returns a list of the event definitions in this application.", "id": "games.events.listDefinitions", "httpMethod": "GET", "flatPath": "games/v1/eventDefinitions", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "language": { "location": "query", "description": "The preferred language to use for strings returned by this method.", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "The token returned by the previous request." }, "maxResults": { "location": "query", "format": "int32", "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`.", "type": "integer" } } } } }, "players": { "methods": { "get": { "parameters": { "playerId": { "location": "path", "description": "A player ID. A value of `me` may be used in place of the authenticated player's ID.", "required": true, "type": "string" }, "language": { "description": "The preferred language to use for strings returned by this method.", "type": "string", "location": "query" }, "playerIdConsistencyToken": { "location": "query", "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" } }, "flatPath": "games/v1/players/{playerId}", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.players.get", "httpMethod": "GET", "description": "Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set `playerId` to `me`.", "parameterOrder": [ "playerId" ], "response": { "$ref": "Player" }, "path": "games/v1/players/{playerId}" }, "getScopedPlayerIds": { "description": "Retrieves scoped player identifiers for currently authenticated user.", "parameterOrder": [], "response": { "$ref": "ScopedPlayerIds" }, "id": "games.players.getScopedPlayerIds", "httpMethod": "GET", "parameters": {}, "flatPath": "games/v1/players/me/scopedIds", "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/players/me/scopedIds" }, "list": { "parameterOrder": [ "collection" ], "response": { "$ref": "PlayerListResponse" }, "description": "Get the collection of players for the currently authenticated user.", "flatPath": "games/v1/players/me/players/{collection}", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "collection": { "enumDeprecated": [ true, true, false ], "location": "path", "enumDescriptions": [ "Retrieve a list of players that are also playing this game in reverse chronological order.", "Retrieve a list of players in the user's social graph that are visible to this game.", "Retrieve a list of players who are friends of the user in alphabetical order." ], "enum": [ "CONNECTED", "VISIBLE", "FRIENDS_ALL" ], "type": "string", "description": "Collection of players being retrieved", "required": true }, "language": { "location": "query", "description": "The preferred language to use for strings returned by this method.", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "The token returned by the previous request." }, "maxResults": { "location": "query", "format": "int32", "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`.", "type": "integer" } }, "id": "games.players.list", "httpMethod": "GET", "path": "games/v1/players/me/players/{collection}" }, "getMultipleApplicationPlayerIds": { "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.", "parameterOrder": [], "response": { "$ref": "GetMultipleApplicationPlayerIdsResponse" }, "parameters": { "applicationIds": { "description": "Required. The application IDs from the Google Play developer console for the games to return scoped ids for.", "repeated": true, "type": "string", "location": "query" } }, "flatPath": "games/v1/players/me/multipleApplicationPlayerIds", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.players.getMultipleApplicationPlayerIds", "httpMethod": "GET", "path": "games/v1/players/me/multipleApplicationPlayerIds" } } }, "accesstokens": { "methods": { "generateRecallPlayGroupingApiToken": { "parameterOrder": [], "response": { "$ref": "GenerateRecallPlayGroupingApiTokenResponse" }, "description": "Generates a Play Grouping API token for the PGS user identified by the Recall session ID provided in the request.", "flatPath": "games/v1/accesstokens/generateRecallPlayGroupingApiToken", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "persona": { "location": "query", "type": "string", "description": "Required. Persona to associate with the token. Persona is a developer-provided stable identifier of the user. Must be deterministically generated (e.g. as a one-way hash) from the user account ID and user profile ID (if the app has the concept), according to the developer's own user identity system." }, "recallSessionId": { "location": "query", "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. See https://developer.android.com/games/pgs/recall/recall-setup on how to integrate with Recall and get session ID.", "type": "string" }, "packageName": { "location": "query", "description": "Required. App package name to generate the token for (e.g. com.example.mygame).", "type": "string" } }, "id": "games.accesstokens.generateRecallPlayGroupingApiToken", "httpMethod": "POST", "path": "games/v1/accesstokens/generateRecallPlayGroupingApiToken" }, "generatePlayGroupingApiToken": { "path": "games/v1/accesstokens/generatePlayGroupingApiToken", "parameters": { "persona": { "description": "Required. Persona to associate with the token. Persona is a developer-provided stable identifier of the user. Must be deterministically generated (e.g. as a one-way hash) from the user account ID and user profile ID (if the app has the concept), according to the developer's own user identity system.", "type": "string", "location": "query" }, "packageName": { "type": "string", "description": "Required. App package name to generate the token for (e.g. com.example.mygame).", "location": "query" } }, "flatPath": "games/v1/accesstokens/generatePlayGroupingApiToken", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.accesstokens.generatePlayGroupingApiToken", "httpMethod": "POST", "description": "Generates a Play Grouping API token for the PGS user identified by the attached credential.", "parameterOrder": [], "response": { "$ref": "GeneratePlayGroupingApiTokenResponse" } } } }, "recall": { "methods": { "lastTokenFromAllDeveloperGames": { "description": "Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.", "parameterOrder": [ "sessionId" ], "response": { "$ref": "RetrieveDeveloperGamesLastPlayerTokenResponse" }, "parameters": { "sessionId": { "location": "path", "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.", "required": true, "type": "string" } }, "flatPath": "games/v1/recall/developerGamesLastPlayerToken/{sessionId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "games.recall.lastTokenFromAllDeveloperGames", "httpMethod": "GET", "path": "games/v1/recall/developerGamesLastPlayerToken/{sessionId}" }, "unlinkPersona": { "path": "games/v1/recall:unlinkPersona", "request": { "$ref": "UnlinkPersonaRequest" }, "parameterOrder": [], "response": { "$ref": "UnlinkPersonaResponse" }, "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.", "flatPath": "games/v1/recall:unlinkPersona", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": {}, "id": "games.recall.unlinkPersona", "httpMethod": "POST" }, "gamesPlayerTokens": { "description": "Retrieve the Recall tokens from all requested games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have an active PGS Player profile.", "parameterOrder": [ "sessionId" ], "response": { "$ref": "RetrieveGamesPlayerTokensResponse" }, "parameters": { "sessionId": { "location": "path", "type": "string", "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.", "required": true }, "applicationIds": { "location": "query", "description": "Required. The application IDs from the Google Play developer console for the games to return scoped ids for.", "repeated": true, "type": "string" } }, "flatPath": "games/v1/recall/gamesPlayerTokens/{sessionId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "games.recall.gamesPlayerTokens", "httpMethod": "GET", "path": "games/v1/recall/gamesPlayerTokens/{sessionId}" }, "resetPersona": { "path": "games/v1/recall:resetPersona", "request": { "$ref": "ResetPersonaRequest" }, "parameterOrder": [], "response": { "$ref": "ResetPersonaResponse" }, "description": "Delete all Recall tokens linking the given persona to any player (with or without a profile).", "flatPath": "games/v1/recall:resetPersona", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": {}, "id": "games.recall.resetPersona", "httpMethod": "POST" }, "linkPersona": { "parameterOrder": [], "response": { "$ref": "LinkPersonaResponse" }, "description": "Associate the PGS Player principal encoded in the provided recall session id with an in-game account", "request": { "$ref": "LinkPersonaRequest" }, "id": "games.recall.linkPersona", "httpMethod": "POST", "flatPath": "games/v1/recall:linkPersona", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": {}, "path": "games/v1/recall:linkPersona" }, "retrieveTokens": { "path": "games/v1/recall/tokens/{sessionId}", "parameterOrder": [ "sessionId" ], "response": { "$ref": "RetrievePlayerTokensResponse" }, "description": "Retrieve all Recall tokens associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.", "flatPath": "games/v1/recall/tokens/{sessionId}", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "sessionId": { "location": "path", "type": "string", "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.", "required": true } }, "id": "games.recall.retrieveTokens", "httpMethod": "GET" } } }, "achievementDefinitions": { "methods": { "list": { "path": "games/v1/achievements", "description": "Lists all the achievement definitions for your application.", "parameterOrder": [], "response": { "$ref": "AchievementDefinitionsListResponse" }, "id": "games.achievementDefinitions.list", "httpMethod": "GET", "parameters": { "maxResults": { "type": "integer", "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`.", "format": "int32", "location": "query" }, "language": { "description": "The preferred language to use for strings returned by this method.", "type": "string", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The token returned by the previous request." } }, "flatPath": "games/v1/achievements", "scopes": [ "https://www.googleapis.com/auth/games" ] } } }, "scores": { "methods": { "submit": { "id": "games.scores.submit", "httpMethod": "POST", "flatPath": "games/v1/leaderboards/{leaderboardId}/scores", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "score": { "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.", "required": true, "type": "string", "location": "query", "format": "int64" }, "scoreTag": { "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.", "pattern": "[a-zA-Z0-9-._~]{0,64}", "type": "string", "location": "query" }, "leaderboardId": { "location": "path", "type": "string", "description": "The ID of the leaderboard.", "required": true }, "language": { "location": "query", "type": "string", "description": "The preferred language to use for strings returned by this method." } }, "parameterOrder": [ "leaderboardId", "score" ], "response": { "$ref": "PlayerScoreResponse" }, "description": "Submits a score to the specified leaderboard.", "path": "games/v1/leaderboards/{leaderboardId}/scores" }, "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'.", "parameterOrder": [ "playerId", "leaderboardId", "timeSpan" ], "response": { "$ref": "PlayerLeaderboardScoreListResponse" }, "id": "games.scores.get", "httpMethod": "GET", "parameters": { "language": { "location": "query", "description": "The preferred language to use for strings returned by this method.", "type": "string" }, "leaderboardId": { "description": "The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application.", "required": true, "type": "string", "location": "path" }, "playerId": { "location": "path", "type": "string", "description": "A player ID. A value of `me` may be used in place of the authenticated player's ID.", "required": true }, "includeRankType": { "location": "query", "enumDescriptions": [ "Retrieve all supported ranks. In HTTP, this parameter value can also be specified as `ALL`.", "Retrieve public ranks, if the player is sharing their gameplay activity publicly.", "(Obsolete) Retrieve the social rank.", "Retrieve the rank on the friends collection." ], "enum": [ "ALL", "PUBLIC", "SOCIAL", "FRIENDS" ], "enumDeprecated": [ false, false, true, false ], "description": "The types of ranks to return. If the parameter is omitted, no ranks will be returned.", "type": "string" }, "pageToken": { "description": "The token returned by the previous request.", "type": "string", "location": "query" }, "maxResults": { "location": "query", "format": "int32", "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`.", "type": "integer" }, "timeSpan": { "location": "path", "enumDescriptions": [ "Get the high scores for all time spans. If this is used, maxResults values will be ignored.", "Get the all time high score.", "List the top scores for the current day.", "List the top scores for the current week." ], "enum": [ "ALL", "ALL_TIME", "WEEKLY", "DAILY" ], "type": "string", "description": "The time span for the scores and ranks you're requesting.", "required": true } }, "flatPath": "games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}", "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}" }, "listWindow": { "parameters": { "language": { "location": "query", "description": "The preferred language to use for strings returned by this method.", "type": "string" }, "collection": { "type": "string", "description": "The collection of scores you're requesting.", "required": true, "enumDeprecated": [ false, true, false ], "location": "path", "enumDescriptions": [ "List all scores in the public leaderboard.", "(Obsolete) Legacy G+ social scores.", "List only scores of friends." ], "enum": [ "PUBLIC", "SOCIAL", "FRIENDS" ] }, "leaderboardId": { "location": "path", "type": "string", "description": "The ID of the leaderboard.", "required": true }, "maxResults": { "location": "query", "format": "int32", "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`.", "type": "integer" }, "pageToken": { "location": "query", "description": "The token returned by the previous request.", "type": "string" }, "timeSpan": { "location": "query", "enumDescriptions": [ "The score is an all-time score.", "The score is a weekly score.", "The score is a daily score." ], "enum": [ "ALL_TIME", "WEEKLY", "DAILY" ], "description": "Required. The time span for the scores and ranks you're requesting.", "required": true, "type": "string" }, "returnTopIfAbsent": { "type": "boolean", "description": "True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.", "location": "query" }, "resultsAbove": { "type": "integer", "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.", "format": "int32", "location": "query" } }, "flatPath": "games/v1/leaderboards/{leaderboardId}/window/{collection}", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.scores.listWindow", "httpMethod": "GET", "description": "Lists the scores in a leaderboard around (and including) a player's score.", "parameterOrder": [ "leaderboardId", "collection", "timeSpan" ], "response": { "$ref": "LeaderboardScores" }, "path": "games/v1/leaderboards/{leaderboardId}/window/{collection}" }, "submitMultiple": { "flatPath": "games/v1/leaderboards/scores", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "language": { "location": "query", "type": "string", "description": "The preferred language to use for strings returned by this method." } }, "id": "games.scores.submitMultiple", "httpMethod": "POST", "request": { "$ref": "PlayerScoreSubmissionList" }, "parameterOrder": [], "response": { "$ref": "PlayerScoreListResponse" }, "description": "Submits multiple scores to leaderboards.", "path": "games/v1/leaderboards/scores" }, "list": { "path": "games/v1/leaderboards/{leaderboardId}/scores/{collection}", "id": "games.scores.list", "httpMethod": "GET", "parameters": { "collection": { "type": "string", "description": "The collection of scores you're requesting.", "required": true, "enumDeprecated": [ false, true, false ], "location": "path", "enumDescriptions": [ "List all scores in the public leaderboard.", "(Obsolete) Legacy G+ social scores.", "List only scores of friends." ], "enum": [ "PUBLIC", "SOCIAL", "FRIENDS" ] }, "leaderboardId": { "description": "The ID of the leaderboard.", "required": true, "type": "string", "location": "path" }, "language": { "location": "query", "type": "string", "description": "The preferred language to use for strings returned by this method." }, "timeSpan": { "description": "Required. The time span for the scores and ranks you're requesting.", "required": true, "type": "string", "location": "query", "enumDescriptions": [ "The score is an all-time score.", "The score is a weekly score.", "The score is a daily score." ], "enum": [ "ALL_TIME", "WEEKLY", "DAILY" ] }, "maxResults": { "type": "integer", "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`.", "format": "int32", "location": "query" }, "pageToken": { "location": "query", "description": "The token returned by the previous request.", "type": "string" } }, "flatPath": "games/v1/leaderboards/{leaderboardId}/scores/{collection}", "scopes": [ "https://www.googleapis.com/auth/games" ], "description": "Lists the scores in a leaderboard, starting from the top.", "parameterOrder": [ "leaderboardId", "collection", "timeSpan" ], "response": { "$ref": "LeaderboardScores" } } } }, "playerGameEvents": { "methods": { "batchRecordEvents": { "id": "games.playerGameEvents.batchRecordEvents", "httpMethod": "POST", "parameters": { "playerId": { "location": "path", "type": "string", "description": "Required. The player ID of the player that performed the events.", "required": true } }, "flatPath": "games/v1/players/{playerId}/gameEvents:batchRecordEvents", "scopes": [ "https://www.googleapis.com/auth/games" ], "description": "Records a batch of player game events for a specific player. This method allows sending multiple events in a single request.", "parameterOrder": [ "playerId" ], "response": { "$ref": "BatchRecordEventsResponse" }, "request": { "$ref": "BatchRecordEventsRequest" }, "path": "games/v1/players/{playerId}/gameEvents:batchRecordEvents" } } }, "snapshots": { "methods": { "list": { "path": "games/v1/players/{playerId}/snapshots", "id": "games.snapshots.list", "httpMethod": "GET", "parameters": { "playerId": { "type": "string", "description": "A player ID. A value of `me` may be used in place of the authenticated player's ID.", "required": true, "location": "path" }, "language": { "description": "The preferred language to use for strings returned by this method.", "type": "string", "location": "query" }, "pageToken": { "type": "string", "description": "The token returned by the previous request.", "location": "query" }, "maxResults": { "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`.", "type": "integer", "location": "query", "format": "int32" } }, "flatPath": "games/v1/players/{playerId}/snapshots", "scopes": [ "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/games" ], "description": "Retrieves a list of snapshots created by your application for the player corresponding to the player ID.", "parameterOrder": [ "playerId" ], "response": { "$ref": "SnapshotListResponse" } }, "get": { "path": "games/v1/snapshots/{snapshotId}", "description": "Retrieves the metadata for a given snapshot ID.", "parameterOrder": [ "snapshotId" ], "response": { "$ref": "Snapshot" }, "id": "games.snapshots.get", "httpMethod": "GET", "parameters": { "snapshotId": { "location": "path", "type": "string", "description": "The ID of the snapshot.", "required": true }, "language": { "description": "The preferred language to use for strings returned by this method.", "type": "string", "location": "query" } }, "flatPath": "games/v1/snapshots/{snapshotId}", "scopes": [ "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/games" ] } } } }, "ownerDomain": "google.com", "baseUrl": "https://games.googleapis.com/", "title": "Google Play Games Services API", "schemas": { "SnapshotImage": { "type": "object", "properties": { "height": { "description": "The height of the image.", "type": "integer", "format": "int32" }, "mime_type": { "description": "The MIME type of the image.", "type": "string" }, "url": { "description": "The URL of the image. This URL may be invalidated at any time and should not be cached.", "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshotImage`." }, "width": { "description": "The width of the image.", "type": "integer", "format": "int32" } }, "id": "SnapshotImage", "description": "An image of a snapshot." }, "Player": { "type": "object", "properties": { "displayName": { "type": "string", "description": "The name to display for the player." }, "gamePlayerId": { "description": "Per-application unique player identifier.", "type": "string" }, "avatarImageUrl": { "description": "The base URL for the image that represents the player.", "type": "string" }, "bannerUrlPortrait": { "type": "string", "description": "The url to the portrait mode player banner image." }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#player`", "type": "string" }, "name": { "type": "object", "properties": { "familyName": { "description": "The family name of this player. In some places, this is known as the last name.", "type": "string" }, "givenName": { "type": "string", "description": "The given name of this player. In some places, this is known as the first name." } }, "description": "A representation of the individual components of the name." }, "experienceInfo": { "description": "An object to represent Play Game experience information for the player.", "$ref": "PlayerExperienceInfo" }, "title": { "description": "The player's title rewarded for their game activities.", "type": "string" }, "bannerUrlLandscape": { "type": "string", "description": "The url to the landscape mode player banner image." }, "originalPlayerId": { "description": "The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs.", "type": "string" }, "playerId": { "type": "string", "description": "The ID of the player." }, "friendStatus": { "type": "string", "description": "The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game.", "enumDescriptions": [ "There is no relationship between the players.", "The player and requester are friends." ], "enum": [ "NO_RELATIONSHIP", "FRIEND" ] }, "profileSettings": { "description": "The player's profile settings. Controls whether or not the player's profile is visible to other players.", "$ref": "ProfileSettings" } }, "id": "Player", "description": "A Player resource." }, "AchievementUpdateMultipleResponse": { "id": "AchievementUpdateMultipleResponse", "description": "Response message for UpdateMultipleAchievements rpc.", "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateMultipleResponse`." }, "updatedAchievements": { "type": "array", "description": "The updated state of the achievements.", "items": { "$ref": "AchievementUpdateResponse" } } } }, "Snapshot": { "id": "Snapshot", "description": "An snapshot object.", "type": "object", "properties": { "coverImage": { "description": "The cover image of this snapshot. May be absent if there is no image.", "$ref": "SnapshotImage" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshot`." }, "title": { "type": "string", "description": "The title of this snapshot." }, "durationMillis": { "type": "string", "description": "The duration associated with this snapshot, in millis.", "format": "int64" }, "uniqueName": { "description": "The unique name provided when the snapshot was created.", "type": "string" }, "id": { "description": "The ID of the snapshot.", "type": "string" }, "lastModifiedMillis": { "format": "int64", "type": "string", "description": "The timestamp (in millis since Unix epoch) of the last modification to this snapshot." }, "description": { "type": "string", "description": "The description of this snapshot." }, "progressValue": { "description": "The progress value (64-bit integer set by developer) associated with this snapshot.", "type": "string", "format": "int64" }, "type": { "description": "The type of this snapshot.", "type": "string", "enumDescriptions": [ "A snapshot representing a save game." ], "enum": [ "SAVE_GAME" ] }, "driveId": { "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.", "type": "string" } } }, "AchievementDefinitionsListResponse": { "id": "AchievementDefinitionsListResponse", "description": "A list of achievement definition objects.", "type": "object", "properties": { "items": { "type": "array", "description": "The achievement definitions.", "items": { "$ref": "AchievementDefinition" } }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementDefinitionsListResponse`." }, "nextPageToken": { "type": "string", "description": "Token corresponding to the next page of results." } } }, "EventRecordRequest": { "id": "EventRecordRequest", "description": "An event period update resource.", "type": "object", "properties": { "currentTimeMillis": { "type": "string", "description": "The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch).", "format": "int64" }, "timePeriods": { "description": "A list of the time period updates being made in this request.", "items": { "$ref": "EventPeriodUpdate" }, "type": "array" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordRequest`.", "type": "string" }, "requestId": { "format": "int64", "description": "The request ID used to identify this attempt to record events.", "type": "string" } } }, "PlayGroupingApiToken": { "id": "PlayGroupingApiToken", "description": "Token data returned from GeneratePlayGroupingApiToken RPC.", "type": "object", "properties": { "tokenValue": { "type": "string", "description": "Value of the token." } } }, "LeaderboardEntry": { "type": "object", "properties": { "formattedScore": { "description": "The localized string for the numerical value of this score.", "type": "string" }, "player": { "description": "The player who holds this score.", "$ref": "Player" }, "scoreRank": { "description": "The rank of this score for this leaderboard.", "type": "string", "format": "int64" }, "writeTimestampMillis": { "type": "string", "description": "The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.", "format": "int64" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.", "type": "string" }, "timeSpan": { "enumDescriptions": [ "The score is an all-time score.", "The score is a weekly score.", "The score is a daily score." ], "enum": [ "ALL_TIME", "WEEKLY", "DAILY" ], "type": "string", "description": "The time span of this high score." }, "formattedScoreRank": { "description": "The localized string for the rank of this score for this leaderboard.", "type": "string" }, "scoreTag": { "description": "Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.", "type": "string" }, "scoreValue": { "format": "int64", "description": "The numerical value of this score.", "type": "string" } }, "id": "LeaderboardEntry", "description": "The Leaderboard Entry resource." }, "AchievementUpdateRequest": { "id": "AchievementUpdateRequest", "description": "A request to update an achievement.", "type": "object", "properties": { "incrementPayload": { "description": "The payload if an update of type `INCREMENT` was requested for the achievement.", "$ref": "GamesAchievementIncrement" }, "updateType": { "type": "string", "description": "The type of update being applied.", "enumDescriptions": [ "Achievement is revealed.", "Achievement is unlocked.", "Achievement is incremented.", "Achievement progress is set to at least the passed value." ], "enum": [ "REVEAL", "UNLOCK", "INCREMENT", "SET_STEPS_AT_LEAST" ] }, "achievementId": { "description": "The achievement this update is being applied to.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateRequest`.", "type": "string" }, "setStepsAtLeastPayload": { "description": "The payload if an update of type `SET_STEPS_AT_LEAST` was requested for the achievement.", "$ref": "GamesAchievementSetStepsAtLeast" } } }, "ApplicationVerifyResponse": { "id": "ApplicationVerifyResponse", "description": "A third party application verification response resource.", "type": "object", "properties": { "alternate_player_id": { "type": "string", "description": "An alternate ID that was once used for the player that was issued the auth token used in this request. (This field is not normally populated.)" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationVerifyResponse`." }, "player_id": { "type": "string", "description": "The ID of the player that was issued the auth token used in this request." } } }, "Instance": { "id": "Instance", "description": "The Instance resource.", "type": "object", "properties": { "androidInstance": { "description": "Platform dependent details for Android.", "$ref": "InstanceAndroidDetails" }, "realtimePlay": { "description": "Flag to show if this game instance supports realtime play.", "type": "boolean" }, "iosInstance": { "description": "Platform dependent details for iOS.", "$ref": "InstanceIosDetails" }, "name": { "type": "string", "description": "Localized display name." }, "acquisitionUri": { "description": "URI which shows where a user can acquire this instance.", "type": "string" }, "platformType": { "enumDescriptions": [ "Instance is for Android.", "Instance is for iOS.", "Instance is for Web App." ], "enum": [ "ANDROID", "IOS", "WEB_APP" ], "type": "string", "description": "The platform type." }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#instance`.", "type": "string" }, "turnBasedPlay": { "type": "boolean", "description": "Flag to show if this game instance supports turn based play." }, "webInstance": { "description": "Platform dependent details for Web.", "$ref": "InstanceWebDetails" } } }, "PlayerExperienceInfo": { "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`." }, "currentLevel": { "description": "The current level of the player.", "$ref": "PlayerLevel" }, "nextLevel": { "description": "The next level of the player. If the current level is the maximum level, this should be same as the current level.", "$ref": "PlayerLevel" }, "currentExperiencePoints": { "type": "string", "description": "The current number of experience points for the player.", "format": "int64" }, "lastLevelUpTimestampMillis": { "description": "The timestamp when the player was leveled up, in millis since Unix epoch UTC.", "type": "string", "format": "int64" } }, "id": "PlayerExperienceInfo", "description": "1P/3P metadata about the player's experience." }, "PlayerAchievement": { "type": "object", "properties": { "lastUpdatedTimestamp": { "type": "string", "description": "The timestamp of the last modification to this achievement's state.", "format": "int64" }, "formattedCurrentStepsString": { "description": "The current steps for an incremental achievement as a string.", "type": "string" }, "achievementState": { "enumDescriptions": [ "Achievement is hidden.", "Achievement is revealed.", "Achievement is unlocked." ], "enum": [ "HIDDEN", "REVEALED", "UNLOCKED" ], "description": "The state of the achievement.", "type": "string" }, "experiencePoints": { "format": "int64", "description": "Experience points earned for the achievement. This field is absent for achievements that have not yet been unlocked and 0 for achievements that have been unlocked by testers but that are unpublished.", "type": "string" }, "currentSteps": { "type": "integer", "description": "The current steps for an incremental achievement.", "format": "int32" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievement`.", "type": "string" }, "id": { "description": "The ID of the achievement.", "type": "string" } }, "id": "PlayerAchievement", "description": "An achievement object." }, "UnlinkPersonaRequest": { "id": "UnlinkPersonaRequest", "description": "Request to remove a Recall token linking PGS principal and an in-game account", "type": "object", "properties": { "token": { "type": "string", "description": "Value of the Recall token as it was provided by the client in LinkPersona RPC" }, "persona": { "type": "string", "description": "Value of the 'persona' field as it was provided by the client in LinkPersona RPC" }, "sessionId": { "type": "string", "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application." } } }, "AchievementUpdateMultipleRequest": { "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateMultipleRequest`." }, "updates": { "description": "The individual achievement update requests.", "items": { "$ref": "AchievementUpdateRequest" }, "type": "array" } }, "id": "AchievementUpdateMultipleRequest", "description": "A list of achievement update requests." }, "PlayerScore": { "id": "PlayerScore", "description": "A player score.", "type": "object", "properties": { "formattedScore": { "type": "string", "description": "The formatted score for this player score." }, "scoreTag": { "description": "Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScore`.", "type": "string" }, "timeSpan": { "enumDescriptions": [ "The score is an all-time score.", "The score is a weekly score.", "The score is a daily score." ], "enum": [ "ALL_TIME", "WEEKLY", "DAILY" ], "type": "string", "description": "The time span for this player score." }, "score": { "description": "The numerical value for this player score.", "type": "string", "format": "int64" } } }, "GetMultipleApplicationPlayerIdsResponse": { "id": "GetMultipleApplicationPlayerIdsResponse", "description": "Response message for GetMultipleApplicationPlayerIds rpc.", "type": "object", "properties": { "playerIds": { "description": "Output only. The requested applications along with the scoped ids for tha player, if that player has an id for the application. If not, the application is not included in the response.", "items": { "$ref": "ApplicationPlayerId" }, "type": "array", "readOnly": true } } }, "AchievementUpdateResponse": { "id": "AchievementUpdateResponse", "description": "An updated achievement.", "type": "object", "properties": { "currentSteps": { "format": "int32", "description": "The current steps recorded for this achievement if it is incremental.", "type": "integer" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateResponse`.", "type": "string" }, "updateOccurred": { "description": "Whether the requested updates actually affected the achievement.", "type": "boolean" }, "newlyUnlocked": { "type": "boolean", "description": "Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player)." }, "achievementId": { "type": "string", "description": "The achievement this update is was applied to." }, "currentState": { "enumDescriptions": [ "Achievement is hidden.", "Achievement is revealed.", "Achievement is unlocked." ], "enum": [ "HIDDEN", "REVEALED", "UNLOCKED" ], "type": "string", "description": "The current state of the achievement." } } }, "EventChild": { "id": "EventChild", "description": "An event child relationship resource.", "type": "object", "properties": { "childId": { "type": "string", "description": "The ID of the child event." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventChild`." } } }, "Status": { "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "format": "int32", "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code." }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "type": "array" } } }, "StatsResponse": { "id": "StatsResponse", "description": "A third party stats resource.", "type": "object", "properties": { "spend_probability": { "format": "float", "description": "The probability of the player going to spend the game in the next seven days. E.g., 0, 0.25, 0.50, 0.75. Not populated if there is not enough information.", "type": "number" }, "high_spender_probability": { "type": "number", "description": "The probability of the player going to spend beyond a threshold amount of money. E.g., 0, 0.25, 0.50, 0.75. Not populated if there is not enough information.", "format": "float" }, "days_since_last_played": { "description": "Number of days since the player last played this game. E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information.", "type": "integer", "format": "int32" }, "avg_session_length_minutes": { "format": "float", "type": "number", "description": "Average session length in minutes of the player. E.g., 1, 30, 60, ... . Not populated if there is not enough information." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#statsResponse`." }, "num_purchases": { "description": "Number of in-app purchases made by the player in this game. E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information.", "type": "integer", "format": "int32" }, "num_sessions": { "description": "The approximate number of sessions of the player within the last 28 days, where a session begins when the player is connected to Play Games Services and ends when they are disconnected. E.g., 0, 1, 5, 10, ... . Not populated if there is not enough information.", "type": "integer", "format": "int32" }, "churn_probability": { "format": "float", "type": "number", "description": "The probability of the player not returning to play the game in the next day. E.g., 0, 0.1, 0.5, ..., 1.0. Not populated if there is not enough information." }, "total_spend_next_28_days": { "format": "float", "description": "The predicted amount of money that the player going to spend in the next 28 days. E.g., 1, 30, 60, ... . Not populated if there is not enough information.", "type": "number" }, "spend_percentile": { "format": "float", "description": "The approximate spend percentile of the player in this game. E.g., 0, 0.25, 0.5, 0.75. Not populated if there is not enough information.", "type": "number" }, "num_sessions_percentile": { "format": "float", "type": "number", "description": "The approximation of the sessions percentile of the player within the last 30 days, where a session begins when the player is connected to Play Games Services and ends when they are disconnected. E.g., 0, 0.25, 0.5, 0.75. Not populated if there is not enough information." } } }, "EventBatchRecordFailure": { "id": "EventBatchRecordFailure", "description": "A batch update failure resource.", "type": "object", "properties": { "failureCause": { "description": "The cause for the update failure.", "type": "string", "enumDescriptions": [ "A batch request was issued with more events than are allowed in a single batch.", "A batch was sent with data too far in the past to record.", "A batch was sent with a time range that was too short.", "A batch was sent with a time range that was too long.", "An attempt was made to record a batch of data which was already seen.", "An attempt was made to record data faster than the server will apply updates." ], "enum": [ "TOO_LARGE", "TIME_PERIOD_EXPIRED", "TIME_PERIOD_SHORT", "TIME_PERIOD_LONG", "ALREADY_UPDATED", "RECORD_RATE_HIGH" ] }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventBatchRecordFailure`." }, "range": { "description": "The time range which was rejected; empty for a request-wide failure.", "$ref": "EventPeriodRange" } } }, "SnapshotListResponse": { "type": "object", "properties": { "items": { "type": "array", "description": "The snapshots.", "items": { "$ref": "Snapshot" } }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshotListResponse`.", "type": "string" }, "nextPageToken": { "description": "Token corresponding to the next page of results. If there are no more results, the token is omitted.", "type": "string" } }, "id": "SnapshotListResponse", "description": "A third party list snapshots response." }, "GeneratePlayGroupingApiTokenResponse": { "type": "object", "properties": { "token": { "description": "Token for accessing the Play Grouping API.", "$ref": "PlayGroupingApiToken" } }, "id": "GeneratePlayGroupingApiTokenResponse", "description": "Response for the GeneratePlayGroupingApiToken RPC." }, "LinkPersonaResponse": { "type": "object", "properties": { "state": { "readOnly": true, "enumDescriptions": [ "The link specified in the request was created.", "The link specified in the request was not created because already existing links would result in the new link violating the specified `RecallTokensCardinalityConstraint` if created." ], "enum": [ "LINK_CREATED", "PERSONA_OR_PLAYER_ALREADY_LINKED" ], "type": "string", "description": "Output only. State of a persona linking attempt." } }, "id": "LinkPersonaResponse", "description": "Outcome of a persona linking attempt." }, "PlayerScoreListResponse": { "id": "PlayerScoreListResponse", "description": "A list of score submission statuses.", "type": "object", "properties": { "submittedScores": { "type": "array", "description": "The score submissions statuses.", "items": { "$ref": "PlayerScoreResponse" } }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreListResponse`." } } }, "PlayerGameEvent": { "type": "object", "properties": { "eventName": { "type": "string", "description": "Required. Client-defined name of the event (e.g., \"run_completed\", \"level_up\"). Maximum length: 100 characters." }, "eventProperties": { "additionalProperties": { "$ref": "PropertyValue" }, "type": "object", "description": "Optional. Key-value properties providing details about the event. - Maximum number of properties: 25. - Property key maximum length: 100 characters. - String values within PropertyValue maximum length: 1024 characters." }, "eventTime": { "type": "string", "description": "Required. The time from the client when this specific event was performed.", "format": "google-datetime" }, "eventId": { "description": "Required. A unique client-generated UUID for this specific event instance. Used for server-side idempotency and deduplication. Submitting an event with a previously recorded event_id for the same player will be ignored.", "type": "string" } }, "id": "PlayerGameEvent", "description": "A representation of a single player game event triggered by a player's event in a game. This might be completing a level, unlocking an item, or finishing a match." }, "ResetPersonaResponse": { "id": "ResetPersonaResponse", "description": "Response for the ResetPersona RPC", "type": "object", "properties": { "unlinked": { "description": "Required. Whether any tokens were unlinked as a result of this request.", "type": "boolean" } } }, "EndPoint": { "id": "EndPoint", "description": "Container for a URL end point of the requested type.", "type": "object", "properties": { "url": { "description": "A URL suitable for loading in a web browser for the requested endpoint.", "type": "string" } } }, "AchievementDefinition": { "type": "object", "properties": { "name": { "description": "The name of the achievement.", "type": "string" }, "totalSteps": { "format": "int32", "type": "integer", "description": "The total steps for an incremental achievement." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementDefinition`." }, "unlockedIconUrl": { "type": "string", "description": "The image URL for the unlocked achievement icon." }, "isRevealedIconUrlDefault": { "type": "boolean", "description": "Indicates whether the revealed icon image being returned is a default image, or is provided by the game." }, "formattedTotalSteps": { "description": "The total steps for an incremental achievement as a string.", "type": "string" }, "revealedIconUrl": { "description": "The image URL for the revealed achievement icon.", "type": "string" }, "id": { "type": "string", "description": "The ID of the achievement." }, "description": { "description": "The description of the achievement.", "type": "string" }, "achievementType": { "enumDescriptions": [ "Achievement is either locked or unlocked.", "Achievement is incremental." ], "enum": [ "STANDARD", "INCREMENTAL" ], "description": "The type of the achievement.", "type": "string" }, "experiencePoints": { "description": "Experience points which will be earned when unlocking this achievement.", "type": "string", "format": "int64" }, "achievementLifecycleState": { "type": "string", "description": "Output only. The lifecycle state of the achievement.", "readOnly": true, "enumDescriptions": [ "Default value. Should not be used.", "The achievement is active and published, and can be earned by players.", "The achievement is archived. It cannot be earned by players, and is hidden from players who have not already unlocked it. from players who haven't unlocked it." ], "enum": [ "ACHIEVEMENT_LIFECYCLE_STATE_UNSPECIFIED", "ACHIEVEMENT_LIFECYCLE_STATE_ACTIVE", "ACHIEVEMENT_LIFECYCLE_STATE_ARCHIVED" ] }, "initialState": { "description": "The initial state of the achievement.", "type": "string", "enumDescriptions": [ "Achievement is hidden.", "Achievement is revealed.", "Achievement is unlocked." ], "enum": [ "HIDDEN", "REVEALED", "UNLOCKED" ] }, "isUnlockedIconUrlDefault": { "type": "boolean", "description": "Indicates whether the unlocked icon image being returned is a default image, or is game-provided." } }, "id": "AchievementDefinition", "description": "An achievement definition object." }, "GamePlayerToken": { "id": "GamePlayerToken", "description": "Recall tokens for a game.", "type": "object", "properties": { "recallToken": { "description": "Recall token data.", "$ref": "RecallToken" }, "applicationId": { "description": "The application that this player identifier is for.", "type": "string" } } }, "Leaderboard": { "id": "Leaderboard", "description": "The Leaderboard resource.", "type": "object", "properties": { "iconUrl": { "description": "The icon for the leaderboard.", "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboard`." }, "isIconUrlDefault": { "description": "Indicates whether the icon image being returned is a default image, or is game-provided.", "type": "boolean" }, "name": { "description": "The name of the leaderboard.", "type": "string" }, "order": { "enumDescriptions": [ "Larger values are better; scores are sorted in descending order", "Smaller values are better; scores are sorted in ascending order" ], "enum": [ "LARGER_IS_BETTER", "SMALLER_IS_BETTER" ], "type": "string", "description": "How scores are ordered." }, "id": { "type": "string", "description": "The leaderboard ID." } } }, "RetrievePlayerTokensResponse": { "id": "RetrievePlayerTokensResponse", "description": "Response for the RetrievePlayerTokens RPC", "type": "object", "properties": { "tokens": { "description": "Required. Recall tokens associated with the requested PGS Player principal", "items": { "$ref": "RecallToken" }, "type": "array" } } }, "AchievementIncrementResponse": { "id": "AchievementIncrementResponse", "description": "An achievement increment response", "type": "object", "properties": { "newlyUnlocked": { "type": "boolean", "description": "Whether the current steps for the achievement has reached the number of steps required to unlock." }, "currentSteps": { "type": "integer", "description": "The current steps recorded for this incremental achievement.", "format": "int32" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementIncrementResponse`.", "type": "string" } } }, "InstanceWebDetails": { "type": "object", "properties": { "launchUrl": { "description": "Launch URL for the game.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceWebDetails`.", "type": "string" }, "preferred": { "type": "boolean", "description": "Indicates that this instance is the default for new installations." } }, "id": "InstanceWebDetails", "description": "The Web details resource." }, "LeaderboardScores": { "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScores`." }, "items": { "description": "The scores in the leaderboard.", "items": { "$ref": "LeaderboardEntry" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results." }, "prevPageToken": { "type": "string", "description": "The pagination token for the previous page of results." }, "playerScore": { "description": "The score of the requesting player on the leaderboard. The player's score may appear both here and in the list of scores above. 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.", "$ref": "LeaderboardEntry" }, "numScores": { "description": "The total number of scores in the leaderboard.", "type": "string", "format": "int64" } }, "id": "LeaderboardScores", "description": "A ListScores response." }, "PropertyValue": { "type": "object", "properties": { "stringValue": { "type": "string", "description": "A string value." }, "intValue": { "format": "int64", "description": "An integer value.", "type": "string" }, "doubleValue": { "format": "double", "type": "number", "description": "A double value." }, "boolValue": { "description": "A boolean value.", "type": "boolean" }, "timestampValue": { "description": "A timestamp value.", "type": "string", "format": "google-datetime" }, "durationValue": { "format": "google-duration", "description": "A duration value.", "type": "string" } }, "id": "PropertyValue", "description": "Wrapper for the value." }, "ImageAsset": { "type": "object", "properties": { "height": { "type": "integer", "description": "The height of the asset.", "format": "int32" }, "url": { "type": "string", "description": "The URL of the asset." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#imageAsset`." }, "name": { "type": "string", "description": "The name of the asset." }, "width": { "format": "int32", "description": "The width of the asset.", "type": "integer" } }, "id": "ImageAsset", "description": "An image asset object." }, "GenerateRecallPlayGroupingApiTokenResponse": { "id": "GenerateRecallPlayGroupingApiTokenResponse", "description": "Response for the GenerateRecallPlayGroupingApiToken RPC.", "type": "object", "properties": { "token": { "description": "Token for accessing the Play Grouping API.", "$ref": "PlayGroupingApiToken" } } }, "EventUpdateResponse": { "id": "EventUpdateResponse", "description": "An event period update resource.", "type": "object", "properties": { "eventFailures": { "type": "array", "description": "Any failures updating a particular event.", "items": { "$ref": "EventRecordFailure" } }, "playerEvents": { "description": "The current status of any updated events", "items": { "$ref": "PlayerEvent" }, "type": "array" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateResponse`.", "type": "string" }, "batchFailures": { "description": "Any batch-wide failures which occurred applying updates.", "items": { "$ref": "EventBatchRecordFailure" }, "type": "array" } } }, "ApplicationPlayerId": { "type": "object", "properties": { "applicationId": { "type": "string", "description": "The application that this player identifier is for." }, "playerId": { "description": "The player identifier for the application.", "type": "string" } }, "id": "ApplicationPlayerId", "description": "Primary scoped player identifier for an application." }, "PlayerLevel": { "type": "object", "properties": { "minExperiencePoints": { "description": "The minimum experience points for this level.", "type": "string", "format": "int64" }, "level": { "format": "int32", "description": "The level for the user.", "type": "integer" }, "maxExperiencePoints": { "format": "int64", "type": "string", "description": "The maximum experience points for this level." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`." } }, "id": "PlayerLevel", "description": "1P/3P metadata about a user's level." }, "ScoreSubmission": { "type": "object", "properties": { "score": { "type": "string", "description": "The new score being submitted.", "format": "int64" }, "leaderboardId": { "description": "The leaderboard this score is being submitted to.", "type": "string" }, "scoreTag": { "type": "string", "description": "Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#scoreSubmission`." }, "signature": { "description": "Signature Values will contain URI-safe characters as defined by section 2.3 of RFC 3986.", "type": "string" } }, "id": "ScoreSubmission", "description": "A request to submit a score to leaderboards." }, "GamesAchievementIncrement": { "type": "object", "properties": { "steps": { "type": "integer", "description": "The number of steps to be incremented.", "format": "int32" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#GamesAchievementIncrement`.", "type": "string" }, "requestId": { "description": "The requestId associated with an increment to an achievement.", "type": "string", "format": "int64" } }, "id": "GamesAchievementIncrement", "description": "The payload to request to increment an achievement." }, "PlayerEvent": { "id": "PlayerEvent", "description": "An event status resource.", "type": "object", "properties": { "definitionId": { "type": "string", "description": "The ID of the event definition." }, "formattedNumEvents": { "description": "The current number of times this event has occurred, as a string. The formatting of this string depends on the configuration of your event in the Play Games Developer Console.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`.", "type": "string" }, "numEvents": { "description": "The current number of times this event has occurred.", "type": "string", "format": "int64" }, "playerId": { "description": "The ID of the player.", "type": "string" } } }, "MetagameConfig": { "type": "object", "properties": { "currentVersion": { "description": "Current version of the metagame configuration data. When this data is updated, the version number will be increased by one.", "type": "integer", "format": "int32" }, "playerLevels": { "type": "array", "description": "The list of player levels.", "items": { "$ref": "PlayerLevel" } }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#metagameConfig`." } }, "id": "MetagameConfig", "description": "The metagame config resource" }, "RecallToken": { "type": "object", "properties": { "expireTime": { "format": "google-datetime", "description": "Optional. Optional expiration time of the token", "type": "string" }, "token": { "description": "Required. Value of the Recall token as it is provided by the client via LinkPersona RPC", "type": "string" }, "multiPlayerPersona": { "description": "Required. Whether the persona identified by the token is linked to multiple PGS Players", "type": "boolean" } }, "id": "RecallToken", "description": "Recall token data returned from RetrievePlayerTokens RPC" }, "LeaderboardListResponse": { "id": "LeaderboardListResponse", "description": "A list of leaderboard objects.", "type": "object", "properties": { "items": { "type": "array", "description": "The leaderboards.", "items": { "$ref": "Leaderboard" } }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardListResponse`.", "type": "string" }, "nextPageToken": { "type": "string", "description": "Token corresponding to the next page of results." } } }, "UnlinkPersonaResponse": { "type": "object", "properties": { "unlinked": { "description": "Required. Whether a Recall token specified by the request was deleted. Can be 'false' when there were no Recall tokens satisfied the criteria from the request.", "type": "boolean" } }, "id": "UnlinkPersonaResponse", "description": "Response for the UnlinkPersona RPC" }, "AchievementSetStepsAtLeastResponse": { "id": "AchievementSetStepsAtLeastResponse", "description": "An achievement set steps at least response.", "type": "object", "properties": { "newlyUnlocked": { "description": "Whether the current steps for the achievement has reached the number of steps required to unlock.", "type": "boolean" }, "currentSteps": { "description": "The current steps recorded for this incremental achievement.", "type": "integer", "format": "int32" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementSetStepsAtLeastResponse`.", "type": "string" } } }, "EventDefinitionListResponse": { "id": "EventDefinitionListResponse", "description": "A ListDefinitions response.", "type": "object", "properties": { "items": { "type": "array", "description": "The event definitions.", "items": { "$ref": "EventDefinition" } }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinitionListResponse`." }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results." } } }, "BatchRecordEventsRequest": { "id": "BatchRecordEventsRequest", "description": "Request message for PlayerGameEvents.BatchRecordEvents Next ID: 7", "type": "object", "properties": { "packageName": { "description": "Required. Application package name (e.g., \"com.example.game\").", "type": "string" }, "requestTime": { "description": "Required. The time from the client when this specific batch of events was submitted.", "type": "string", "format": "google-datetime" }, "droidGuardBlob": { "description": "Optional. The DroidGuard blob generated by the client. This is used to detect abuse signals from the devices", "type": "string" }, "salt": { "type": "string", "description": "Optional. The salt used to generate content binding for the DroidGuard blob. This is used to prevent replay attacks." }, "events": { "type": "array", "description": "Required. A list of player game events to be recorded. Maximum of 30 events per batch request.", "items": { "$ref": "PlayerGameEvent" } } } }, "ScopedPlayerIds": { "type": "object", "properties": { "developerPlayerKey": { "description": "Identifier of the player across all games of the given developer. Every player has the same developer_player_key in all games of one developer. Developer player key changes for the game if the game is transferred to another developer. Note that game_player_id will stay unchanged.", "type": "string" }, "gamePlayerId": { "type": "string", "description": "Game-scoped player identifier. This is the same id that is returned in GetPlayer game_player_id field." } }, "id": "ScopedPlayerIds", "description": "Scoped player identifiers." }, "PlayerListResponse": { "id": "PlayerListResponse", "description": "A third party player list response.", "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerListResponse`." }, "nextPageToken": { "description": "Token corresponding to the next page of results.", "type": "string" }, "items": { "description": "The players.", "items": { "$ref": "Player" }, "type": "array" } } }, "RevisionCheckResponse": { "type": "object", "properties": { "revisionStatus": { "description": "The result of the revision check.", "type": "string", "enumDescriptions": [ "The revision being used is current.", "There is currently a newer version available, but the revision being used still works.", "The revision being used is not supported in any released version." ], "enum": [ "OK", "DEPRECATED", "INVALID" ] }, "apiVersion": { "type": "string", "description": "The version of the API this client revision should use when calling API methods." }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#revisionCheckResponse`.", "type": "string" } }, "id": "RevisionCheckResponse", "description": "A third party checking a revision response." }, "LeaderboardScoreRank": { "type": "object", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScoreRank`.", "type": "string" }, "formattedRank": { "description": "The rank in the leaderboard as a string.", "type": "string" }, "formattedNumScores": { "type": "string", "description": "The number of scores in the leaderboard as a string." }, "rank": { "format": "int64", "description": "The rank in the leaderboard.", "type": "string" }, "numScores": { "type": "string", "description": "The number of scores in the leaderboard.", "format": "int64" } }, "id": "LeaderboardScoreRank", "description": "A score rank in a leaderboard." }, "PlayerEventListResponse": { "id": "PlayerEventListResponse", "description": "A ListByPlayer response.", "type": "object", "properties": { "items": { "description": "The player events.", "items": { "$ref": "PlayerEvent" }, "type": "array" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEventListResponse`.", "type": "string" }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results." } } }, "CategoryListResponse": { "id": "CategoryListResponse", "description": "A third party list metagame categories response.", "type": "object", "properties": { "items": { "description": "The list of categories with usage data.", "items": { "$ref": "Category" }, "type": "array" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#categoryListResponse`.", "type": "string" }, "nextPageToken": { "type": "string", "description": "Token corresponding to the next page of results." } } }, "InstanceIosDetails": { "id": "InstanceIosDetails", "description": "The iOS details resource.", "type": "object", "properties": { "itunesAppId": { "description": "iTunes App ID.", "type": "string" }, "bundleIdentifier": { "type": "string", "description": "Bundle identifier." }, "supportIphone": { "type": "boolean", "description": "Flag to indicate if this instance supports iPhone." }, "supportIpad": { "description": "Flag to indicate if this instance supports iPad.", "type": "boolean" }, "preferredForIphone": { "type": "boolean", "description": "Indicates that this instance is the default for new installations on iPhone devices." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceIosDetails`." }, "preferredForIpad": { "description": "Indicates that this instance is the default for new installations on iPad devices.", "type": "boolean" } } }, "PlayerAchievementListResponse": { "type": "object", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievementListResponse`.", "type": "string" }, "nextPageToken": { "type": "string", "description": "Token corresponding to the next page of results." }, "items": { "description": "The achievements.", "items": { "$ref": "PlayerAchievement" }, "type": "array" } }, "id": "PlayerAchievementListResponse", "description": "A list of achievement objects." }, "AchievementUnlockResponse": { "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUnlockResponse`." }, "newlyUnlocked": { "description": "Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player).", "type": "boolean" } }, "id": "AchievementUnlockResponse", "description": "An achievement unlock response" }, "InstanceAndroidDetails": { "id": "InstanceAndroidDetails", "description": "The Android instance details resource.", "type": "object", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceAndroidDetails`.", "type": "string" }, "preferred": { "description": "Indicates that this instance is the default for new installations.", "type": "boolean" }, "packageName": { "type": "string", "description": "Android package name which maps to Google Play URL." }, "enablePiracyCheck": { "description": "Flag indicating whether the anti-piracy check is enabled.", "type": "boolean" } } }, "BatchRecordEventsResponse": { "id": "BatchRecordEventsResponse", "description": "A successful response indicates that the batch of events has been processed.", "type": "object", "properties": { "failedRequests": { "additionalProperties": { "$ref": "Status" }, "type": "object", "description": "Map of failed events, keyed by their zero-based index in `BatchRecordEventsRequest.events`. Omitted keys indicate successful recording." } } }, "GamesAchievementSetStepsAtLeast": { "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#GamesAchievementSetStepsAtLeast`." }, "steps": { "format": "int32", "description": "The minimum number of steps for the achievement to be set to.", "type": "integer" } }, "id": "GamesAchievementSetStepsAtLeast", "description": "The payload to request to increment an achievement." }, "PlayerScoreResponse": { "id": "PlayerScoreResponse", "description": "A list of leaderboard entry resources.", "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreResponse`." }, "formattedScore": { "type": "string", "description": "The formatted value of the submitted score." }, "scoreTag": { "description": "Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.", "type": "string" }, "leaderboardId": { "type": "string", "description": "The leaderboard ID that this score was submitted to." }, "unbeatenScores": { "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.", "items": { "$ref": "PlayerScore" }, "type": "array" }, "beatenScoreTimeSpans": { "type": "array", "description": "The time spans where the submitted score is better than the existing score for that time span.", "items": { "type": "string", "enumDescriptions": [ "The score is an all-time score.", "The score is a weekly score.", "The score is a daily score." ], "enum": [ "ALL_TIME", "WEEKLY", "DAILY" ] } } } }, "AchievementRevealResponse": { "id": "AchievementRevealResponse", "description": "An achievement reveal response", "type": "object", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementRevealResponse`.", "type": "string" }, "currentState": { "description": "The current state of the achievement for which a reveal was attempted. This might be `UNLOCKED` if the achievement was already unlocked.", "type": "string", "enumDescriptions": [ "Achievement is revealed.", "Achievement is unlocked." ], "enum": [ "REVEALED", "UNLOCKED" ] } } }, "PlayerScoreSubmissionList": { "type": "object", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreSubmissionList`.", "type": "string" }, "scores": { "description": "The score submissions.", "items": { "$ref": "ScoreSubmission" }, "type": "array" } }, "id": "PlayerScoreSubmissionList", "description": "A list of score submission requests." }, "Application": { "type": "object", "properties": { "category": { "description": "The category of the application.", "$ref": "ApplicationCategory" }, "achievement_count": { "format": "int32", "description": "The number of achievements visible to the currently authenticated player.", "type": "integer" }, "description": { "description": "The description of the application.", "type": "string" }, "enabledFeatures": { "type": "array", "description": "A list of features that have been enabled for the application.", "items": { "enumDescriptions": [ "Saved Games (snapshots)." ], "enum": [ "SNAPSHOTS" ], "type": "string" } }, "themeColor": { "type": "string", "description": "A hint to the client UI for what color to use as an app-themed color. The color is given as an RGB triplet (e.g. \"E0E0E0\")." }, "id": { "description": "The ID of the application.", "type": "string" }, "author": { "type": "string", "description": "The author of the application." }, "assets": { "type": "array", "description": "The assets of the application.", "items": { "$ref": "ImageAsset" } }, "instances": { "type": "array", "description": "The instances of the application.", "items": { "$ref": "Instance" } }, "lastUpdatedTimestamp": { "type": "string", "description": "The last updated timestamp of the application.", "format": "int64" }, "leaderboard_count": { "description": "The number of leaderboards visible to the currently authenticated player.", "type": "integer", "format": "int32" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#application`." }, "name": { "type": "string", "description": "The name of the application." } }, "id": "Application", "description": "The Application resource." }, "EventDefinition": { "id": "EventDefinition", "description": "An event definition resource.", "type": "object", "properties": { "visibility": { "type": "string", "description": "The visibility of event being tracked in this definition.", "enumDescriptions": [ "This event should be visible to all users.", "This event should only be shown to users that have recorded this event at least once." ], "enum": [ "REVEALED", "HIDDEN" ] }, "isDefaultImageUrl": { "description": "Indicates whether the icon image being returned is a default image, or is game-provided.", "type": "boolean" }, "description": { "description": "Description of what this event represents.", "type": "string" }, "imageUrl": { "type": "string", "description": "The base URL for the image that represents the event." }, "childEvents": { "description": "A list of events that are a child of this event.", "items": { "$ref": "EventChild" }, "type": "array" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinition`." }, "id": { "type": "string", "description": "The ID of the event." }, "displayName": { "description": "The name to display for the event.", "type": "string" } } }, "RetrieveGamesPlayerTokensResponse": { "id": "RetrieveGamesPlayerTokensResponse", "description": "A list of recall token data returned from the RetrieveGamesPlayerTokens RPC", "type": "object", "properties": { "gamePlayerTokens": { "type": "array", "description": "The requested applications along with the recall tokens for the player. If the player does not have recall tokens for an application, that application is not included in the response.", "items": { "$ref": "GamePlayerToken" } } } }, "ResetPersonaRequest": { "type": "object", "properties": { "persona": { "type": "string", "description": "Value of the 'persona' field as it was provided by the client in LinkPersona RPC" } }, "id": "ResetPersonaRequest", "description": "Request to remove all Recall tokens associated with a persona for an app." }, "ProfileSettings": { "id": "ProfileSettings", "description": "Profile settings", "type": "object", "properties": { "profileVisible": { "description": "Whether the player's profile is visible to the currently signed in player.", "type": "boolean" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`." }, "friendsListVisibility": { "enumDescriptions": [ "The friends list is currently visible to the game.", "The developer does not have access to the friends list, but can call the Android API to show a consent dialog.", "The friends list is currently unavailable for this user, and it is not possible to request access at this time, either because the user has permanently declined or the friends feature is not available to them. In this state, any attempts to request access to the friends list will be unsuccessful." ], "enum": [ "VISIBLE", "REQUEST_REQUIRED", "UNAVAILABLE" ], "type": "string" } } }, "ApplicationCategory": { "type": "object", "properties": { "primary": { "description": "The primary category.", "type": "string" }, "secondary": { "description": "The secondary category.", "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationCategory`." } }, "id": "ApplicationCategory", "description": "An application category object." }, "Category": { "id": "Category", "description": "Data related to individual game categories.", "type": "object", "properties": { "category": { "type": "string", "description": "The category name." }, "experiencePoints": { "type": "string", "description": "Experience points earned in this category.", "format": "int64" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#category`.", "type": "string" } } }, "EventPeriodUpdate": { "id": "EventPeriodUpdate", "description": "An event period update resource.", "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodUpdate`." }, "updates": { "description": "The updates being made for this time period.", "items": { "$ref": "EventUpdateRequest" }, "type": "array" }, "timePeriod": { "description": "The time period being covered by this update.", "$ref": "EventPeriodRange" } } }, "LinkPersonaRequest": { "id": "LinkPersonaRequest", "description": "Request to link an in-game account with a PGS principal (encoded in the session id).", "type": "object", "properties": { "ttl": { "format": "google-duration", "type": "string", "description": "Input only. Optional time-to-live." }, "cardinalityConstraint": { "enumDescriptions": [ "1:1 cardinality between in-game personas and Play Games Services players. By the end of the linking operation only one entry for the player and the persona should remain in the scope of the application. Whether a new link is created or not when this constraint is specified is determined by the chosen `ConflictingLinksResolutionPolicy`: * If `KEEP_EXISTING_LINKS` is specified and the provided persona is already linked to a different player, or the player is already linked to a different persona, no new link will be created and the already existing link(s) will remain as is(are). * If `CREATE_NEW_LINK` is specified and the provided persona is already linked to a different player, or the player is already linked to another persona, the older link(s) will be removed in favour of the new link being created." ], "enum": [ "ONE_PERSONA_TO_ONE_PLAYER" ], "description": "Required. Cardinality constraint to observe when linking a persona to a player in the scope of a game.", "type": "string" }, "expireTime": { "format": "google-datetime", "description": "Input only. Optional expiration time.", "type": "string" }, "token": { "type": "string", "description": "Required. Value of the token to create. Opaque to Play Games and assumed to be non-stable (encrypted with key rotation)." }, "conflictingLinksResolutionPolicy": { "enumDescriptions": [ "If link(s) between a player and persona already exists which would result in violating the specified `RecallTokensCardinalityConstraint` if the new link was created, keep the already existing link(s). For example, if Persona1-Player1 is already linked in the scope of application1 and a new link Persona1-Player2 is attempted to be created in the scope of application1, then the old link will remain and no new link will be added. Note that if the already existing links do violate the specified policy (which could occur if not all `LinkPersona` calls use the same `RecallTokensCardinalityConstraint`) this policy will leave these violations unresolved; in order to resolve conflicts, the {@link `CREATE_NEW_LINK` policy needs to be used to rewrite links resolving conflicts.", "If an existing link between a player and persona already exists which would result in violating the specified `RecallTokensCardinalityConstraint` if the new link was created, replace the already existing link(s) with the new link. For example, if Persona1-Player1 is already linked in the scope of application1 and a new link Persona1-Player2 is attempted to be created in the scope of application1, then the old link will be removed and the new link will be added to replace it." ], "enum": [ "KEEP_EXISTING_LINKS", "CREATE_NEW_LINK" ], "type": "string", "description": "Required. Resolution policy to apply when the linking of a persona to a player would result in violating the specified cardinality constraint." }, "sessionId": { "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.", "type": "string" }, "persona": { "description": "Required. Stable identifier of the in-game account. Please refrain from re-using the same persona for different games.", "type": "string" } } }, "EventRecordFailure": { "id": "EventRecordFailure", "description": "An event update failure resource.", "type": "object", "properties": { "eventId": { "type": "string", "description": "The ID of the event that was not updated." }, "failureCause": { "enumDescriptions": [ "An attempt was made to set an event that was not defined.", "An attempt was made to increment an event by a non-positive value." ], "enum": [ "NOT_FOUND", "INVALID_UPDATE_VALUE" ], "type": "string", "description": "The cause for the update failure." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordFailure`." } } }, "EventUpdateRequest": { "id": "EventUpdateRequest", "description": "An event period update resource.", "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateRequest`." }, "definitionId": { "description": "The ID of the event being modified in this update.", "type": "string" }, "updateCount": { "description": "The number of times this event occurred in this time period.", "type": "string", "format": "int64" } } }, "RetrieveDeveloperGamesLastPlayerTokenResponse": { "type": "object", "properties": { "gamePlayerToken": { "description": "The recall token associated with the requested PGS Player principal. It can be unset if there is no recall token associated with the requested principal.", "$ref": "GamePlayerToken" } }, "id": "RetrieveDeveloperGamesLastPlayerTokenResponse", "description": "Recall token data returned from for the RetrieveDeveloperGamesLastPlayerToken RPC" }, "EventPeriodRange": { "type": "object", "properties": { "periodStartMillis": { "format": "int64", "type": "string", "description": "The time when this update period begins, in millis, since 1970 UTC (Unix Epoch)." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodRange`." }, "periodEndMillis": { "format": "int64", "type": "string", "description": "The time when this update period ends, in millis, since 1970 UTC (Unix Epoch)." } }, "id": "EventPeriodRange", "description": "An event period time range." }, "PlayerLeaderboardScoreListResponse": { "id": "PlayerLeaderboardScoreListResponse", "description": "A list of player leaderboard scores.", "type": "object", "properties": { "items": { "type": "array", "description": "The leaderboard scores.", "items": { "$ref": "PlayerLeaderboardScore" } }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScoreListResponse`." }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results." }, "player": { "description": "The Player resources for the owner of this score.", "$ref": "Player" } } }, "PlayerLeaderboardScore": { "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScore`." }, "leaderboard_id": { "description": "The ID of the leaderboard this score is in.", "type": "string" }, "publicRank": { "description": "The public rank of the score in this leaderboard. This object will not be present if the user is not sharing their scores publicly.", "$ref": "LeaderboardScoreRank" }, "socialRank": { "description": "The social rank of the score in this leaderboard.", "$ref": "LeaderboardScoreRank" }, "scoreString": { "description": "The formatted value of this score.", "type": "string" }, "timeSpan": { "enumDescriptions": [ "The score is an all-time score.", "The score is a weekly score.", "The score is a daily score." ], "enum": [ "ALL_TIME", "WEEKLY", "DAILY" ], "type": "string", "description": "The time span of this score." }, "writeTimestamp": { "description": "The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.", "type": "string", "format": "int64" }, "scoreTag": { "description": "Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.", "type": "string" }, "scoreValue": { "description": "The numerical value of this score.", "type": "string", "format": "int64" }, "friendsRank": { "description": "The rank of the score in the friends collection for this leaderboard.", "$ref": "LeaderboardScoreRank" } }, "id": "PlayerLeaderboardScore", "description": "A player leaderboard score object." } }, "kind": "discovery#restDescription" }