google_api_games v0.8.0 GoogleApi.Games.V1.Api.AchievementDefinitions 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
games_achievement_definitions_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.AchievementDefinitionsListResponse.t()}
  | {:error, Tesla.Env.t()}

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

    • :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 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