google_api_games v0.6.0 GoogleApi.Games.V1.Api.Snapshots View Source

API calls for all endpoints tagged Snapshots.

Link to this section Summary

Functions

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

Link to this section Functions

Link to this function

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

View Source
games_snapshots_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.Snapshot.t()} | {:error, Tesla.Env.t()}

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

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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
Link to this function

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

View Source
games_snapshots_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Games.V1.Model.SnapshotListResponse.t()}
  | {:error, Tesla.Env.t()}

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

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :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