リーダーボードを上から順に表示します。 実習をご覧ください。
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/games/v1/leaderboards/leaderboardId/scores/collection
パラメータ
パラメータ名 | 値 | 説明 |
---|---|---|
パスパラメータ | ||
collection |
string |
リクエストするスコアのコレクション。
有効な値は次のとおりです。
|
leaderboardId |
string |
リーダーボードの ID。 |
必須のクエリ パラメータ | ||
timeSpan |
string |
リクエストするスコアとランクの期間。
有効な値は次のとおりです。
|
省略可能なクエリ パラメータ | ||
language |
string |
このメソッドから返される文字列に使用する言語。 |
maxResults |
integer |
レスポンスで返されるリーダーボード スコアの最大数。レスポンスで返される実際のリーダーボード スコアの数は、指定した maxResults より少ない場合があります。
有効な値は 1 ~30 (指定した値を含む)です。
|
pageToken |
string |
前のリクエストによって返されたトークン。 |
承認
このリクエストには、次のスコープによる認証が必要です。
範囲 |
---|
https://www.googleapis.com/auth/games |
詳細については、認証と承認のページをご覧ください。
リクエスト本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{ "kind": "games#leaderboardScores", "nextPageToken": string, "prevPageToken": string, "numScores": long, "playerScore": { "kind": "games#leaderboardEntry", "player": players Resource, "scoreRank": long, "formattedScoreRank": string, "scoreValue": long, "formattedScore": string, "timeSpan": string, "writeTimestampMillis": long, "scoreTag": string }, "items": [ { "kind": "games#leaderboardEntry", "player": players Resource, "scoreRank": long, "formattedScoreRank": string, "scoreValue": long, "formattedScore": string, "timeSpan": string, "writeTimestampMillis": long, "scoreTag": string } ] }
プロパティ名 | 値 | 説明 | 備考 |
---|---|---|---|
kind |
string |
このリソースの種類を一意に識別します。値は常に固定文字列の games#leaderboardScores です。 |
|
nextPageToken |
string |
結果の次のページのページネーション トークン。 | |
prevPageToken |
string |
検索結果の前のページのページ設定トークン。 | |
numScores |
long |
リーダーボードの合計スコア。 | |
playerScore |
nested object |
リーダーボード上のリクエスト元のプレーヤーのスコア。プレーヤーのスコアは、上記のスコアリストと上記のスコアリストの両方に表示されます。公開リーダーボードを表示していて、プレーヤーがゲームプレイ情報を公開していない場合、scoreRank と formattedScoreRank の値は存在しません。 |
|
playerScore.kind |
string |
このリソースの種類を一意に識別します。値は常に固定文字列の games#leaderboardEntry です。 |
|
playerScore.player |
nested object |
このスコアを持つプレーヤー。 | |
playerScore.scoreRank |
long |
このリーダーボードのスコアのランク。 | |
playerScore.formattedScoreRank |
string |
このリーダーボードのスコアのランクのローカライズされた文字列。 | |
playerScore.scoreValue |
long |
このスコアの数値。 | |
playerScore.formattedScore |
string |
このスコアの数値をローカライズした文字列。 | |
playerScore.timeSpan |
string |
このハイスコアの期間。 有効な値は次のとおりです。
有効な値は次のとおりです。
|
|
playerScore.writeTimestampMillis |
long |
このスコアが記録されたタイムスタンプ(UTC でのエポックからの時間、ミリ秒単位)。 | |
playerScore.scoreTag |
string |
スコアに関する追加情報。値には、RFC 3986 のセクション 2.3 で定義されている 64 文字以下の URI セーフ文字を含める必要があります。 | |
items[] |
list |
リーダーボードのスコア。 | |
items[].kind |
string |
このリソースの種類を一意に識別します。値は常に固定文字列の games#leaderboardEntry です。 |
|
items[].player |
nested object |
このスコアを持つプレーヤー。 | |
items[].scoreRank |
long |
このリーダーボードのスコアのランク。 | |
items[].formattedScoreRank |
string |
このリーダーボードのスコアのランクのローカライズされた文字列。 | |
items[].scoreValue |
long |
このスコアの数値。 | |
items[].formattedScore |
string |
このスコアの数値をローカライズした文字列。 | |
items[].timeSpan |
string |
このハイスコアの期間。 有効な値は次のとおりです。
有効な値は次のとおりです。
|
|
items[].writeTimestampMillis |
long |
このスコアが記録されたタイムスタンプ(UTC でのエポックからの時間、ミリ秒単位)。 | |
items[].scoreTag |
string |
スコアに関する追加情報。値には、RFC 3986 のセクション 2.3 で定義されている 64 文字以下の URI セーフ文字を含める必要があります。 |
実習
以下の API Explorer を使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。