このページは Cloud Translation API によって翻訳されました。

Scores: listWindow

リーダーボード内のスコアをスコアとともに表示します。実習をご覧ください。

リクエスト

HTTP リクエスト

GET https://www.googleapis.com/games/v1/leaderboards/leaderboardId/window/collection

パラメータ

パラメータ名	値	説明
パスパラメータ
`collection`	`string`	リクエストするスコアのコレクション。有効な値は次のとおりです。 `FRIENDS`: 友だちのスコアのみを一覧表示します。 `PUBLIC`: 公開リーダーボードのすべてのスコアを一覧表示します。 "`SOCIAL`": （廃止）以前の G+ ソーシャルスコア。代わりに Friends コレクションを使用します。
`leaderboardId`	`string`	リーダーボードの ID。
必須のクエリパラメータ
`timeSpan`	`string`	リクエストするスコアとランクの期間。有効な値は次のとおりです。 `ALL_TIME`: 全期間のトップスコアを一覧表示します。 `DAILY`: 現在の日付における上位のスコアを一覧表示します。 `WEEKLY`: 今週のトップスコアを一覧表示します。
省略可能なクエリパラメータ
`language`	`string`	このメソッドから返される文字列に使用する言語。
`maxResults`	`integer`	レスポンスで返されるリーダーボードスコアの最大数。レスポンスで返される実際のリーダーボードスコアの数は、指定した `maxResults` より少ない場合があります。有効な値は `1`～`30`（指定した値を含む）です。
`pageToken`	`string`	前のリクエストによって返されたトークン。
`resultsAbove`	`integer`	プレーヤーのスコアよりも優先して返すスコアの数。プレーヤーがリーダーボードの最下位にあれば、より多くのスコアを返すことができます。プレーヤーが一番上にいる場合は、少ないスコアを返すことがあります。maxResults 以下の値にする必要があります。
`returnTopIfAbsent`	`boolean`	プレーヤーがリーダーボードに参加していないときに、上位のスコアを返す場合は true。デフォルトは true です。

承認

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

範囲
`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`	このハイスコアの期間。有効な値は次のとおりです。「`ALL_TIME`」 - スコアは史上最高スコアです。「`WEEKLY`」 - スコアは 1 週間のハイスコアです。「`DAILY`」- 毎日のハイスコア。有効な値は次のとおりです。 "`ALL_TIME`" 「`DAILY`」「`WEEKLY`」
`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`	このハイスコアの期間。有効な値は次のとおりです。「`ALL_TIME`」 - スコアは史上最高スコアです。「`WEEKLY`」 - スコアは 1 週間のハイスコアです。「`DAILY`」- 毎日のハイスコア。有効な値は次のとおりです。 "`ALL_TIME`" 「`DAILY`」「`WEEKLY`」
`items[].writeTimestampMillis`	`long`	このスコアが記録されたタイムスタンプ（UTC でのエポックからの時間、ミリ秒単位）。
`items[].scoreTag`	`string`	スコアに関する追加情報。値には、RFC 3986 のセクション 2.3 で定義されている 64 文字以下の URI セーフ文字を含める必要があります。

実習

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