Class: Google::Apis::GamesV1::GamesService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/games_v1/service.rb

Overview

Google Play Game Services API

The API for Google Play Game Services.

Examples:

require 'google/apis/games_v1'

Games = Google::Apis::GamesV1 # Alias the module
service = Games::GamesService.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

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ GamesService

Returns a new instance of GamesService.



49
50
51
52
 
# File 'generated/google/apis/games_v1/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'games/v1/')
  @batch_path = 'batch/games/v1'
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_v1/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.

Returns:

  • (String) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



43
44
45
 
# File 'generated/google/apis/games_v1/service.rb', line 43

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



47
48
49
 
# File 'generated/google/apis/games_v1/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#cancel_turn_based_match(match_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Cancel a turn-based match.

Parameters:

  • match_id (String) —

    The ID of the match.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



1549
1550
1551
1552
1553
1554
1555
1556
 
# File 'generated/google/apis/games_v1/service.rb', line 1549

def cancel_turn_based_match(match_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'turnbasedmatches/{matchId}/cancel', options)
  command.params['matchId'] = match_id unless match_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

#check_revision(client_revision, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::CheckRevisionResponse

Checks whether the games client is out of date.

Parameters:

  • client_revision (String) —

    The revision of the client SDK used by your application. Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are:

    • "ANDROID" - Client is running the Android SDK.
    • "IOS" - Client is running the iOS SDK.
    • "WEB_APP" - Client is running as a Web App.
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



877
878
879
880
881
882
883
884
885
886
 
# File 'generated/google/apis/games_v1/service.rb', line 877

def check_revision(client_revision, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'revisions/check', options)
  command.response_representation = Google::Apis::GamesV1::CheckRevisionResponse::Representation
  command.response_class = Google::Apis::GamesV1::CheckRevisionResponse
  command.query['clientRevision'] = client_revision unless client_revision.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

#create_room(create_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Room

Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters:

  • create_room_request_object (Google::Apis::GamesV1::CreateRoomRequest) (defaults to: nil)
  • language (String) (defaults to: nil) —

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'generated/google/apis/games_v1/service.rb', line 912

def create_room(create_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'rooms/create', options)
  command.request_representation = Google::Apis::GamesV1::CreateRoomRequest::Representation
  command.request_object = create_room_request_object
  command.response_representation = Google::Apis::GamesV1::Room::Representation
  command.response_class = Google::Apis::GamesV1::Room
  command.query['language'] = language unless language.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

#create_turn_based_match(create_turn_based_match_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatch

Create a turn-based match.

Parameters:

  • create_turn_based_match_request_object (Google::Apis::GamesV1::CreateTurnBasedMatchRequest) (defaults to: nil)
  • language (String) (defaults to: nil) —

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
 
# File 'generated/google/apis/games_v1/service.rb', line 1581

def create_turn_based_match(create_turn_based_match_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'turnbasedmatches/create', options)
  command.request_representation = Google::Apis::GamesV1::CreateTurnBasedMatchRequest::Representation
  command.request_object = create_turn_based_match_request_object
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatch
  command.query['language'] = language unless language.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

#decline_room(room_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Room

Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters:

  • room_id (String) —

    The ID of the room.

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

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



950
951
952
953
954
955
956
957
958
959
960
 
# File 'generated/google/apis/games_v1/service.rb', line 950

def decline_room(room_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'rooms/{roomId}/decline', options)
  command.response_representation = Google::Apis::GamesV1::Room::Representation
  command.response_class = Google::Apis::GamesV1::Room
  command.params['roomId'] = room_id unless room_id.nil?
  command.query['language'] = language unless language.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

#decline_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatch

Decline an invitation to play a turn-based match.

Parameters:

  • match_id (String) —

    The ID of the match.

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

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
 
# File 'generated/google/apis/games_v1/service.rb', line 1618

def decline_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'turnbasedmatches/{matchId}/decline', options)
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatch
  command.params['matchId'] = match_id unless match_id.nil?
  command.query['language'] = language unless language.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

