Class: Google::Apis::GamesConfigurationV1configuration::GamesConfigurationService

Inherits:
Core::BaseService
  • Object
show all
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.

Examples:

require 'google/apis/games_configuration_v1configuration'

GamesConfiguration = Google::Apis::GamesConfigurationV1configuration # Alias the module
service = GamesConfiguration::GamesConfigurationService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initialize ⇒ GamesConfigurationService

Returns a new instance of GamesConfigurationService.



51
52
53
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'games/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.

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.



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.

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

Returns:

  • (String) —

    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.

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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



79
80
81
82
83
84
85
86
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 79

def delete_achievement_configuration(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'achievements/{achievementId}', 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?
  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.

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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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:



353
354
355
356
357
358
359
360
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 353

def delete_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'leaderboards/{leaderboardId}', 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?
  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.

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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



112
113
114
115
116
117
118
119
120
121
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 112

def get_achievement_configuration(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'achievements/{achievementId}', options)
  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.

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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



386
387
388
389
390
391
392
393
394
395
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 386

def get_leaderboard_configuration(leaderboard_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'leaderboards/{leaderboardId}', options)
  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.

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

  • achievement_configuration_object (Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration) (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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 148

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', options)
  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.

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

  • leaderboard_configuration_object (Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration) (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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 422

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', options)
  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.

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

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

    The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the 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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 191

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', options)
  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.

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

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

    The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the 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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 465

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', options)
  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.

Parameters:

  • achievement_id (String) —

    The ID of the achievement used by this method.

  • achievement_configuration_object (Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration) (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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 230

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}', options)
  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.

Parameters:

  • leaderboard_id (String) —

    The ID of the leaderboard.

  • leaderboard_configuration_object (Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration) (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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 504

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}', options)
  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.

Parameters:

  • achievement_id (String) —

    The ID of the achievement used by this method.

  • achievement_configuration_object (Google::Apis::GamesConfigurationV1configuration::AchievementConfiguration) (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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 268

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}', options)
  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.

Parameters:

  • leaderboard_id (String) —

    The ID of the leaderboard.

  • leaderboard_configuration_object (Google::Apis::GamesConfigurationV1configuration::LeaderboardConfiguration) (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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 542

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}', options)
  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.

Parameters:

  • resource_id (String) —

    The ID of the resource used by this method.

  • image_type (String) —

    Selects which image in a resource for 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. Overrides userIp if both are provided.

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

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • upload_source (IO, String) (defaults to: nil) —

    IO stream or filename containing content to upload

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

    Content type of the uploaded content.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'generated/google/apis/games_configuration_v1configuration/service.rb', line 311

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}', options)
  else
    command = make_upload_command(:post, 'images/{resourceId}/imageType/{imageType}', options)
    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