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.



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

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) 


1621
1622
1623
 
# File 'lib/google/apis/games_v1/classes.rb', line 1621

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) 


1626
1627
1628
 
# File 'lib/google/apis/games_v1/classes.rb', line 1626

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) 


1631
1632
1633
 
# File 'lib/google/apis/games_v1/classes.rb', line 1631

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) 


1636
1637
1638
 
# File 'lib/google/apis/games_v1/classes.rb', line 1636

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:



1641
1642
1643
 
# File 'lib/google/apis/games_v1/classes.rb', line 1641

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) 


1647
1648
1649
 
# File 'lib/google/apis/games_v1/classes.rb', line 1647

def friend_status
  @friend_status
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) 


1653
1654
1655
 
# File 'lib/google/apis/games_v1/classes.rb', line 1653

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:



1658
1659
1660
 
# File 'lib/google/apis/games_v1/classes.rb', line 1658

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) 


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

def original_player_id
  @original_player_id
end

#player_id ⇒ String

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

Returns:

  • (String) 


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

def player_id
  @player_id
end

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

Profile settings Corresponds to the JSON property profileSettings

Returns:



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

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) 


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

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
 
# File 'lib/google/apis/games_v1/classes.rb', line 1688

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