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

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

Overview

This is a JSON template for a Player resource.

Defined Under Namespace

Classes: Name

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Player

Returns a new instance of Player.



2056
2057
2058
 
# File 'generated/google/apis/games_v1/classes.rb', line 2056

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) 


1988
1989
1990
 
# File 'generated/google/apis/games_v1/classes.rb', line 1988

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) 


1993
1994
1995
 
# File 'generated/google/apis/games_v1/classes.rb', line 1993

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) 


1998
1999
2000
 
# File 'generated/google/apis/games_v1/classes.rb', line 1998

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) 


2003
2004
2005
 
# File 'generated/google/apis/games_v1/classes.rb', line 2003

def display_name
  @display_name
end

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

This is a JSON template for 1P/3P metadata about the player's experience. Corresponds to the JSON property experienceInfo

Returns:



2008
2009
2010
 
# File 'generated/google/apis/games_v1/classes.rb', line 2008

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


2014
2015
2016
 
# File 'generated/google/apis/games_v1/classes.rb', line 2014

def kind
  @kind
end

#last_played_with ⇒ Google::Apis::GamesV1::Played

This is a JSON template for metadata about a player playing a game with the currently authenticated user. Corresponds to the JSON property lastPlayedWith

Returns:



2020
2021
2022
 
# File 'generated/google/apis/games_v1/classes.rb', line 2020

def last_played_with
  @last_played_with
end

#name ⇒ Google::Apis::GamesV1::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:



2026
2027
2028
 
# File 'generated/google/apis/games_v1/classes.rb', line 2026

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) 


2034
2035
2036
 
# File 'generated/google/apis/games_v1/classes.rb', line 2034

def original_player_id
  @original_player_id
end

#player_id ⇒ String

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

Returns:

  • (String) 


2039
2040
2041
 
# File 'generated/google/apis/games_v1/classes.rb', line 2039

def player_id
  @player_id
end

#player_stattus ⇒ String

Corresponds to the JSON property playerStattus

Returns:

  • (String) 


2044
2045
2046
 
# File 'generated/google/apis/games_v1/classes.rb', line 2044

def player_stattus
  @player_stattus
end

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

This is a JSON template for profile settings Corresponds to the JSON property profileSettings

Returns:



2049
2050
2051
 
# File 'generated/google/apis/games_v1/classes.rb', line 2049

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) 


2054
2055
2056
 
# File 'generated/google/apis/games_v1/classes.rb', line 2054

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
 
# File 'generated/google/apis/games_v1/classes.rb', line 2061

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)
  @last_played_with = args[:last_played_with] if args.key?(:last_played_with)
  @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)
  @player_stattus = args[:player_stattus] if args.key?(:player_stattus)
  @profile_settings = args[:profile_settings] if args.key?(:profile_settings)
  @title = args[:title] if args.key?(:title)
end