An achievement definition object.
Lists all the achievement definitions for your application.
A builder providing access to all methods supported on
achievementDefinition resources.
It is not used directly, but through the
Games
hub.
A list of achievement definition objects.
Increments the steps of the achievement with the given ID for the currently authenticated player.
An achievement increment response
Lists the progress for all your application’s achievements for the currently authenticated player.
A builder providing access to all methods supported on
achievement resources.
It is not used directly, but through the
Games
hub.
Sets the state of the achievement with the given ID to REVEALED
for the currently authenticated player.
An achievement reveal response
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.
An achievement set steps at least response.
Unlocks this achievement for the currently authenticated player.
An achievement unlock response
Updates multiple achievements for the currently authenticated player.
A list of achievement update requests.
Response message for UpdateMultipleAchievements rpc.
A request to update an achievement.
An updated achievement.
The Application resource.
An application category object.
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.
Returns a URL for the requested end point type.
A builder providing access to all methods supported on
application resources.
It is not used directly, but through the
Games
hub.
Indicate that the currently authenticated user is playing your application.
Primary scoped player identifier for an application.
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.
A third party application verification response resource.
Data related to individual game categories.
A third party list metagame categories response.
Container for a URL end point of the requested type.
A batch update failure resource.
An event child relationship resource.
An event definition resource.
A ListDefinitions response.
Returns a list showing the current progress on events in this application for the currently authenticated user.
Returns a list of the event definitions in this application.
A builder providing access to all methods supported on
event resources.
It is not used directly, but through the
Games
hub.
An event period time range.
An event period update resource.
Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.
An event update failure resource.
An event period update resource.
An event period update resource.
An event period update resource.
Central instance to access all Games related resource activities
The payload to request to increment an achievement.
The payload to request to increment an achievement.
Response message for GetMultipleApplicationPlayerIds rpc.
An image asset object.
The Instance resource.
The Android instance details resource.
The iOS details resource.
The Web details resource.
The Leaderboard resource.
The Leaderboard Entry resource.
Retrieves the metadata of the leaderboard with the given ID.
Lists all the leaderboard metadata for your application.
A list of leaderboard objects.
A builder providing access to all methods supported on
leaderboard resources.
It is not used directly, but through the
Games
hub.
A score rank in a leaderboard.
A ListScores response.
Request to link an in-game account with a PGS principal (encoded in the session id).
Outcome of a persona linking attempt.
The metagame config resource
Return the metagame configuration data for the calling application.
List play data aggregated per category for the player corresponding to playerId
.
A builder providing access to all methods supported on
metagame resources.
It is not used directly, but through the
Games
hub.
A Player resource.
An achievement object.
A list of achievement objects.
An event status resource.
A ListByPlayer response.
1P/3P metadata about the player’s experience.
Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId
to me
.
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.
Retrieves scoped player identifiers for currently authenticated user.
A player leaderboard score object.
A list of player leaderboard scores.
1P/3P metadata about a user’s level.
Get the collection of players for the currently authenticated user.
A third party player list response.
A builder providing access to all methods supported on
player resources.
It is not used directly, but through the
Games
hub.
A representation of the individual components of the name.
A player score.
A list of score submission statuses.
A list of leaderboard entry resources.
A list of score submission requests.
Profile settings
Associate the PGS Player principal encoded in the provided recall session id with an in-game account
A builder providing access to all methods supported on
recall resources.
It is not used directly, but through the
Games
hub.
Delete all Recall tokens linking the given persona to any player (with or without a profile).
Retrieve all Recall tokens associated with the PGS Player principal encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.
Recall token data returned from RetrievePlayerTokens RPC
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.
Request to remove all Recall tokens associated with a persona for an app.
Response for the ResetPersona RPC
Response for the RetrievePlayerTokens RPC
Checks whether the games client is out of date.
A third party checking a revision response.
A builder providing access to all methods supported on
revision resources.
It is not used directly, but through the
Games
hub.
Scoped player identifiers.
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’.
Lists the scores in a leaderboard, starting from the top.
Lists the scores in a leaderboard around (and including) a player’s score.
A builder providing access to all methods supported on
score resources.
It is not used directly, but through the
Games
hub.
A request to submit a score to leaderboards.
Submits a score to the specified leaderboard.
Submits multiple scores to leaderboards.
An snapshot object.
Retrieves the metadata for a given snapshot ID.
An image of a snapshot.
Retrieves a list of snapshots created by your application for the player corresponding to the player ID.
A third party list snapshots response.
A builder providing access to all methods supported on
snapshot resources.
It is not used directly, but through the
Games
hub.
Returns engagement and spend statistics in this application for the currently authenticated user.
A builder providing access to all methods supported on
stat resources.
It is not used directly, but through the
Games
hub.
A third party stats resource.
Request to remove a Recall token linking PGS principal and an in-game account
Response for the UnlinkPersona RPC