View Source GoogleApi.Games.V1.Api.Leaderboards (google_api_games v0.24.0)
API calls for all endpoints tagged Leaderboards
.
Summary
Functions
Retrieves the metadata of the leaderboard with the given ID.
Lists all the leaderboard metadata for your application.
Functions
Link to this function
games_leaderboards_get(connection, leaderboard_id, optional_params \\ [], opts \\ [])
View Source@spec games_leaderboards_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.Leaderboard.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the metadata of the leaderboard with the given ID.
Parameters
-
connection
(type:GoogleApi.Games.V1.Connection.t
) - Connection to server -
leaderboard_id
(type:String.t
) - The ID of the leaderboard. -
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.Leaderboard{}}
on success -
{:error, info}
on failure
Link to this function
games_leaderboards_list(connection, optional_params \\ [], opts \\ [])
View Source@spec games_leaderboards_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Games.V1.Model.LeaderboardListResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all the leaderboard metadata for your application.
Parameters
-
connection
(type:GoogleApi.Games.V1.Connection.t
) - Connection to server -
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 leaderboards to return in the response. For any response, the actual number of leaderboards 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.LeaderboardListResponse{}}
on success -
{:error, info}
on failure