Class: Google::Apis::PeopleV1::Person

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

Overview

Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with metadata.primary set to true.

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



669
670
671
 
# File 'generated/google/apis/people_v1/classes.rb', line 669

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

Instance Attribute Details

#addresses ⇒ Array<Google::Apis::PeopleV1::Address>

The person's street addresses. Corresponds to the JSON property addresses

Returns:



617
618
619
 
# File 'generated/google/apis/people_v1/classes.rb', line 617

def addresses
  @addresses
end

#age_range ⇒ String

DEPRECATED (Please use person.ageRanges instead)** The person's read-only age range. Corresponds to the JSON property ageRange

Returns:

  • (String) 


602
603
604
 
# File 'generated/google/apis/people_v1/classes.rb', line 602

def age_range
  @age_range
end

#age_ranges ⇒ Array<Google::Apis::PeopleV1::AgeRangeType>

The person's read-only age ranges. Corresponds to the JSON property ageRanges

Returns:



612
613
614
 
# File 'generated/google/apis/people_v1/classes.rb', line 612

def age_ranges
  @age_ranges
end

#biographies ⇒ Array<Google::Apis::PeopleV1::Biography>

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

Returns:



581
582
583
 
# File 'generated/google/apis/people_v1/classes.rb', line 581

def biographies
  @biographies
end

#birthdays ⇒ Array<Google::Apis::PeopleV1::Birthday>

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

Returns:



647
648
649
 
# File 'generated/google/apis/people_v1/classes.rb', line 647

def birthdays
  @birthdays
end

#bragging_rights ⇒ Array<Google::Apis::PeopleV1::BraggingRights>

The person's bragging rights. Corresponds to the JSON property braggingRights

Returns:



550
551
552
 
# File 'generated/google/apis/people_v1/classes.rb', line 550

def bragging_rights
  @bragging_rights
end

#cover_photos ⇒ Array<Google::Apis::PeopleV1::CoverPhoto>

The person's read-only cover photos. Corresponds to the JSON property coverPhotos

Returns:



637
638
639
 
# File 'generated/google/apis/people_v1/classes.rb', line 637

def cover_photos
  @cover_photos
end

#email_addresses ⇒ Array<Google::Apis::PeopleV1::EmailAddress>

The person's email addresses. Corresponds to the JSON property emailAddresses

Returns:



534
535
536
 
# File 'generated/google/apis/people_v1/classes.rb', line 534

def email_addresses
  @email_addresses
end

#etag ⇒ String

The HTTP entity tag of the resource. Used for web cache validation. Corresponds to the JSON property etag

Returns:

  • (String) 


545
546
547
 
# File 'generated/google/apis/people_v1/classes.rb', line 545

def etag
  @etag
end

#events ⇒ Array<Google::Apis::PeopleV1::Event>

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

Returns:



622
623
624
 
# File 'generated/google/apis/people_v1/classes.rb', line 622

def events
  @events
end

#genders ⇒ Array<Google::Apis::PeopleV1::Gender>

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

Returns:



565
566
567
 
# File 'generated/google/apis/people_v1/classes.rb', line 565

def genders
  @genders
end

#im_clients ⇒ Array<Google::Apis::PeopleV1::ImClient>

The person's instant messaging clients. Corresponds to the JSON property imClients

Returns:



642
643
644
 
# File 'generated/google/apis/people_v1/classes.rb', line 642

def im_clients
  @im_clients
end

#interests ⇒ Array<Google::Apis::PeopleV1::Interest>

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

Returns:



570
571
572
 
# File 'generated/google/apis/people_v1/classes.rb', line 570

def interests
  @interests
end

#locales ⇒ Array<Google::Apis::PeopleV1::Locale>

The person's locale preferences. Corresponds to the JSON property locales

Returns:



652
653
654
 
# File 'generated/google/apis/people_v1/classes.rb', line 652

def locales
  @locales
end

#memberships ⇒ Array<Google::Apis::PeopleV1::Membership>

The person's read-only group memberships. Corresponds to the JSON property memberships

Returns:



627
628
629
 
# File 'generated/google/apis/people_v1/classes.rb', line 627

def memberships
  @memberships
end

#metadata ⇒ Google::Apis::PeopleV1::PersonMetadata

The read-only metadata about a person. Corresponds to the JSON property metadata

Returns:



555
556
557
 
# File 'generated/google/apis/people_v1/classes.rb', line 555

def metadata
  @metadata
end

#names ⇒ Array<Google::Apis::PeopleV1::Name>

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

Returns:



519
520
521
 
# File 'generated/google/apis/people_v1/classes.rb', line 519

def names
  @names
end

#nicknames ⇒ Array<Google::Apis::PeopleV1::Nickname>

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

Returns:



667
668
669
 
# File 'generated/google/apis/people_v1/classes.rb', line 667

def nicknames
  @nicknames
end

#occupations ⇒ Array<Google::Apis::PeopleV1::Occupation>

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

Returns:



529
530
531
 
