現在認証されているプレーヤーのリーダーボードで、ハイスコアとランキング(任意)を取得する。特定の期間では、leaderboardId
を ALL
に設定して、特定の期間のすべてのリーダーボードのデータを取得できます。
注: 同じリクエストで「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 |
リクエストするスコアとランクの期間。
有効な値は次のとおりです。
|
省略可能なクエリ パラメータ | ||
includeRankType |
string |
返されるランクのタイプ。このパラメータを省略すると、ランクは返されません。
有効な値は次のとおりです。
|
language |
string |
このメソッドから返される文字列に使用する言語。 |
maxResults |
integer |
レスポンスで返されるリーダーボード スコアの最大数。レスポンスで返される実際のリーダーボード スコアの数は、指定した maxResults より少ない場合があります。
有効な値は 1 ~30 (指定した値を含む)です。
|
pageToken |
string |
前のリクエストによって返されたトークン。 |
承認
このリクエストには、次のスコープによる認証が必要です。
範囲 |
---|
https://www.googleapis.com/auth/games |
詳細については、認証と承認のページをご覧ください。
リクエスト本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功すると、このメソッドはレスポンスの本文で Scores リソースを返します。
実習
以下の API Explorer を使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。