google_api_games

v0.1.0

google_api_games v0.1.0 GoogleApi.Games.V1.Api.Applications View Source

API calls for all endpoints tagged Applications.

Link to this section Summary

Functions

games_applications_get(connection, application_id, opts \\ [])

Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified platformType, the returned response will not include any instance data

games_applications_played(connection, opts \\ [])

Indicate that the the currently authenticated user is playing your application

games_applications_verify(connection, application_id, opts \\ [])

Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for

Link to this section Functions

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

Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified platformType, the returned response will not include any instance data.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • application_id (String.t): The application ID from the Google Play developer console.

  • opts (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.
    • :platformType (String.t): Restrict application details returned to the specific platform.

Returns

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

Link to this function games_applications_played(connection, opts \\ []) View Source 
games_applications_played(Tesla.Env.client(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Indicate that the the currently authenticated user is playing your application.

Parameters

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

  • opts (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.

Returns

{:ok, %{}} on success {:error, info} on failure

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

Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.

Parameters

  • connection (GoogleApi.Games.V1.Connection): Connection to server
  • application_id (String.t): The application ID from the Google Play developer console.

  • opts (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.

Returns

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