Scores: get

Requires authorization

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'. Try it now.

Request

HTTP request

GET https://www.googleapis.com/games/v1/players/playerId/leaderboards/leaderboardId/scores/timeSpan

Parameters

Parameter name Value Description
Path parameters
leaderboardId string The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application.
playerId string A player ID. A value of me may be used in place of the authenticated player's ID.
timeSpan string The time span for the scores and ranks you're requesting.

Acceptable values are:
  • "ALL": Get the high scores for all time spans. If this is used, maxResults values will be ignored.
  • "ALL_TIME": Get the all time high score.
  • "DAILY": List the top scores for the current day.
  • "WEEKLY": List the top scores for the current week.
Optional query parameters
consistencyToken long The last-seen mutation timestamp.
includeRankType string The types of ranks to return. If the parameter is omitted, no ranks will be returned.

Acceptable values are:
  • "ALL": Retrieve public and social ranks.
  • "PUBLIC": Retrieve public ranks, if the player is sharing their gameplay activity publicly.
  • "SOCIAL": Retrieve the social rank.
language string The preferred language to use for strings returned by this method.
maxResults integer 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. Acceptable values are 1 to 30, inclusive.
pageToken string The token returned by the previous request.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/games

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Scores resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Play Games Services for Web
Play Games Services for Web