Leaderboards

For a list of methods for this resource, see the end of this page.

Resource representations

This is a JSON template for the Leaderboard resource.

{
  "kind": "games#leaderboard",
  "id": string,
  "name": string,
  "iconUrl": string,
  "isIconUrlDefault": boolean,
  "order": string
}

Property name	Value	Description	Notes
iconUrl	string	The icon for the leaderboard.
id	string	The leaderboard ID.
isIconUrlDefault	boolean	Indicates whether the icon image being returned is a default image, or is game-provided.
kind	string	Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboard.
name	string	The name of the leaderboard.
order	string	How scores are ordered. Possible values are: "LARGER_IS_BETTER" - Larger values are better; scores are sorted in descending order. "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in ascending order. Acceptable values are: "LARGER_IS_BETTER" "SMALLER_IS_BETTER"

Methods

get

Retrieves the metadata of the leaderboard with the given ID.

list

Lists all the leaderboard metadata for your application.