class Google::Apis::GamesManagementV1management::GamesManagementService
Google
Play Game Management
The Google
Play Game Management API allows developers to manage resources from
the Google Play Game service.
@example
require 'google/apis/games_management_v1management' GamesManagement = Google::Apis::GamesManagementV1management # Alias the module service = GamesManagement::GamesManagementService.new
Attributes
@return [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.
@return [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.
Public Class Methods
# File lib/google/apis/games_management_v1management/service.rb, line 46 def initialize super('https://gamesmanagement.googleapis.com/', '', client_name: 'google-apis-games_management_v1management', client_version: Google::Apis::GamesManagementV1management::GEM_VERSION) @batch_path = 'batch' end
Public Instance Methods
Hide the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console. @param [String] application_id
The application ID from the Google Play developer console.
@param [String] player_id
A player ID. A value of `me` may be used in place of the authenticated player' s ID.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 406 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
Resets the achievement with the given ID for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. @param [String] achievement_id
The ID of the achievement used by this method.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::GamesManagementV1management::AchievementResetResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::GamesManagementV1management::AchievementResetResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 75 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
Resets all achievements for the currently authenticated player for your application. This method is only accessible to whitelisted tester accounts for your application. @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::GamesManagementV1management::AchievementResetAllResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::GamesManagementV1management::AchievementResetAllResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 105 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
Resets all draft achievements for all players. This method is only available to user accounts for your developer console. @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 133 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
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. @param [String] achievement_id
The ID of the achievement used by this method.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 162 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
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. @param [Google::Apis::GamesManagementV1management::AchievementResetMultipleForAllRequest] achievement_reset_multiple_for_all_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 191 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
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. @param [String] event_id
The ID of the event.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 261 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
Resets all player progress on all events for the currently authenticated player. This method is only accessible to whitelisted tester accounts for your application. @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 289 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
Resets all draft events for all players. This method is only available to user accounts for your developer console. @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 315 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
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. @param [String] event_id
The ID of the event.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 344 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
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. @param [Google::Apis::GamesManagementV1management::EventsResetMultipleForAllRequest] events_reset_multiple_for_all_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 373 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
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. @param [String] leaderboard_id
The ID of the leaderboard.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::GamesManagementV1management::PlayerScoreResetResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::GamesManagementV1management::PlayerScoreResetResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 470 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
Resets all scores for all leaderboards for the currently authenticated players. This method is only accessible to whitelisted tester accounts for your application. @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::GamesManagementV1management::PlayerScoreResetAllResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 500 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
Resets scores for all draft leaderboards for all players. This method is only available to user accounts for your developer console. @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 528 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
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. @param [String] leaderboard_id
The ID of the leaderboard.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 557 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
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. @param [Google::Apis::GamesManagementV1management::ScoresResetMultipleForAllRequest] scores_reset_multiple_for_all_request_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 586 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 the given player's leaderboard scores from the given application. This method is only available to user accounts for your developer console. @param [String] application_id
The application ID from the Google Play developer console.
@param [String] player_id
A player ID. A value of `me` may be used in place of the authenticated player' s ID.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
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.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/games_management_v1management/service.rb, line 439 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
Protected Instance Methods
# File lib/google/apis/games_management_v1management/service.rb, line 597 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? end