Method: players.list

現在認証されているユーザーのプレーヤーのコレクションを取得します。

HTTP リクエスト

GET https://games.googleapis.com/games/v1/players/me/players/{collection}

パスパラメータ

パラメータ
collection

enum (Collection)

取得するプレーヤーのコレクション

クエリ パラメータ

パラメータ
language

string

このメソッドによって返される文字列に使用する言語。

maxResults

integer

レスポンスで返すプレーヤー リソースの最大数。ページングに使用されます。どのようなレスポンスでも、返されるプレーヤー リソースの実際の数は、指定された maxResults より少なくなる可能性があります。

pageToken

string

前のリクエストによって返されたトークン。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

サードパーティのプレーヤー リスト レスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (Player)
    }
  ]
}
フィールド
kind

string

このリソースのタイプを一意に識別します。値は常に固定文字列 games#playerListResponse です。

nextPageToken

string

結果の次のページに対応するトークン。

items[]

object (Player)

プレーヤー。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/games
  • https://www.googleapis.com/auth/games_lite

詳しくは、OAuth 2.0 の概要をご覧ください。

コレクション

列挙型
CONNECTED

同じくこのゲームをプレイしているプレーヤーのリストを、新しい順で取得します。

VISIBLE

ユーザーのソーシャル グラフから、このゲームに表示されるプレーヤーのリストを取得します。

FRIENDS_ALL ユーザーの友だちであるプレーヤーのリストをアルファベット順で取得します。