Scores: get

現在認証されているプレーヤーのリーダーボードで、ハイスコアとランキング(任意)を取得する。特定の期間では、leaderboardIdALL に設定して、特定の期間のすべてのリーダーボードのデータを取得できます。
注: 同じリクエストで「ALL」リーダーボードと「ALL」timeSpans をリクエストすることはできません。「ALL」に設定できるのは 1 つのパラメータのみです。こちらから今すぐお試しください。

リクエスト

HTTP リクエスト

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

パラメータ

パラメータ名 説明
パスパラメータ
leaderboardId string リーダーボードの ID。「ALL」に設定すると、このアプリのすべてのリーダーボードのデータを取得できます。
playerId string プレーヤー ID。認証済みプレーヤーの ID の代わりに値 me を使用できます。
timeSpan string リクエストするスコアとランクの期間。

有効な値は次のとおりです。
  • "ALL": すべての期間のハイスコアを取得します。これを使用すると、maxResults 値は無視されます。
  • "ALL_TIME": 常にハイスコアを獲得します。
  • DAILY: 現在の日付における上位のスコアを一覧表示します。
  • WEEKLY: 今週のトップスコアを一覧表示します。
省略可能なクエリ パラメータ
includeRankType string 返されるランクのタイプ。このパラメータを省略すると、ランクは返されません。

有効な値は次のとおりです。
  • "ALL": サポートされているすべてのランクを取得します。
  • "FRIENDS": 友だちコレクションでランクを取得します。
  • "PUBLIC": プレーヤーがゲームプレイ アクティビティを一般公開で共有している場合、公開ランクを取得します。
  • "SOCIAL": (廃止)以前の G+ ソーシャル リーダーボード ランク、常に 1
language string このメソッドから返される文字列に使用する言語。
maxResults integer レスポンスで返されるリーダーボード スコアの最大数。レスポンスで返される実際のリーダーボード スコアの数は、指定した maxResults より少ない場合があります。 有効な値は 130(指定した値を含む)です。
pageToken string 前のリクエストによって返されたトークン。

承認

このリクエストには、次のスコープによる認証が必要です。

範囲
https://www.googleapis.com/auth/games

詳細については、認証と承認のページをご覧ください。

リクエスト本文

このメソッドをリクエストの本文に含めないでください。

レスポンス

成功すると、このメソッドはレスポンスの本文で Scores リソースを返します。

実習

以下の API Explorer を使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。