Class: Google::Apis::GamesConfigurationV1configuration::GamesConfigurationService
- Inherits:
 - 
      Core::BaseService
      
        
- Object
 - Core::BaseService
 - Google::Apis::GamesConfigurationV1configuration::GamesConfigurationService
 
 
- Defined in:
 - generated/google/apis/games_configuration_v1configuration/service.rb
 
Overview
Google Play Game Services Publishing API
The Publishing API for Google Play Game Services.
Instance Attribute Summary collapse
- 
  
    
      #key  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
API key.
 - 
  
    
      #quota_user  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
An opaque string that represents a user for quota purposes.
 - 
  
    
      #user_ip  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Deprecated.
 
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
- 
  
    
      #delete_achievement_configuration(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } 
    
    
  
  
  
  
  
  
  
  
  
    
Delete the achievement configuration with the given ID.
 - 
  
    
      #delete_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } 
    
    
  
  
  
  
  
  
  
  
  
    
Delete the leaderboard configuration with the given ID.
 - 
  
    
      #get_achievement_configuration(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration 
    
    
  
  
  
  
  
  
  
  
  
    
Retrieves the metadata of the achievement configuration with the given ID.
 - 
  
    
      #get_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration 
    
    
  
  
  
  
  
  
  
  
  
    
Retrieves the metadata of the leaderboard configuration with the given ID.
 - 
  
    
      #initialize  ⇒ GamesConfigurationService 
    
    
  
  
  
    constructor
  
  
  
  
  
  
  
    
A new instance of GamesConfigurationService.
 - 
  
    
      #insert_achievement_configuration(application_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration 
    
    
  
  
  
  
  
  
  
  
  
    
Insert a new achievement configuration in this application.
 - 
  
    
      #insert_leaderboard_configuration(application_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration 
    
    
  
  
  
  
  
  
  
  
  
    
Insert a new leaderboard configuration in this application.
 - 
  
    
      #list_achievement_configurations(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::ListAchievementConfigurationResponse 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a list of the achievement configurations in this application.
 - 
  
    
      #list_leaderboard_configurations(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::ListLeaderboardConfigurationResponse 
    
    
  
  
  
  
  
  
  
  
  
    
Returns a list of the leaderboard configurations in this application.
 - 
  
    
      #patch_achievement_configuration(achievement_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration 
    
    
  
  
  
  
  
  
  
  
  
    
Update the metadata of the achievement configuration with the given ID.
 - 
  
    
      #patch_leaderboard_configuration(leaderboard_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration 
    
    
  
  
  
  
  
  
  
  
  
    
Update the metadata of the leaderboard configuration with the given ID.
 - 
  
    
      #update_achievement_configuration(achievement_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration 
    
    
  
  
  
  
  
  
  
  
  
    
Update the metadata of the achievement configuration with the given ID.
 - 
  
    
      #update_leaderboard_configuration(leaderboard_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration 
    
    
  
  
  
  
  
  
  
  
  
    
Update the metadata of the leaderboard configuration with the given ID.
 - 
  
    
      #upload_image_configuration(resource_id, image_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::ImageConfiguration 
    
    
  
  
  
  
  
  
  
  
  
    
Uploads an image for a resource with the given ID and image type.
 
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ GamesConfigurationService
Returns a new instance of GamesConfigurationService
      49 50 51 52  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 49 def initialize super('https://www.googleapis.com/', 'games/v1configuration/') @batch_path = 'batch/gamesConfiguration/v1configuration' 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.
      38 39 40  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 38 def key @key end  | 
  
#quota_user ⇒ String
Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
      43 44 45  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 43 def quota_user @quota_user end  | 
  
#user_ip ⇒ String
Returns Deprecated. Please use quotaUser instead.
      47 48 49  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 47 def user_ip @user_ip end  | 
  
Instance Method Details
#delete_achievement_configuration(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Delete the achievement configuration with the given ID.
      76 77 78 79 80 81 82 83  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 76 def delete_achievement_configuration(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'achievements/{achievementId}', ) 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#delete_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Delete the leaderboard configuration with the given ID.
      336 337 338 339 340 341 342 343  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 336 def delete_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'leaderboards/{leaderboardId}', ) 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#get_achievement_configuration(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration
