Class: Google::Apis::PlusV1::Person

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

Defined Under Namespace

Classes: AgeRange, Cover, Email, Image, Name, Organization, PlacesLived, Url

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) ⇒ Person

Returns a new instance of Person.



1562
1563
1564
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1562

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

Instance Attribute Details

#about_me ⇒ String

A short biography for this person. Corresponds to the JSON property aboutMe

Returns:

  • (String) 


1387
1388
1389
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1387

def about_me
  @about_me
end

#age_range ⇒ Google::Apis::PlusV1::Person::AgeRange

The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning. Corresponds to the JSON property ageRange

Returns:



1394
1395
1396
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1394

def age_range
  @age_range
end

#birthday ⇒ String

The person's date of birth, represented as YYYY-MM-DD. Corresponds to the JSON property birthday

Returns:

  • (String) 


1399
1400
1401
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1399

def birthday
  @birthday
end

#bragging_rights ⇒ String

The "bragging rights" line of this person. Corresponds to the JSON property braggingRights

Returns:

  • (String) 


1404
1405
1406
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1404

def bragging_rights
  @bragging_rights
end

#circled_by_count ⇒ Fixnum

For followers who are visible, the number of people who have added this person or page to a circle. Corresponds to the JSON property circledByCount

Returns:

  • (Fixnum) 


1410
1411
1412
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1410

def circled_by_count
  @circled_by_count
end

#cover ⇒ Google::Apis::PlusV1::Person::Cover

The cover photo content. Corresponds to the JSON property cover

Returns:



1415
1416
1417
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1415

def cover
  @cover
end

#current_location ⇒ String

(this field is not currently used) Corresponds to the JSON property currentLocation

Returns:

  • (String) 


1420
1421
1422
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1420

def current_location
  @current_location
end

#display_name ⇒ String

The name of this person, which is suitable for display. Corresponds to the JSON property displayName

Returns:

  • (String) 


1425
1426
1427
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1425

def display_name
  @display_name
end

#domain ⇒ String

The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name. Corresponds to the JSON property domain

Returns:

  • (String) 


1432
1433
1434
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1432

def domain
  @domain
end

#emails ⇒ Array<Google::Apis::PlusV1::Person::Email>

A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. Corresponds to the JSON property emails

Returns:



1441
1442
1443
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1441

def emails
  @emails
end

#etag ⇒ String

ETag of this response for caching purposes. Corresponds to the JSON property etag

Returns:

  • (String) 


1446
1447
1448
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1446

def etag
  @etag
end

#gender ⇒ String

The person's gender. Possible values include, but are not limited to, the following values:

  • "male" - Male gender.
  • "female" - Female gender.
  • "other" - Other. Corresponds to the JSON property gender

Returns:

  • (String) 


1455
1456
1457
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1455

def gender
  @gender
end

#id ⇒ String

The ID of this person. Corresponds to the JSON property id

Returns:

  • (String) 


1460
1461
1462
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1460

def id
  @id
end

#image ⇒ Google::Apis::PlusV1::Person::Image

The representation of the person's profile photo. Corresponds to the JSON property image

Returns:



1465
1466
1467
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1465

def image
  @image
end

#is_plus_user ⇒ Boolean Also known as: is_plus_user?

Whether this user has signed up for Google+. Corresponds to the JSON property isPlusUser

Returns:

  • (Boolean) 


1470
1471
1472
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1470

def is_plus_user
  @is_plus_user
end

#kind ⇒ String

Identifies this resource as a person. Value: "plus#person". Corresponds to the JSON property kind

Returns:

  • (String) 


1476
1477
1478
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1476

def kind
  @kind
end

#language ⇒ String

The user's preferred language for rendering. Corresponds to the JSON property language

Returns:

  • (String) 


1481
1482
1483
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1481

def language
  @language
end

#name ⇒ Google::Apis::PlusV1::Person::Name

An object representation of the individual components of a person's name. Corresponds to the JSON property name

Returns:



1486
1487
1488
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1486

def name
  @name
end

#nickname ⇒ String

The nickname of this person. Corresponds to the JSON property nickname

Returns:

  • (String) 


1491
1492
1493
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1491

def nickname
  @nickname
end

#object_type ⇒ String

Type of person within Google+. Possible values include, but are not limited to, the following values:

  • "person" - represents an actual person.
  • "page" - represents a page. Corresponds to the JSON property objectType

Returns:

  • (String) 


1499
1500
1501
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1499

def object_type
  @object_type
end

#occupation ⇒ String

