GoogleApi.Games.V1.Api.Recall (google_api_games v0.26.2)

View Source

API calls for all endpoints tagged Recall.

Summary

Functions

Retrieve the Recall tokens from all requested games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have an active PGS Player profile.

Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

Associate the PGS Player principal encoded in the provided recall session id with an in-game account

Delete all Recall tokens linking the given persona to any player (with or without a profile).

Retrieve all Recall tokens associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

Delete a Recall token linking the PGS Player principal identified by the Recall session and an in-game account identified either by the 'persona' or by the token value.

Functions

games_recall_games_player_tokens(connection, session_id, optional_params \\ [], opts \\ [])

@spec games_recall_games_player_tokens(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Games.V1.Model.RetrieveGamesPlayerTokensResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieve the Recall tokens from all requested games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have an active PGS Player profile.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
  • session_id (type: String.t) - Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.
  • 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").
    • :applicationIds (type: list(String.t)) - Required. The application IDs from the Google Play developer console for the games to return scoped ids for.
  • opts (type: keyword()) - Call options

Returns

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

games_recall_last_token_from_all_developer_games(connection, session_id, optional_params \\ [], opts \\ [])

@spec games_recall_last_token_from_all_developer_games(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.Games.V1.Model.RetrieveDeveloperGamesLastPlayerTokenResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
  • session_id (type: String.t) - Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.
  • 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").
  • opts (type: keyword()) - Call options

Returns

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

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

@spec games_recall_reset_persona(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.ResetPersonaResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Delete all Recall tokens linking the given persona to any player (with or without a profile).

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").
    • :body (type: GoogleApi.Games.V1.Model.ResetPersonaRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

games_recall_retrieve_tokens(connection, session_id, optional_params \\ [], opts \\ [])

@spec games_recall_retrieve_tokens(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Games.V1.Model.RetrievePlayerTokensResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieve all Recall tokens associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

Parameters

  • connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
  • session_id (type: String.t) - Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.
  • 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").
  • opts (type: keyword()) - Call options

Returns

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