Following the deprecation of the Google Sign-In API, we are removing the games v1 SDK in 2026. After February 2025, you will be unable to publish titles that are newly integrated with games v1 SDK, on Google Play. We recommend that you use the games v2 SDK instead.
While existing titles with the previous games v1 integrations continue to function for a couple of years, you are encouraged to migrate to v2 starting June 2025.
Leaderboards.LeaderboardMetadataResult
Stay organized with collections
Save and categorize content based on your preferences.
This interface is deprecated.
LeaderboardBuffer
is returned directly in the LeaderboardsClient
.
Result delivered when leaderboard metadata has been loaded.
Possible status codes include:
Inherited Method Summary
From interface com.google.android.gms.common.api.Result
From interface
com.google.android.gms.common.api.Releasable
Public Methods
public abstract
LeaderboardBuffer getLeaderboards
()
Returns
- The leaderboard metadata that was requested. This is guaranteed to be non-null,
though it may be empty. The listener must close this object when finished.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-24 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 2025-01-24 UTC."],[[["\u003cp\u003e\u003ccode\u003eLeaderboards.LeaderboardMetadataResult\u003c/code\u003e is deprecated and \u003ccode\u003eLeaderboardBuffer\u003c/code\u003e is now used directly with \u003ccode\u003eLeaderboardsClient\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis interface delivers results when leaderboard metadata is loaded, with potential status codes indicating success, network issues, licensing problems, or internal errors.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetLeaderboards()\u003c/code\u003e method returns a \u003ccode\u003eLeaderboardBuffer\u003c/code\u003e containing the requested leaderboard metadata, which may be empty but is always non-null.\u003c/p\u003e\n"]]],["The `Leaderboards.LeaderboardMetadataResult` interface, now deprecated, delivers results when leaderboard metadata is loaded. It returns a `LeaderboardBuffer` via the `getLeaderboards()` method, which must be closed after use. Possible status codes indicate success (`STATUS_OK`), network errors (`STATUS_NETWORK_ERROR_NO_DATA`, `STATUS_NETWORK_ERROR_STALE_DATA`), reconnection needs (`STATUS_CLIENT_RECONNECT_REQUIRED`), licensing issues (`STATUS_LICENSE_CHECK_FAILED`), or internal errors (`STATUS_INTERNAL_ERROR`). This result also implements methods to get the status and to release the buffer.\n"],null,["# Leaderboards.LeaderboardMetadataResult\n\npublic static interface **Leaderboards.LeaderboardMetadataResult** implements [Result](/android/reference/com/google/android/gms/common/api/Result) [Releasable](/android/reference/com/google/android/gms/common/api/Releasable) \n**This interface is deprecated.** \n\n[LeaderboardBuffer](/android/games_v1/reference/com/google/android/gms/games/leaderboard/LeaderboardBuffer) is returned directly in the [LeaderboardsClient](/android/games_v1/reference/com/google/android/gms/games/LeaderboardsClient).\n\nResult delivered when leaderboard metadata has been loaded.\n\nPossible status codes include:\n\n- [GamesStatusCodes.STATUS_OK](/android/games_v1/reference/com/google/android/gms/games/GamesStatusCodes#STATUS_OK) if data was successfully loaded and is up-to-date.\n- [GamesStatusCodes.STATUS_NETWORK_ERROR_NO_DATA](/android/games_v1/reference/com/google/android/gms/games/GamesStatusCodes#STATUS_NETWORK_ERROR_NO_DATA) if the device was unable to retrieve any data from the network and has no data cached locally.\n- [GamesStatusCodes.STATUS_NETWORK_ERROR_STALE_DATA](/android/games_v1/reference/com/google/android/gms/games/GamesStatusCodes#STATUS_NETWORK_ERROR_STALE_DATA) if the device was unable to retrieve the latest data from the network, but has some data cached locally.\n- [GamesStatusCodes.STATUS_CLIENT_RECONNECT_REQUIRED](/android/games_v1/reference/com/google/android/gms/games/GamesStatusCodes#STATUS_CLIENT_RECONNECT_REQUIRED) if the client needs to reconnect to the service to access this data.\n- [GamesStatusCodes.STATUS_LICENSE_CHECK_FAILED](/android/games_v1/reference/com/google/android/gms/games/GamesStatusCodes#STATUS_LICENSE_CHECK_FAILED) if the game is not licensed to the user.\n- [GamesStatusCodes.STATUS_INTERNAL_ERROR](/android/games_v1/reference/com/google/android/gms/games/GamesStatusCodes#STATUS_INTERNAL_ERROR) if an unexpected error occurred in the service. \n\n### Public Method Summary\n\n|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [LeaderboardBuffer](/android/games_v1/reference/com/google/android/gms/games/leaderboard/LeaderboardBuffer) | [getLeaderboards](/android/games_v1/reference/com/google/android/gms/games/leaderboard/Leaderboards.LeaderboardMetadataResult#getLeaderboards())() |\n\n### Inherited Method Summary\n\nFrom interface com.google.android.gms.common.api.Result \n\n|--------------------------------------------------------------------------------|-------------|\n| abstract [Status](/android/reference/com/google/android/gms/common/api/Status) | getStatus() |\n\nFrom interface com.google.android.gms.common.api.Releasable \n\n|---------------|-----------|\n| abstract void | release() |\n\nPublic Methods\n--------------\n\n#### public abstract [LeaderboardBuffer](/android/games_v1/reference/com/google/android/gms/games/leaderboard/LeaderboardBuffer) **getLeaderboards**\n()\n\n##### Returns\n\n- The leaderboard metadata that was requested. This is guaranteed to be non-null, though it may be empty. The listener must close this object when finished."]]