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

Inherits:

Core::BaseService

Object
Core::BaseService
Google::Apis::GamesV1::GamesService

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

Instance Attribute Summary collapse

#key ⇒ String
API key.
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
#user_ip ⇒ String
IP address of the site where the request originates.

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

#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.
#cancel_turn_based_match(match_id, consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Cancel a turn-based match.
#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.
#claim_quest_milestone(quest_id, milestone_id, request_id, consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Report that a reward for the milestone corresponding to milestoneId for the quest corresponding to questId has been claimed by the currently authorized user.
#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.
#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.
#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.
#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.
#dismiss_room(room_id, consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Dismiss an invitation to join a room.
#dismiss_turn_based_match(match_id, consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Dismiss a turn-based match from the match list.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#initialize ⇒ GamesService constructor
A new instance of GamesService.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#played_application(consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Indicate that the the currently authenticated user is playing your application.
#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.
#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.
#remove_pushtoken(push_token_id_object = nil, consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Removes a push token for the current user and application.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#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.
#update_pushtoken(push_token_object = nil, consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Registers a push token for the current user and application.
#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.

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Constructor Details

#initialize ⇒ `GamesService`

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

#key ⇒ `String`

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

(String) —
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40

# File 'generated/google/apis/games_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ `String`

Returns 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_ip ⇒ `String`

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

Returns:

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



49
50
51

# File 'generated/google/apis/games_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:

result (Google::Apis::GamesV1::Quest) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::Quest)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::CheckRevisionResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::CheckRevisionResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::Room) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::Room)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatch) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatch)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::Room) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::Room)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatch) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatch)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatch) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatch)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::Application) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::Application)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::Leaderboard) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::Leaderboard)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::MetagameConfig) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::MetagameConfig)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::Player) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::Player)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::Room) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::Room)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::Snapshot) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::Snapshot)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatch) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatch)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::AchievementIncrementResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::AchievementIncrementResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::Room) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::Room)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatch) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatch)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::Room) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::Room)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatch) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatch)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatch) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatch)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListAchievementDefinitionsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListAchievementDefinitionsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListPlayerAchievementResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListPlayerAchievementResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListPlayerEventResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListPlayerEventResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListEventDefinitionResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListEventDefinitionResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListLeaderboardResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListLeaderboardResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListCategoryResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListCategoryResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListPlayerResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListPlayerResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListQuestResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListQuestResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::RoomList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::RoomList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::LeaderboardScores) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::LeaderboardScores)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::LeaderboardScores) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::LeaderboardScores)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListSnapshotResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListSnapshotResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatchList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatchList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::UpdateEventResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::UpdateEventResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatchRematch) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatchRematch)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::RoomStatus) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::RoomStatus)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::AchievementRevealResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::AchievementRevealResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::PlayerScoreResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::PlayerScoreResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ListPlayerScoreResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ListPlayerScoreResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatchSync) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatchSync)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::TurnBasedMatch) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::TurnBasedMatch)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::AchievementUnlockResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::AchievementUnlockResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::AchievementUpdateMultipleResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::AchievementUpdateMultipleResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

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

result (Google::Apis::GamesV1::ApplicationVerifyResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::GamesV1::ApplicationVerifyResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# 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

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

Overview

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

Instance Method Summary collapse

Methods inherited from Core::BaseService

Constructor Details

#initialize ⇒ GamesService

Instance Attribute Details

#key ⇒ String

#quota_user ⇒ String

#user_ip ⇒ String

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

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

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

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

#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_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

#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_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

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

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

#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

#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

#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

#get_metagame_config(consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::MetagameConfig

#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

#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_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_snapshot(snapshot_id, consistency_token: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Snapshot

#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

#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

#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_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_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_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_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

#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

#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

#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

#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

#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

#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_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

#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

#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

#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

#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

#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

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

#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

#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

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

#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

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

#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

#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

#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

#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

#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

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

#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

#update_pushtoken(push_token_object = nil, consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

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

#initialize ⇒ `GamesService`

#key ⇒ `String`

#quota_user ⇒ `String`

#user_ip ⇒ `String`

#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`

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

#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_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`

#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_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`

#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`

#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`

#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`

#get_metagame_config(consistency_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GamesV1::MetagameConfig`

#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`

#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_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_snapshot(snapshot_id, consistency_token: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::GamesV1::Snapshot`

#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`

#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`

#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_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_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_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_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`

#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`

#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`

#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`

#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`

#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`

#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_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`

#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`

#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`

#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`

#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`

#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`

#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`

#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`

#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`

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

#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`

#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`

#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`

#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`

#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`

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

#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`

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