google_api_games_configuration v0.10.0 GoogleApi.GamesConfiguration.V1configuration.Api.LeaderboardConfigurations View Source
API calls for all endpoints tagged LeaderboardConfigurations
.
Link to this section Summary
Functions
Delete the leaderboard configuration with the given ID.
Retrieves the metadata of the leaderboard configuration with the given ID.
Insert a new leaderboard configuration in this application.
Returns a list of the leaderboard configurations in this application.
Update the metadata of the leaderboard configuration with the given ID.
Link to this section Functions
Link to this function
games_configuration_leaderboard_configurations_delete(connection, leaderboard_id, optional_params \\ [], opts \\ [])
View SourceSpecs
games_configuration_leaderboard_configurations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Delete the leaderboard configuration with the given ID.
Parameters
-
connection
(type:GoogleApi.GamesConfiguration.V1configuration.Connection.t
) - Connection to server -
leaderboard_id
(type:String.t
) - The ID of the leaderboard. -
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_configuration_leaderboard_configurations_get(connection, leaderboard_id, optional_params \\ [], opts \\ [])
View SourceSpecs
games_configuration_leaderboard_configurations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GamesConfiguration.V1configuration.Model.LeaderboardConfiguration.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves the metadata of the leaderboard configuration with the given ID.
Parameters
-
connection
(type:GoogleApi.GamesConfiguration.V1configuration.Connection.t
) - Connection to server -
leaderboard_id
(type:String.t
) - The ID of the leaderboard. -
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.GamesConfiguration.V1configuration.Model.LeaderboardConfiguration{}}
on success -
{:error, info}
on failure
Link to this function
games_configuration_leaderboard_configurations_insert(connection, application_id, optional_params \\ [], opts \\ [])
View SourceSpecs
games_configuration_leaderboard_configurations_insert( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GamesConfiguration.V1configuration.Model.LeaderboardConfiguration.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Insert a new leaderboard configuration in this application.
Parameters
-
connection
(type:GoogleApi.GamesConfiguration.V1configuration.Connection.t
) - Connection to server -
application_id
(type:String.t
) - The application ID from the Google Play developer console. -
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.GamesConfiguration.V1configuration.Model.LeaderboardConfiguration.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GamesConfiguration.V1configuration.Model.LeaderboardConfiguration{}}
on success -
{:error, info}
on failure
Link to this function
games_configuration_leaderboard_configurations_list(connection, application_id, optional_params \\ [], opts \\ [])
View SourceSpecs
games_configuration_leaderboard_configurations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GamesConfiguration.V1configuration.Model.LeaderboardConfigurationListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Returns a list of the leaderboard configurations in this application.
Parameters
-
connection
(type:GoogleApi.GamesConfiguration.V1configuration.Connection.t
) - Connection to server -
application_id
(type:String.t
) - The application ID from the Google Play developer console. -
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"). -
:maxResults
(type:integer()
) - The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specifiedmaxResults
. -
:pageToken
(type:String.t
) - The token returned by the previous request.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GamesConfiguration.V1configuration.Model.LeaderboardConfigurationListResponse{}}
on success -
{:error, info}
on failure
Link to this function
games_configuration_leaderboard_configurations_update(connection, leaderboard_id, optional_params \\ [], opts \\ [])
View SourceSpecs
games_configuration_leaderboard_configurations_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.GamesConfiguration.V1configuration.Model.LeaderboardConfiguration.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Update the metadata of the leaderboard configuration with the given ID.
Parameters
-
connection
(type:GoogleApi.GamesConfiguration.V1configuration.Connection.t
) - Connection to server -
leaderboard_id
(type:String.t
) - The ID of the leaderboard. -
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.GamesConfiguration.V1configuration.Model.LeaderboardConfiguration.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.GamesConfiguration.V1configuration.Model.LeaderboardConfiguration{}}
on success -
{:error, info}
on failure