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