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

Constructor Details

#initializeGamesService

Returns a new instance of GamesService.


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

def initialize
  super('https://www.googleapis.com/', 'games/v1/')
end

Instance Attribute Details

#keyString

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_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.


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

def quota_user
  @quota_user
end

#user_ipString

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

Returns:

  • (String)

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


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

def user_ip
  @user_ip
end

Instance Method Details

#accept_quest(quest_id, consistency_token: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Quest

Indicates that the currently authorized user will participate in the quest.

Parameters:

  • quest_id (String)

    The ID of the quest.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File 'generated/google/apis/games_v1/service.rb', line 1029

def accept_quest(quest_id, consistency_token: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'quests/{questId}/accept', options)
  command.response_representation = Google::Apis::GamesV1::Quest::Representation
  command.response_class = Google::Apis::GamesV1::Quest
  command.params['questId'] = quest_id unless quest_id.nil?
  command.query['consistencyToken'] = consistency_token unless consistency_token.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

#cancel_turn_based_match(match_id, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'generated/google/apis/games_v1/service.rb', line 1877

def cancel_turn_based_match(match_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_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

#check_revision(client_revision, consistency_token: nil, 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.
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
# File 'generated/google/apis/games_v1/service.rb', line 1125

def check_revision(client_revision, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_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

#claim_quest_milestone(quest_id, milestone_id, request_id, consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user.

Parameters:

  • quest_id (String)

    The ID of the quest.

  • milestone_id (String)

    The ID of the milestone.

  • request_id (String)

    A numeric ID to ensure that the request is handled correctly across retries. Your client application must generate this ID randomly.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


989
990
991
992
993
994
995
996
997
998
999
# File 'generated/google/apis/games_v1/service.rb', line 989

def claim_quest_milestone(quest_id, milestone_id, request_id, consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'quests/{questId}/milestones/{milestoneId}/claim', options)
  command.params['questId'] = quest_id unless quest_id.nil?
  command.params['milestoneId'] = milestone_id unless milestone_id.nil?
  command.query['consistencyToken'] = consistency_token unless consistency_token.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

#create_room(create_room_request_object = nil, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
# File 'generated/google/apis/games_v1/service.rb', line 1165

def create_room(create_room_request_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_token.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

#create_turn_based_match(create_turn_based_match_request_object = nil, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
# File 'generated/google/apis/games_v1/service.rb', line 1914

def create_turn_based_match(create_turn_based_match_request_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_token.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_room(room_id, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
# File 'generated/google/apis/games_v1/service.rb', line 1208

def decline_room(room_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
# File 'generated/google/apis/games_v1/service.rb', line 1956

def decline_turn_based_match(match_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1248
1249
1250
1251
1252
1253
1254
1255
1256
# File 'generated/google/apis/games_v1/service.rb', line 1248

def dismiss_room(room_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_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

#dismiss_turn_based_match(match_id, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


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

def dismiss_turn_based_match(match_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_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

#finish_turn_based_match(match_id, turn_based_match_results_object = nil, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def finish_turn_based_match(match_id, turn_based_match_results_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


394
395
396
397
398
399
400
401
402
403
404
405
406
# File 'generated/google/apis/games_v1/service.rb', line 394

def get_application(application_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def get_leaderboard(leaderboard_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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(consistency_token: nil, 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:

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


726
727
728
729
730
731
732
733
734
735
# File 'generated/google/apis/games_v1/service.rb', line 726

def get_metagame_config(consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_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_player(player_id, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


821
822
823
824
825
826
827
828
829
830
831
832
# File 'generated/google/apis/games_v1/service.rb', line 821

def get_player(player_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def get_room(room_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
# File 'generated/google/apis/games_v1/service.rb', line 1527

def get_score(player_id, leaderboard_id, time_span, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
# File 'generated/google/apis/games_v1/service.rb', line 1787

def get_snapshot(snapshot_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
# File 'generated/google/apis/games_v1/service.rb', line 2082

def get_turn_based_match(match_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • request_id (String) (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)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'generated/google/apis/games_v1/service.rb', line 134

def increment_achievement(achievement_id, steps_to_increment, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
# File 'generated/google/apis/games_v1/service.rb', line 1329

def join_room(room_id, join_room_request_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
# File 'generated/google/apis/games_v1/service.rb', line 2124

def join_turn_based_match(match_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
# File 'generated/google/apis/games_v1/service.rb', line 1374

def leave_room(room_id, leave_room_request_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
# File 'generated/google/apis/games_v1/service.rb', line 2215

def leave_turn(match_id, match_version, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
# File 'generated/google/apis/games_v1/service.rb', line 2166

def leave_turn_based_match(match_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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(consistency_token: nil, 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:

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'generated/google/apis/games_v1/service.rb', line 87

def list_achievement_definitions(consistency_token: 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, 'achievements', options)
  command.response_representation = Google::Apis::GamesV1::ListAchievementDefinitionsResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListAchievementDefinitionsResponse
  command.query['consistencyToken'] = consistency_token unless consistency_token.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_achievements(player_id, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'generated/google/apis/games_v1/service.rb', line 187

def list_achievements(player_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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(consistency_token: nil, 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:

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


513
514
515
516
517
518
519
520
521
522
523
524
525
# File 'generated/google/apis/games_v1/service.rb', line 513

def list_event_by_player(consistency_token: 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, 'events', options)
  command.response_representation = Google::Apis::GamesV1::ListPlayerEventResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerEventResponse
  command.query['consistencyToken'] = consistency_token unless consistency_token.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_event_definitions(consistency_token: nil, 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:

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


559
560
561
562
563
564
565
566
567
568
569
570
571
# File 'generated/google/apis/games_v1/service.rb', line 559

def list_event_definitions(consistency_token: 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, 'eventDefinitions', options)
  command.response_representation = Google::Apis::GamesV1::ListEventDefinitionResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListEventDefinitionResponse
  command.query['consistencyToken'] = consistency_token unless consistency_token.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_leaderboards(consistency_token: nil, 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:

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_leaderboards(consistency_token: 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, 'leaderboards', options)
  command.response_representation = Google::Apis::GamesV1::ListLeaderboardResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListLeaderboardResponse
  command.query['consistencyToken'] = consistency_token unless consistency_token.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_metagame_categories_by_player(player_id, collection, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def list_metagame_categories_by_player(player_id, collection, consistency_token: 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}/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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


868
869
870
871
872
873
874
875
876
877
878
879
880
881
# File 'generated/google/apis/games_v1/service.rb', line 868

def list_players(collection, consistency_token: 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/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['consistencyToken'] = consistency_token unless consistency_token.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_quests(player_id, consistency_token: nil, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListQuestResponse

Get a list of quests for your application and 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • 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 quest resources to return in the response, used for paging. For any response, the actual number of quest resources returned may be less than the specified maxResults. Acceptable values are 1 to 50, inclusive. ( Default: 50).

  • page_token (String) (defaults to: nil)

    The token returned by the previous request.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
# File 'generated/google/apis/games_v1/service.rb', line 1079

def list_quests(player_id, consistency_token: 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}/quests', options)
  command.response_representation = Google::Apis::GamesV1::ListQuestResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListQuestResponse
  command.params['playerId'] = player_id unless player_id.nil?
  command.query['consistencyToken'] = consistency_token unless consistency_token.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(consistency_token: nil, 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:

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
# File 'generated/google/apis/games_v1/service.rb', line 1421

def list_rooms(consistency_token: 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, 'rooms', options)
  command.response_representation = Google::Apis::GamesV1::RoomList::Representation
  command.response_class = Google::Apis::GamesV1::RoomList
  command.query['consistencyToken'] = consistency_token unless consistency_token.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_score_window(leaderboard_id, collection, time_span, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
# File 'generated/google/apis/games_v1/service.rb', line 1646

def list_score_window(leaderboard_id, collection, time_span, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
# File 'generated/google/apis/games_v1/service.rb', line 1583

def list_scores(leaderboard_id, collection, time_span, consistency_token: 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, '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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
# File 'generated/google/apis/games_v1/service.rb', line 1836

def list_snapshots(player_id, consistency_token: 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}/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['consistencyToken'] = consistency_token unless consistency_token.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(consistency_token: nil, 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:

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
# File 'generated/google/apis/games_v1/service.rb', line 2271

def list_turn_based_matches(consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.nil?
  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(consistency_token: nil, 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:

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


432
433
434
435
436
437
438
439
# File 'generated/google/apis/games_v1/service.rb', line 432

def played_application(consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'applications/played', options)
  command.query['consistencyToken'] = consistency_token unless consistency_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

#record_event(event_record_request_object = nil, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


601
602
603
604
605
606
607
608
609
610
611
612
613
# File 'generated/google/apis/games_v1/service.rb', line 601

def record_event(event_record_request_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_token.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

#rematch_turn_based_match(match_id, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • language (String) (defaults to: nil)

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

  • request_id (String) (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)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
# File 'generated/google/apis/games_v1/service.rb', line 2322

def rematch_turn_based_match(match_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


909
910
911
912
913
914
915
916
917
918
# File 'generated/google/apis/games_v1/service.rb', line 909

def remove_pushtoken(push_token_id_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_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

#report_room_status(room_id, room_p2_p_statuses_object = nil, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def report_room_status(room_id, room_p2_p_statuses_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def reveal_achievement(achievement_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_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

#set_achievement_steps_at_least(achievement_id, steps, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


273
274
275
276
277
278
279
280
281
282
283
284
# File 'generated/google/apis/games_v1/service.rb', line 273

def set_achievement_steps_at_least(achievement_id, steps, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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 (String)

    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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
# File 'generated/google/apis/games_v1/service.rb', line 1703

def submit_score(leaderboard_id, score, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
# File 'generated/google/apis/games_v1/service.rb', line 1745

def submit_score_multiple(player_score_submission_list_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_token.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

#sync_turn_based_match(consistency_token: nil, 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:

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
# File 'generated/google/apis/games_v1/service.rb', line 2379

def sync_turn_based_match(consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_token.nil?
  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, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
# File 'generated/google/apis/games_v1/service.rb', line 2424

def take_turn(match_id, turn_based_match_turn_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_token.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, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

def unlock_achievement(achievement_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_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

#update_multiple_achievements(achievement_update_multiple_request_object = nil, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


349
350
351
352
353
354
355
356
357
358
359
360
# File 'generated/google/apis/games_v1/service.rb', line 349

def update_multiple_achievements(achievement_update_multiple_request_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_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

#update_pushtoken(push_token_object = nil, consistency_token: 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)
  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


945
946
947
948
949
950
951
952
953
954
# File 'generated/google/apis/games_v1/service.rb', line 945

def update_pushtoken(push_token_object = nil, consistency_token: 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['consistencyToken'] = consistency_token unless consistency_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

#verify_application(application_id, consistency_token: nil, 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.

  • consistency_token (String) (defaults to: nil)

    The last-seen mutation timestamp.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


468
469
470
471
472
473
474
475
476
477
478
# File 'generated/google/apis/games_v1/service.rb', line 468

def verify_application(application_id, consistency_token: nil, 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['consistencyToken'] = consistency_token unless consistency_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