google_api_games v0.5.0 GoogleApi.Games.V1.Api.Leaderboards View Source

API calls for all endpoints tagged Leaderboards.

Link to this section Summary

Functions

Retrieves the metadata of the leaderboard with the given ID.

Lists all the leaderboard metadata for your application.

Link to this section Functions

Link to this function

games_leaderboards_get(connection, leaderboard_id, optional_params \\ [], opts \\ [])

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

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

    • :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.
  • 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
games_leaderboards_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.LeaderboardListResponse.t()}
  | {:error, Tesla.Env.t()}

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

    • :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 leaderboards to return in the response. For any response, the actual number of leaderboards 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.LeaderboardListResponse{}} on success
  • {:error, info} on failure