Class: Google::Apis::GamesV1::Player

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/games_v1/classes.rb,
lib/google/apis/games_v1/representations.rb,
lib/google/apis/games_v1/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.



1734
1735
1736
 
# File 'lib/google/apis/games_v1/classes.rb', line 1734

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) 


1667
1668
1669
 
# File 'lib/google/apis/games_v1/classes.rb', line 1667

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) 


1672
1673
1674
 
# File 'lib/google/apis/games_v1/classes.rb', line 1672

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) 


1677
1678
1679
 
# File 'lib/google/apis/games_v1/classes.rb', line 1677

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) 


1682
1683
1684
 
# File 'lib/google/apis/games_v1/classes.rb', line 1682

def display_name
  @display_name
end

#experience_info ⇒ Google::Apis::GamesV1::PlayerExperienceInfo

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

Returns:



1687
1688
1689
 
# File 'lib/google/apis/games_v1/classes.rb', line 1687

def experience_info
  @experience_info
end

#friend_status ⇒ String

The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. Corresponds to the JSON property friendStatus

Returns:

  • (String) 


1693
1694
1695
 
# File 'lib/google/apis/games_v1/classes.rb', line 1693

def friend_status
  @friend_status
end

#game_player_id ⇒ String

Per-application unique player identifier. Corresponds to the JSON property gamePlayerId

Returns:

  • (String) 


1698
1699
1700
 
# File 'lib/google/apis/games_v1/classes.rb', line 1698

def game_player_id
  @game_player_id
end

#kind ⇒ String

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

Returns:

  • (String) 


1704
1705
1706
 
# File 'lib/google/apis/games_v1/classes.rb', line 1704

def kind
  @kind
end

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

A representation of the individual components of the name. Corresponds to the JSON property name

Returns:



1709
1710
1711
 
# File 'lib/google/apis/games_v1/classes.rb', line 1709

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) 


1717
1718
1719
 
# File 'lib/google/apis/games_v1/classes.rb', line 1717

def original_player_id
  @original_player_id
end

#player_id ⇒ String

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

Returns:

  • (String) 


1722
1723
1724
 
# File 'lib/google/apis/games_v1/classes.rb', line 1722

def player_id
  @player_id
end

#profile_settings ⇒ Google::Apis::GamesV1::ProfileSettings

Profile settings Corresponds to the JSON property profileSettings

Returns:



1727
1728
1729
 
# File 'lib/google/apis/games_v1/classes.rb', line 1727

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) 


1732
1733
1734
 
# File 'lib/google/apis/games_v1/classes.rb', line 1732

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
 
# File 'lib/google/apis/games_v1/classes.rb', line 1739

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)
  @friend_status = args[:friend_status] if args.key?(:friend_status)
  @game_player_id = args[:game_player_id] if args.key?(:game_player_id)
  @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