Class: Google::Apis::GamesManagementV1management::GamesManagementService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/games_management_v1management/service.rb

Overview

Google Play Game Management

The Google Play Game Management API allows developers to manage resources from the Google Play Game service.

Examples:

require 'google/apis/games_management_v1management'

GamesManagement = Google::Apis::GamesManagementV1management # Alias the module
service = GamesManagement::GamesManagementService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://gamesmanagement.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GamesManagementService

Returns a new instance of GamesManagementService.



48
49
50
51
52
53
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-games_management_v1management',
        client_version: Google::Apis::GamesManagementV1management::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



41
42
43
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



46
47
48
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#hide_player(application_id, player_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

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

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

  • player_id (String) —

    A player ID. A value of me may be used in place of the authenticated player' s ID.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



408
409
410
411
412
413
414
415
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 408

def hide_player(application_id, player_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/applications/{applicationId}/players/hidden/{playerId}', options)
  command.params['applicationId'] = application_id unless application_id.nil?
  command.params['playerId'] = player_id unless player_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_application_hidden(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesManagementV1management::HiddenPlayerList

Get the list of players hidden from the given application. This method is only available to user accounts for your developer console.

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

  • max_results (Fixnum) (defaults to: nil) —

    The maximum number of player resources to return in the response, used for paging. For any response, the actual number of player resources returned may be less than the specified maxResults.

  • page_token (String) (defaults to: nil) —

    The token returned by the previous request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 229

def list_application_hidden(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1management/applications/{applicationId}/players/hidden', options)
  command.response_representation = Google::Apis::GamesManagementV1management::HiddenPlayerList::Representation
  command.response_class = Google::Apis::GamesManagementV1management::HiddenPlayerList
  command.params['applicationId'] = application_id unless application_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_achievement(achievement_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesManagementV1management::AchievementResetResponse

Resets the achievement with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

Parameters:

  • achievement_id (String) —

    The ID of the achievement used by this method.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



77
78
79
80
81
82
83
84
85
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 77

def reset_achievement(achievement_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/achievements/{achievementId}/reset', options)
  command.response_representation = Google::Apis::GamesManagementV1management::AchievementResetResponse::Representation
  command.response_class = Google::Apis::GamesManagementV1management::AchievementResetResponse
  command.params['achievementId'] = achievement_id unless achievement_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_achievement_all(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesManagementV1management::AchievementResetAllResponse

Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



107
108
109
110
111
112
113
114
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 107

def reset_achievement_all(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/achievements/reset', options)
  command.response_representation = Google::Apis::GamesManagementV1management::AchievementResetAllResponse::Representation
  command.response_class = Google::Apis::GamesManagementV1management::AchievementResetAllResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_achievement_all_for_all_players(fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets all draft achievements for all players. This method is only available to user accounts for your developer console.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



135
136
137
138
139
140
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 135

def reset_achievement_all_for_all_players(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/achievements/resetAllForAllPlayers', options)
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_achievement_for_all_players(achievement_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets the achievement with the given ID for all players. This method is only available to user accounts for your developer console. Only draft achievements can be reset.

Parameters:

  • achievement_id (String) —

    The ID of the achievement used by this method.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



164
165
166
167
168
169
170
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 164

def reset_achievement_for_all_players(achievement_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/achievements/{achievementId}/resetForAllPlayers', options)
  command.params['achievementId'] = achievement_id unless achievement_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_achievement_multiple_for_all_players(achievement_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets achievements with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft achievements may be reset.

Parameters:

  • achievement_reset_multiple_for_all_request_object (Google::Apis::GamesManagementV1management::AchievementResetMultipleForAllRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



193
194
195
196
197
198
199
200
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 193

def reset_achievement_multiple_for_all_players(achievement_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/achievements/resetMultipleForAllPlayers', options)
  command.request_representation = Google::Apis::GamesManagementV1management::AchievementResetMultipleForAllRequest::Representation
  command.request_object = achievement_reset_multiple_for_all_request_object
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_event(event_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets all player progress on the event with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

Parameters:

  • event_id (String) —

    The ID of the event.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



263
264
265
266
267
268
269
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 263

def reset_event(event_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/events/{eventId}/reset', options)
  command.params['eventId'] = event_id unless event_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_event_all(fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



291
292
293
294
295
296
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 291

def reset_event_all(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/events/reset', options)
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_event_all_for_all_players(fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets all draft events for all players. This method is only available to user accounts for your developer console.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



317
318
319
320
321
322
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 317

def reset_event_all_for_all_players(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/events/resetAllForAllPlayers', options)
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_event_for_all_players(event_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets the event with the given ID for all players. This method is only available to user accounts for your developer console. Only draft events can be reset.

Parameters:

  • event_id (String) —

    The ID of the event.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



346
347
348
349
350
351
352
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 346

def reset_event_for_all_players(event_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/events/{eventId}/resetForAllPlayers', options)
  command.params['eventId'] = event_id unless event_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_event_multiple_for_all_players(events_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets events with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft events may be reset.

Parameters:

  • events_reset_multiple_for_all_request_object (Google::Apis::GamesManagementV1management::EventsResetMultipleForAllRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



375
376
377
378
379
380
381
382
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 375

def reset_event_multiple_for_all_players(events_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/events/resetMultipleForAllPlayers', options)
  command.request_representation = Google::Apis::GamesManagementV1management::EventsResetMultipleForAllRequest::Representation
  command.request_object = events_reset_multiple_for_all_request_object
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_score(leaderboard_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesManagementV1management::PlayerScoreResetResponse

Resets scores for the leaderboard with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application.

Parameters:

  • leaderboard_id (String) —

    The ID of the leaderboard.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



472
473
474
475
476
477
478
479
480
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 472

def reset_score(leaderboard_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/leaderboards/{leaderboardId}/scores/reset', options)
  command.response_representation = Google::Apis::GamesManagementV1management::PlayerScoreResetResponse::Representation
  command.response_class = Google::Apis::GamesManagementV1management::PlayerScoreResetResponse
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_score_all(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse

Resets all scores for all leaderboards for the currently authenticated players. This method is only accessible to whitelisted tester accounts for your application.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



502
503
504
505
506
507
508
509
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 502

def reset_score_all(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/scores/reset', options)
  command.response_representation = Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse::Representation
  command.response_class = Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_score_all_for_all_players(fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets scores for all draft leaderboards for all players. This method is only available to user accounts for your developer console.

Parameters:

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



530
531
532
533
534
535
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 530

def reset_score_all_for_all_players(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/scores/resetAllForAllPlayers', options)
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_score_for_all_players(leaderboard_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets scores for the leaderboard with the given ID for all players. This method is only available to user accounts for your developer console. Only draft leaderboards can be reset.

Parameters:

  • leaderboard_id (String) —

    The ID of the leaderboard.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



559
560
561
562
563
564
565
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 559

def reset_score_for_all_players(leaderboard_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/leaderboards/{leaderboardId}/scores/resetForAllPlayers', options)
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_score_multiple_for_all_players(scores_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Resets scores for the leaderboards with the given IDs for all players. This method is only available to user accounts for your developer console. Only draft leaderboards may be reset.

Parameters:

  • scores_reset_multiple_for_all_request_object (Google::Apis::GamesManagementV1management::ScoresResetMultipleForAllRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



588
589
590
591
592
593
594
595
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 588

def reset_score_multiple_for_all_players(scores_reset_multiple_for_all_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1management/scores/resetMultipleForAllPlayers', options)
  command.request_representation = Google::Apis::GamesManagementV1management::ScoresResetMultipleForAllRequest::Representation
  command.request_object = scores_reset_multiple_for_all_request_object
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unhide_player(application_id, player_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

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

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

  • player_id (String) —

    A player ID. A value of me may be used in place of the authenticated player' s ID.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (NilClass) —

    No result returned for this method

  • err (StandardError) —

    error object if request failed

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



441
442
443
444
445
446
447
448
 
# File 'lib/google/apis/games_management_v1management/service.rb', line 441

def unhide_player(application_id, player_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'games/v1management/applications/{applicationId}/players/hidden/{playerId}', options)
  command.params['applicationId'] = application_id unless application_id.nil?
  command.params['playerId'] = player_id unless player_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end