Retrieves the metadata of the achievement configuration with the given ID.
      107 108 109 110 111 112 113 114 115 116  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 107 def get_achievement_configuration(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'achievements/{achievementId}', ) command.response_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#get_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration
Retrieves the metadata of the leaderboard configuration with the given ID.
      367 368 369 370 371 372 373 374 375 376  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 367 def get_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'leaderboards/{leaderboardId}', ) command.response_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#insert_achievement_configuration(application_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration
Insert a new achievement configuration in this application.
      141 142 143 144 145 146 147 148 149 150 151 152  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 141 def insert_achievement_configuration(application_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'applications/{applicationId}/achievements', ) command.request_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation command.request_object = achievement_configuration_object command.response_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration command.params['applicationId'] = application_id unless application_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#insert_leaderboard_configuration(application_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration
Insert a new leaderboard configuration in this application.
      401 402 403 404 405 406 407 408 409 410 411 412  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 401 def insert_leaderboard_configuration(application_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'applications/{applicationId}/leaderboards', ) command.request_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation command.request_object = leaderboard_configuration_object command.response_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration command.params['applicationId'] = application_id unless application_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#list_achievement_configurations(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::ListAchievementConfigurationResponse
Returns a list of the achievement configurations in this application.
      182 183 184 185 186 187 188 189 190 191 192 193  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 182 def list_achievement_configurations(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'applications/{applicationId}/achievements', ) command.response_representation = Google::Apis::GamesConfigurationV1configuration::ListAchievementConfigurationResponse::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::ListAchievementConfigurationResponse 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#list_leaderboard_configurations(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::ListLeaderboardConfigurationResponse
Returns a list of the leaderboard configurations in this application.
      442 443 444 445 446 447 448 449 450 451 452 453  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 442 def list_leaderboard_configurations(application_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'applications/{applicationId}/leaderboards', ) command.response_representation = Google::Apis::GamesConfigurationV1configuration::ListLeaderboardConfigurationResponse::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::ListLeaderboardConfigurationResponse 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#patch_achievement_configuration(achievement_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration
Update the metadata of the achievement configuration with the given ID. This method supports patch semantics.
      219 220 221 222 223 224 225 226 227 228 229 230  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 219 def patch_achievement_configuration(achievement_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'achievements/{achievementId}', ) command.request_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation command.request_object = achievement_configuration_object command.response_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#patch_leaderboard_configuration(leaderboard_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration
Update the metadata of the leaderboard configuration with the given ID. This method supports patch semantics.
      479 480 481 482 483 484 485 486 487 488 489 490  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 479 def patch_leaderboard_configuration(leaderboard_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, 'leaderboards/{leaderboardId}', ) command.request_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation command.request_object = leaderboard_configuration_object command.response_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#update_achievement_configuration(achievement_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration
Update the metadata of the achievement configuration with the given ID.
      255 256 257 258 259 260 261 262 263 264 265 266  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 255 def update_achievement_configuration(achievement_id, achievement_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'achievements/{achievementId}', ) command.request_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation command.request_object = achievement_configuration_object command.response_representation = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#update_leaderboard_configuration(leaderboard_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration
Update the metadata of the leaderboard configuration with the given ID.
      515 516 517 518 519 520 521 522 523 524 525 526  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 515 def update_leaderboard_configuration(leaderboard_id, leaderboard_configuration_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'leaderboards/{leaderboardId}', ) command.request_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation command.request_object = leaderboard_configuration_object command.response_representation = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  | 
  
#upload_image_configuration(resource_id, image_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesConfigurationV1configuration::ImageConfiguration
Uploads an image for a resource with the given ID and image type.
      296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312  | 
    
      # File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 296 def upload_image_configuration(resource_id, image_type, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? command = make_simple_command(:post, 'images/{resourceId}/imageType/{imageType}', ) else command = make_upload_command(:post, 'images/{resourceId}/imageType/{imageType}', ) command.upload_source = upload_source command.upload_content_type = content_type end command.response_representation = Google::Apis::GamesConfigurationV1configuration::ImageConfiguration::Representation command.response_class = Google::Apis::GamesConfigurationV1configuration::ImageConfiguration command.params['resourceId'] = resource_id unless resource_id.nil? command.params['imageType'] = image_type unless image_type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end  |