Method: scores.get

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

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 友達コレクションのランクを取得します。