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 ユーザーのフレンドであるプレーヤーのリストをアルファベット順で取得します。