REST Resource: leaderboards

Resource: Leaderboard

The Leaderboard resource.

JSON representation
{
  "kind": string,
  "id": string,
  "name": string,
  "iconUrl": string,
  "isIconUrlDefault": boolean,
  "order": enum (ScoreOrder)
}
Fields
kind

string

Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboard.

id

string

The leaderboard ID.

name

string

The name of the leaderboard.

iconUrl

string

The icon for the leaderboard.

isIconUrlDefault

boolean

Indicates whether the icon image being returned is a default image, or is game-provided.

order

enum (ScoreOrder)

How scores are ordered.

ScoreOrder

Possible score orders.

Enums
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

Methods

get

Retrieves the metadata of the leaderboard with the given ID.

list

Lists all the leaderboard metadata for your application.