View Source GoogleApi.Games.V1.Api.Accesstokens (google_api_games v0.25.0)

API calls for all endpoints tagged Accesstokens.

Summary

Functions

Generates a Play Grouping API token for the PGS user identified by the attached credential.

Generates a Play Grouping API token for the PGS user identified by the Recall session ID provided in the request.

Functions

Link to this function

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

View Source
@spec games_accesstokens_generate_play_grouping_api_token(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Games.V1.Model.GeneratePlayGroupingApiTokenResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Generates a Play Grouping API token for the PGS user identified by the attached credential.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :packageName (type: String.t) - Required. App package name to generate the token for (e.g. com.example.mygame).
    • :persona (type: String.t) - Required. Persona to associate with the token. Persona is a developer-provided stable identifier of the user. Must be deterministically generated (e.g. as a one-way hash) from the user account ID and user profile ID (if the app has the concept), according to the developer's own user identity system.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Games.V1.Model.GeneratePlayGroupingApiTokenResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec games_accesstokens_generate_recall_play_grouping_api_token(
  Tesla.Env.client(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Games.V1.Model.GenerateRecallPlayGroupingApiTokenResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Generates a Play Grouping API token for the PGS user identified by the Recall session ID provided in the request.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :packageName (type: String.t) - Required. App package name to generate the token for (e.g. com.example.mygame).
    • :persona (type: String.t) - Required. Persona to associate with the token. Persona is a developer-provided stable identifier of the user. Must be deterministically generated (e.g. as a one-way hash) from the user account ID and user profile ID (if the app has the concept), according to the developer's own user identity system.
    • :recallSessionId (type: String.t) - Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. See https://developer.android.com/games/pgs/recall/recall-setup on how to integrate with Recall and get session ID.
  • opts (type: keyword()) - Call options

Returns

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