# File 'generated/google/apis/people_v1/classes.rb', line 529

def occupations
  @occupations
end

#organizations ⇒ Array<Google::Apis::PeopleV1::Organization>

The person's past or current organizations. Corresponds to the JSON property organizations

Returns:



539
540
541
 
# File 'generated/google/apis/people_v1/classes.rb', line 539

def organizations
  @organizations
end

#phone_numbers ⇒ Array<Google::Apis::PeopleV1::PhoneNumber>

The person's phone numbers. Corresponds to the JSON property phoneNumbers

Returns:



632
633
634
 
# File 'generated/google/apis/people_v1/classes.rb', line 632

def phone_numbers
  @phone_numbers
end

#photos ⇒ Array<Google::Apis::PeopleV1::Photo>

The person's read-only photos. Corresponds to the JSON property photos

Returns:



596
597
598
 
# File 'generated/google/apis/people_v1/classes.rb', line 596

def photos
  @photos
end

#relations ⇒ Array<Google::Apis::PeopleV1::Relation>

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

Returns:



524
525
526
 
# File 'generated/google/apis/people_v1/classes.rb', line 524

def relations
  @relations
end

#relationship_interests ⇒ Array<Google::Apis::PeopleV1::RelationshipInterest>

The person's read-only relationship interests. Corresponds to the JSON property relationshipInterests

Returns:



657
658
659
 
# File 'generated/google/apis/people_v1/classes.rb', line 657

def relationship_interests
  @relationship_interests
end

#relationship_statuses ⇒ Array<Google::Apis::PeopleV1::RelationshipStatus>

The person's read-only relationship statuses. Corresponds to the JSON property relationshipStatuses

Returns:



591
592
593
 
# File 'generated/google/apis/people_v1/classes.rb', line 591

def relationship_statuses
  @relationship_statuses
end

#residences ⇒ Array<Google::Apis::PeopleV1::Residence>

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

Returns:



560
561
562
 
# File 'generated/google/apis/people_v1/classes.rb', line 560

def residences
  @residences
end

#resource_name ⇒ String

The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters, in the form of people/<person_id>. Corresponds to the JSON property resourceName

Returns:

  • (String) 


576
577
578
 
# File 'generated/google/apis/people_v1/classes.rb', line 576

def resource_name
  @resource_name
end

#skills ⇒ Array<Google::Apis::PeopleV1::Skill>

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

Returns:



586
587
588
 
# File 'generated/google/apis/people_v1/classes.rb', line 586

def skills
  @skills
end

#taglines ⇒ Array<Google::Apis::PeopleV1::Tagline>

The person's read-only taglines. Corresponds to the JSON property taglines

Returns:



607
608
609
 
# File 'generated/google/apis/people_v1/classes.rb', line 607

def taglines
  @taglines
end

#urls ⇒ Array<Google::Apis::PeopleV1::Url>

The person's associated URLs. Corresponds to the JSON property urls

Returns:



662
663
664
 
# File 'generated/google/apis/people_v1/classes.rb', line 662

def urls
  @urls
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'generated/google/apis/people_v1/classes.rb', line 674

def update!(**args)
  @names = args[:names] if args.key?(:names)
  @relations = args[:relations] if args.key?(:relations)
  @occupations = args[:occupations] if args.key?(:occupations)
  @email_addresses = args[:email_addresses] if args.key?(:email_addresses)
  @organizations = args[:organizations] if args.key?(:organizations)
  @etag = args[:etag] if args.key?(:etag)
  @bragging_rights = args[:bragging_rights] if args.key?(:bragging_rights)
  @metadata = args[:metadata] if args.key?(:metadata)
  @residences = args[:residences] if args.key?(:residences)
  @genders = args[:genders] if args.key?(:genders)
  @interests = args[:interests] if args.key?(:interests)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @biographies = args[:biographies] if args.key?(:biographies)
  @skills = args[:skills] if args.key?(:skills)
  @relationship_statuses = args[:relationship_statuses] if args.key?(:relationship_statuses)
  @photos = args[:photos] if args.key?(:photos)
  @age_range = args[:age_range] if args.key?(:age_range)
  @taglines = args[:taglines] if args.key?(:taglines)
  @age_ranges = args[:age_ranges] if args.key?(:age_ranges)
  @addresses = args[:addresses] if args.key?(:addresses)
  @events = args[:events] if args.key?(:events)
  @memberships = args[:memberships] if args.key?(:memberships)
  @phone_numbers = args[:phone_numbers] if args.key?(:phone_numbers)
  @cover_photos = args[:cover_photos] if args.key?(:cover_photos)
  @im_clients = args[:im_clients] if args.key?(:im_clients)
  @birthdays = args[:birthdays] if args.key?(:birthdays)
  @locales = args[:locales] if args.key?(:locales)
  @relationship_interests = args[:relationship_interests] if args.key?(:relationship_interests)
  @urls = args[:urls] if args.key?(:urls)
  @nicknames = args[:nicknames] if args.key?(:nicknames)
end