API Reference

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. AchievementDefinitions
  2. Achievements
  3. Applications
  4. Events
  5. Leaderboards
  6. Metagame
  7. Players
  8. Pushtokens
  9. QuestMilestones
  10. Quests
  11. Revisions
  12. Rooms
  13. Scores
  14. Snapshots
  15. Stats
  16. TurnBasedMatches

AchievementDefinitions

For AchievementDefinitions Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
list GET  /achievements Lists all the achievement definitions for your application.

Achievements

For Achievements Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
increment POST  /achievements/achievementId/increment Increments the steps of the achievement with the given ID for the currently authenticated player.

Required query parameters: stepsToIncrement

list GET  /players/playerId/achievements Lists the progress for all your application's achievements for the currently authenticated player.
reveal POST  /achievements/achievementId/reveal Sets the state of the achievement with the given ID to REVEALED for the currently authenticated player.
setStepsAtLeast POST  /achievements/achievementId/setStepsAtLeast 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.

Required query parameters: steps

unlock POST  /achievements/achievementId/unlock Unlocks this achievement for the currently authenticated player.
updateMultiple POST  /achievements/updateMultiple Updates multiple achievements for the currently authenticated player.

Applications

For Applications Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
get GET  /applications/applicationId 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.
played POST  /applications/played Indicate that the the currently authenticated user is playing your application.
verify GET  /applications/applicationId/verify 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.

Events

For Events Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
listByPlayer GET  /events Returns a list showing the current progress on events in this application for the currently authenticated user.
listDefinitions GET  /eventDefinitions Returns a list of the event definitions in this application.
record POST  /events Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.

Leaderboards

For Leaderboards Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
get GET  /leaderboards/leaderboardId Retrieves the metadata of the leaderboard with the given ID.
list GET  /leaderboards Lists all the leaderboard metadata for your application.

Metagame

For Metagame Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
getMetagameConfig GET  /metagameConfig Return the metagame configuration data for the calling application.
listCategoriesByPlayer GET  /players/playerId/categories/collection List play data aggregated per category for the player corresponding to playerId.

Players

For Players Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
get GET  /players/playerId Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId to me.
list GET  /players/me/players/collection Get the collection of players for the currently authenticated user.

Pushtokens

For Pushtokens Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
remove POST  /pushtokens/remove Removes a push token for the current user and application. Removing a non-existent push token will report success.
update PUT  /pushtokens Registers a push token for the current user and application.

QuestMilestones

For QuestMilestones Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
claim PUT  /quests/questId/milestones/milestoneId/claim Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user.

Required query parameters: requestId

Quests

For Quests Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
accept POST  /quests/questId/accept Indicates that the currently authorized user will participate in the quest.
list GET  /players/playerId/quests Get a list of quests for your application and the currently authenticated player.

Revisions

For Revisions Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
check GET  /revisions/check Checks whether the games client is out of date.

Required query parameters: clientRevision

Rooms

For Rooms Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
create POST  /rooms/create Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
decline POST  /rooms/roomId/decline Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
dismiss POST  /rooms/roomId/dismiss Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
get GET  /rooms/roomId Get the data for a room.
join POST  /rooms/roomId/join Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
leave POST  /rooms/roomId/leave Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.
list GET  /rooms Returns invitations to join rooms.
reportStatus POST  /rooms/roomId/reportstatus Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Scores

For Scores Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
get GET  /players/playerId/leaderboards/leaderboardId/scores/timeSpan 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'.
list GET  /leaderboards/leaderboardId/scores/collection Lists the scores in a leaderboard, starting from the top.

Required query parameters: timeSpan

listWindow GET  /leaderboards/leaderboardId/window/collection Lists the scores in a leaderboard around (and including) a player's score.

Required query parameters: timeSpan

submit POST  /leaderboards/leaderboardId/scores Submits a score to the specified leaderboard.

Required query parameters: score

submitMultiple POST  /leaderboards/scores Submits multiple scores to leaderboards.

Snapshots

For Snapshots Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
get GET  /snapshots/snapshotId Retrieves the metadata for a given snapshot ID.
list GET  /players/playerId/snapshots Retrieves a list of snapshots created by your application for the player corresponding to the player ID.

Stats

For Stats Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
get GET  /stats Returns engagement and spend statistics in this application for the currently authenticated user.

TurnBasedMatches

For TurnBasedMatches Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/games/v1, unless otherwise noted
cancel PUT  /turnbasedmatches/matchId/cancel Cancel a turn-based match.
create POST  /turnbasedmatches/create Create a turn-based match.
decline PUT  /turnbasedmatches/matchId/decline Decline an invitation to play a turn-based match.
dismiss PUT  /turnbasedmatches/matchId/dismiss Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.
finish PUT  /turnbasedmatches/matchId/finish Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state.
get GET  /turnbasedmatches/matchId Get the data for a turn-based match.
join PUT  /turnbasedmatches/matchId/join Join a turn-based match.
leave PUT  /turnbasedmatches/matchId/leave Leave a turn-based match when it is not the current player's turn, without canceling the match.
leaveTurn PUT  /turnbasedmatches/matchId/leaveTurn Leave a turn-based match during the current player's turn, without canceling the match.

Required query parameters: matchVersion

list GET  /turnbasedmatches Returns turn-based matches the player is or was involved in.
rematch POST  /turnbasedmatches/matchId/rematch Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn.
sync GET  /turnbasedmatches/sync Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.
takeTurn PUT  /turnbasedmatches/matchId/turn Commit the results of a player turn.

Send feedback about...

Play Games Services for Web
Play Games Services for Web