googleapis
Version:
Google APIs Client Library for Node.js
1,504 lines • 212 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace games_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* 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.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* 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.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Google Play Games Services API
*
* The Google Play Games Service allows developers to enhance games with social leaderboards, achievements, game state, sign-in with Google, and more.
*
* @example
* ```js
* const {google} = require('googleapis');
* const games = google.games('v1');
* ```
*/
export class Games {
context: APIRequestContext;
accesstokens: Resource$Accesstokens;
achievementDefinitions: Resource$Achievementdefinitions;
achievements: Resource$Achievements;
applications: Resource$Applications;
events: Resource$Events;
leaderboards: Resource$Leaderboards;
metagame: Resource$Metagame;
players: Resource$Players;
recall: Resource$Recall;
revisions: Resource$Revisions;
scores: Resource$Scores;
snapshots: Resource$Snapshots;
stats: Resource$Stats;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An achievement definition object.
*/
export interface Schema$AchievementDefinition {
/**
* The type of the achievement.
*/
achievementType?: string | null;
/**
* The description of the achievement.
*/
description?: string | null;
/**
* Experience points which will be earned when unlocking this achievement.
*/
experiencePoints?: string | null;
/**
* The total steps for an incremental achievement as a string.
*/
formattedTotalSteps?: string | null;
/**
* The ID of the achievement.
*/
id?: string | null;
/**
* The initial state of the achievement.
*/
initialState?: string | null;
/**
* Indicates whether the revealed icon image being returned is a default image, or is provided by the game.
*/
isRevealedIconUrlDefault?: boolean | null;
/**
* Indicates whether the unlocked icon image being returned is a default image, or is game-provided.
*/
isUnlockedIconUrlDefault?: boolean | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementDefinition`.
*/
kind?: string | null;
/**
* The name of the achievement.
*/
name?: string | null;
/**
* The image URL for the revealed achievement icon.
*/
revealedIconUrl?: string | null;
/**
* The total steps for an incremental achievement.
*/
totalSteps?: number | null;
/**
* The image URL for the unlocked achievement icon.
*/
unlockedIconUrl?: string | null;
}
/**
* A list of achievement definition objects.
*/
export interface Schema$AchievementDefinitionsListResponse {
/**
* The achievement definitions.
*/
items?: Schema$AchievementDefinition[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementDefinitionsListResponse`.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results.
*/
nextPageToken?: string | null;
}
/**
* An achievement increment response
*/
export interface Schema$AchievementIncrementResponse {
/**
* The current steps recorded for this incremental achievement.
*/
currentSteps?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementIncrementResponse`.
*/
kind?: string | null;
/**
* Whether the current steps for the achievement has reached the number of steps required to unlock.
*/
newlyUnlocked?: boolean | null;
}
/**
* An achievement reveal response
*/
export interface Schema$AchievementRevealResponse {
/**
* The current state of the achievement for which a reveal was attempted. This might be `UNLOCKED` if the achievement was already unlocked.
*/
currentState?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementRevealResponse`.
*/
kind?: string | null;
}
/**
* An achievement set steps at least response.
*/
export interface Schema$AchievementSetStepsAtLeastResponse {
/**
* The current steps recorded for this incremental achievement.
*/
currentSteps?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementSetStepsAtLeastResponse`.
*/
kind?: string | null;
/**
* Whether the current steps for the achievement has reached the number of steps required to unlock.
*/
newlyUnlocked?: boolean | null;
}
/**
* An achievement unlock response
*/
export interface Schema$AchievementUnlockResponse {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUnlockResponse`.
*/
kind?: string | null;
/**
* Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player).
*/
newlyUnlocked?: boolean | null;
}
/**
* A list of achievement update requests.
*/
export interface Schema$AchievementUpdateMultipleRequest {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateMultipleRequest`.
*/
kind?: string | null;
/**
* The individual achievement update requests.
*/
updates?: Schema$AchievementUpdateRequest[];
}
/**
* Response message for UpdateMultipleAchievements rpc.
*/
export interface Schema$AchievementUpdateMultipleResponse {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateMultipleResponse`.
*/
kind?: string | null;
/**
* The updated state of the achievements.
*/
updatedAchievements?: Schema$AchievementUpdateResponse[];
}
/**
* A request to update an achievement.
*/
export interface Schema$AchievementUpdateRequest {
/**
* The achievement this update is being applied to.
*/
achievementId?: string | null;
/**
* The payload if an update of type `INCREMENT` was requested for the achievement.
*/
incrementPayload?: Schema$GamesAchievementIncrement;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateRequest`.
*/
kind?: string | null;
/**
* The payload if an update of type `SET_STEPS_AT_LEAST` was requested for the achievement.
*/
setStepsAtLeastPayload?: Schema$GamesAchievementSetStepsAtLeast;
/**
* The type of update being applied.
*/
updateType?: string | null;
}
/**
* An updated achievement.
*/
export interface Schema$AchievementUpdateResponse {
/**
* The achievement this update is was applied to.
*/
achievementId?: string | null;
/**
* The current state of the achievement.
*/
currentState?: string | null;
/**
* The current steps recorded for this achievement if it is incremental.
*/
currentSteps?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#achievementUpdateResponse`.
*/
kind?: string | null;
/**
* Whether this achievement was newly unlocked (that is, whether the unlock request for the achievement was the first for the player).
*/
newlyUnlocked?: boolean | null;
/**
* Whether the requested updates actually affected the achievement.
*/
updateOccurred?: boolean | null;
}
/**
* The Application resource.
*/
export interface Schema$Application {
/**
* The number of achievements visible to the currently authenticated player.
*/
achievement_count?: number | null;
/**
* The assets of the application.
*/
assets?: Schema$ImageAsset[];
/**
* The author of the application.
*/
author?: string | null;
/**
* The category of the application.
*/
category?: Schema$ApplicationCategory;
/**
* The description of the application.
*/
description?: string | null;
/**
* A list of features that have been enabled for the application.
*/
enabledFeatures?: string[] | null;
/**
* The ID of the application.
*/
id?: string | null;
/**
* The instances of the application.
*/
instances?: Schema$Instance[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#application`.
*/
kind?: string | null;
/**
* The last updated timestamp of the application.
*/
lastUpdatedTimestamp?: string | null;
/**
* The number of leaderboards visible to the currently authenticated player.
*/
leaderboard_count?: number | null;
/**
* The name of the application.
*/
name?: string | null;
/**
* 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").
*/
themeColor?: string | null;
}
/**
* An application category object.
*/
export interface Schema$ApplicationCategory {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationCategory`.
*/
kind?: string | null;
/**
* The primary category.
*/
primary?: string | null;
/**
* The secondary category.
*/
secondary?: string | null;
}
/**
* Primary scoped player identifier for an application.
*/
export interface Schema$ApplicationPlayerId {
/**
* The application that this player identifier is for.
*/
applicationId?: string | null;
/**
* The player identifier for the application.
*/
playerId?: string | null;
}
/**
* A third party application verification response resource.
*/
export interface Schema$ApplicationVerifyResponse {
/**
* 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.)
*/
alternate_player_id?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#applicationVerifyResponse`.
*/
kind?: string | null;
/**
* The ID of the player that was issued the auth token used in this request.
*/
player_id?: string | null;
}
/**
* Data related to individual game categories.
*/
export interface Schema$Category {
/**
* The category name.
*/
category?: string | null;
/**
* Experience points earned in this category.
*/
experiencePoints?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#category`.
*/
kind?: string | null;
}
/**
* A third party list metagame categories response.
*/
export interface Schema$CategoryListResponse {
/**
* The list of categories with usage data.
*/
items?: Schema$Category[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#categoryListResponse`.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Container for a URL end point of the requested type.
*/
export interface Schema$EndPoint {
/**
* A URL suitable for loading in a web browser for the requested endpoint.
*/
url?: string | null;
}
/**
* A batch update failure resource.
*/
export interface Schema$EventBatchRecordFailure {
/**
* The cause for the update failure.
*/
failureCause?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#eventBatchRecordFailure`.
*/
kind?: string | null;
/**
* The time range which was rejected; empty for a request-wide failure.
*/
range?: Schema$EventPeriodRange;
}
/**
* An event child relationship resource.
*/
export interface Schema$EventChild {
/**
* The ID of the child event.
*/
childId?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#eventChild`.
*/
kind?: string | null;
}
/**
* An event definition resource.
*/
export interface Schema$EventDefinition {
/**
* A list of events that are a child of this event.
*/
childEvents?: Schema$EventChild[];
/**
* Description of what this event represents.
*/
description?: string | null;
/**
* The name to display for the event.
*/
displayName?: string | null;
/**
* The ID of the event.
*/
id?: string | null;
/**
* The base URL for the image that represents the event.
*/
imageUrl?: string | null;
/**
* Indicates whether the icon image being returned is a default image, or is game-provided.
*/
isDefaultImageUrl?: boolean | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinition`.
*/
kind?: string | null;
/**
* The visibility of event being tracked in this definition.
*/
visibility?: string | null;
}
/**
* A ListDefinitions response.
*/
export interface Schema$EventDefinitionListResponse {
/**
* The event definitions.
*/
items?: Schema$EventDefinition[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#eventDefinitionListResponse`.
*/
kind?: string | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
}
/**
* An event period time range.
*/
export interface Schema$EventPeriodRange {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodRange`.
*/
kind?: string | null;
/**
* The time when this update period ends, in millis, since 1970 UTC (Unix Epoch).
*/
periodEndMillis?: string | null;
/**
* The time when this update period begins, in millis, since 1970 UTC (Unix Epoch).
*/
periodStartMillis?: string | null;
}
/**
* An event period update resource.
*/
export interface Schema$EventPeriodUpdate {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#eventPeriodUpdate`.
*/
kind?: string | null;
/**
* The time period being covered by this update.
*/
timePeriod?: Schema$EventPeriodRange;
/**
* The updates being made for this time period.
*/
updates?: Schema$EventUpdateRequest[];
}
/**
* An event update failure resource.
*/
export interface Schema$EventRecordFailure {
/**
* The ID of the event that was not updated.
*/
eventId?: string | null;
/**
* The cause for the update failure.
*/
failureCause?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordFailure`.
*/
kind?: string | null;
}
/**
* An event period update resource.
*/
export interface Schema$EventRecordRequest {
/**
* The current time when this update was sent, in milliseconds, since 1970 UTC (Unix Epoch).
*/
currentTimeMillis?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#eventRecordRequest`.
*/
kind?: string | null;
/**
* The request ID used to identify this attempt to record events.
*/
requestId?: string | null;
/**
* A list of the time period updates being made in this request.
*/
timePeriods?: Schema$EventPeriodUpdate[];
}
/**
* An event period update resource.
*/
export interface Schema$EventUpdateRequest {
/**
* The ID of the event being modified in this update.
*/
definitionId?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateRequest`.
*/
kind?: string | null;
/**
* The number of times this event occurred in this time period.
*/
updateCount?: string | null;
}
/**
* An event period update resource.
*/
export interface Schema$EventUpdateResponse {
/**
* Any batch-wide failures which occurred applying updates.
*/
batchFailures?: Schema$EventBatchRecordFailure[];
/**
* Any failures updating a particular event.
*/
eventFailures?: Schema$EventRecordFailure[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#eventUpdateResponse`.
*/
kind?: string | null;
/**
* The current status of any updated events
*/
playerEvents?: Schema$PlayerEvent[];
}
/**
* Recall tokens for a game.
*/
export interface Schema$GamePlayerToken {
/**
* The application that this player identifier is for.
*/
applicationId?: string | null;
/**
* Recall token data.
*/
recallToken?: Schema$RecallToken;
}
/**
* The payload to request to increment an achievement.
*/
export interface Schema$GamesAchievementIncrement {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#GamesAchievementIncrement`.
*/
kind?: string | null;
/**
* The requestId associated with an increment to an achievement.
*/
requestId?: string | null;
/**
* The number of steps to be incremented.
*/
steps?: number | null;
}
/**
* The payload to request to increment an achievement.
*/
export interface Schema$GamesAchievementSetStepsAtLeast {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#GamesAchievementSetStepsAtLeast`.
*/
kind?: string | null;
/**
* The minimum number of steps for the achievement to be set to.
*/
steps?: number | null;
}
/**
* Response for the GeneratePlayGroupingApiToken RPC.
*/
export interface Schema$GeneratePlayGroupingApiTokenResponse {
/**
* Token for accessing the Play Grouping API.
*/
token?: Schema$PlayGroupingApiToken;
}
/**
* Response for the GenerateRecallPlayGroupingApiToken RPC.
*/
export interface Schema$GenerateRecallPlayGroupingApiTokenResponse {
/**
* Token for accessing the Play Grouping API.
*/
token?: Schema$PlayGroupingApiToken;
}
/**
* Response message for GetMultipleApplicationPlayerIds rpc.
*/
export interface Schema$GetMultipleApplicationPlayerIdsResponse {
/**
* 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.
*/
playerIds?: Schema$ApplicationPlayerId[];
}
/**
* An image asset object.
*/
export interface Schema$ImageAsset {
/**
* The height of the asset.
*/
height?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#imageAsset`.
*/
kind?: string | null;
/**
* The name of the asset.
*/
name?: string | null;
/**
* The URL of the asset.
*/
url?: string | null;
/**
* The width of the asset.
*/
width?: number | null;
}
/**
* The Instance resource.
*/
export interface Schema$Instance {
/**
* URI which shows where a user can acquire this instance.
*/
acquisitionUri?: string | null;
/**
* Platform dependent details for Android.
*/
androidInstance?: Schema$InstanceAndroidDetails;
/**
* Platform dependent details for iOS.
*/
iosInstance?: Schema$InstanceIosDetails;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#instance`.
*/
kind?: string | null;
/**
* Localized display name.
*/
name?: string | null;
/**
* The platform type.
*/
platformType?: string | null;
/**
* Flag to show if this game instance supports realtime play.
*/
realtimePlay?: boolean | null;
/**
* Flag to show if this game instance supports turn based play.
*/
turnBasedPlay?: boolean | null;
/**
* Platform dependent details for Web.
*/
webInstance?: Schema$InstanceWebDetails;
}
/**
* The Android instance details resource.
*/
export interface Schema$InstanceAndroidDetails {
/**
* Flag indicating whether the anti-piracy check is enabled.
*/
enablePiracyCheck?: boolean | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceAndroidDetails`.
*/
kind?: string | null;
/**
* Android package name which maps to Google Play URL.
*/
packageName?: string | null;
/**
* Indicates that this instance is the default for new installations.
*/
preferred?: boolean | null;
}
/**
* The iOS details resource.
*/
export interface Schema$InstanceIosDetails {
/**
* Bundle identifier.
*/
bundleIdentifier?: string | null;
/**
* iTunes App ID.
*/
itunesAppId?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceIosDetails`.
*/
kind?: string | null;
/**
* Indicates that this instance is the default for new installations on iPad devices.
*/
preferredForIpad?: boolean | null;
/**
* Indicates that this instance is the default for new installations on iPhone devices.
*/
preferredForIphone?: boolean | null;
/**
* Flag to indicate if this instance supports iPad.
*/
supportIpad?: boolean | null;
/**
* Flag to indicate if this instance supports iPhone.
*/
supportIphone?: boolean | null;
}
/**
* The Web details resource.
*/
export interface Schema$InstanceWebDetails {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#instanceWebDetails`.
*/
kind?: string | null;
/**
* Launch URL for the game.
*/
launchUrl?: string | null;
/**
* Indicates that this instance is the default for new installations.
*/
preferred?: boolean | null;
}
/**
* The Leaderboard resource.
*/
export interface Schema$Leaderboard {
/**
* The icon for the leaderboard.
*/
iconUrl?: string | null;
/**
* The leaderboard ID.
*/
id?: string | null;
/**
* Indicates whether the icon image being returned is a default image, or is game-provided.
*/
isIconUrlDefault?: boolean | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboard`.
*/
kind?: string | null;
/**
* The name of the leaderboard.
*/
name?: string | null;
/**
* How scores are ordered.
*/
order?: string | null;
}
/**
* The Leaderboard Entry resource.
*/
export interface Schema$LeaderboardEntry {
/**
* The localized string for the numerical value of this score.
*/
formattedScore?: string | null;
/**
* The localized string for the rank of this score for this leaderboard.
*/
formattedScoreRank?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardEntry`.
*/
kind?: string | null;
/**
* The player who holds this score.
*/
player?: Schema$Player;
/**
* The rank of this score for this leaderboard.
*/
scoreRank?: string | null;
/**
* Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
*/
scoreTag?: string | null;
/**
* The numerical value of this score.
*/
scoreValue?: string | null;
/**
* The time span of this high score.
*/
timeSpan?: string | null;
/**
* The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
*/
writeTimestampMillis?: string | null;
}
/**
* A list of leaderboard objects.
*/
export interface Schema$LeaderboardListResponse {
/**
* The leaderboards.
*/
items?: Schema$Leaderboard[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardListResponse`.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results.
*/
nextPageToken?: string | null;
}
/**
* A score rank in a leaderboard.
*/
export interface Schema$LeaderboardScoreRank {
/**
* The number of scores in the leaderboard as a string.
*/
formattedNumScores?: string | null;
/**
* The rank in the leaderboard as a string.
*/
formattedRank?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScoreRank`.
*/
kind?: string | null;
/**
* The number of scores in the leaderboard.
*/
numScores?: string | null;
/**
* The rank in the leaderboard.
*/
rank?: string | null;
}
/**
* A ListScores response.
*/
export interface Schema$LeaderboardScores {
/**
* The scores in the leaderboard.
*/
items?: Schema$LeaderboardEntry[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboardScores`.
*/
kind?: string | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
/**
* The total number of scores in the leaderboard.
*/
numScores?: string | null;
/**
* 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.
*/
playerScore?: Schema$LeaderboardEntry;
/**
* The pagination token for the previous page of results.
*/
prevPageToken?: string | null;
}
/**
* Request to link an in-game account with a PGS principal (encoded in the session id).
*/
export interface Schema$LinkPersonaRequest {
/**
* Required. Cardinality constraint to observe when linking a persona to a player in the scope of a game.
*/
cardinalityConstraint?: string | null;
/**
* Required. Resolution policy to apply when the linking of a persona to a player would result in violating the specified cardinality constraint.
*/
conflictingLinksResolutionPolicy?: string | null;
/**
* Input only. Optional expiration time.
*/
expireTime?: string | null;
/**
* Required. Stable identifier of the in-game account. Please refrain from re-using the same persona for different games.
*/
persona?: string | null;
/**
* Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.
*/
sessionId?: string | null;
/**
* Required. Value of the token to create. Opaque to Play Games and assumed to be non-stable (encrypted with key rotation).
*/
token?: string | null;
/**
* Input only. Optional time-to-live.
*/
ttl?: string | null;
}
/**
* Outcome of a persona linking attempt.
*/
export interface Schema$LinkPersonaResponse {
/**
* Output only. State of a persona linking attempt.
*/
state?: string | null;
}
/**
* The metagame config resource
*/
export interface Schema$MetagameConfig {
/**
* Current version of the metagame configuration data. When this data is updated, the version number will be increased by one.
*/
currentVersion?: number | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#metagameConfig`.
*/
kind?: string | null;
/**
* The list of player levels.
*/
playerLevels?: Schema$PlayerLevel[];
}
/**
* A Player resource.
*/
export interface Schema$Player {
/**
* The base URL for the image that represents the player.
*/
avatarImageUrl?: string | null;
/**
* The url to the landscape mode player banner image.
*/
bannerUrlLandscape?: string | null;
/**
* The url to the portrait mode player banner image.
*/
bannerUrlPortrait?: string | null;
/**
* The name to display for the player.
*/
displayName?: string | null;
/**
* An object to represent Play Game experience information for the player.
*/
experienceInfo?: Schema$PlayerExperienceInfo;
/**
* 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.
*/
friendStatus?: string | null;
/**
* Per-application unique player identifier.
*/
gamePlayerId?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#player`
*/
kind?: string | null;
/**
* A representation of the individual components of the name.
*/
name?: {
familyName?: string;
givenName?: string;
} | null;
/**
* 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.
*/
originalPlayerId?: string | null;
/**
* The ID of the player.
*/
playerId?: string | null;
/**
* The player's profile settings. Controls whether or not the player's profile is visible to other players.
*/
profileSettings?: Schema$ProfileSettings;
/**
* The player's title rewarded for their game activities.
*/
title?: string | null;
}
/**
* An achievement object.
*/
export interface Schema$PlayerAchievement {
/**
* The state of the achievement.
*/
achievementState?: string | null;
/**
* The current steps for an incremental achievement.
*/
currentSteps?: number | null;
/**
* 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.
*/
experiencePoints?: string | null;
/**
* The current steps for an incremental achievement as a string.
*/
formattedCurrentStepsString?: string | null;
/**
* The ID of the achievement.
*/
id?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievement`.
*/
kind?: string | null;
/**
* The timestamp of the last modification to this achievement's state.
*/
lastUpdatedTimestamp?: string | null;
}
/**
* A list of achievement objects.
*/
export interface Schema$PlayerAchievementListResponse {
/**
* The achievements.
*/
items?: Schema$PlayerAchievement[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerAchievementListResponse`.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results.
*/
nextPageToken?: string | null;
}
/**
* An event status resource.
*/
export interface Schema$PlayerEvent {
/**
* The ID of the event definition.
*/
definitionId?: string | null;
/**
* 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.
*/
formattedNumEvents?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEvent`.
*/
kind?: string | null;
/**
* The current number of times this event has occurred.
*/
numEvents?: string | null;
/**
* The ID of the player.
*/
playerId?: string | null;
}
/**
* A ListByPlayer response.
*/
export interface Schema$PlayerEventListResponse {
/**
* The player events.
*/
items?: Schema$PlayerEvent[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerEventListResponse`.
*/
kind?: string | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
}
/**
* 1P/3P metadata about the player's experience.
*/
export interface Schema$PlayerExperienceInfo {
/**
* The current number of experience points for the player.
*/
currentExperiencePoints?: string | null;
/**
* The current level of the player.
*/
currentLevel?: Schema$PlayerLevel;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerExperienceInfo`.
*/
kind?: string | null;
/**
* The timestamp when the player was leveled up, in millis since Unix epoch UTC.
*/
lastLevelUpTimestampMillis?: string | null;
/**
* The next level of the player. If the current level is the maximum level, this should be same as the current level.
*/
nextLevel?: Schema$PlayerLevel;
}
/**
* A player leaderboard score object.
*/
export interface Schema$PlayerLeaderboardScore {
/**
* The rank of the score in the friends collection for this leaderboard.
*/
friendsRank?: Schema$LeaderboardScoreRank;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScore`.
*/
kind?: string | null;
/**
* The ID of the leaderboard this score is in.
*/
leaderboard_id?: string | null;
/**
* The public rank of the score in this leaderboard. This object will not be present if the user is not sharing their scores publicly.
*/
publicRank?: Schema$LeaderboardScoreRank;
/**
* The formatted value of this score.
*/
scoreString?: string | null;
/**
* Additional information about the score. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
*/
scoreTag?: string | null;
/**
* The numerical value of this score.
*/
scoreValue?: string | null;
/**
* The social rank of the score in this leaderboard.
*/
socialRank?: Schema$LeaderboardScoreRank;
/**
* The time span of this score.
*/
timeSpan?: string | null;
/**
* The timestamp at which this score was recorded, in milliseconds since the epoch in UTC.
*/
writeTimestamp?: string | null;
}
/**
* A list of player leaderboard scores.
*/
export interface Schema$PlayerLeaderboardScoreListResponse {
/**
* The leaderboard scores.
*/
items?: Schema$PlayerLeaderboardScore[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLeaderboardScoreListResponse`.
*/
kind?: string | null;
/**
* The pagination token for the next page of results.
*/
nextPageToken?: string | null;
/**
* The Player resources for the owner of this score.
*/
player?: Schema$Player;
}
/**
* 1P/3P metadata about a user's level.
*/
export interface Schema$PlayerLevel {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerLevel`.
*/
kind?: string | null;
/**
* The level for the user.
*/
level?: number | null;
/**
* The maximum experience points for this level.
*/
maxExperiencePoints?: string | null;
/**
* The minimum experience points for this level.
*/
minExperiencePoints?: string | null;
}
/**
* A third party player list response.
*/
export interface Schema$PlayerListResponse {
/**
* The players.
*/
items?: Schema$Player[];
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerListResponse`.
*/
kind?: string | null;
/**
* Token corresponding to the next page of results.
*/
nextPageToken?: string | null;
}
/**
* A player score.
*/
export interface Schema$PlayerScore {
/**
* The formatted score for this player score.
*/
formattedScore?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScore`.
*/
kind?: string | null;
/**
* The numerical value for this player score.
*/
score?: string | null;
/**
* Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
*/
scoreTag?: string | null;
/**
* The time span for this player score.
*/
timeSpan?: string | null;
}
/**
* A list of score submission statuses.
*/
export interface Schema$PlayerScoreListResponse {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreListResponse`.
*/
kind?: string | null;
/**
* The score submissions statuses.
*/
submittedScores?: Schema$PlayerScoreResponse[];
}
/**
* A list of leaderboard entry resources.
*/
export interface Schema$PlayerScoreResponse {
/**
* The time spans where the submitted score is better than the existing score for that time span.
*/
beatenScoreTimeSpans?: string[] | null;
/**
* The formatted value of the submitted score.
*/
formattedScore?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreResponse`.
*/
kind?: string | null;
/**
* The leaderboard ID that this score was submitted to.
*/
leaderboardId?: string | null;
/**
* Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
*/
scoreTag?: string | null;
/**
* 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.
*/
unbeatenScores?: Schema$PlayerScore[];
}
/**
* A list of score submission requests.
*/
export interface Schema$PlayerScoreSubmissionList {
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#playerScoreSubmissionList`.
*/
kind?: string | null;
/**
* The score submissions.
*/
scores?: Schema$ScoreSubmission[];
}
/**
* Token data returned from GeneratePlayGroupingApiToken RPC.
*/
export interface Schema$PlayGroupingApiToken {
/**
* Value of the token.
*/
tokenValue?: string | null;
}
/**
* Profile settings
*/
export interface Schema$ProfileSettings {
friendsListVisibility?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#profileSettings`.
*/
kind?: string | null;
/**
* Whether the player's profile is visible to the currently signed in player.
*/
profileVisible?: boolean | null;
}
/**
* Recall token data returned from RetrievePlayerTokens RPC
*/
export interface Schema$RecallToken {
/**
* Optional. Optional expiration time of the token
*/
expireTime?: string | null;
/**
* Required. Whether the persona identified by the token is linked to multiple PGS Players
*/
multiPlayerPersona?: boolean | null;
/**
* Required. Value of the Recall token as it is provided by the client via LinkPersona RPC
*/
token?: string | null;
}
/**
* Request to remove all Recall tokens associated with a persona for an app.
*/
export interface Schema$ResetPersonaRequest {
/**
* Value of the 'persona' field as it was provided by the client in LinkPersona RPC
*/
persona?: string | null;
}
/**
* Response for the ResetPersona RPC
*/
export interface Schema$ResetPersonaResponse {
/**
* Required. Whether any tokens were unlinked as a result of this request.
*/
unlinked?: boolean | null;
}
/**
* Recall token data returned from for the RetrieveDeveloperGamesLastPlayerToken RPC
*/
export interface Schema$RetrieveDeveloperGamesLastPlayerTokenResponse {
/**
* 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.
*/
gamePlayerToken?: Schema$GamePlayerToken;
}
/**
* A list of recall token data returned from the RetrieveGamesPlayerTokens RPC
*/
export interface Schema$RetrieveGamesPlayerTokensResponse {
/**
* 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.
*/
gamePlayerTokens?: Schema$GamePlayerToken[];
}
/**
* Response for the RetrievePlayerTokens RPC
*/
export interface Schema$RetrievePlayerTokensResponse {
/**
* Required. Recall tokens associated with the requested PGS Player principal
*/
tokens?: Schema$RecallToken[];
}
/**
* A third party checking a revision response.
*/
export interface Schema$RevisionCheckResponse {
/**
* The version of the API this client revision should use when calling API methods.
*/
apiVersion?: string | null;
/**
* Uniquely identifies the type of this resource. Value is always the fixed string `games#revisionCheckResponse`.
*/
kin