google_api_games v0.14.0 GoogleApi.Games.V1.Api.Players View Source
API calls for all endpoints tagged Players
.
Link to this section Summary
Functions
Retrieves the Player resource with the given ID. To retrieve the player
for the currently authenticated user, set playerId
to me
.
Get the collection of players for the currently authenticated user.
Link to this section Functions
Link to this function
games_players_get(connection, player_id, optional_params \\ [], opts \\ [])
View SourceSpecs
games_players_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.Player.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves the Player resource with the given ID. To retrieve the player
for the currently authenticated user, set playerId
to me
.
Parameters
-
connection
(type:GoogleApi.Games.V1.Connection.t
) - Connection to server -
player_id
(type:String.t
) - A player ID. A value ofme
may be used in place of the authenticated player's ID. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:language
(type:String.t
) - The preferred language to use for strings returned by this method.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Games.V1.Model.Player{}}
on success -
{:error, info}
on failure
Link to this function
games_players_list(connection, collection, optional_params \\ [], opts \\ [])
View SourceSpecs
games_players_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.PlayerListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Get the collection of players for the currently authenticated user.
Parameters
-
connection
(type:GoogleApi.Games.V1.Connection.t
) - Connection to server -
collection
(type:String.t
) - Collection of players being retrieved -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:language
(type:String.t
) - The preferred language to use for strings returned by this method. -
:maxResults
(type: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 specifiedmaxResults
. -
:pageToken
(type:String.t
) - The token returned by the previous request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Games.V1.Model.PlayerListResponse{}}
on success -
{:error, info}
on failure