Method: scores.listWindow

Lists the scores in a leaderboard around (and including) a player's score.

HTTP request

GET https://games.googleapis.com/games/v1/leaderboards/{leaderboardId}/window/{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.
resultsAbove

integer

The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.
returnTopIfAbsent

boolean

True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
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.