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

Scopes

You will need authorization for the https://www.googleapis.com/auth/games scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/games. You can set the scope for this method like this: games1 --scope <scope> scores list-window ...

Required Scalar Arguments

  • <leaderboard-id> (string)
    • The ID of the leaderboard.
  • <collection> (string)
    • The collection of scores you're requesting.
  • <time-span> (string)
    • Required. The time span for the scores and ranks you're requesting.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p language=string

    • The preferred language to use for strings returned by this method.

  • -p max-results=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.

  • -p page-token=string

    • The token returned by the previous request.

  • -p results-above=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.

  • -p return-top-if-absent=boolean

    • True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").