GoogleApi.Games.V1.Api.Scores.games_scores_get
games_scores_get
, go back to GoogleApi.Games.V1.Api.Scores module for more information.
games_scores_get(connection, player_id, leaderboard_id, time_span, optional_params \\ [], opts \\ [])
View SourceSpecs
games_scores_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Games.V1.Model.PlayerLeaderboardScoreListResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, leaderboardId
can be set to ALL
to retrieve data for all leaderboards in a given time span. NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'. ## Parameters *
connection(*type:*
GoogleApi.Games.V1.Connection.t) - Connection to server *
player_id(*type:*
String.t) - A player ID. A value of
memay be used in place of the authenticated player's ID. *
leaderboard_id(*type:*
String.t) - The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application. *
time_span(*type:*
String.t) - The time span for the scores and ranks you're requesting. *
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"). *
:includeRankType(*type:*
String.t) - The types of ranks to return. If the parameter is omitted, no ranks will be returned. *
:language(*type:*
String.t) - The preferred language to use for strings returned by this method. *
:maxResults(*type:*
integer()) - The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified
maxResults. *
:pageToken(*type:*
String.t) - The token returned by the previous request. *
opts(*type:*
keyword()) - Call options ## Returns *
}on success *
` on failure