Class: Google::Apis::GamesManagementV1management::Player

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/games_management_v1management/classes.rb,
generated/google/apis/games_management_v1management/representations.rb,
generated/google/apis/games_management_v1management/representations.rb

Overview

A Player resource.

Defined Under Namespace

Classes: Name

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Player

Returns a new instance of Player.



341
342
343
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 341

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#avatar_image_url ⇒ String

The base URL for the image that represents the player. Corresponds to the JSON property avatarImageUrl

Returns:

  • (String) 


284
285
286
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 284

def avatar_image_url
  @avatar_image_url
end

The url to the landscape mode player banner image. Corresponds to the JSON property bannerUrlLandscape

Returns:

  • (String) 


289
290
291
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 289

def banner_url_landscape
  @banner_url_landscape
end

The url to the portrait mode player banner image. Corresponds to the JSON property bannerUrlPortrait

Returns:

  • (String) 


294
295
296
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 294

def banner_url_portrait
  @banner_url_portrait
end

#display_name ⇒ String

The name to display for the player. Corresponds to the JSON property displayName

Returns:

  • (String) 


299
300
301
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 299

def display_name
  @display_name
end

#experience_info ⇒ Google::Apis::GamesManagementV1management::GamesPlayerExperienceInfoResource

1P/3P metadata about the player's experience. Corresponds to the JSON property experienceInfo

Returns:



304
305
306
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 304

def experience_info
  @experience_info
end

#kind ⇒ String

Uniquely identifies the type of this resource. Value is always the fixed string gamesManagement#player. Corresponds to the JSON property kind

Returns:

  • (String) 


310
311
312
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 310

def kind
  @kind
end

#name ⇒ Google::Apis::GamesManagementV1management::Player::Name

An object representation of the individual components of the player's name. For some players, these fields may not be present. Corresponds to the JSON property name

Returns:



316
317
318
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 316

def name
  @name
end

#original_player_id ⇒ String

The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. Corresponds to the JSON property originalPlayerId

Returns:

  • (String) 


324
325
326
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 324

def original_player_id
  @original_player_id
end

#player_id ⇒ String

The ID of the player. Corresponds to the JSON property playerId

Returns:

  • (String) 


329
330
331
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 329

def player_id
  @player_id
end

#profile_settings ⇒ Google::Apis::GamesManagementV1management::ProfileSettings

Profile settings Corresponds to the JSON property profileSettings

Returns:



334
335
336
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 334

def profile_settings
  @profile_settings
end

#title ⇒ String

The player's title rewarded for their game activities. Corresponds to the JSON property title

Returns:

  • (String) 


339
340
341
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 339

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'generated/google/apis/games_management_v1management/classes.rb', line 346

def update!(**args)
  @avatar_image_url = args[:avatar_image_url] if args.key?(:avatar_image_url)
  @banner_url_landscape = args[:banner_url_landscape] if args.key?(:banner_url_landscape)
  @banner_url_portrait = args[:banner_url_portrait] if args.key?(:banner_url_portrait)
  @display_name = args[:display_name] if args.key?(:display_name)
  @experience_info = args[:experience_info] if args.key?(:experience_info)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @original_player_id = args[:original_player_id] if args.key?(:original_player_id)
  @player_id = args[:player_id] if args.key?(:player_id)
  @profile_settings = args[:profile_settings] if args.key?(:profile_settings)
  @title = args[:title] if args.key?(:title)
end