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

API calls for all endpoints tagged Quests.

Link to this section Summary

Functions

Indicates that the currently authorized user will participate in the quest.

Get a list of quests for your application and the currently authenticated player.

Link to this section Functions

Link to this function

games_quests_accept(connection, quest_id, optional_params \\ [], opts \\ [])

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

Indicates that the currently authorized user will participate in the quest.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
  • quest_id (type: String.t) - The ID of the quest.
  • 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.Quest{}} on success
  • {:error, info} on failure
Link to this function

games_quests_list(connection, player_id, optional_params \\ [], opts \\ [])

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

Get a list of quests for your application and the currently authenticated player.

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.
  • 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 quest resources to return in the response, used for paging. For any response, the actual number of quest resources returned may be less than the specified maxResults. Acceptable values are 1 to 50, inclusive. (Default: 50).
    • :pageToken (type: String.t) - The token returned by the previous request.
  • opts (type: keyword()) - Call options

Returns

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