google_api_games

v0.7.0

google_api_games v0.7.0 GoogleApi.Games.V1.Api.Scores View Source

API calls for all endpoints tagged Scores.

Link to this section Summary

Functions

games_scores_get(connection, player_id, leaderboard_id, time_span, optional_params \\ [], opts \\ [])

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'.

games_scores_list(connection, leaderboard_id, collection, time_span, optional_params \\ [], opts \\ [])

Lists the scores in a leaderboard, starting from the top.

games_scores_list_window(connection, leaderboard_id, collection, time_span, optional_params \\ [], opts \\ [])

Lists the scores in a leaderboard around (and including) a player's score.

games_scores_submit(connection, leaderboard_id, score, optional_params \\ [], opts \\ [])

Submits a score to the specified leaderboard.

games_scores_submit_multiple(connection, optional_params \\ [], opts \\ [])

Submits multiple scores to leaderboards.

Link to this section Functions

Link to this function

games_scores_get(connection, player_id, leaderboard_id, time_span, optional_params \\ [], opts \\ [])

View Source 
games_scores_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Games.V1.Model.PlayerLeaderboardScoreListResponse.t()}
  | {:error, Tesla.Env.t()}

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 me may 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

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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

  • {:ok, %GoogleApi.Games.V1.Model.PlayerLeaderboardScoreListResponse{}} on success
  • {:error, info} on failure
Link to this function

games_scores_list(connection, leaderboard_id, collection, time_span, optional_params \\ [], opts \\ [])

View Source 
games_scores_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Games.V1.Model.LeaderboardScores.t()}
  | {:error, Tesla.Env.t()}

Lists the scores in a leaderboard, starting from the top.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
  • leaderboard_id (type: String.t) - The ID of the leaderboard.
  • collection (type: String.t) - The collection of scores you're requesting.
  • time_span (type: String.t) - The time span for the scores and ranks you're requesting.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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

  • {:ok, %GoogleApi.Games.V1.Model.LeaderboardScores{}} on success
  • {:error, info} on failure
Link to this function

games_scores_list_window(connection, leaderboard_id, collection, time_span, optional_params \\ [], opts \\ [])

View Source 
games_scores_list_window(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Games.V1.Model.LeaderboardScores.t()}
  | {:error, Tesla.Env.t()}

Lists the scores in a leaderboard around (and including) a player's score.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
  • leaderboard_id (type: String.t) - The ID of the leaderboard.
  • collection (type: String.t) - The collection of scores you're requesting.
  • time_span (type: String.t) - The time span for the scores and ranks you're requesting.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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.
    • :resultsAbove (type: integer()) - The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.
    • :returnTopIfAbsent (type: boolean()) - True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Games.V1.Model.LeaderboardScores{}} on success
  • {:error, info} on failure
Link to this function

games_scores_submit(connection, leaderboard_id, score, optional_params \\ [], opts \\ [])

View Source 
games_scores_submit(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Games.V1.Model.PlayerScoreResponse.t()}
  | {:error, Tesla.Env.t()}

Submits a score to the specified leaderboard.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
  • leaderboard_id (type: String.t) - The ID of the leaderboard.
  • score (type: String.t) - The score you're submitting. The submitted score is ignored if it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units.

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :language (type: String.t) - The preferred language to use for strings returned by this method.
    • :scoreTag (type: String.t) - Additional information about the score you're submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Games.V1.Model.PlayerScoreResponse{}} on success
  • {:error, info} on failure
Link to this function

games_scores_submit_multiple(connection, optional_params \\ [], opts \\ [])

View Source 
games_scores_submit_multiple(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.PlayerScoreListResponse.t()}
  | {:error, Tesla.Env.t()}

Submits multiple scores to leaderboards.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server

  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :language (type: String.t) - The preferred language to use for strings returned by this method.
    • :body (type: GoogleApi.Games.V1.Model.PlayerScoreSubmissionList.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Games.V1.Model.PlayerScoreListResponse{}} on success
  • {:error, info} on failure