{ "batchPath": "batch", "ownerName": "Google", "id": "games:v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "description": "The Google Play Games Service allows developers to enhance games with social leaderboards, achievements, game state, sign-in with Google, and more.", "fullyEncodeReservedExpansion": true, "revision": "20260820", "resources": { "revisions": { "methods": { "check": { "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "clientRevision": { "type": "string", "location": "query", "required": true, "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." } }, "id": "games.revisions.check", "flatPath": "games/v1/revisions/check", "path": "games/v1/revisions/check", "description": "Checks whether the games client is out of date.", "response": { "$ref": "RevisionCheckResponse" }, "httpMethod": "GET", "parameterOrder": [ "clientRevision" ] } } }, "applications": { "methods": { "played": { "description": "Indicate that the currently authenticated user is playing your application.", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameterOrder": [], "flatPath": "games/v1/applications/played", "httpMethod": "POST", "path": "games/v1/applications/played", "id": "games.applications.played", "parameters": {} }, "getEndPoint": { "httpMethod": "POST", "id": "games.applications.getEndPoint", "description": "Returns a URL for the requested end point type.", "parameterOrder": [], "parameters": { "applicationId": { "description": "The application ID from the Google Play developer console.", "type": "string", "location": "query" }, "endPointType": { "description": "Type of endpoint being requested.", "enum": [ "PROFILE_CREATION", "PROFILE_SETTINGS" ], "type": "string", "enumDescriptions": [ "Request a URL to create a new profile.", "Request a URL for the Settings view." ], "location": "query" } }, "path": "games/v1/applications/getEndPoint", "response": { "$ref": "EndPoint" }, "scopes": [ "https://www.googleapis.com/auth/games" ], "flatPath": "games/v1/applications/getEndPoint" }, "get": { "response": { "$ref": "Application" }, "parameterOrder": [ "applicationId" ], "httpMethod": "GET", "path": "games/v1/applications/{applicationId}", "id": "games.applications.get", "flatPath": "games/v1/applications/{applicationId}", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "platformType": { "location": "query", "type": "string", "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" ], "description": "Restrict application details returned to the specific platform." }, "applicationId": { "type": "string", "description": "The application ID from the Google Play developer console.", "location": "path", "required": true }, "language": { "location": "query", "description": "The preferred language to use for strings returned by this method.", "type": "string" } }, "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." }, "verify": { "parameters": { "applicationId": { "description": "The application ID from the Google Play developer console.", "type": "string", "location": "path", "required": true } }, "id": "games.applications.verify", "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/applications/{applicationId}/verify", "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.", "response": { "$ref": "ApplicationVerifyResponse" }, "parameterOrder": [ "applicationId" ], "httpMethod": "GET", "flatPath": "games/v1/applications/{applicationId}/verify" } } }, "stats": { "methods": { "get": { "flatPath": "games/v1/stats", "response": { "$ref": "StatsResponse" }, "parameters": {}, "parameterOrder": [], "id": "games.stats.get", "path": "games/v1/stats", "description": "Returns engagement and spend statistics in this application for the currently authenticated user.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/games" ] } } }, "snapshots": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/games" ], "httpMethod": "GET", "id": "games.snapshots.get", "description": "Retrieves the metadata for a given snapshot ID.", "path": "games/v1/snapshots/{snapshotId}", "parameterOrder": [ "snapshotId" ], "flatPath": "games/v1/snapshots/{snapshotId}", "parameters": { "snapshotId": { "description": "The ID of the snapshot.", "type": "string", "location": "path", "required": true }, "language": { "type": "string", "description": "The preferred language to use for strings returned by this method.", "location": "query" } }, "response": { "$ref": "Snapshot" } }, "list": { "flatPath": "games/v1/players/{playerId}/snapshots", "id": "games.snapshots.list", "httpMethod": "GET", "description": "Retrieves a list of snapshots created by your application for the player corresponding to the player ID.", "response": { "$ref": "SnapshotListResponse" }, "scopes": [ "https://www.googleapis.com/auth/drive.appdata", "https://www.googleapis.com/auth/games" ], "path": "games/v1/players/{playerId}/snapshots", "parameterOrder": [ "playerId" ], "parameters": { "playerId": { "type": "string", "description": "A player ID. A value of `me` may be used in place of the authenticated player's ID.", "location": "path", "required": true }, "language": { "location": "query", "description": "The preferred language to use for strings returned by this method.", "type": "string" }, "maxResults": { "type": "integer", "format": "int32", "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`.", "location": "query" }, "pageToken": { "description": "The token returned by the previous request.", "location": "query", "type": "string" } } } } }, "achievementDefinitions": { "methods": { "list": { "response": { "$ref": "AchievementDefinitionsListResponse" }, "path": "games/v1/achievements", "scopes": [ "https://www.googleapis.com/auth/games" ], "httpMethod": "GET", "flatPath": "games/v1/achievements", "parameterOrder": [], "id": "games.achievementDefinitions.list", "parameters": { "maxResults": { "type": "integer", "format": "int32", "location": "query", "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`." }, "language": { "location": "query", "type": "string", "description": "The preferred language to use for strings returned by this method." }, "pageToken": { "type": "string", "description": "The token returned by the previous request.", "location": "query" } }, "description": "Lists all the achievement definitions for your application." } } }, "gameStats": { "methods": { "batchRecordEvents": { "path": "games/v1/players/{playerId}/gameStats:batchRecordEvents", "request": { "$ref": "BatchRecordEventsRequest" }, "parameters": { "playerId": { "location": "path", "required": true, "type": "string", "description": "Required. The player ID of the player that performed the events." } }, "id": "games.gameStats.batchRecordEvents", "scopes": [ "https://www.googleapis.com/auth/games" ], "httpMethod": "POST", "parameterOrder": [ "playerId" ], "description": "Records a batch of player game events for a specific player. This method allows sending multiple events in a single request.", "flatPath": "games/v1/players/{playerId}/gameStats:batchRecordEvents", "response": { "$ref": "BatchRecordEventsResponse" } } } }, "accesstokens": { "methods": { "generatePlayGroupingApiToken": { "parameters": { "packageName": { "description": "Required. App package name to generate the token for (e.g. com.example.mygame).", "location": "query", "type": "string" }, "persona": { "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.", "location": "query" } }, "description": "Generates a Play Grouping API token for the PGS user identified by the attached credential.", "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/accesstokens/generatePlayGroupingApiToken", "parameterOrder": [], "id": "games.accesstokens.generatePlayGroupingApiToken", "response": { "$ref": "GeneratePlayGroupingApiTokenResponse" }, "httpMethod": "POST", "flatPath": "games/v1/accesstokens/generatePlayGroupingApiToken" }, "generateRecallPlayGroupingApiToken": { "id": "games.accesstokens.generateRecallPlayGroupingApiToken", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST", "path": "games/v1/accesstokens/generateRecallPlayGroupingApiToken", "parameterOrder": [], "response": { "$ref": "GenerateRecallPlayGroupingApiTokenResponse" }, "parameters": { "persona": { "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.", "location": "query" }, "packageName": { "description": "Required. App package name to generate the token for (e.g. com.example.mygame).", "type": "string", "location": "query" }, "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" } }, "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" } } }, "metagame": { "methods": { "getMetagameConfig": { "httpMethod": "GET", "id": "games.metagame.getMetagameConfig", "response": { "$ref": "MetagameConfig" }, "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/metagameConfig", "flatPath": "games/v1/metagameConfig", "description": "Return the metagame configuration data for the calling application.", "parameterOrder": [], "parameters": {} }, "listCategoriesByPlayer": { "response": { "$ref": "CategoryListResponse" }, "id": "games.metagame.listCategoriesByPlayer", "scopes": [ "https://www.googleapis.com/auth/games" ], "flatPath": "games/v1/players/{playerId}/categories/{collection}", "httpMethod": "GET", "path": "games/v1/players/{playerId}/categories/{collection}", "parameterOrder": [ "playerId", "collection" ], "parameters": { "collection": { "description": "The collection of categories for which data will be returned.", "enumDescriptions": [ "Retrieve data for all categories. This is the default." ], "type": "string", "location": "path", "required": true, "enum": [ "ALL" ] }, "language": { "location": "query", "type": "string", "description": "The preferred language to use for strings returned by this method." }, "pageToken": { "location": "query", "type": "string", "description": "The token returned by the previous request." }, "maxResults": { "type": "integer", "location": "query", "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`.", "format": "int32" }, "playerId": { "description": "A player ID. A value of `me` may be used in place of the authenticated player's ID.", "location": "path", "required": true, "type": "string" } }, "description": "List play data aggregated per category for the player corresponding to `playerId`." } } }, "achievements": { "methods": { "updateMultiple": { "response": { "$ref": "AchievementUpdateMultipleResponse" }, "description": "Updates multiple achievements for the currently authenticated player.", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/games" ], "flatPath": "games/v1/achievements/updateMultiple", "parameterOrder": [], "parameters": {}, "path": "games/v1/achievements/updateMultiple", "id": "games.achievements.updateMultiple", "request": { "$ref": "AchievementUpdateMultipleRequest" } }, "reveal": { "httpMethod": "POST", "path": "games/v1/achievements/{achievementId}/reveal", "id": "games.achievements.reveal", "response": { "$ref": "AchievementRevealResponse" }, "parameterOrder": [ "achievementId" ], "parameters": { "achievementId": { "description": "The ID of the achievement used by this method.", "type": "string", "location": "path", "required": true } }, "description": "Sets the state of the achievement with the given ID to `REVEALED` for the currently authenticated player.", "flatPath": "games/v1/achievements/{achievementId}/reveal", "scopes": [ "https://www.googleapis.com/auth/games" ] }, "setStepsAtLeast": { "parameterOrder": [ "achievementId", "steps" ], "scopes": [ "https://www.googleapis.com/auth/games" ], "httpMethod": "POST", "path": "games/v1/achievements/{achievementId}/setStepsAtLeast", "id": "games.achievements.setStepsAtLeast", "response": { "$ref": "AchievementSetStepsAtLeastResponse" }, "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.", "flatPath": "games/v1/achievements/{achievementId}/setStepsAtLeast", "parameters": { "steps": { "type": "integer", "location": "query", "required": true, "format": "int32", "description": "Required. The minimum value to set the steps to." }, "achievementId": { "type": "string", "location": "path", "required": true, "description": "The ID of the achievement used by this method." } } }, "list": { "httpMethod": "GET", "path": "games/v1/players/{playerId}/achievements", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameterOrder": [ "playerId" ], "description": "Lists the progress for all your application's achievements for the currently authenticated player.", "flatPath": "games/v1/players/{playerId}/achievements", "parameters": { "playerId": { "location": "path", "required": true, "type": "string", "description": "A player ID. A value of `me` may be used in place of the authenticated player's ID." }, "maxResults": { "type": "integer", "location": "query", "format": "int32", "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`." }, "language": { "location": "query", "type": "string", "description": "The preferred language to use for strings returned by this method." }, "state": { "type": "string", "enum": [ "ALL", "HIDDEN", "REVEALED", "UNLOCKED" ], "enumDescriptions": [ "List all achievements. This is the default.", "List only hidden achievements.", "List only revealed achievements.", "List only unlocked achievements." ], "location": "query", "description": "Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned." }, "pageToken": { "type": "string", "location": "query", "description": "The token returned by the previous request." } }, "response": { "$ref": "PlayerAchievementListResponse" }, "id": "games.achievements.list" }, "increment": { "flatPath": "games/v1/achievements/{achievementId}/increment", "response": { "$ref": "AchievementIncrementResponse" }, "parameters": { "achievementId": { "type": "string", "description": "The ID of the achievement used by this method.", "location": "path", "required": true }, "stepsToIncrement": { "format": "int32", "location": "query", "required": true, "description": "Required. The number of steps to increment.", "type": "integer" }, "requestId": { "format": "int64", "location": "query", "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" } }, "path": "games/v1/achievements/{achievementId}/increment", "id": "games.achievements.increment", "description": "Increments the steps of the achievement with the given ID for the currently authenticated player.", "parameterOrder": [ "achievementId", "stepsToIncrement" ], "scopes": [ "https://www.googleapis.com/auth/games" ], "httpMethod": "POST" }, "unlock": { "path": "games/v1/achievements/{achievementId}/unlock", "flatPath": "games/v1/achievements/{achievementId}/unlock", "httpMethod": "POST", "response": { "$ref": "AchievementUnlockResponse" }, "parameterOrder": [ "achievementId" ], "description": "Unlocks this achievement for the currently authenticated player.", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.achievements.unlock", "parameters": { "achievementId": { "description": "The ID of the achievement used by this method.", "type": "string", "location": "path", "required": true } } } } }, "scores": { "methods": { "submit": { "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.scores.submit", "parameters": { "scoreTag": { "location": "query", "type": "string", "description": "Additional information about the score you're submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.", "pattern": "[a-zA-Z0-9-._~]{0,64}" }, "language": { "type": "string", "location": "query", "description": "The preferred language to use for strings returned by this method." }, "score": { "format": "int64", "type": "string", "description": "Required. The score you're submitting. The submitted score is ignored if it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units.", "location": "query", "required": true }, "leaderboardId": { "description": "The ID of the leaderboard.", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "PlayerScoreResponse" }, "httpMethod": "POST", "flatPath": "games/v1/leaderboards/{leaderboardId}/scores", "path": "games/v1/leaderboards/{leaderboardId}/scores", "parameterOrder": [ "leaderboardId", "score" ], "description": "Submits a score to the specified leaderboard." }, "get": { "parameters": { "leaderboardId": { "location": "path", "required": true, "type": "string", "description": "The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application." }, "includeRankType": { "location": "query", "type": "string", "enumDeprecated": [ false, false, true, false ], "description": "The types of ranks to return. If the parameter is omitted, no ranks will be returned.", "enum": [ "ALL", "PUBLIC", "SOCIAL", "FRIENDS" ], "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." ] }, "timeSpan": { "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." ], "location": "path", "required": true, "description": "The time span for the scores and ranks you're requesting.", "enum": [ "ALL", "ALL_TIME", "WEEKLY", "DAILY" ], "type": "string" }, "language": { "type": "string", "location": "query", "description": "The preferred language to use for strings returned by this method." }, "maxResults": { "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", "location": "query", "format": "int32" }, "playerId": { "description": "A player ID. A value of `me` may be used in place of the authenticated player's ID.", "location": "path", "required": true, "type": "string" }, "pageToken": { "location": "query", "description": "The token returned by the previous request.", "type": "string" } }, "httpMethod": "GET", "id": "games.scores.get", "flatPath": "games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}", "parameterOrder": [ "playerId", "leaderboardId", "timeSpan" ], "path": "games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}", "response": { "$ref": "PlayerLeaderboardScoreListResponse" }, "scopes": [ "https://www.googleapis.com/auth/games" ], "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'." }, "listWindow": { "parameterOrder": [ "leaderboardId", "collection", "timeSpan" ], "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.scores.listWindow", "httpMethod": "GET", "response": { "$ref": "LeaderboardScores" }, "path": "games/v1/leaderboards/{leaderboardId}/window/{collection}", "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The token returned by the previous request." }, "timeSpan": { "description": "Required. The time span for the scores and ranks you're requesting.", "location": "query", "required": true, "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" }, "resultsAbove": { "type": "integer", "location": "query", "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" }, "maxResults": { "format": "int32", "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`.", "location": "query" }, "language": { "location": "query", "type": "string", "description": "The preferred language to use for strings returned by this method." }, "leaderboardId": { "location": "path", "required": true, "type": "string", "description": "The ID of the leaderboard." }, "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" }, "collection": { "location": "path", "required": true, "enumDescriptions": [ "List all scores in the public leaderboard.", "(Obsolete) Legacy G+ social scores.", "List only scores of friends." ], "description": "The collection of scores you're requesting.", "enumDeprecated": [ false, true, false ], "enum": [ "PUBLIC", "SOCIAL", "FRIENDS" ], "type": "string" } }, "description": "Lists the scores in a leaderboard around (and including) a player's score.", "flatPath": "games/v1/leaderboards/{leaderboardId}/window/{collection}" }, "submitMultiple": { "scopes": [ "https://www.googleapis.com/auth/games" ], "response": { "$ref": "PlayerScoreListResponse" }, "parameterOrder": [], "path": "games/v1/leaderboards/scores", "httpMethod": "POST", "flatPath": "games/v1/leaderboards/scores", "description": "Submits multiple scores to leaderboards.", "request": { "$ref": "PlayerScoreSubmissionList" }, "id": "games.scores.submitMultiple", "parameters": { "language": { "description": "The preferred language to use for strings returned by this method.", "location": "query", "type": "string" } } }, "list": { "httpMethod": "GET", "path": "games/v1/leaderboards/{leaderboardId}/scores/{collection}", "id": "games.scores.list", "description": "Lists the scores in a leaderboard, starting from the top.", "flatPath": "games/v1/leaderboards/{leaderboardId}/scores/{collection}", "scopes": [ "https://www.googleapis.com/auth/games" ], "parameters": { "language": { "description": "The preferred language to use for strings returned by this method.", "location": "query", "type": "string" }, "maxResults": { "type": "integer", "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`." }, "pageToken": { "location": "query", "description": "The token returned by the previous request.", "type": "string" }, "timeSpan": { "type": "string", "location": "query", "required": true, "enum": [ "ALL_TIME", "WEEKLY", "DAILY" ], "description": "Required. The time span for the scores and ranks you're requesting.", "enumDescriptions": [ "The score is an all-time score.", "The score is a weekly score.", "The score is a daily score." ] }, "leaderboardId": { "location": "path", "required": true, "type": "string", "description": "The ID of the leaderboard." }, "collection": { "enumDescriptions": [ "List all scores in the public leaderboard.", "(Obsolete) Legacy G+ social scores.", "List only scores of friends." ], "type": "string", "enumDeprecated": [ false, true, false ], "location": "path", "required": true, "description": "The collection of scores you're requesting.", "enum": [ "PUBLIC", "SOCIAL", "FRIENDS" ] } }, "parameterOrder": [ "leaderboardId", "collection", "timeSpan" ], "response": { "$ref": "LeaderboardScores" } } } }, "recall": { "methods": { "unlinkPersona": { "id": "games.recall.unlinkPersona", "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.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "httpMethod": "POST", "response": { "$ref": "UnlinkPersonaResponse" }, "path": "games/v1/recall:unlinkPersona", "parameterOrder": [], "flatPath": "games/v1/recall:unlinkPersona", "request": { "$ref": "UnlinkPersonaRequest" }, "parameters": {} }, "linkPersona": { "path": "games/v1/recall:linkPersona", "parameters": {}, "response": { "$ref": "LinkPersonaResponse" }, "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "flatPath": "games/v1/recall:linkPersona", "description": "Associate the PGS Player principal encoded in the provided recall session id with an in-game account", "request": { "$ref": "LinkPersonaRequest" }, "httpMethod": "POST", "id": "games.recall.linkPersona" }, "resetPersona": { "description": "Delete all Recall tokens linking the given persona to any player (with or without a profile).", "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "games.recall.resetPersona", "response": { "$ref": "ResetPersonaResponse" }, "httpMethod": "POST", "parameterOrder": [], "request": { "$ref": "ResetPersonaRequest" }, "path": "games/v1/recall:resetPersona", "flatPath": "games/v1/recall:resetPersona" }, "retrieveTokens": { "parameterOrder": [ "sessionId" ], "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.", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "parameters": { "sessionId": { "type": "string", "location": "path", "required": true, "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application." } }, "response": { "$ref": "RetrievePlayerTokensResponse" }, "path": "games/v1/recall/tokens/{sessionId}", "id": "games.recall.retrieveTokens", "flatPath": "games/v1/recall/tokens/{sessionId}" }, "gamesPlayerTokens": { "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "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.", "parameters": { "applicationIds": { "description": "Required. The application IDs from the Google Play developer console for the games to return scoped ids for.", "type": "string", "location": "query", "repeated": true }, "sessionId": { "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.", "location": "path", "required": true, "type": "string" } }, "path": "games/v1/recall/gamesPlayerTokens/{sessionId}", "parameterOrder": [ "sessionId" ], "httpMethod": "GET", "response": { "$ref": "RetrieveGamesPlayerTokensResponse" }, "flatPath": "games/v1/recall/gamesPlayerTokens/{sessionId}", "id": "games.recall.gamesPlayerTokens" }, "lastTokenFromAllDeveloperGames": { "flatPath": "games/v1/recall/developerGamesLastPlayerToken/{sessionId}", "parameterOrder": [ "sessionId" ], "response": { "$ref": "RetrieveDeveloperGamesLastPlayerTokenResponse" }, "httpMethod": "GET", "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.", "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ], "id": "games.recall.lastTokenFromAllDeveloperGames", "path": "games/v1/recall/developerGamesLastPlayerToken/{sessionId}", "parameters": { "sessionId": { "type": "string", "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.", "location": "path", "required": true } } } } }, "players": { "methods": { "getMultipleApplicationPlayerIds": { "parameterOrder": [], "id": "games.players.getMultipleApplicationPlayerIds", "httpMethod": "GET", "description": "Get the application player ids for the currently authenticated player across all requested games by the same developer as the calling application. This will only return ids for players that actually have an id (scoped or otherwise) with that game.", "response": { "$ref": "GetMultipleApplicationPlayerIdsResponse" }, "flatPath": "games/v1/players/me/multipleApplicationPlayerIds", "path": "games/v1/players/me/multipleApplicationPlayerIds", "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" } }, "scopes": [ "https://www.googleapis.com/auth/games" ] }, "getScopedPlayerIds": { "path": "games/v1/players/me/scopedIds", "flatPath": "games/v1/players/me/scopedIds", "id": "games.players.getScopedPlayerIds", "parameters": {}, "description": "Retrieves scoped player identifiers for currently authenticated user.", "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/games" ], "response": { "$ref": "ScopedPlayerIds" }, "httpMethod": "GET" }, "get": { "response": { "$ref": "Player" }, "flatPath": "games/v1/players/{playerId}", "httpMethod": "GET", "description": "Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set `playerId` to `me`.", "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/players/{playerId}", "parameterOrder": [ "playerId" ], "id": "games.players.get", "parameters": { "playerId": { "location": "path", "required": true, "description": "A player ID. A value of `me` may be used in place of the authenticated player's ID.", "type": "string" }, "language": { "description": "The preferred language to use for strings returned by this method.", "location": "query", "type": "string" }, "playerIdConsistencyToken": { "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", "location": "query" } } }, "list": { "description": "Get the collection of players for the currently authenticated user.", "flatPath": "games/v1/players/me/players/{collection}", "httpMethod": "GET", "response": { "$ref": "PlayerListResponse" }, "path": "games/v1/players/me/players/{collection}", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.players.list", "parameters": { "pageToken": { "location": "query", "description": "The token returned by the previous request.", "type": "string" }, "collection": { "description": "Collection of players being retrieved", "location": "path", "required": true, "enum": [ "CONNECTED", "VISIBLE", "FRIENDS_ALL" ], "enumDeprecated": [ true, true, false ], "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." ], "type": "string" }, "maxResults": { "type": "integer", "format": "int32", "location": "query", "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`." }, "language": { "type": "string", "location": "query", "description": "The preferred language to use for strings returned by this method." } }, "parameterOrder": [ "collection" ] } } }, "events": { "methods": { "listByPlayer": { "id": "games.events.listByPlayer", "path": "games/v1/events", "parameters": { "language": { "location": "query", "type": "string", "description": "The preferred language to use for strings returned by this method." }, "pageToken": { "description": "The token returned by the previous request.", "location": "query", "type": "string" }, "maxResults": { "location": "query", "type": "integer", "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.", "format": "int32" } }, "scopes": [ "https://www.googleapis.com/auth/games" ], "flatPath": "games/v1/events", "httpMethod": "GET", "parameterOrder": [], "description": "Returns a list showing the current progress on events in this application for the currently authenticated user.", "response": { "$ref": "PlayerEventListResponse" } }, "record": { "path": "games/v1/events", "httpMethod": "POST", "parameterOrder": [], "scopes": [ "https://www.googleapis.com/auth/games" ], "request": { "$ref": "EventRecordRequest" }, "parameters": { "language": { "type": "string", "location": "query", "description": "The preferred language to use for strings returned by this method." } }, "response": { "$ref": "EventUpdateResponse" }, "id": "games.events.record", "description": "Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.", "flatPath": "games/v1/events" }, "listDefinitions": { "flatPath": "games/v1/eventDefinitions", "parameters": { "pageToken": { "description": "The token returned by the previous request.", "type": "string", "location": "query" }, "maxResults": { "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`.", "location": "query", "type": "integer", "format": "int32" }, "language": { "type": "string", "location": "query", "description": "The preferred language to use for strings returned by this method." } }, "response": { "$ref": "EventDefinitionListResponse" }, "scopes": [ "https://www.googleapis.com/auth/games" ], "path": "games/v1/eventDefinitions", "description": "Returns a list of the event definitions in this application.", "httpMethod": "GET", "parameterOrder": [], "id": "games.events.listDefinitions" } } }, "leaderboards": { "methods": { "list": { "httpMethod": "GET", "description": "Lists all the leaderboard metadata for your application.", "scopes": [ "https://www.googleapis.com/auth/games" ], "id": "games.leaderboards.list", "parameterOrder": [], "path": "games/v1/leaderboards", "parameters": { "maxResults": { "location": "query", "type": "integer", "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`.", "format": "int32" }, "language": { "description": "The preferred language to use for strings returned by this method.", "location": "query", "type": "string" }, "pageToken": { "description": "The token returned by the previous request.", "type": "string", "location": "query" } }, "response": { "$ref": "LeaderboardListResponse" }, "flatPath": "games/v1/leaderboards" }, "get": { "description": "Retrieves the metadata of the leaderboard with the given ID.", "parameters": { "leaderboardId": { "type": "string", "description": "The ID of the leaderboard.", "location": "path", "required": true }, "language": { "location": "query", "description": "The preferred language to use for strings returned by this method.", "type": "string" } }, "path": "games/v1/leaderboards/{leaderboardId}", "scopes": [ "https://www.googleapis.com/auth/games" ], "response": { "$ref": "Leaderboard" }, "httpMethod": "GET", "id": "games.leaderboards.get", "parameterOrder": [ "leaderboardId" ], "flatPath": "games/v1/leaderboards/{leaderboardId}" } } } }, "kind": "discovery#restDescription", "schemas": { "AchievementUpdateRequest": { "type": "object", "properties": { "updateType": { "enum": [ "REVEAL", "UNLOCK", "INCREMENT", "SET_STEPS_AT_LEAST" ], "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." ], "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateRequest`." }, "setStepsAtLeastPayload": { "description": "The payload if an update of type `SET_STEPS_AT_LEAST` was requested for the achievement.", "$ref": "GamesAchievementSetStepsAtLeast" }, "incrementPayload": { "description": "The payload if an update of type `INCREMENT` was requested for the achievement.", "$ref": "GamesAchievementIncrement" }, "achievementId": { "description": "The achievement this update is being applied to.", "type": "string" } }, "description": "A request to update an achievement.", "id": "AchievementUpdateRequest" }, "AchievementDefinition": { "description": "An achievement definition object.", "properties": { "achievementLifecycleState": { "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." ], "description": "Output only. The lifecycle state of the achievement.", "type": "string", "enum": [ "ACHIEVEMENT_LIFECYCLE_STATE_UNSPECIFIED", "ACHIEVEMENT_LIFECYCLE_STATE_ACTIVE", "ACHIEVEMENT_LIFECYCLE_STATE_ARCHIVED" ] }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementDefinition`." }, "name": { "description": "The name of the achievement.", "type": "string" }, "formattedTotalSteps": { "description": "The total steps for an incremental achievement as a string.", "type": "string" }, "achievementType": { "type": "string", "description": "The type of the achievement.", "enumDescriptions": [ "Achievement is either locked or unlocked.", "Achievement is incremental." ], "enum": [ "STANDARD", "INCREMENTAL" ] }, "isUnlockedIconUrlDefault": { "description": "Indicates whether the unlocked icon image being returned is a default image, or is game-provided.", "type": "boolean" }, "experiencePoints": { "type": "string", "description": "Experience points which will be earned when unlocking this achievement.", "format": "int64" }, "totalSteps": { "description": "The total steps for an incremental achievement.", "type": "integer", "format": "int32" }, "revealedIconUrl": { "type": "string", "description": "The image URL for the revealed achievement icon." }, "isRevealedIconUrlDefault": { "description": "Indicates whether the revealed icon image being returned is a default image, or is provided by the game.", "type": "boolean" }, "id": { "type": "string", "description": "The ID of the achievement." }, "description": { "description": "The description of the achievement.", "type": "string" }, "unlockedIconUrl": { "type": "string", "description": "The image URL for the unlocked achievement icon." }, "initialState": { "type": "string", "enum": [ "HIDDEN", "REVEALED", "UNLOCKED" ], "description": "The initial state of the achievement.", "enumDescriptions": [ "Achievement is hidden.", "Achievement is revealed.", "Achievement is unlocked." ] } }, "id": "AchievementDefinition", "type": "object" }, "AchievementUpdateMultipleRequest": { "description": "A list of achievement update requests.", "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.", "type": "array", "items": { "$ref": "AchievementUpdateRequest" } } }, "id": "AchievementUpdateMultipleRequest", "type": "object" }, "UnlinkPersonaResponse": { "type": "object", "id": "UnlinkPersonaResponse", "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" } }, "description": "Response for the UnlinkPersona RPC" }, "LeaderboardScoreRank": { "id": "LeaderboardScoreRank", "properties": { "rank": { "format": "int64", "description": "The rank in the leaderboard.", "type": "string" }, "formattedNumScores": { "description": "The number of scores in the leaderboard as a string.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScoreRank`.", "type": "string" }, "formattedRank": { "type": "string", "description": "The rank in the leaderboard as a string." }, "numScores": { "description": "The number of scores in the leaderboard.", "type": "string", "format": "int64" } }, "description": "A score rank in a leaderboard.", "type": "object" }, "ImageAsset": { "description": "An image asset object.", "properties": { "url": { "type": "string", "description": "The URL of the asset." }, "name": { "description": "The name of the asset.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#imageAsset`.", "type": "string" }, "width": { "description": "The width of the asset.", "format": "int32", "type": "integer" }, "height": { "description": "The height of the asset.", "format": "int32", "type": "integer" } }, "type": "object", "id": "ImageAsset" }, "EventRecordRequest": { "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordRequest`.", "type": "string" }, "timePeriods": { "type": "array", "description": "A list of the time period updates being made in this request.", "items": { "$ref": "EventPeriodUpdate" } }, "requestId": { "description": "The request ID used to identify this attempt to record events.", "type": "string", "format": "int64" }, "currentTimeMillis": { "type": "string", "description": "The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch).", "format": "int64" } }, "description": "An event period update resource.", "type": "object", "id": "EventRecordRequest" }, "LeaderboardEntry": { "properties": { "formattedScoreRank": { "type": "string", "description": "The localized string for the rank of this score for this leaderboard." }, "formattedScore": { "description": "The localized string for the numerical value of this score.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.", "type": "string" }, "timeSpan": { "description": "The time span of this high score.", "enumDescriptions": [ "The score is an all-time score.", "The score is a weekly score.", "The score is a daily score." ], "type": "string", "enum": [ "ALL_TIME", "WEEKLY", "DAILY" ] }, "scoreRank": { "format": "int64", "description": "The rank of this score for this leaderboard.", "type": "string" }, "scoreTag": { "type": "string", "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." }, "writeTimestampMillis": { "description": "The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.", "type": "string", "format": "int64" }, "scoreValue": { "type": "string", "format": "int64", "description": "The numerical value of this score." }, "player": { "description": "The player who holds this score.", "$ref": "Player" } }, "type": "object", "description": "The Leaderboard Entry resource.", "id": "LeaderboardEntry" }, "GamesAchievementIncrement": { "description": "The payload to request to increment an achievement.", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#GamesAchievementIncrement`.", "type": "string" }, "steps": { "type": "integer", "format": "int32", "description": "The number of steps to be incremented." }, "requestId": { "format": "int64", "type": "string", "description": "The requestId associated with an increment to an achievement." } }, "id": "GamesAchievementIncrement", "type": "object" }, "RetrieveDeveloperGamesLastPlayerTokenResponse": { "type": "object", "id": "RetrieveDeveloperGamesLastPlayerTokenResponse", "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" } }, "description": "Recall token data returned from for the RetrieveDeveloperGamesLastPlayerToken RPC" }, "Status": { "type": "object", "properties": { "message": { "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.", "type": "string" }, "details": { "type": "array", "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." } } }, "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" } }, "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)." }, "LeaderboardScores": { "description": "A ListScores response.", "type": "object", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScores`.", "type": "string" }, "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results." }, "numScores": { "format": "int64", "type": "string", "description": "The total number of scores in the leaderboard." }, "prevPageToken": { "description": "The pagination token for the previous page of results.", "type": "string" }, "items": { "type": "array", "items": { "$ref": "LeaderboardEntry" }, "description": "The scores in the leaderboard." }, "playerScore": { "$ref": "LeaderboardEntry", "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." } }, "id": "LeaderboardScores" }, "PlayerExperienceInfo": { "type": "object", "id": "PlayerExperienceInfo", "description": "1P/3P metadata about the player's experience.", "properties": { "nextLevel": { "$ref": "PlayerLevel", "description": "The next level of the player. If the current level is the maximum level, this should be same as the current level." }, "currentExperiencePoints": { "type": "string", "format": "int64", "description": "The current number of experience points for the player." }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.", "type": "string" }, "currentLevel": { "description": "The current level of the player.", "$ref": "PlayerLevel" }, "lastLevelUpTimestampMillis": { "type": "string", "description": "The timestamp when the player was leveled up, in millis since Unix epoch UTC.", "format": "int64" } } }, "RecallToken": { "description": "Recall token data returned from RetrievePlayerTokens RPC", "properties": { "multiPlayerPersona": { "description": "Required. Whether the persona identified by the token is linked to multiple PGS Players", "type": "boolean" }, "token": { "description": "Required. Value of the Recall token as it is provided by the client via LinkPersona RPC", "type": "string" }, "expireTime": { "format": "google-datetime", "description": "Optional. Optional expiration time of the token", "type": "string" } }, "id": "RecallToken", "type": "object" }, "EndPoint": { "properties": { "url": { "type": "string", "description": "A URL suitable for loading in a web browser for the requested endpoint." } }, "type": "object", "description": "Container for a URL end point of the requested type.", "id": "EndPoint" }, "GenerateRecallPlayGroupingApiTokenResponse": { "id": "GenerateRecallPlayGroupingApiTokenResponse", "description": "Response for the GenerateRecallPlayGroupingApiToken RPC.", "properties": { "token": { "description": "Token for accessing the Play Grouping API.", "$ref": "PlayGroupingApiToken" } }, "type": "object" }, "LinkPersonaResponse": { "type": "object", "properties": { "state": { "description": "Output only. State of a persona linking attempt.", "type": "string", "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." ], "readOnly": true, "enum": [ "LINK_CREATED", "PERSONA_OR_PLAYER_ALREADY_LINKED" ] } }, "id": "LinkPersonaResponse", "description": "Outcome of a persona linking attempt." }, "ResetPersonaResponse": { "description": "Response for the ResetPersona RPC", "id": "ResetPersonaResponse", "type": "object", "properties": { "unlinked": { "description": "Required. Whether any tokens were unlinked as a result of this request.", "type": "boolean" } } }, "PlayerListResponse": { "properties": { "items": { "items": { "$ref": "Player" }, "type": "array", "description": "The players." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerListResponse`." }, "nextPageToken": { "type": "string", "description": "Token corresponding to the next page of results." } }, "type": "object", "description": "A third party player list response.", "id": "PlayerListResponse" }, "ProfileSettings": { "id": "ProfileSettings", "description": "Profile settings", "properties": { "friendsListVisibility": { "type": "string", "enum": [ "VISIBLE", "REQUEST_REQUIRED", "UNAVAILABLE" ], "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." ] }, "profileVisible": { "type": "boolean", "description": "Whether the player's profile is visible to the currently signed in player." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`." } }, "type": "object" }, "PlayerLevel": { "properties": { "minExperiencePoints": { "format": "int64", "type": "string", "description": "The minimum experience points for this level." }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.", "type": "string" }, "level": { "type": "integer", "format": "int32", "description": "The level for the user." }, "maxExperiencePoints": { "type": "string", "format": "int64", "description": "The maximum experience points for this level." } }, "description": "1P/3P metadata about a user's level.", "id": "PlayerLevel", "type": "object" }, "CategoryListResponse": { "description": "A third party list metagame categories response.", "id": "CategoryListResponse", "type": "object", "properties": { "items": { "description": "The list of categories with usage data.", "items": { "$ref": "Category" }, "type": "array" }, "nextPageToken": { "description": "Token corresponding to the next page of results.", "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#categoryListResponse`." } } }, "EventUpdateResponse": { "id": "EventUpdateResponse", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateResponse`." }, "playerEvents": { "description": "The current status of any updated events", "items": { "$ref": "PlayerEvent" }, "type": "array" }, "batchFailures": { "type": "array", "description": "Any batch-wide failures which occurred applying updates.", "items": { "$ref": "EventBatchRecordFailure" } }, "eventFailures": { "items": { "$ref": "EventRecordFailure" }, "description": "Any failures updating a particular event.", "type": "array" } }, "type": "object", "description": "An event period update resource." }, "AchievementIncrementResponse": { "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementIncrementResponse`." }, "currentSteps": { "format": "int32", "description": "The current steps recorded for this incremental achievement.", "type": "integer" }, "newlyUnlocked": { "description": "Whether the current steps for the achievement has reached the number of steps required to unlock.", "type": "boolean" } }, "id": "AchievementIncrementResponse", "description": "An achievement increment response" }, "SnapshotListResponse": { "type": "object", "description": "A third party list snapshots response.", "properties": { "items": { "description": "The snapshots.", "type": "array", "items": { "$ref": "Snapshot" } }, "nextPageToken": { "description": "Token corresponding to the next page of results. If there are no more results, the token is omitted.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshotListResponse`.", "type": "string" } }, "id": "SnapshotListResponse" }, "PropertyValue": { "type": "object", "properties": { "stringValue": { "description": "A string value.", "type": "string" }, "boolValue": { "description": "A boolean value.", "type": "boolean" }, "timestampValue": { "description": "A timestamp value.", "type": "string", "format": "google-datetime" }, "intValue": { "format": "int64", "description": "An integer value.", "type": "string" }, "durationValue": { "format": "google-duration", "type": "string", "description": "A duration value." }, "doubleValue": { "description": "A double value.", "type": "number", "format": "double" } }, "description": "Wrapper for the value.", "id": "PropertyValue" }, "LeaderboardListResponse": { "properties": { "nextPageToken": { "type": "string", "description": "Token corresponding to the next page of results." }, "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" } }, "id": "LeaderboardListResponse", "description": "A list of leaderboard objects.", "type": "object" }, "ScoreSubmission": { "id": "ScoreSubmission", "properties": { "signature": { "type": "string", "description": "Signature Values will contain URI-safe characters as defined by section 2.3 of RFC 3986." }, "leaderboardId": { "description": "The leaderboard this score is being submitted to.", "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#scoreSubmission`." }, "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." }, "score": { "description": "The new score being submitted.", "format": "int64", "type": "string" } }, "description": "A request to submit a score to leaderboards.", "type": "object" }, "Snapshot": { "properties": { "coverImage": { "description": "The cover image of this snapshot. May be absent if there is no image.", "$ref": "SnapshotImage" }, "uniqueName": { "type": "string", "description": "The unique name provided when the snapshot was created." }, "id": { "type": "string", "description": "The ID of the snapshot." }, "type": { "enum": [ "SAVE_GAME" ], "description": "The type of this snapshot.", "type": "string", "enumDescriptions": [ "A snapshot representing a save game." ] }, "lastModifiedMillis": { "description": "The timestamp (in millis since Unix epoch) of the last modification to this snapshot.", "type": "string", "format": "int64" }, "progressValue": { "format": "int64", "type": "string", "description": "The progress value (64-bit integer set by developer) associated with this snapshot." }, "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." }, "description": { "description": "The description of this snapshot.", "type": "string" }, "durationMillis": { "format": "int64", "type": "string", "description": "The duration associated with this snapshot, in millis." }, "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" } }, "description": "An snapshot object.", "type": "object", "id": "Snapshot" }, "EventUpdateRequest": { "description": "An event period update resource.", "type": "object", "id": "EventUpdateRequest", "properties": { "updateCount": { "type": "string", "format": "int64", "description": "The number of times this event occurred in this time period." }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateRequest`.", "type": "string" }, "definitionId": { "description": "The ID of the event being modified in this update.", "type": "string" } } }, "EventChild": { "type": "object", "id": "EventChild", "description": "An event child relationship resource.", "properties": { "childId": { "description": "The ID of the child event.", "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventChild`." } } }, "ApplicationCategory": { "description": "An application category object.", "id": "ApplicationCategory", "properties": { "secondary": { "type": "string", "description": "The secondary category." }, "primary": { "type": "string", "description": "The primary category." }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationCategory`.", "type": "string" } }, "type": "object" }, "ScopedPlayerIds": { "type": "object", "id": "ScopedPlayerIds", "properties": { "gamePlayerId": { "type": "string", "description": "Game-scoped player identifier. This is the same id that is returned in GetPlayer game_player_id field." }, "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" } }, "description": "Scoped player identifiers." }, "AchievementDefinitionsListResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "AchievementDefinition" }, "description": "The achievement definitions." }, "nextPageToken": { "type": "string", "description": "Token corresponding to the next page of results." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementDefinitionsListResponse`." } }, "id": "AchievementDefinitionsListResponse", "description": "A list of achievement definition objects." }, "ResetPersonaRequest": { "properties": { "persona": { "type": "string", "description": "Value of the 'persona' field as it was provided by the client in LinkPersona RPC" } }, "description": "Request to remove all Recall tokens associated with a persona for an app.", "id": "ResetPersonaRequest", "type": "object" }, "PlayerEventListResponse": { "description": "A ListByPlayer response.", "type": "object", "id": "PlayerEventListResponse", "properties": { "nextPageToken": { "description": "The pagination token for the next page of results.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEventListResponse`.", "type": "string" }, "items": { "description": "The player events.", "type": "array", "items": { "$ref": "PlayerEvent" } } } }, "PlayerGameEvent": { "id": "PlayerGameEvent", "type": "object", "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.", "properties": { "eventName": { "type": "string", "description": "Required. Client-defined name of the event (e.g., \"run_completed\", \"level_up\"). Maximum length: 100 characters." }, "eventId": { "type": "string", "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." }, "eventTime": { "type": "string", "description": "Required. The time from the client when this specific event was performed.", "format": "google-datetime" }, "eventProperties": { "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.", "additionalProperties": { "$ref": "PropertyValue" } } } }, "GeneratePlayGroupingApiTokenResponse": { "type": "object", "id": "GeneratePlayGroupingApiTokenResponse", "description": "Response for the GeneratePlayGroupingApiToken RPC.", "properties": { "token": { "description": "Token for accessing the Play Grouping API.", "$ref": "PlayGroupingApiToken" } } }, "PlayerEvent": { "description": "An event status resource.", "properties": { "playerId": { "type": "string", "description": "The ID of the player." }, "definitionId": { "description": "The ID of the event definition.", "type": "string" }, "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": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`." }, "numEvents": { "format": "int64", "description": "The current number of times this event has occurred.", "type": "string" } }, "type": "object", "id": "PlayerEvent" }, "PlayerLeaderboardScoreListResponse": { "properties": { "items": { "description": "The leaderboard scores.", "type": "array", "items": { "$ref": "PlayerLeaderboardScore" } }, "nextPageToken": { "description": "The pagination token for the next page of results.", "type": "string" }, "player": { "$ref": "Player", "description": "The Player resources for the owner of this score." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScoreListResponse`." } }, "description": "A list of player leaderboard scores.", "id": "PlayerLeaderboardScoreListResponse", "type": "object" }, "LinkPersonaRequest": { "type": "object", "id": "LinkPersonaRequest", "properties": { "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." ], "type": "string", "enum": [ "KEEP_EXISTING_LINKS", "CREATE_NEW_LINK" ], "description": "Required. Resolution policy to apply when the linking of a persona to a player would result in violating the specified cardinality constraint." }, "token": { "description": "Required. Value of the token to create. Opaque to Play Games and assumed to be non-stable (encrypted with key rotation).", "type": "string" }, "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" }, "expireTime": { "format": "google-datetime", "description": "Input only. Optional expiration time.", "type": "string" }, "cardinalityConstraint": { "type": "string", "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." ], "description": "Required. Cardinality constraint to observe when linking a persona to a player in the scope of a game.", "enum": [ "ONE_PERSONA_TO_ONE_PLAYER" ] }, "ttl": { "format": "google-duration", "description": "Input only. Optional time-to-live.", "type": "string" } }, "description": "Request to link an in-game account with a PGS principal (encoded in the session id)." }, "ApplicationVerifyResponse": { "id": "ApplicationVerifyResponse", "type": "object", "description": "A third party application verification response resource.", "properties": { "player_id": { "type": "string", "description": "The ID of the player that was issued the auth token used in this request." }, "alternate_player_id": { "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.)", "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationVerifyResponse`." } } }, "MetagameConfig": { "id": "MetagameConfig", "description": "The metagame config resource", "type": "object", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#metagameConfig`.", "type": "string" }, "currentVersion": { "description": "Current version of the metagame configuration data. When this data is updated, the version number will be increased by one.", "format": "int32", "type": "integer" }, "playerLevels": { "type": "array", "description": "The list of player levels.", "items": { "$ref": "PlayerLevel" } } } }, "InstanceAndroidDetails": { "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceAndroidDetails`." }, "packageName": { "type": "string", "description": "Android package name which maps to Google Play URL." }, "preferred": { "type": "boolean", "description": "Indicates that this instance is the default for new installations." }, "enablePiracyCheck": { "description": "Flag indicating whether the anti-piracy check is enabled.", "type": "boolean" } }, "id": "InstanceAndroidDetails", "description": "The Android instance details resource.", "type": "object" }, "PlayerLeaderboardScore": { "type": "object", "description": "A player leaderboard score object.", "properties": { "scoreValue": { "type": "string", "format": "int64", "description": "The numerical value of this score." }, "socialRank": { "$ref": "LeaderboardScoreRank", "description": "The social rank of the score in this leaderboard." }, "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" }, "scoreString": { "type": "string", "description": "The formatted value of this score." }, "timeSpan": { "enum": [ "ALL_TIME", "WEEKLY", "DAILY" ], "description": "The time span of this score.", "type": "string", "enumDescriptions": [ "The score is an all-time score.", "The score is a weekly score.", "The score is a daily score." ] }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScore`." }, "writeTimestamp": { "type": "string", "format": "int64", "description": "The timestamp at which this score was recorded, in milliseconds since the epoch in UTC." }, "friendsRank": { "description": "The rank of the score in the friends collection for this leaderboard.", "$ref": "LeaderboardScoreRank" }, "publicRank": { "$ref": "LeaderboardScoreRank", "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." }, "leaderboard_id": { "description": "The ID of the leaderboard this score is in.", "type": "string" } }, "id": "PlayerLeaderboardScore" }, "AchievementRevealResponse": { "description": "An achievement reveal response", "properties": { "currentState": { "description": "The current state of the achievement for which a reveal was attempted. This might be `UNLOCKED` if the achievement was already unlocked.", "enum": [ "REVEALED", "UNLOCKED" ], "enumDescriptions": [ "Achievement is revealed.", "Achievement is unlocked." ], "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementRevealResponse`." } }, "id": "AchievementRevealResponse", "type": "object" }, "RetrieveGamesPlayerTokensResponse": { "properties": { "gamePlayerTokens": { "type": "array", "items": { "$ref": "GamePlayerToken" }, "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." } }, "id": "RetrieveGamesPlayerTokensResponse", "description": "A list of recall token data returned from the RetrieveGamesPlayerTokens RPC", "type": "object" }, "ApplicationPlayerId": { "id": "ApplicationPlayerId", "type": "object", "description": "Primary scoped player identifier for an application.", "properties": { "applicationId": { "description": "The application that this player identifier is for.", "type": "string" }, "playerId": { "type": "string", "description": "The player identifier for the application." } } }, "StatsResponse": { "properties": { "high_spender_probability": { "type": "number", "format": "float", "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." }, "total_spend_next_28_days": { "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.", "format": "float", "type": "number" }, "num_purchases": { "format": "int32", "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" }, "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" }, "avg_session_length_minutes": { "description": "Average session length in minutes of the player. E.g., 1, 30, 60, ... . Not populated if there is not enough information.", "format": "float", "type": "number" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#statsResponse`.", "type": "string" }, "num_sessions": { "format": "int32", "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" }, "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" }, "num_sessions_percentile": { "type": "number", "format": "float", "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." }, "churn_probability": { "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.", "type": "number", "format": "float" }, "spend_probability": { "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.", "format": "float", "type": "number" } }, "id": "StatsResponse", "description": "A third party stats resource.", "type": "object" }, "GamesAchievementSetStepsAtLeast": { "type": "object", "description": "The payload to request to increment an achievement.", "id": "GamesAchievementSetStepsAtLeast", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#GamesAchievementSetStepsAtLeast`.", "type": "string" }, "steps": { "format": "int32", "description": "The minimum number of steps for the achievement to be set to.", "type": "integer" } } }, "PlayerScoreResponse": { "id": "PlayerScoreResponse", "description": "A list of leaderboard entry resources.", "type": "object", "properties": { "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" }, "beatenScoreTimeSpans": { "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" ] }, "description": "The time spans where the submitted score is better than the existing score for that time span.", "type": "array" }, "leaderboardId": { "description": "The leaderboard ID that this score was submitted to.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreResponse`.", "type": "string" }, "formattedScore": { "type": "string", "description": "The formatted value of the submitted score." }, "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" } } }, "RetrievePlayerTokensResponse": { "id": "RetrievePlayerTokensResponse", "type": "object", "properties": { "tokens": { "type": "array", "description": "Required. Recall tokens associated with the requested PGS Player principal", "items": { "$ref": "RecallToken" } } }, "description": "Response for the RetrievePlayerTokens RPC" }, "AchievementSetStepsAtLeastResponse": { "id": "AchievementSetStepsAtLeastResponse", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementSetStepsAtLeastResponse`.", "type": "string" }, "newlyUnlocked": { "description": "Whether the current steps for the achievement has reached the number of steps required to unlock.", "type": "boolean" }, "currentSteps": { "format": "int32", "description": "The current steps recorded for this incremental achievement.", "type": "integer" } }, "type": "object", "description": "An achievement set steps at least response." }, "PlayerScore": { "type": "object", "id": "PlayerScore", "properties": { "timeSpan": { "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" ], "description": "The time span for this player score." }, "formattedScore": { "description": "The formatted score for this player score.", "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScore`." }, "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" }, "score": { "type": "string", "description": "The numerical value for this player score.", "format": "int64" } }, "description": "A player score." }, "PlayGroupingApiToken": { "description": "Token data returned from GeneratePlayGroupingApiToken RPC.", "properties": { "tokenValue": { "description": "Value of the token.", "type": "string" } }, "id": "PlayGroupingApiToken", "type": "object" }, "Application": { "type": "object", "id": "Application", "properties": { "enabledFeatures": { "description": "A list of features that have been enabled for the application.", "items": { "enumDescriptions": [ "Saved Games (snapshots)." ], "type": "string", "enum": [ "SNAPSHOTS" ] }, "type": "array" }, "themeColor": { "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\").", "type": "string" }, "description": { "type": "string", "description": "The description of the application." }, "lastUpdatedTimestamp": { "description": "The last updated timestamp of the application.", "format": "int64", "type": "string" }, "id": { "type": "string", "description": "The ID of the application." }, "author": { "description": "The author of the application.", "type": "string" }, "leaderboard_count": { "description": "The number of leaderboards visible to the currently authenticated player.", "type": "integer", "format": "int32" }, "category": { "description": "The category of the application.", "$ref": "ApplicationCategory" }, "instances": { "type": "array", "items": { "$ref": "Instance" }, "description": "The instances of the application." }, "assets": { "type": "array", "description": "The assets of the application.", "items": { "$ref": "ImageAsset" } }, "name": { "description": "The name of the application.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#application`.", "type": "string" }, "achievement_count": { "description": "The number of achievements visible to the currently authenticated player.", "format": "int32", "type": "integer" } }, "description": "The Application resource." }, "PlayerScoreSubmissionList": { "properties": { "scores": { "type": "array", "description": "The score submissions.", "items": { "$ref": "ScoreSubmission" } }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreSubmissionList`." } }, "description": "A list of score submission requests.", "type": "object", "id": "PlayerScoreSubmissionList" }, "EventDefinitionListResponse": { "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "The pagination token for the next page of results." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinitionListResponse`." }, "items": { "description": "The event definitions.", "items": { "$ref": "EventDefinition" }, "type": "array" } }, "id": "EventDefinitionListResponse", "description": "A ListDefinitions response." }, "UnlinkPersonaRequest": { "id": "UnlinkPersonaRequest", "type": "object", "description": "Request to remove a Recall token linking PGS principal and an in-game account", "properties": { "sessionId": { "type": "string", "description": "Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application." }, "token": { "description": "Value of the Recall token as it was provided by the client in LinkPersona RPC", "type": "string" }, "persona": { "description": "Value of the 'persona' field as it was provided by the client in LinkPersona RPC", "type": "string" } } }, "AchievementUpdateMultipleResponse": { "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateMultipleResponse`.", "type": "string" }, "updatedAchievements": { "description": "The updated state of the achievements.", "items": { "$ref": "AchievementUpdateResponse" }, "type": "array" } }, "description": "Response message for UpdateMultipleAchievements rpc.", "type": "object", "id": "AchievementUpdateMultipleResponse" }, "BatchRecordEventsRequest": { "properties": { "droidGuardBlob": { "type": "string", "description": "Optional. The DroidGuard blob generated by the client. This is used to detect abuse signals from the devices" }, "packageName": { "description": "Required. Application package name (e.g., \"com.example.game\").", "type": "string" }, "salt": { "description": "Optional. The salt used to generate content binding for the DroidGuard blob. This is used to prevent replay attacks.", "type": "string" }, "requestTime": { "format": "google-datetime", "type": "string", "description": "Required. The time from the client when this specific batch of events was submitted." }, "events": { "description": "Required. A list of player game events to be recorded. Maximum of 30 events per batch request.", "type": "array", "items": { "$ref": "PlayerGameEvent" } } }, "description": "Request message for PlayerGameEvents.BatchRecordEvents Next ID: 7", "id": "BatchRecordEventsRequest", "type": "object" }, "AchievementUnlockResponse": { "properties": { "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" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUnlockResponse`.", "type": "string" } }, "description": "An achievement unlock response", "id": "AchievementUnlockResponse", "type": "object" }, "InstanceWebDetails": { "id": "InstanceWebDetails", "properties": { "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." }, "launchUrl": { "type": "string", "description": "Launch URL for the game." } }, "type": "object", "description": "The Web details resource." }, "PlayerAchievement": { "id": "PlayerAchievement", "description": "An achievement object.", "type": "object", "properties": { "id": { "description": "The ID of the achievement.", "type": "string" }, "currentSteps": { "format": "int32", "type": "integer", "description": "The current steps for an incremental achievement." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievement`." }, "formattedCurrentStepsString": { "type": "string", "description": "The current steps for an incremental achievement as a string." }, "lastUpdatedTimestamp": { "type": "string", "format": "int64", "description": "The timestamp of the last modification to this achievement's state." }, "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" }, "achievementState": { "enum": [ "HIDDEN", "REVEALED", "UNLOCKED" ], "enumDescriptions": [ "Achievement is hidden.", "Achievement is revealed.", "Achievement is unlocked." ], "type": "string", "description": "The state of the achievement." } } }, "PlayerAchievementListResponse": { "id": "PlayerAchievementListResponse", "description": "A list of achievement objects.", "type": "object", "properties": { "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievementListResponse`." }, "items": { "items": { "$ref": "PlayerAchievement" }, "description": "The achievements.", "type": "array" }, "nextPageToken": { "type": "string", "description": "Token corresponding to the next page of results." } } }, "Player": { "type": "object", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#player`", "type": "string" }, "name": { "description": "A representation of the individual components of the name.", "properties": { "familyName": { "description": "The family name of this player. In some places, this is known as the last name.", "type": "string" }, "givenName": { "description": "The given name of this player. In some places, this is known as the first name.", "type": "string" } }, "type": "object" }, "bannerUrlLandscape": { "description": "The url to the landscape mode player banner image.", "type": "string" }, "avatarImageUrl": { "type": "string", "description": "The base URL for the image that represents the player." }, "playerId": { "description": "The ID of the player.", "type": "string" }, "friendStatus": { "enumDescriptions": [ "There is no relationship between the players.", "The player and requester are friends." ], "enum": [ "NO_RELATIONSHIP", "FRIEND" ], "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.", "type": "string" }, "bannerUrlPortrait": { "description": "The url to the portrait mode player banner image.", "type": "string" }, "originalPlayerId": { "type": "string", "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." }, "profileSettings": { "description": "The player's profile settings. Controls whether or not the player's profile is visible to other players.", "$ref": "ProfileSettings" }, "experienceInfo": { "$ref": "PlayerExperienceInfo", "description": "An object to represent Play Game experience information for the player." }, "gamePlayerId": { "description": "Per-application unique player identifier.", "type": "string" }, "displayName": { "description": "The name to display for the player.", "type": "string" }, "title": { "description": "The player's title rewarded for their game activities.", "type": "string" } }, "description": "A Player resource.", "id": "Player" }, "EventRecordFailure": { "description": "An event update failure resource.", "properties": { "failureCause": { "enum": [ "NOT_FOUND", "INVALID_UPDATE_VALUE" ], "description": "The cause for the update failure.", "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." ], "type": "string" }, "eventId": { "description": "The ID of the event that was not updated.", "type": "string" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordFailure`." } }, "type": "object", "id": "EventRecordFailure" }, "GamePlayerToken": { "id": "GamePlayerToken", "properties": { "applicationId": { "description": "The application that this player identifier is for.", "type": "string" }, "recallToken": { "$ref": "RecallToken", "description": "Recall token data." } }, "type": "object", "description": "Recall tokens for a game." }, "PlayerScoreListResponse": { "type": "object", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreListResponse`.", "type": "string" }, "submittedScores": { "description": "The score submissions statuses.", "type": "array", "items": { "$ref": "PlayerScoreResponse" } } }, "id": "PlayerScoreListResponse", "description": "A list of score submission statuses." }, "AchievementUpdateResponse": { "properties": { "updateOccurred": { "type": "boolean", "description": "Whether the requested updates actually affected the achievement." }, "achievementId": { "description": "The achievement this update is was applied to.", "type": "string" }, "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)." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateResponse`." }, "currentState": { "enum": [ "HIDDEN", "REVEALED", "UNLOCKED" ], "enumDescriptions": [ "Achievement is hidden.", "Achievement is revealed.", "Achievement is unlocked." ], "description": "The current state of the achievement.", "type": "string" }, "currentSteps": { "description": "The current steps recorded for this achievement if it is incremental.", "format": "int32", "type": "integer" } }, "description": "An updated achievement.", "type": "object", "id": "AchievementUpdateResponse" }, "Category": { "id": "Category", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#category`.", "type": "string" }, "experiencePoints": { "description": "Experience points earned in this category.", "format": "int64", "type": "string" }, "category": { "type": "string", "description": "The category name." } }, "description": "Data related to individual game categories.", "type": "object" }, "SnapshotImage": { "description": "An image of a snapshot.", "id": "SnapshotImage", "type": "object", "properties": { "width": { "format": "int32", "type": "integer", "description": "The width of the image." }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#snapshotImage`.", "type": "string" }, "mime_type": { "type": "string", "description": "The MIME type of the image." }, "height": { "type": "integer", "description": "The height of the image.", "format": "int32" }, "url": { "type": "string", "description": "The URL of the image. This URL may be invalidated at any time and should not be cached." } } }, "EventPeriodRange": { "id": "EventPeriodRange", "type": "object", "properties": { "periodStartMillis": { "type": "string", "description": "The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).", "format": "int64" }, "periodEndMillis": { "format": "int64", "type": "string", "description": "The time when this update period ends, 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`." } }, "description": "An event period time range." }, "EventDefinition": { "id": "EventDefinition", "description": "An event definition resource.", "properties": { "description": { "type": "string", "description": "Description of what this event represents." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinition`." }, "childEvents": { "items": { "$ref": "EventChild" }, "description": "A list of events that are a child of this event.", "type": "array" }, "visibility": { "type": "string", "enum": [ "REVEALED", "HIDDEN" ], "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." ] }, "isDefaultImageUrl": { "description": "Indicates whether the icon image being returned is a default image, or is game-provided.", "type": "boolean" }, "imageUrl": { "description": "The base URL for the image that represents the event.", "type": "string" }, "id": { "type": "string", "description": "The ID of the event." }, "displayName": { "type": "string", "description": "The name to display for the event." } }, "type": "object" }, "InstanceIosDetails": { "type": "object", "id": "InstanceIosDetails", "properties": { "preferredForIpad": { "description": "Indicates that this instance is the default for new installations on iPad devices.", "type": "boolean" }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceIosDetails`." }, "supportIphone": { "type": "boolean", "description": "Flag to indicate if this instance supports iPhone." }, "itunesAppId": { "type": "string", "description": "iTunes App ID." }, "bundleIdentifier": { "description": "Bundle identifier.", "type": "string" }, "preferredForIphone": { "description": "Indicates that this instance is the default for new installations on iPhone devices.", "type": "boolean" }, "supportIpad": { "type": "boolean", "description": "Flag to indicate if this instance supports iPad." } }, "description": "The iOS details resource." }, "GetMultipleApplicationPlayerIdsResponse": { "properties": { "playerIds": { "type": "array", "readOnly": true, "items": { "$ref": "ApplicationPlayerId" }, "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." } }, "id": "GetMultipleApplicationPlayerIdsResponse", "type": "object", "description": "Response message for GetMultipleApplicationPlayerIds rpc." }, "EventBatchRecordFailure": { "properties": { "range": { "$ref": "EventPeriodRange", "description": "The time range which was rejected; empty for a request-wide failure." }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventBatchRecordFailure`.", "type": "string" }, "failureCause": { "type": "string", "description": "The cause for the update failure.", "enum": [ "TOO_LARGE", "TIME_PERIOD_EXPIRED", "TIME_PERIOD_SHORT", "TIME_PERIOD_LONG", "ALREADY_UPDATED", "RECORD_RATE_HIGH" ], "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." ] } }, "type": "object", "id": "EventBatchRecordFailure", "description": "A batch update failure resource." }, "Leaderboard": { "type": "object", "id": "Leaderboard", "properties": { "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboard`.", "type": "string" }, "name": { "description": "The name of the leaderboard.", "type": "string" }, "isIconUrlDefault": { "description": "Indicates whether the icon image being returned is a default image, or is game-provided.", "type": "boolean" }, "id": { "type": "string", "description": "The leaderboard ID." }, "iconUrl": { "type": "string", "description": "The icon for the leaderboard." }, "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" ], "description": "How scores are ordered.", "type": "string" } }, "description": "The Leaderboard resource." }, "BatchRecordEventsResponse": { "id": "BatchRecordEventsResponse", "type": "object", "description": "A successful response indicates that the batch of events has been processed.", "properties": { "failedRequests": { "type": "object", "description": "Map of failed events, keyed by their zero-based index in `BatchRecordEventsRequest.events`. Omitted keys indicate successful recording.", "additionalProperties": { "$ref": "Status" } } } }, "Instance": { "type": "object", "description": "The Instance resource.", "id": "Instance", "properties": { "turnBasedPlay": { "description": "Flag to show if this game instance supports turn based play.", "type": "boolean" }, "acquisitionUri": { "type": "string", "description": "URI which shows where a user can acquire this instance." }, "webInstance": { "description": "Platform dependent details for Web.", "$ref": "InstanceWebDetails" }, "androidInstance": { "description": "Platform dependent details for Android.", "$ref": "InstanceAndroidDetails" }, "iosInstance": { "description": "Platform dependent details for iOS.", "$ref": "InstanceIosDetails" }, "platformType": { "type": "string", "enumDescriptions": [ "Instance is for Android.", "Instance is for iOS.", "Instance is for Web App." ], "description": "The platform type.", "enum": [ "ANDROID", "IOS", "WEB_APP" ] }, "realtimePlay": { "type": "boolean", "description": "Flag to show if this game instance supports realtime play." }, "name": { "type": "string", "description": "Localized display name." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#instance`." } } }, "EventPeriodUpdate": { "description": "An event period update resource.", "type": "object", "properties": { "timePeriod": { "$ref": "EventPeriodRange", "description": "The time period being covered by this update." }, "updates": { "type": "array", "items": { "$ref": "EventUpdateRequest" }, "description": "The updates being made for this time period." }, "kind": { "type": "string", "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodUpdate`." } }, "id": "EventPeriodUpdate" }, "RevisionCheckResponse": { "description": "A third party checking a revision response.", "properties": { "apiVersion": { "description": "The version of the API this client revision should use when calling API methods.", "type": "string" }, "kind": { "description": "Uniquely identifies the type of this resource. Value is always the fixed string `games#revisionCheckResponse`.", "type": "string" }, "revisionStatus": { "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." ], "description": "The result of the revision check.", "enum": [ "OK", "DEPRECATED", "INVALID" ] } }, "type": "object", "id": "RevisionCheckResponse" } }, "ownerDomain": "google.com", "baseUrl": "https://games.googleapis.com/", "servicePath": "", "discoveryVersion": "v1", "title": "Google Play Games Services API", "parameters": { "key": { "location": "query", "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." }, "quotaUser": { "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.", "location": "query", "type": "string" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "$.xgafv": { "type": "string", "description": "V1 error format.", "location": "query", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query", "type": "string" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "alt": { "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "type": "string", "default": "json" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean", "location": "query" } }, "protocol": "rest", "documentationLink": "https://developers.google.com/games/", "basePath": "", "mtlsRootUrl": "https://games.mtls.googleapis.com/", "auth": { "oauth2": { "scopes": { "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/androidpublisher": { "description": "View and manage your Google Play Developer account" }, "https://www.googleapis.com/auth/games": { "description": "Create, edit, and delete your Google Play Games activity" } } } }, "rootUrl": "https://games.googleapis.com/", "name": "games", "canonicalName": "Games", "version": "v1" }