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

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

Constructor Details

#initialize(**args) ⇒ Person

Returns a new instance of Person.



1903
1904
1905
 
# File 'lib/google/apis/people_v1/classes.rb', line 1903

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:



1710
1711
1712
 
# File 'lib/google/apis/people_v1/classes.rb', line 1710

def addresses
  @addresses
end

#age_range ⇒ String

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

Returns:

  • (String) 


1716
1717
1718
 
# File 'lib/google/apis/people_v1/classes.rb', line 1716

def age_range
  @age_range
end

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

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

Returns:



1721
1722
1723
 
# File 'lib/google/apis/people_v1/classes.rb', line 1721

def age_ranges
  @age_ranges
end

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

The person's biographies. This field is a singleton for contact sources. Corresponds to the JSON property biographies

Returns:



1726
1727
1728
 
# File 'lib/google/apis/people_v1/classes.rb', line 1726

def biographies
  @biographies
end

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

The person's birthdays. This field is a singleton for contact sources. Corresponds to the JSON property birthdays

Returns:



1731
1732
1733
 
# File 'lib/google/apis/people_v1/classes.rb', line 1731

def birthdays
  @birthdays
end

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

DEPRECATED: No data will be returned The person's bragging rights. Corresponds to the JSON property braggingRights

Returns:



1736
1737
1738
 
# File 'lib/google/apis/people_v1/classes.rb', line 1736

def bragging_rights
  @bragging_rights
end

#calendar_urls ⇒ Array<Google::Apis::PeopleV1::CalendarUrl>

The person's calendar URLs. Corresponds to the JSON property calendarUrls

Returns:



1741
1742
1743
 
# File 'lib/google/apis/people_v1/classes.rb', line 1741

def calendar_urls
  @calendar_urls
end

#client_data ⇒ Array<Google::Apis::PeopleV1::ClientData>

The person's client data. Corresponds to the JSON property clientData

Returns:



1746
1747
1748
 
# File 'lib/google/apis/people_v1/classes.rb', line 1746

def client_data
  @client_data
end

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

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

Returns:



1751
1752
1753
 
# File 'lib/google/apis/people_v1/classes.rb', line 1751

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:



1756
1757
1758
 
# File 'lib/google/apis/people_v1/classes.rb', line 1756

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) 


1762
1763
1764
 
# File 'lib/google/apis/people_v1/classes.rb', line 1762

def etag
  @etag
end

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

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

Returns:



1767
1768
1769
 
# File 'lib/google/apis/people_v1/classes.rb', line 1767

def events
  @events
end

#external_ids ⇒ Array<Google::Apis::PeopleV1::ExternalId>

The person's external IDs. Corresponds to the JSON property externalIds

Returns:



1772
1773
1774
 
# File 'lib/google/apis/people_v1/classes.rb', line 1772

def external_ids
  @external_ids
end

#file_ases ⇒ Array<Google::Apis::PeopleV1::FileAs>

The person's file-ases. Corresponds to the JSON property fileAses

Returns:



1777
1778
1779
 
# File 'lib/google/apis/people_v1/classes.rb', line 1777

def file_ases
  @file_ases
end

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

The person's genders. This field is a singleton for contact sources. Corresponds to the JSON property genders

Returns:



1782
1783
1784
 
# File 'lib/google/apis/people_v1/classes.rb', line 1782

def genders
  @genders
end

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

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

Returns:



1787
1788
1789
 
# File 'lib/google/apis/people_v1/classes.rb', line 1787

def im_clients
  @im_clients
end

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

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

Returns:



1792
1793
1794
 
# File 'lib/google/apis/people_v1/classes.rb', line 1792

def interests
  @interests
end

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

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

Returns:



1797
1798
1799
 
# File 'lib/google/apis/people_v1/classes.rb', line 1797

def locales
  @locales
end

#locations ⇒ Array<Google::Apis::PeopleV1::Location>

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

Returns:



1802
1803
1804
 
# File 'lib/google/apis/people_v1/classes.rb', line 1802

def locations
  @locations
end

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

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

