REST Resource: leaderboards
Stay organized with collections
Save and categorize content based on your preferences.
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
| 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 |
|
|
Retrieves the metadata of the leaderboard with the given ID. |
|
|
Lists all the leaderboard metadata for your application. |
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,["# REST Resource: leaderboards\n\n- [Resource: Leaderboard](#Leaderboard)\n - [JSON representation](#Leaderboard.SCHEMA_REPRESENTATION)\n- [ScoreOrder](#ScoreOrder)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Leaderboard\n---------------------\n\nThe Leaderboard resource.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"id\": string, \"name\": string, \"iconUrl\": string, \"isIconUrlDefault\": boolean, \"order\": enum (/games/services/web/api/rest/v1/leaderboards#ScoreOrder) } ``` |\n\n| Fields ||\n|--------------------|---------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Uniquely identifies the type of this resource. Value is always the fixed string `games#leaderboard`. |\n| `id` | `string` The leaderboard ID. |\n| `name` | `string` The name of the leaderboard. |\n| `iconUrl` | `string` The icon for the leaderboard. |\n| `isIconUrlDefault` | `boolean` Indicates whether the icon image being returned is a default image, or is game-provided. |\n| `order` | `enum (`[ScoreOrder](/games/services/web/api/rest/v1/leaderboards#ScoreOrder)`)` How scores are ordered. |\n\nScoreOrder\n----------\n\nPossible score orders.\n\n| Enums ||\n|---------------------|-----------------------------------------------------------------|\n| `LARGER_IS_BETTER` | Larger values are better; scores are sorted in descending order |\n| `SMALLER_IS_BETTER` | Smaller values are better; scores are sorted in ascending order |\n\n| Methods ------- ||\n|---------------------------------------------------------------|--------------------------------------------------------------|\n| ### [get](/games/services/web/api/rest/v1/leaderboards/get) | Retrieves the metadata of the leaderboard with the given ID. |\n| ### [list](/games/services/web/api/rest/v1/leaderboards/list) | Lists all the leaderboard metadata for your application. |"]]