#dismiss_room(room_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters:

  • room_id (String) —

    The ID of the room.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



985
986
987
988
989
990
991
992
 
# File 'generated/google/apis/games_v1/service.rb', line 985

def dismiss_room(room_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'rooms/{roomId}/dismiss', options)
  command.params['roomId'] = room_id unless room_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

#dismiss_turn_based_match(match_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.

Parameters:

  • match_id (String) —

    The ID of the match.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'generated/google/apis/games_v1/service.rb', line 1653

def dismiss_turn_based_match(match_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'turnbasedmatches/{matchId}/dismiss', options)
  command.params['matchId'] = match_id unless match_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

#finish_turn_based_match(match_id, turn_based_match_results_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatch

Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state.

Parameters:

  • match_id (String) —

    The ID of the match.

  • turn_based_match_results_object (Google::Apis::GamesV1::TurnBasedMatchResults) (defaults to: nil)
  • language (String) (defaults to: nil) —

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'generated/google/apis/games_v1/service.rb', line 1689

def finish_turn_based_match(match_id, turn_based_match_results_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'turnbasedmatches/{matchId}/finish', options)
  command.request_representation = Google::Apis::GamesV1::TurnBasedMatchResults::Representation
  command.request_object = turn_based_match_results_object
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatch
  command.params['matchId'] = match_id unless match_id.nil?
  command.query['language'] = language unless language.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_application(application_id, language: nil, platform_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Application

Retrieves the metadata of the application with the given ID. If the requested application is not available for the specified platformType, the returned response will not include any instance data.

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

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

    The preferred language to use for strings returned by this method.

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

    Restrict application details returned to the specific platform.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'generated/google/apis/games_v1/service.rb', line 354

def get_application(application_id, language: nil, platform_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'applications/{applicationId}', options)
  command.response_representation = Google::Apis::GamesV1::Application::Representation
  command.response_class = Google::Apis::GamesV1::Application
  command.params['applicationId'] = application_id unless application_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['platformType'] = platform_type unless platform_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

#get_leaderboard(leaderboard_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Leaderboard

Retrieves the metadata of the leaderboard with the given ID.

Parameters:

  • leaderboard_id (String) —

    The ID of the leaderboard.

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

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



573
574
575
576
577
578
579
580
581
582
583
 
# File 'generated/google/apis/games_v1/service.rb', line 573

def get_leaderboard(leaderboard_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'leaderboards/{leaderboardId}', options)
  command.response_representation = Google::Apis::GamesV1::Leaderboard::Representation
  command.response_class = Google::Apis::GamesV1::Leaderboard
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.query['language'] = language unless language.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_metagame_config(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::MetagameConfig

Return the metagame configuration data for the calling application.

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



646
647
648
649
650
651
652
653
654
 
# File 'generated/google/apis/games_v1/service.rb', line 646

def get_metagame_config(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'metagameConfig', options)
  command.response_representation = Google::Apis::GamesV1::MetagameConfig::Representation
  command.response_class = Google::Apis::GamesV1::MetagameConfig
  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_player(player_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Player

Retrieves the Player resource with the given ID. To retrieve the player for the currently authenticated user, set playerId to me.

Parameters:

  • player_id (String) —

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

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

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



731
732
733
734
735
736
737
738
739
740
741
 
# File 'generated/google/apis/games_v1/service.rb', line 731

def get_player(player_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'players/{playerId}', options)
  command.response_representation = Google::Apis::GamesV1::Player::Representation
  command.response_class = Google::Apis::GamesV1::Player
  command.params['playerId'] = player_id unless player_id.nil?
  command.query['language'] = language unless language.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_room(room_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Room

Get the data for a room.

Parameters:

  • room_id (String) —

    The ID of the room.

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

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'generated/google/apis/games_v1/service.rb', line 1018

def get_room(room_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'rooms/{roomId}', options)
  command.response_representation = Google::Apis::GamesV1::Room::Representation
  command.response_class = Google::Apis::GamesV1::Room
  command.params['roomId'] = room_id unless room_id.nil?
  command.query['language'] = language unless language.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_score(player_id, leaderboard_id, time_span, include_rank_type: nil, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse

Get high scores, and optionally ranks, in leaderboards for the currently authenticated player. For a specific time span, leaderboardId can be set to ALL to retrieve data for all leaderboards in a given time span. NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same request; only one parameter may be set to 'ALL'.

Parameters:

  • player_id (String) —

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

  • leaderboard_id (String) —

    The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all leaderboards for this application.

  • time_span (String) —

    The time span for the scores and ranks you're requesting.

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

    The types of ranks to return. If the parameter is omitted, no ranks will be returned.

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'generated/google/apis/games_v1/service.rb', line 1234

def get_score(player_id, leaderboard_id, time_span, include_rank_type: nil, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}', options)
  command.response_representation = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse
  command.params['playerId'] = player_id unless player_id.nil?
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.params['timeSpan'] = time_span unless time_span.nil?
  command.query['includeRankType'] = include_rank_type unless include_rank_type.nil?
  command.query['language'] = language unless language.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

#get_snapshot(snapshot_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Snapshot

Retrieves the metadata for a given snapshot ID.

Parameters:

  • snapshot_id (String) —

    The ID of the snapshot.

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

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
 
# File 'generated/google/apis/games_v1/service.rb', line 1469

def get_snapshot(snapshot_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'snapshots/{snapshotId}', options)
  command.response_representation = Google::Apis::GamesV1::Snapshot::Representation
  command.response_class = Google::Apis::GamesV1::Snapshot
  command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
  command.query['language'] = language unless language.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_turn_based_match(match_id, include_match_data: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatch

Get the data for a turn-based match.

Parameters:

  • match_id (String) —

    The ID of the match.

  • include_match_data (Boolean) (defaults to: nil) —

    Get match data along with metadata.

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

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
 
# File 'generated/google/apis/games_v1/service.rb', line 1729

def get_turn_based_match(match_id, include_match_data: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'turnbasedmatches/{matchId}', options)
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatch
  command.params['matchId'] = match_id unless match_id.nil?
  command.query['includeMatchData'] = include_match_data unless include_match_data.nil?
  command.query['language'] = language unless language.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

#increment_achievement(achievement_id, steps_to_increment, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::AchievementIncrementResponse

Increments the steps of the achievement with the given ID for the currently authenticated player.

Parameters:

  • achievement_id (String) —

    The ID of the achievement used by this method.

  • steps_to_increment (Fixnum) —

    The number of steps to increment.

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

    A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'generated/google/apis/games_v1/service.rb', line 124

def increment_achievement(achievement_id, steps_to_increment, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'achievements/{achievementId}/increment', options)
  command.response_representation = Google::Apis::GamesV1::AchievementIncrementResponse::Representation
  command.response_class = Google::Apis::GamesV1::AchievementIncrementResponse
  command.params['achievementId'] = achievement_id unless achievement_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['stepsToIncrement'] = steps_to_increment unless steps_to_increment.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

#join_room(room_id, join_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Room

Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters:

  • room_id (String) —

    The ID of the room.

  • join_room_request_object (Google::Apis::GamesV1::JoinRoomRequest) (defaults to: nil)
  • language (String) (defaults to: nil) —

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'generated/google/apis/games_v1/service.rb', line 1056

def join_room(room_id, join_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'rooms/{roomId}/join', options)
  command.request_representation = Google::Apis::GamesV1::JoinRoomRequest::Representation
  command.request_object = join_room_request_object
  command.response_representation = Google::Apis::GamesV1::Room::Representation
  command.response_class = Google::Apis::GamesV1::Room
  command.params['roomId'] = room_id unless room_id.nil?
  command.query['language'] = language unless language.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

#join_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatch

Join a turn-based match.

Parameters:

  • match_id (String) —

    The ID of the match.

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

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
 
# File 'generated/google/apis/games_v1/service.rb', line 1766

def join_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'turnbasedmatches/{matchId}/join', options)
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatch
  command.params['matchId'] = match_id unless match_id.nil?
  command.query['language'] = language unless language.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

#leave_room(room_id, leave_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Room

Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters:

  • room_id (String) —

    The ID of the room.

  • leave_room_request_object (Google::Apis::GamesV1::LeaveRoomRequest) (defaults to: nil)
  • language (String) (defaults to: nil) —

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'generated/google/apis/games_v1/service.rb', line 1096

def leave_room(room_id, leave_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'rooms/{roomId}/leave', options)
  command.request_representation = Google::Apis::GamesV1::LeaveRoomRequest::Representation
  command.request_object = leave_room_request_object
  command.response_representation = Google::Apis::GamesV1::Room::Representation
  command.response_class = Google::Apis::GamesV1::Room
  command.params['roomId'] = room_id unless room_id.nil?
  command.query['language'] = language unless language.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

#leave_turn(match_id, match_version, language: nil, pending_participant_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatch

Leave a turn-based match during the current player's turn, without canceling the match.

Parameters:

  • match_id (String) —

    The ID of the match.

  • match_version (Fixnum) —

    The version of the match being updated.

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

    The preferred language to use for strings returned by this method.

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

    The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
 
# File 'generated/google/apis/games_v1/service.rb', line 1847

def leave_turn(match_id, match_version, language: nil, pending_participant_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'turnbasedmatches/{matchId}/leaveTurn', options)
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatch
  command.params['matchId'] = match_id unless match_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['matchVersion'] = match_version unless match_version.nil?
  command.query['pendingParticipantId'] = pending_participant_id unless pending_participant_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

#leave_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatch

Leave a turn-based match when it is not the current player's turn, without canceling the match.

Parameters:

  • match_id (String) —

    The ID of the match.

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

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
 
# File 'generated/google/apis/games_v1/service.rb', line 1803

def leave_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'turnbasedmatches/{matchId}/leave', options)
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatch
  command.params['matchId'] = match_id unless match_id.nil?
  command.query['language'] = language unless language.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_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListAchievementDefinitionsResponse

Lists all the achievement definitions for your application.

Parameters:

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of achievement resources to return in the response, used for paging. For any response, the actual number of achievement 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'generated/google/apis/games_v1/service.rb', line 82

def list_achievement_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'achievements', options)
  command.response_representation = Google::Apis::GamesV1::ListAchievementDefinitionsResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListAchievementDefinitionsResponse
  command.query['language'] = language unless language.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_achievements(player_id, language: nil, max_results: nil, page_token: nil, state: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListPlayerAchievementResponse

Lists the progress for all your application's achievements for the currently authenticated player.

Parameters:

  • player_id (String) —

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

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

    The preferred language to use for strings returned by this method.

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

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

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

    The token returned by the previous request.

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

    Tells the server to return only achievements with the specified state. If this parameter isn't specified, all achievements are returned.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'generated/google/apis/games_v1/service.rb', line 172

def list_achievements(player_id, language: nil, max_results: nil, page_token: nil, state: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'players/{playerId}/achievements', options)
  command.response_representation = Google::Apis::GamesV1::ListPlayerAchievementResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerAchievementResponse
  command.params['playerId'] = player_id unless player_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['state'] = state unless state.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_event_by_player(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListPlayerEventResponse

Returns a list showing the current progress on events in this application for the currently authenticated user.

Parameters:

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of events to return in the response, used for paging. For any response, the actual number of events to return 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'generated/google/apis/games_v1/service.rb', line 458

def list_event_by_player(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'events', options)
  command.response_representation = Google::Apis::GamesV1::ListPlayerEventResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerEventResponse
  command.query['language'] = language unless language.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_event_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListEventDefinitionResponse

Returns a list of the event definitions in this application.

Parameters:

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'generated/google/apis/games_v1/service.rb', line 499

def list_event_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'eventDefinitions', options)
  command.response_representation = Google::Apis::GamesV1::ListEventDefinitionResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListEventDefinitionResponse
  command.query['language'] = language unless language.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_leaderboards(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListLeaderboardResponse

Lists all the leaderboard metadata for your application.

Parameters:

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of leaderboards to return in the response. For any response, the actual number of leaderboards 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'generated/google/apis/games_v1/service.rb', line 613

def list_leaderboards(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'leaderboards', options)
  command.response_representation = Google::Apis::GamesV1::ListLeaderboardResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListLeaderboardResponse
  command.query['language'] = language unless language.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_metagame_categories_by_player(player_id, collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListCategoryResponse

List play data aggregated per category for the player corresponding to playerId.

Parameters:

  • player_id (String) —

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

  • collection (String) —

    The collection of categories for which data will be returned.

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of category resources to return in the response, used for paging. For any response, the actual number of category 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'generated/google/apis/games_v1/service.rb', line 690

def list_metagame_categories_by_player(player_id, collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'players/{playerId}/categories/{collection}', options)
  command.response_representation = Google::Apis::GamesV1::ListCategoryResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListCategoryResponse
  command.params['playerId'] = player_id unless player_id.nil?
  command.params['collection'] = collection unless collection.nil?
  command.query['language'] = language unless language.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_players(collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListPlayerResponse

Get the collection of players for the currently authenticated user.

Parameters:

  • collection (String) —

    Collection of players being retrieved

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

    The preferred language to use for strings returned by this method.

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'generated/google/apis/games_v1/service.rb', line 773

def list_players(collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'players/me/players/{collection}', options)
  command.response_representation = Google::Apis::GamesV1::ListPlayerResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerResponse
  command.params['collection'] = collection unless collection.nil?
  command.query['language'] = language unless language.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_rooms(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::RoomList

Returns invitations to join rooms.

Parameters:

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of rooms to return in the response, used for paging. For any response, the actual number of rooms to return 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'generated/google/apis/games_v1/service.rb', line 1138

def list_rooms(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'rooms', options)
  command.response_representation = Google::Apis::GamesV1::RoomList::Representation
  command.response_class = Google::Apis::GamesV1::RoomList
  command.query['language'] = language unless language.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_score_window(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, results_above: nil, return_top_if_absent: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::LeaderboardScores

Lists the scores in a leaderboard around (and including) a player's score.

Parameters:

  • leaderboard_id (String) —

    The ID of the leaderboard.

  • collection (String) —

    The collection of scores you're requesting.

  • time_span (String) —

    The time span for the scores and ranks you're requesting.

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores returned may be less than the specified maxResults.

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

    The token returned by the previous request.

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

    The preferred number of scores to return above the player's score. More scores may be returned if the player is at the bottom of the leaderboard; fewer may be returned if the player is at the top. Must be less than or equal to maxResults.

  • return_top_if_absent (Boolean) (defaults to: nil) —

    True if the top scores should be returned when the player is not in the leaderboard. Defaults to true.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
 
# File 'generated/google/apis/games_v1/service.rb', line 1343

def list_score_window(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, results_above: nil, return_top_if_absent: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'leaderboards/{leaderboardId}/window/{collection}', options)
  command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation
  command.response_class = Google::Apis::GamesV1::LeaderboardScores
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.params['collection'] = collection unless collection.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['resultsAbove'] = results_above unless results_above.nil?
  command.query['returnTopIfAbsent'] = return_top_if_absent unless return_top_if_absent.nil?
  command.query['timeSpan'] = time_span unless time_span.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_scores(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::LeaderboardScores

Lists the scores in a leaderboard, starting from the top.

Parameters:

  • leaderboard_id (String) —

    The ID of the leaderboard.

  • collection (String) —

    The collection of scores you're requesting.

  • time_span (String) —

    The time span for the scores and ranks you're requesting.

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of leaderboard scores to return in the response. For any response, the actual number of leaderboard scores 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
 
# File 'generated/google/apis/games_v1/service.rb', line 1285

def list_scores(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'leaderboards/{leaderboardId}/scores/{collection}', options)
  command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation
  command.response_class = Google::Apis::GamesV1::LeaderboardScores
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.params['collection'] = collection unless collection.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['timeSpan'] = time_span unless time_span.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_snapshots(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListSnapshotResponse

Retrieves a list of snapshots created by your application for the player corresponding to the player ID.

Parameters:

  • player_id (String) —

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

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of snapshot resources to return in the response, used for paging. For any response, the actual number of snapshot 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
 
# File 'generated/google/apis/games_v1/service.rb', line 1513

def list_snapshots(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'players/{playerId}/snapshots', options)
  command.response_representation = Google::Apis::GamesV1::ListSnapshotResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListSnapshotResponse
  command.params['playerId'] = player_id unless player_id.nil?
  command.query['language'] = language unless language.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_turn_based_matches(include_match_data: nil, language: nil, max_completed_matches: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatchList

Returns turn-based matches the player is or was involved in.

Parameters:

  • include_match_data (Boolean) (defaults to: nil) —

    True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.

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

    The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
 
# File 'generated/google/apis/games_v1/service.rb', line 1898

def list_turn_based_matches(include_match_data: nil, language: nil, max_completed_matches: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'turnbasedmatches', options)
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatchList::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatchList
  command.query['includeMatchData'] = include_match_data unless include_match_data.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxCompletedMatches'] = max_completed_matches unless max_completed_matches.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

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

This method returns an undefined value.

Indicate that the the currently authenticated user is playing your application.

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



387
388
389
390
391
392
393
 
# File 'generated/google/apis/games_v1/service.rb', line 387

def played_application(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'applications/played', options)
  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

#record_event(event_record_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::UpdateEventResponse

Records a batch of changes to the number of times events have occurred for the currently authenticated user of this application.

Parameters:

  • event_record_request_object (Google::Apis::GamesV1::EventRecordRequest) (defaults to: nil)
  • language (String) (defaults to: nil) —

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'generated/google/apis/games_v1/service.rb', line 536

def record_event(event_record_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'events', options)
  command.request_representation = Google::Apis::GamesV1::EventRecordRequest::Representation
  command.request_object = event_record_request_object
  command.response_representation = Google::Apis::GamesV1::UpdateEventResponse::Representation
  command.response_class = Google::Apis::GamesV1::UpdateEventResponse
  command.query['language'] = language unless language.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

#rematch_turn_based_match(match_id, language: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatchRematch

Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn.

Parameters:

  • match_id (String) —

    The ID of the match.

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

    The preferred language to use for strings returned by this method.

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

    A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
 
# File 'generated/google/apis/games_v1/service.rb', line 1944

def rematch_turn_based_match(match_id, language: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'turnbasedmatches/{matchId}/rematch', options)
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatchRematch::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatchRematch
  command.params['matchId'] = match_id unless match_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['requestId'] = request_id unless request_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

#remove_pushtoken(push_token_id_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes a push token for the current user and application. Removing a non- existent push token will report success.

Parameters:

  • push_token_id_object (Google::Apis::GamesV1::PushTokenId) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



809
810
811
812
813
814
815
816
817
 
# File 'generated/google/apis/games_v1/service.rb', line 809

def remove_pushtoken(push_token_id_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'pushtokens/remove', options)
  command.request_representation = Google::Apis::GamesV1::PushTokenId::Representation
  command.request_object = push_token_id_object
  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

#report_room_status(room_id, room_p2_p_statuses_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::RoomStatus

Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

Parameters:

  • room_id (String) —

    The ID of the room.

  • room_p2_p_statuses_object (Google::Apis::GamesV1::RoomP2PStatuses) (defaults to: nil)
  • language (String) (defaults to: nil) —

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
 
# File 'generated/google/apis/games_v1/service.rb', line 1177

def report_room_status(room_id, room_p2_p_statuses_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'rooms/{roomId}/reportstatus', options)
  command.request_representation = Google::Apis::GamesV1::RoomP2PStatuses::Representation
  command.request_object = room_p2_p_statuses_object
  command.response_representation = Google::Apis::GamesV1::RoomStatus::Representation
  command.response_class = Google::Apis::GamesV1::RoomStatus
  command.params['roomId'] = room_id unless room_id.nil?
  command.query['language'] = language unless language.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

#reveal_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::AchievementRevealResponse

Sets the state of the achievement with the given ID to REVEALED for the currently authenticated player.

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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



210
211
212
213
214
215
216
217
218
219
 
# File 'generated/google/apis/games_v1/service.rb', line 210

def reveal_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'achievements/{achievementId}/reveal', options)
  command.response_representation = Google::Apis::GamesV1::AchievementRevealResponse::Representation
  command.response_class = Google::Apis::GamesV1::AchievementRevealResponse
  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

#set_achievement_steps_at_least(achievement_id, steps, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse

Sets the steps for the currently authenticated player towards unlocking an achievement. If the steps parameter is less than the current number of steps that the player already gained for the achievement, the achievement is not modified.

Parameters:

  • achievement_id (String) —

    The ID of the achievement used by this method.

  • steps (Fixnum) —

    The minimum value to set the steps to.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



248
249
250
251
252
253
254
255
256
257
258
 
# File 'generated/google/apis/games_v1/service.rb', line 248

def set_achievement_steps_at_least(achievement_id, steps, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'achievements/{achievementId}/setStepsAtLeast', options)
  command.response_representation = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse::Representation
  command.response_class = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse
  command.params['achievementId'] = achievement_id unless achievement_id.nil?
  command.query['steps'] = steps unless steps.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

#submit_score(leaderboard_id, score, language: nil, score_tag: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::PlayerScoreResponse

Submits a score to the specified leaderboard.

Parameters:

  • leaderboard_id (String) —

    The ID of the leaderboard.

  • score (Fixnum) —

    The score you're submitting. The submitted score is ignored if it is worse than a previously submitted score, where worse depends on the leaderboard sort order. The meaning of the score value depends on the leaderboard format type. For fixed-point, the score represents the raw value. For time, the score represents elapsed time in milliseconds. For currency, the score represents a value in micro units.

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

    The preferred language to use for strings returned by this method.

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

    Additional information about the score you're submitting. Values must contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
 
# File 'generated/google/apis/games_v1/service.rb', line 1395

def submit_score(leaderboard_id, score, language: nil, score_tag: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'leaderboards/{leaderboardId}/scores', options)
  command.response_representation = Google::Apis::GamesV1::PlayerScoreResponse::Representation
  command.response_class = Google::Apis::GamesV1::PlayerScoreResponse
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['score'] = score unless score.nil?
  command.query['scoreTag'] = score_tag unless score_tag.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

#submit_score_multiple(player_score_submission_list_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListPlayerScoreResponse

Submits multiple scores to leaderboards.

Parameters:

  • player_score_submission_list_object (Google::Apis::GamesV1::PlayerScoreSubmissionList) (defaults to: nil)
  • language (String) (defaults to: nil) —

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'generated/google/apis/games_v1/service.rb', line 1432

def submit_score_multiple(player_score_submission_list_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'leaderboards/scores', options)
  command.request_representation = Google::Apis::GamesV1::PlayerScoreSubmissionList::Representation
  command.request_object = player_score_submission_list_object
  command.response_representation = Google::Apis::GamesV1::ListPlayerScoreResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerScoreResponse
  command.query['language'] = language unless language.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

#sync_turn_based_match(include_match_data: nil, language: nil, max_completed_matches: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatchSync

Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.

Parameters:

  • include_match_data (Boolean) (defaults to: nil) —

    True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request.

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

    The preferred language to use for strings returned by this method.

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

    The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled.

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

    The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return 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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'generated/google/apis/games_v1/service.rb', line 1996

def sync_turn_based_match(include_match_data: nil, language: nil, max_completed_matches: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'turnbasedmatches/sync', options)
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatchSync::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatchSync
  command.query['includeMatchData'] = include_match_data unless include_match_data.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxCompletedMatches'] = max_completed_matches unless max_completed_matches.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

#take_turn(match_id, turn_based_match_turn_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::TurnBasedMatch

Commit the results of a player turn.

Parameters:

  • match_id (String) —

    The ID of the match.

  • turn_based_match_turn_object (Google::Apis::GamesV1::TurnBasedMatchTurn) (defaults to: nil)
  • language (String) (defaults to: nil) —

    The preferred language to use for strings returned by this method.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
 
# File 'generated/google/apis/games_v1/service.rb', line 2036

def take_turn(match_id, turn_based_match_turn_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'turnbasedmatches/{matchId}/turn', options)
  command.request_representation = Google::Apis::GamesV1::TurnBasedMatchTurn::Representation
  command.request_object = turn_based_match_turn_object
  command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation
  command.response_class = Google::Apis::GamesV1::TurnBasedMatch
  command.params['matchId'] = match_id unless match_id.nil?
  command.query['language'] = language unless language.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

#unlock_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::AchievementUnlockResponse

Unlocks this achievement for the currently authenticated player.

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) —

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



282
283
284
285
286
287
288
289
290
291
 
# File 'generated/google/apis/games_v1/service.rb', line 282

def unlock_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'achievements/{achievementId}/unlock', options)
  command.response_representation = Google::Apis::GamesV1::AchievementUnlockResponse::Representation
  command.response_class = Google::Apis::GamesV1::AchievementUnlockResponse
  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_multiple_achievements(achievement_update_multiple_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::AchievementUpdateMultipleResponse

Updates multiple achievements for the currently authenticated player.

Parameters:

  • achievement_update_multiple_request_object (Google::Apis::GamesV1::AchievementUpdateMultipleRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



314
315
316
317
318
319
320
321
322
323
324
 
# File 'generated/google/apis/games_v1/service.rb', line 314

def update_multiple_achievements(achievement_update_multiple_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, 'achievements/updateMultiple', options)
  command.request_representation = Google::Apis::GamesV1::AchievementUpdateMultipleRequest::Representation
  command.request_object = achievement_update_multiple_request_object
  command.response_representation = Google::Apis::GamesV1::AchievementUpdateMultipleResponse::Representation
  command.response_class = Google::Apis::GamesV1::AchievementUpdateMultipleResponse
  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_pushtoken(push_token_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Registers a push token for the current user and application.

Parameters:

  • push_token_object (Google::Apis::GamesV1::PushToken) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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



840
841
842
843
844
845
846
847
848
 
# File 'generated/google/apis/games_v1/service.rb', line 840

def update_pushtoken(push_token_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, 'pushtokens', options)
  command.request_representation = Google::Apis::GamesV1::PushToken::Representation
  command.request_object = push_token_object
  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

#verify_application(application_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ApplicationVerifyResponse

Verifies the auth token provided with this request is for the application with the specified ID, and returns the ID of the player it was granted for.

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

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

    Selector specifying which fields to include in a partial response.

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

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

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

    Deprecated. Please use quotaUser instead.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



418
419
420
421
422
423
424
425
426
427
 
# File 'generated/google/apis/games_v1/service.rb', line 418

def verify_application(application_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, 'applications/{applicationId}/verify', options)
  command.response_representation = Google::Apis::GamesV1::ApplicationVerifyResponse::Representation
  command.response_class = Google::Apis::GamesV1::ApplicationVerifyResponse
  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