Method: scores.get

現在認証されているプレーヤーのリーダーボードでハイスコアと、必要に応じてランクを取得します。特定の期間については、leaderboardId を ALL に設定して、その期間内のすべてのリーダーボードのデータを取得できます。「注: 同じリクエストで「ALL」のリーダーボードと「ALL」の期間をリクエストすることはできません。1 つのパラメータのみを「ALL」に設定できます。

HTTP リクエスト

GET https://games.googleapis.com/games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}

パスパラメータ

パラメータ
playerId

string

プレーヤー ID。認証済みのプレーヤーの ID の代わりに、me の値を使用できます。
leaderboardId

string

リーダーボードの ID。「ALL」に設定すると、このアプリのすべてのリーダーボードのデータが取得されます。
timeSpan

enum (ScoreTimeSpan)

リクエストするスコアとランクの期間。

クエリ パラメータ

パラメータ
language

string

このメソッドによって返される文字列に使用する優先言語。
includeRankType

enum (IncludeRankType)

返されるランクのタイプ。このパラメータを省略すると、ランクは返されません。
maxResults

integer

レスポンスで返されるリーダーボード スコアの最大数。レスポンスごとに、返されるリーダーボード スコアの実際の数は、指定された maxResults より少なくなる場合があります。
pageToken

string

前のリクエストで返されたトークン。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には GetLeaderboardScoresResponse のインスタンスが含まれます。

認可スコープ

次のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/games
  • https://www.googleapis.com/auth/games_lite

詳しくは、OAuth 2.0 の概要をご覧ください。

ScoreTimeSpan

スコアの可能な期間を定義します。

列挙型
ALL すべての期間の最高スコアを取得します。このオプションを使用すると、maxResults の値は無視されます。
ALL_TIME 歴代最高のスコアを獲得する。
WEEKLY 当日の最高スコアを一覧表示します。
DAILY 今週のトップスコアを一覧表示します。

IncludeRankType

ランクタイプの有効な値。

列挙型
ALL サポートされているすべてのランクを取得します。HTTP では、このパラメータ値を ALL として指定することもできます。
PUBLIC プレーヤーがゲームプレイ アクティビティを一般公開している場合は、公開ランクを取得します。
SOCIAL

（非推奨）ソーシャル ランクを取得します。
FRIENDS 友達コレクションのランクを取得します。