google_api_games

v0.3.0

google_api_games v0.3.0 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, optional_params \\ [], opts \\ [])

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

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

Returns a list of the event definitions in this application.

games_events_record(connection, optional_params \\ [], 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, optional_params \\ [], opts \\ []) View Source

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

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): The preferred language to use for strings returned by this method.
    • :maxResults (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.
    • :pageToken (String.t): 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, optional_params \\ [], opts \\ []) View Source

Returns a list of the event definitions in this application.

Parameters

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

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): The preferred language to use for strings returned by this method.
    • :maxResults (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.
    • :pageToken (String.t): 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, optional_params \\ [], opts \\ []) View Source

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

  • optional_params (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :language (String.t): 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