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
Available to use for quota purposes for server-side applications.
-
#user_ip ⇒ String
IP address of the site where the request originates.
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
51 52 53 54 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 51 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 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. Overrides userIp if both are provided.
44 45 46 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 44 def quota_user @quota_user end |
#user_ip ⇒ String
Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.
49 50 51 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 49 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.
80 81 82 83 84 85 86 87 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 80 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.
354 355 356 357 358 359 360 361 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 354 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.
113 114 115 116 117 118 119 120 121 122 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 113 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.
387 388 389 390 391 392 393 394 395 396 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 387 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.
149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 149 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.
423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 423 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.
192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 192 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.
466 467 468 469 470 471 472 473 474 475 476 477 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 466 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.
231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 231 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.
505 506 507 508 509 510 511 512 513 514 515 516 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 505 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.
269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 269 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.
543 544 545 546 547 548 549 550 551 552 553 554 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 543 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.
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 312 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 |