google_api_games

v0.0.1

google_api_games v0.0.1 GoogleApi.Games.V1.Api.Events View Source

API calls for all endpoints tagged Events.

Link to this section Summary

Functions

games_events_list_by_player(connection, opts \\ [])

Returns a list showing the current progress on events in this application for the currently authenticated user

games_events_list_definitions(connection, opts \\ [])

Returns a list of the event definitions in this application

games_events_record(connection, opts \\ [])

Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application

Link to this section Functions

Link to this function games_events_list_by_player(connection, opts \\ []) View Source 
games_events_list_by_player(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.Games.V1.Model.PlayerEventListResponse.t} |
  {:error, Tesla.Env.t}

Returns a list showing the current progress on events in this application for the currently authenticated user.

Parameters

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

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :consistency_token (String): The last-seen mutation timestamp.
    • :language (String): The preferred language to use for strings returned by this method.
    • :max_results (Integer): The maximum number of events to return in the response, used for paging. For any response, the actual number of events to return may be less than the specified maxResults.
    • :page_token (String): The token returned by the previous request.

Returns

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

Link to this function games_events_list_definitions(connection, opts \\ []) View Source 
games_events_list_definitions(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.Games.V1.Model.EventDefinitionListResponse.t} |
  {:error, Tesla.Env.t}

Returns a list of the event definitions in this application.

Parameters

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

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :consistency_token (String): The last-seen mutation timestamp.
    • :language (String): The preferred language to use for strings returned by this method.
    • :max_results (Integer): The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified maxResults.
    • :page_token (String): The token returned by the previous request.

Returns

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

Link to this function games_events_record(connection, opts \\ []) View Source 
games_events_record(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.Games.V1.Model.EventUpdateResponse.t} |
  {:error, Tesla.Env.t}

Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.

Parameters

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

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :consistency_token (String): The last-seen mutation timestamp.
    • :language (String): The preferred language to use for strings returned by this method.
    • :body (EventRecordRequest):

Returns

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