GoogleApi.Games.V1.Api.AchievementDefinitions (google_api_games v0.22.0) View Source

API calls for all endpoints tagged AchievementDefinitions.

Link to this section Summary

Functions

Lists all the achievement definitions for your application.

Link to this section Functions

Link to this function

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

View Source

Specs

games_achievement_definitions_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.AchievementDefinitionsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the achievement definitions 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 achievement resources to return in the response, used for paging. For any response, the actual number of achievement resources 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.AchievementDefinitionsListResponse{}} on success
  • {:error, info} on failure