Returns:



1807
1808
1809
 
# File 'lib/google/apis/people_v1/classes.rb', line 1807

def memberships
  @memberships
end

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

The metadata about a person. Corresponds to the JSON property metadata

Returns:



1812
1813
1814
 
# File 'lib/google/apis/people_v1/classes.rb', line 1812

def metadata
  @metadata
end

#misc_keywords ⇒ Array<Google::Apis::PeopleV1::MiscKeyword>

The person's miscellaneous keywords. Corresponds to the JSON property miscKeywords

Returns:



1817
1818
1819
 
# File 'lib/google/apis/people_v1/classes.rb', line 1817

def misc_keywords
  @misc_keywords
end

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

The person's names. This field is a singleton for contact sources. Corresponds to the JSON property names

Returns:



1822
1823
1824
 
# File 'lib/google/apis/people_v1/classes.rb', line 1822

def names
  @names
end

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

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

Returns:



1827
1828
1829
 
# File 'lib/google/apis/people_v1/classes.rb', line 1827

def nicknames
  @nicknames
end

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

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

Returns:



1832
1833
1834
 
# File 'lib/google/apis/people_v1/classes.rb', line 1832

def occupations
  @occupations
end

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

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

Returns:



1837
1838
1839
 
# File 'lib/google/apis/people_v1/classes.rb', line 1837

def organizations
  @organizations
end

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

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

Returns:



1842
1843
1844
 
# File 'lib/google/apis/people_v1/classes.rb', line 1842

def phone_numbers
  @phone_numbers
end

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

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

Returns:



1847
1848
1849
 
# File 'lib/google/apis/people_v1/classes.rb', line 1847

def photos
  @photos
end

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

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

Returns:



1852
1853
1854
 
# File 'lib/google/apis/people_v1/classes.rb', line 1852

def relations
  @relations
end

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

Output only. DEPRECATED: No data will be returned The person's relationship interests. Corresponds to the JSON property relationshipInterests

Returns:



1858
1859
1860
 
# File 'lib/google/apis/people_v1/classes.rb', line 1858

def relationship_interests
  @relationship_interests
end

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

Output only. DEPRECATED: No data will be returned The person's relationship statuses. Corresponds to the JSON property relationshipStatuses

Returns:



1864
1865
1866
 
# File 'lib/google/apis/people_v1/classes.rb', line 1864

def relationship_statuses
  @relationship_statuses
end

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

DEPRECATED: (Please use person.locations instead) The person's residences. Corresponds to the JSON property residences

Returns:



1870
1871
1872
 
# File 'lib/google/apis/people_v1/classes.rb', line 1870

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 propertyresourceName`

Returns:

  • (String) 


1876
1877
1878
 
# File 'lib/google/apis/people_v1/classes.rb', line 1876

def resource_name
  @resource_name
end

#sip_addresses ⇒ Array<Google::Apis::PeopleV1::SipAddress>

The person's SIP addresses. Corresponds to the JSON property sipAddresses

Returns:



1881
1882
1883
 
# File 'lib/google/apis/people_v1/classes.rb', line 1881

def sip_addresses
  @sip_addresses
end

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

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

Returns:



1886
1887
1888
 
# File 'lib/google/apis/people_v1/classes.rb', line 1886

def skills
  @skills
end

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

Output only. DEPRECATED: No data will be returned The person's taglines. Corresponds to the JSON property taglines

Returns:



1891
1892
1893
 
# File 'lib/google/apis/people_v1/classes.rb', line 1891

def taglines
  @taglines
end

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

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

Returns:



1896
1897
1898
 
# File 'lib/google/apis/people_v1/classes.rb', line 1896

def urls
  @urls
end

#user_defined ⇒ Array<Google::Apis::PeopleV1::UserDefined>

The person's user defined data. Corresponds to the JSON property userDefined

Returns:



1901
1902
1903
 
# File 'lib/google/apis/people_v1/classes.rb', line 1901

def user_defined
  @user_defined
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
 
# File 'lib/google/apis/people_v1/classes.rb', line 1908

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