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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/games_v1/service.rb

Overview

Google Play Game Services

The Google Play games service allows developers to enhance games with social leaderboards, achievements, game state, sign-in with Google, and more.

Examples:

require 'google/apis/games_v1'

Games = Google::Apis::GamesV1 # Alias the module
service = Games::GamesService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://games.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ GamesService

Returns a new instance of GamesService.



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

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-games_v1',
        client_version: Google::Apis::GamesV1::GEM_VERSION)
  @batch_path = 'batch'
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.



41
42
43
 
# File 'lib/google/apis/games_v1/service.rb', line 41

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.

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.



46
47
48
 
# File 'lib/google/apis/games_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

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

Checks whether the games client is out of date.

Parameters:

  • client_revision (String) —

    Required. The revision of the client SDK used by your application. Format: [ PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: * ANDROID - Client is running the Android SDK. * IOS - Client is running the iOS SDK. * WEB_APP - Client is running as a Web App.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



1130
1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'lib/google/apis/games_v1/service.rb', line 1130

def check_revision(client_revision, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/revisions/check', options)
  command.response_representation = Google::Apis::GamesV1::CheckRevisionResponse::Representation
  command.response_class = Google::Apis::GamesV1::CheckRevisionResponse
  command.query['clientRevision'] = client_revision unless client_revision.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#games_recall_player_tokens(session_id, application_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::RetrieveGamesPlayerTokensResponse

Retrieve the Recall tokens from all requested games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have an active PGS Player profile.

Parameters:

  • session_id (String) —

    Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.

  • application_ids (Array<String>, String) (defaults to: nil) —

    Required. The application IDs from the Google Play developer console for the games to return scoped ids for.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



936
937
938
939
940
941
942
943
944
945
 
# File 'lib/google/apis/games_v1/service.rb', line 936

def games_recall_player_tokens(session_id, application_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/recall/gamesPlayerTokens/{sessionId}', options)
  command.response_representation = Google::Apis::GamesV1::RetrieveGamesPlayerTokensResponse::Representation
  command.response_class = Google::Apis::GamesV1::RetrieveGamesPlayerTokensResponse
  command.params['sessionId'] = session_id unless session_id.nil?
  command.query['applicationIds'] = application_ids unless application_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_accesstoken_play_grouping_api_token(package_name: nil, persona: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::GeneratePlayGroupingApiTokenResponse

Generates a Play Grouping API token for the PGS user identified by the attached credential.

Parameters:

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

    Required. App package name to generate the token for (e.g. com.example.mygame).

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

    Required. Persona to associate with the token. Persona is a developer-provided stable identifier of the user. Must be deterministically generated (e.g. as a one-way hash) from the user account ID and user profile ID (if the app has the concept), according to the developer's own user identity system.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/google/apis/games_v1/service.rb', line 81

def generate_accesstoken_play_grouping_api_token(package_name: nil, persona: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/accesstokens/generatePlayGroupingApiToken', options)
  command.response_representation = Google::Apis::GamesV1::GeneratePlayGroupingApiTokenResponse::Representation
  command.response_class = Google::Apis::GamesV1::GeneratePlayGroupingApiTokenResponse
  command.query['packageName'] = package_name unless package_name.nil?
  command.query['persona'] = persona unless persona.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_accesstoken_recall_play_grouping_api_token(package_name: nil, persona: nil, recall_session_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::GenerateRecallPlayGroupingApiTokenResponse

Generates a Play Grouping API token for the PGS user identified by the Recall session ID provided in the request.

Parameters:

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

    Required. App package name to generate the token for (e.g. com.example.mygame).

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

    Required. Persona to associate with the token. Persona is a developer-provided stable identifier of the user. Must be deterministically generated (e.g. as a one-way hash) from the user account ID and user profile ID (if the app has the concept), according to the developer's own user identity system.

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

    Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application. See https://developer.android.com/games/pgs/recall/recall-setup on how to integrate with Recall and get session ID.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



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

def generate_accesstoken_recall_play_grouping_api_token(package_name: nil, persona: nil, recall_session_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/accesstokens/generateRecallPlayGroupingApiToken', options)
  command.response_representation = Google::Apis::GamesV1::GenerateRecallPlayGroupingApiTokenResponse::Representation
  command.response_class = Google::Apis::GamesV1::GenerateRecallPlayGroupingApiTokenResponse
  command.query['packageName'] = package_name unless package_name.nil?
  command.query['persona'] = persona unless persona.nil?
  command.query['recallSessionId'] = recall_session_id unless recall_session_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_application(application_id, language: nil, platform_type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Application

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

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

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

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

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

    Restrict application details returned to the specific platform.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/google/apis/games_v1/service.rb', line 412

def get_application(application_id, language: nil, platform_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/applications/{applicationId}', options)
  command.response_representation = Google::Apis::GamesV1::Application::Representation
  command.response_class = Google::Apis::GamesV1::Application
  command.params['applicationId'] = application_id unless application_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['platformType'] = platform_type unless platform_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_application_end_point(application_id: nil, end_point_type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::EndPoint

Returns a URL for the requested end point type.

Parameters:

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

    The application ID from the Google Play developer console.

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

    Type of endpoint being requested.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



446
447
448
449
450
451
452
453
454
455
 
# File 'lib/google/apis/games_v1/service.rb', line 446

def get_application_end_point(application_id: nil, end_point_type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/applications/getEndPoint', options)
  command.response_representation = Google::Apis::GamesV1::EndPoint::Representation
  command.response_class = Google::Apis::GamesV1::EndPoint
  command.query['applicationId'] = application_id unless application_id.nil?
  command.query['endPointType'] = end_point_type unless end_point_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves the metadata of the leaderboard with the given ID.

Parameters:

  • leaderboard_id (String) —

    The ID of the leaderboard.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



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

def get_leaderboard(leaderboard_id, language: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/leaderboards/{leaderboardId}', options)
  command.response_representation = Google::Apis::GamesV1::Leaderboard::Representation
  command.response_class = Google::Apis::GamesV1::Leaderboard
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Return the metagame configuration data for the calling application.

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



713
714
715
716
717
718
719
720
 
# File 'lib/google/apis/games_v1/service.rb', line 713

def get_metagame_config(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/metagameConfig', options)
  command.response_representation = Google::Apis::GamesV1::MetagameConfig::Representation
  command.response_class = Google::Apis::GamesV1::MetagameConfig
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_player(player_id, language: nil, player_id_consistency_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::Player

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

Parameters:

  • player_id (String) —

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

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

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

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

    Consistency token of the player id. The call returns a 'not found' result when the token is present and invalid. Empty value is ignored. See also GlobalPlayerIdConsistencyTokenProto

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/google/apis/games_v1/service.rb', line 796

def get_player(player_id, language: nil, player_id_consistency_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/players/{playerId}', options)
  command.response_representation = Google::Apis::GamesV1::Player::Representation
  command.response_class = Google::Apis::GamesV1::Player
  command.params['playerId'] = player_id unless player_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['playerIdConsistencyToken'] = player_id_consistency_token unless player_id_consistency_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_player_multiple_application_player_ids(application_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::GetMultipleApplicationPlayerIdsResponse

Get the application player ids for the currently authenticated player across all requested games by the same developer as the calling application. This will only return ids for players that actually have an id (scoped or otherwise) with that game.

Parameters:

  • application_ids (Array<String>, String) (defaults to: nil) —

    Required. The application IDs from the Google Play developer console for the games to return scoped ids for.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



832
833
834
835
836
837
838
839
840
 
# File 'lib/google/apis/games_v1/service.rb', line 832

def get_player_multiple_application_player_ids(application_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/players/me/multipleApplicationPlayerIds', options)
  command.response_representation = Google::Apis::GamesV1::GetMultipleApplicationPlayerIdsResponse::Representation
  command.response_class = Google::Apis::GamesV1::GetMultipleApplicationPlayerIdsResponse
  command.query['applicationIds'] = application_ids unless application_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_player_scoped_player_ids(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ScopedPlayerIds

Retrieves scoped player identifiers for currently authenticated user.

Parameters:

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



860
861
862
863
864
865
866
867
 
# File 'lib/google/apis/games_v1/service.rb', line 860

def get_player_scoped_player_ids(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/players/me/scopedIds', options)
  command.response_representation = Google::Apis::GamesV1::ScopedPlayerIds::Representation
  command.response_class = Google::Apis::GamesV1::ScopedPlayerIds
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_score(player_id, leaderboard_id, time_span, include_rank_type: nil, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse

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

Parameters:

  • player_id (String) —

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

  • leaderboard_id (String) —

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

  • time_span (String) —

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

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

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

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

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

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
 
# File 'lib/google/apis/games_v1/service.rb', line 1181

def get_score(player_id, leaderboard_id, time_span, include_rank_type: nil, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}', options)
  command.response_representation = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse
  command.params['playerId'] = player_id unless player_id.nil?
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.params['timeSpan'] = time_span unless time_span.nil?
  command.query['includeRankType'] = include_rank_type unless include_rank_type.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Retrieves the metadata for a given snapshot ID.

Parameters:

  • snapshot_id (String) —

    The ID of the snapshot.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'lib/google/apis/games_v1/service.rb', line 1401

def get_snapshot(snapshot_id, language: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/snapshots/{snapshotId}', options)
  command.response_representation = Google::Apis::GamesV1::Snapshot::Representation
  command.response_class = Google::Apis::GamesV1::Snapshot
  command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_stat(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::StatsResponse

Returns engagement and spend statistics in this application for the currently authenticated user.

Parameters:

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



1474
1475
1476
1477
1478
1479
1480
1481
 
# File 'lib/google/apis/games_v1/service.rb', line 1474

def get_stat(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/stats', options)
  command.response_representation = Google::Apis::GamesV1::StatsResponse::Representation
  command.response_class = Google::Apis::GamesV1::StatsResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#increment_achievement(achievement_id, steps_to_increment, request_id: nil, fields: nil, quota_user: 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) —

    Required. The number of steps to increment.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/google/apis/games_v1/service.rb', line 200

def increment_achievement(achievement_id, steps_to_increment, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/increment', options)
  command.response_representation = Google::Apis::GamesV1::AchievementIncrementResponse::Representation
  command.response_class = Google::Apis::GamesV1::AchievementIncrementResponse
  command.params['achievementId'] = achievement_id unless achievement_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['stepsToIncrement'] = steps_to_increment unless steps_to_increment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#last_recall_token_from_all_developer_games(session_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::RetrieveDeveloperGamesLastPlayerTokenResponse

Retrieve the last Recall token from all developer games that is associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

Parameters:

  • session_id (String) —

    Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



970
971
972
973
974
975
976
977
978
 
# File 'lib/google/apis/games_v1/service.rb', line 970

def last_recall_token_from_all_developer_games(session_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/recall/developerGamesLastPlayerToken/{sessionId}', options)
  command.response_representation = Google::Apis::GamesV1::RetrieveDeveloperGamesLastPlayerTokenResponse::Representation
  command.response_class = Google::Apis::GamesV1::RetrieveDeveloperGamesLastPlayerTokenResponse
  command.params['sessionId'] = session_id unless session_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#link_recall_persona(link_persona_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::LinkPersonaResponse

Associate the PGS Player principal encoded in the provided recall session id with an in-game account

Parameters:

  • link_persona_request_object (Google::Apis::GamesV1::LinkPersonaRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/google/apis/games_v1/service.rb', line 1000

def link_recall_persona(link_persona_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/recall:linkPersona', options)
  command.request_representation = Google::Apis::GamesV1::LinkPersonaRequest::Representation
  command.request_object = link_persona_request_object
  command.response_representation = Google::Apis::GamesV1::LinkPersonaResponse::Representation
  command.response_class = Google::Apis::GamesV1::LinkPersonaResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_achievement_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListAchievementDefinitionsResponse

Lists all the achievement definitions for your application.

Parameters:

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

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

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/google/apis/games_v1/service.rb', line 161

def list_achievement_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/achievements', options)
  command.response_representation = Google::Apis::GamesV1::ListAchievementDefinitionsResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListAchievementDefinitionsResponse
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_achievements(player_id, language: nil, max_results: nil, page_token: nil, state: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListPlayerAchievementResponse

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

Parameters:

  • player_id (String) —

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

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

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

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

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

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

    The token returned by the previous request.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/google/apis/games_v1/service.rb', line 245

def list_achievements(player_id, language: nil, max_results: nil, page_token: nil, state: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/players/{playerId}/achievements', options)
  command.response_representation = Google::Apis::GamesV1::ListPlayerAchievementResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerAchievementResponse
  command.params['playerId'] = player_id unless player_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['state'] = state unless state.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_event_by_player(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListPlayerEventResponse

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

Parameters:

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

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

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/google/apis/games_v1/service.rb', line 540

def list_event_by_player(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/events', options)
  command.response_representation = Google::Apis::GamesV1::ListPlayerEventResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerEventResponse
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_event_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListEventDefinitionResponse

Returns a list of the event definitions in this application.

Parameters:

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

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

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/google/apis/games_v1/service.rb', line 578

def list_event_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/eventDefinitions', options)
  command.response_representation = Google::Apis::GamesV1::ListEventDefinitionResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListEventDefinitionResponse
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_leaderboards(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListLeaderboardResponse

Lists all the leaderboard metadata for your application.

Parameters:

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

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

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/google/apis/games_v1/service.rb', line 683

def list_leaderboards(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/leaderboards', options)
  command.response_representation = Google::Apis::GamesV1::ListLeaderboardResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListLeaderboardResponse
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_metagame_categories_by_player(player_id, collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListCategoryResponse

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

Parameters:

  • player_id (String) —

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

  • collection (String) —

    The collection of categories for which data will be returned.

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

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

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/google/apis/games_v1/service.rb', line 754

def list_metagame_categories_by_player(player_id, collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/players/{playerId}/categories/{collection}', options)
  command.response_representation = Google::Apis::GamesV1::ListCategoryResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListCategoryResponse
  command.params['playerId'] = player_id unless player_id.nil?
  command.params['collection'] = collection unless collection.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_players(collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListPlayerResponse

Get the collection of players for the currently authenticated user.

Parameters:

  • collection (String) —

    Collection of players being retrieved

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

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

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'lib/google/apis/games_v1/service.rb', line 897

def list_players(collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/players/me/players/{collection}', options)
  command.response_representation = Google::Apis::GamesV1::ListPlayerResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerResponse
  command.params['collection'] = collection unless collection.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_score_window(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, results_above: nil, return_top_if_absent: nil, fields: nil, quota_user: nil, 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) —

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

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

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

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

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

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

    The token returned by the previous request.

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



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

def list_score_window(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, results_above: nil, return_top_if_absent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/leaderboards/{leaderboardId}/window/{collection}', options)
  command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation
  command.response_class = Google::Apis::GamesV1::LeaderboardScores
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.params['collection'] = collection unless collection.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['resultsAbove'] = results_above unless results_above.nil?
  command.query['returnTopIfAbsent'] = return_top_if_absent unless return_top_if_absent.nil?
  command.query['timeSpan'] = time_span unless time_span.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_scores(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, 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) —

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

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

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

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
 
# File 'lib/google/apis/games_v1/service.rb', line 1229

def list_scores(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/leaderboards/{leaderboardId}/scores/{collection}', options)
  command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation
  command.response_class = Google::Apis::GamesV1::LeaderboardScores
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.params['collection'] = collection unless collection.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['timeSpan'] = time_span unless time_span.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_snapshots(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ListSnapshotResponse

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

Parameters:

  • player_id (String) —

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

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

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

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

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

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

    The token returned by the previous request.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
 
# File 'lib/google/apis/games_v1/service.rb', line 1442

def list_snapshots(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/players/{playerId}/snapshots', options)
  command.response_representation = Google::Apis::GamesV1::ListSnapshotResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListSnapshotResponse
  command.params['playerId'] = player_id unless player_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Indicate that the currently authenticated user is playing your application.

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

    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.

  • 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



475
476
477
478
479
480
 
# File 'lib/google/apis/games_v1/service.rb', line 475

def played_application(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/applications/played', options)
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



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

def record_event(event_record_request_object = nil, language: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/events', options)
  command.request_representation = Google::Apis::GamesV1::EventRecordRequest::Representation
  command.request_object = event_record_request_object
  command.response_representation = Google::Apis::GamesV1::UpdateEventResponse::Representation
  command.response_class = Google::Apis::GamesV1::UpdateEventResponse
  command.query['language'] = language unless language.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reset_recall_persona(reset_persona_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::ResetPersonaResponse

Delete all Recall tokens linking the given persona to any player (with or without a profile).

Parameters:

  • reset_persona_request_object (Google::Apis::GamesV1::ResetPersonaRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



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

def reset_recall_persona(reset_persona_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/recall:resetPersona', options)
  command.request_representation = Google::Apis::GamesV1::ResetPersonaRequest::Representation
  command.request_object = reset_persona_request_object
  command.response_representation = Google::Apis::GamesV1::ResetPersonaResponse::Representation
  command.response_class = Google::Apis::GamesV1::ResetPersonaResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#retrieve_recall_tokens(session_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::RetrievePlayerTokensResponse

Retrieve all Recall tokens associated with the PGS Player encoded in the provided recall session id. The API is only available for users that have active PGS Player profile.

Parameters:

  • session_id (String) —

    Required. Opaque server-generated string that encodes all the necessary information to identify the PGS player / Google user and application.

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# File 'lib/google/apis/games_v1/service.rb', line 1065

def retrieve_recall_tokens(session_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/recall/tokens/{sessionId}', options)
  command.response_representation = Google::Apis::GamesV1::RetrievePlayerTokensResponse::Representation
  command.response_class = Google::Apis::GamesV1::RetrievePlayerTokensResponse
  command.params['sessionId'] = session_id unless session_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • achievement_id (String) —

    The ID of the achievement used by this method.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



280
281
282
283
284
285
286
287
288
 
# File 'lib/google/apis/games_v1/service.rb', line 280

def reveal_achievement(achievement_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/reveal', options)
  command.response_representation = Google::Apis::GamesV1::AchievementRevealResponse::Representation
  command.response_class = Google::Apis::GamesV1::AchievementRevealResponse
  command.params['achievementId'] = achievement_id unless achievement_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_achievement_steps_at_least(achievement_id, steps, fields: nil, quota_user: 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) —

    Required. The minimum value to set the steps to.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



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

def set_achievement_steps_at_least(achievement_id, steps, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/setStepsAtLeast', options)
  command.response_representation = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse::Representation
  command.response_class = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse
  command.params['achievementId'] = achievement_id unless achievement_id.nil?
  command.query['steps'] = steps unless steps.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Submits a score to the specified leaderboard.

Parameters:

  • leaderboard_id (String) —

    The ID of the leaderboard.

  • score (Fixnum) —

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'lib/google/apis/games_v1/service.rb', line 1333

def submit_score(leaderboard_id, score, language: nil, score_tag: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/leaderboards/{leaderboardId}/scores', options)
  command.response_representation = Google::Apis::GamesV1::PlayerScoreResponse::Representation
  command.response_class = Google::Apis::GamesV1::PlayerScoreResponse
  command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil?
  command.query['language'] = language unless language.nil?
  command.query['score'] = score unless score.nil?
  command.query['scoreTag'] = score_tag unless score_tag.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Submits multiple scores to leaderboards.

Parameters:

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/google/apis/games_v1/service.rb', line 1367

def submit_score_multiple(player_score_submission_list_object = nil, language: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/leaderboards/scores', options)
  command.request_representation = Google::Apis::GamesV1::PlayerScoreSubmissionList::Representation
  command.request_object = player_score_submission_list_object
  command.response_representation = Google::Apis::GamesV1::ListPlayerScoreResponse::Representation
  command.response_class = Google::Apis::GamesV1::ListPlayerScoreResponse
  command.query['language'] = language unless language.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unlink_recall_persona(unlink_persona_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::UnlinkPersonaResponse

Delete a Recall token linking the PGS Player principal identified by the Recall session and an in-game account identified either by the 'persona' or by the token value.

Parameters:

  • unlink_persona_request_object (Google::Apis::GamesV1::UnlinkPersonaRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



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

def unlink_recall_persona(unlink_persona_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/recall:unlinkPersona', options)
  command.request_representation = Google::Apis::GamesV1::UnlinkPersonaRequest::Representation
  command.request_object = unlink_persona_request_object
  command.response_representation = Google::Apis::GamesV1::UnlinkPersonaResponse::Representation
  command.response_class = Google::Apis::GamesV1::UnlinkPersonaResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Unlocks this achievement for the currently authenticated player.

Parameters:

  • achievement_id (String) —

    The ID of the achievement used by this method.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



346
347
348
349
350
351
352
353
354
 
# File 'lib/google/apis/games_v1/service.rb', line 346

def unlock_achievement(achievement_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/unlock', options)
  command.response_representation = Google::Apis::GamesV1::AchievementUnlockResponse::Representation
  command.response_class = Google::Apis::GamesV1::AchievementUnlockResponse
  command.params['achievementId'] = achievement_id unless achievement_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_multiple_achievements(achievement_update_multiple_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::GamesV1::AchievementUpdateMultipleResponse

Updates multiple achievements for the currently authenticated player.

Parameters:

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



375
376
377
378
379
380
381
382
383
384
 
# File 'lib/google/apis/games_v1/service.rb', line 375

def update_multiple_achievements(achievement_update_multiple_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'games/v1/achievements/updateMultiple', options)
  command.request_representation = Google::Apis::GamesV1::AchievementUpdateMultipleRequest::Representation
  command.request_object = achievement_update_multiple_request_object
  command.response_representation = Google::Apis::GamesV1::AchievementUpdateMultipleResponse::Representation
  command.response_class = Google::Apis::GamesV1::AchievementUpdateMultipleResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • application_id (String) —

    The application ID from the Google Play developer console.

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

    Selector specifying which fields to include in a partial response.

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

    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.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

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



503
504
505
506
507
508
509
510
511
 
# File 'lib/google/apis/games_v1/service.rb', line 503

def verify_application(application_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'games/v1/applications/{applicationId}/verify', options)
  command.response_representation = Google::Apis::GamesV1::ApplicationVerifyResponse::Representation
  command.response_class = Google::Apis::GamesV1::ApplicationVerifyResponse
  command.params['applicationId'] = application_id unless application_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end