The occupation of this person. Corresponds to the JSON property occupation

Returns:

  • (String) 


1504
1505
1506
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1504

def occupation
  @occupation
end

#organizations ⇒ Array<Google::Apis::PlusV1::Person::Organization>

A list of current or past organizations with which this person is associated. Corresponds to the JSON property organizations

Returns:



1509
1510
1511
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1509

def organizations
  @organizations
end

#places_lived ⇒ Array<Google::Apis::PlusV1::Person::PlacesLived>

A list of places where this person has lived. Corresponds to the JSON property placesLived

Returns:



1514
1515
1516
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1514

def places_lived
  @places_lived
end

#plus_one_count ⇒ Fixnum

If a Google+ Page, the number of people who have +1'd this page. Corresponds to the JSON property plusOneCount

Returns:

  • (Fixnum) 


1519
1520
1521
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1519

def plus_one_count
  @plus_one_count
end

#relationship_status ⇒ String

The person's relationship status. Possible values include, but are not limited to, the following values:

  • "single" - Person is single.
  • "in_a_relationship" - Person is in a relationship.
  • "engaged" - Person is engaged.
  • "married" - Person is married.
  • "its_complicated" - The relationship is complicated.
  • "open_relationship" - Person is in an open relationship.
  • "widowed" - Person is widowed.
  • "in_domestic_partnership" - Person is in a domestic partnership.
  • "in_civil_union" - Person is in a civil union. Corresponds to the JSON property relationshipStatus

Returns:

  • (String) 


1534
1535
1536
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1534

def relationship_status
  @relationship_status
end

#skills ⇒ String

The person's skills. Corresponds to the JSON property skills

Returns:

  • (String) 


1539
1540
1541
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1539

def skills
  @skills
end

#tagline ⇒ String

The brief description (tagline) of this person. Corresponds to the JSON property tagline

Returns:

  • (String) 


1544
1545
1546
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1544

def tagline
  @tagline
end

#url ⇒ String

The URL of this person's profile. Corresponds to the JSON property url

Returns:

  • (String) 


1549
1550
1551
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1549

def url
  @url
end

#urls ⇒ Array<Google::Apis::PlusV1::Person::Url>

A list of URLs for this person. Corresponds to the JSON property urls

Returns:



1554
1555
1556
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1554

def urls
  @urls
end

#verified ⇒ Boolean Also known as: verified?

Whether the person or Google+ Page has been verified. Corresponds to the JSON property verified

Returns:

  • (Boolean) 


1559
1560
1561
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1559

def verified
  @verified
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
 
# File 'generated/google/apis/plus_v1/classes.rb', line 1567

def update!(**args)
  @about_me = args[:about_me] if args.key?(:about_me)
  @age_range = args[:age_range] if args.key?(:age_range)
  @birthday = args[:birthday] if args.key?(:birthday)
  @bragging_rights = args[:bragging_rights] if args.key?(:bragging_rights)
  @circled_by_count = args[:circled_by_count] if args.key?(:circled_by_count)
  @cover = args[:cover] if args.key?(:cover)
  @current_location = args[:current_location] if args.key?(:current_location)
  @display_name = args[:display_name] if args.key?(:display_name)
  @domain = args[:domain] if args.key?(:domain)
  @emails = args[:emails] if args.key?(:emails)
  @etag = args[:etag] if args.key?(:etag)
  @gender = args[:gender] if args.key?(:gender)
  @id = args[:id] if args.key?(:id)
  @image = args[:image] if args.key?(:image)
  @is_plus_user = args[:is_plus_user] if args.key?(:is_plus_user)
  @kind = args[:kind] if args.key?(:kind)
  @language = args[:language] if args.key?(:language)
  @name = args[:name] if args.key?(:name)
  @nickname = args[:nickname] if args.key?(:nickname)
  @object_type = args[:object_type] if args.key?(:object_type)
  @occupation = args[:occupation] if args.key?(:occupation)
  @organizations = args[:organizations] if args.key?(:organizations)
  @places_lived = args[:places_lived] if args.key?(:places_lived)
  @plus_one_count = args[:plus_one_count] if args.key?(:plus_one_count)
  @relationship_status = args[:relationship_status] if args.key?(:relationship_status)
  @skills = args[:skills] if args.key?(:skills)
  @tagline = args[:tagline] if args.key?(:tagline)
  @url = args[:url] if args.key?(:url)
  @urls = args[:urls] if args.key?(:urls)
  @verified = args[:verified] if args.key?(:verified)
end