GoogleApi.GamesManagement.V1management.Api.Players (google_api_games_management v0.18.0) View Source

API calls for all endpoints tagged Players.

Link to this section Summary

Functions

Hide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.

Unhide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.

Link to this section Functions

Link to this function

games_management_players_hide(connection, application_id, player_id, optional_params \\ [], opts \\ [])

View Source

Specs

games_management_players_hide(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Hide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.

Parameters

  • connection (type: GoogleApi.GamesManagement.V1management.Connection.t) - Connection to server
  • application_id (type: String.t) - The application ID from the Google Play developer console.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

games_management_players_unhide(connection, application_id, player_id, optional_params \\ [], opts \\ [])

View Source

Specs

games_management_players_unhide(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Unhide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console.

Parameters

  • connection (type: GoogleApi.GamesManagement.V1management.Connection.t) - Connection to server
  • application_id (type: String.t) - The application ID from the Google Play developer console.
  • 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").
  • opts (type: keyword()) - Call options

Returns

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