Method: players.list

Get the collection of players for the currently authenticated user.

HTTP request

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

Path parameters

Parameters
collection

enum (Collection)

Collection of players being retrieved

Query parameters

Parameters
language

string

The preferred language to use for strings returned by this method.
maxResults

integer

The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults.
pageToken

string

The token returned by the previous request.

Request body

The request body must be empty.

Response body

A third party player list response.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "nextPageToken": string,
  "items": [
    {
      object (Player)
    }
  ]
}
Fields
kind

string

Uniquely identifies the type of this resource. Value is always the fixed string games#playerListResponse.
nextPageToken

string

Token corresponding to the next page of results.
items[]

object (Player)

The players.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the OAuth 2.0 Overview.

Collection

Enums
CONNECTED

Retrieve a list of players that are also playing this game in reverse chronological order.
VISIBLE

Retrieve a list of players in the user's social graph that are visible to this game.
FRIENDS_ALL Retrieve a list of players who are friends of the user in alphabetical order.