Method: scores.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the scores in a leaderboard, starting from the top.
HTTP request
GET https://games.googleapis.com/games/v1/leaderboards/{leaderboardId}/scores/{collection}
Path parameters
| Parameters |
leaderboardId |
string
The ID of the leaderboard.
|
collection |
enum (ScoreCollection)
The collection of scores you're requesting.
|
Query parameters
| Parameters |
language |
string
The preferred language to use for strings returned by this method.
|
timeSpan |
enum (ScoreTimeSpan)
Required. The time span for the scores and ranks you're requesting.
|
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.
|
pageToken |
string
The token returned by the previous request.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListLeaderboardScoresResponse.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/games
https://www.googleapis.com/auth/games_lite
For more information, see the OAuth 2.0 Overview.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-28 UTC."],[],[],null,["# Method: scores.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the scores in a leaderboard, starting from the top.\n\n### HTTP request\n\n`GET https://games.googleapis.com/games/v1/leaderboards/{leaderboardId}/scores/{collection}`\n\n### Path parameters\n\n| Parameters ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------|\n| `leaderboardId` | `string` The ID of the leaderboard. |\n| `collection` | `enum (`[ScoreCollection](/games/services/web/api/rest/v1/ScoreCollection)`)` The collection of scores you're requesting. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `language` | `string` The preferred language to use for strings returned by this method. |\n| `timeSpan` | `enum (`[ScoreTimeSpan](/games/services/web/api/rest/v1/scores#ScoreTimeSpan)`)` Required. The time span for the scores and ranks you're requesting. |\n| `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`. |\n| `pageToken` | `string` The token returned by the previous request. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListLeaderboardScoresResponse](/games/services/web/api/rest/v1/ListLeaderboardScoresResponse).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/games`\n- `\n https://www.googleapis.com/auth/games_lite`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
