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

API calls for all endpoints tagged Snapshots.

Summary

Functions

games_snapshots_get(connection, snapshot_id, optional_params \\ [], opts \\ [])

Retrieves the metadata for a given snapshot ID.

games_snapshots_list(connection, player_id, optional_params \\ [], opts \\ [])

Retrieves a list of snapshots created by your application for the player corresponding to the player ID.

Functions

games_snapshots_get(connection, snapshot_id, optional_params \\ [], opts \\ [])

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

Retrieves the metadata for a given snapshot ID.

Parameters

connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
snapshot_id (type: String.t) - The ID of the snapshot.
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").
- :language (type: String.t) - The preferred language to use for strings returned by this method.
opts (type: keyword()) - Call options

Returns

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

games_snapshots_list(connection, player_id, optional_params \\ [], opts \\ [])

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

Retrieves a list of snapshots created by your application for the player corresponding to the player ID.

Parameters

connection (type: GoogleApi.Games.V1.Connection.t) - Connection to server
player_id (type: String.t) - A player ID. A value of me may be used in place of the authenticated player's ID.
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").
- :language (type: String.t) - The preferred language to use for strings returned by this method.
- :maxResults (type: integer()) - The maximum number of snapshot resources to return in the response, used for paging. For any response, the actual number of snapshot resources returned may be less than the specified maxResults.
- :pageToken (type: String.t) - The token returned by the previous request.
opts (type: keyword()) - Call options

Returns

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