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.



2084
2085
2086
 
# File 'lib/google/apis/people_v1/classes.rb', line 2084

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:



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

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) 


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

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:



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

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:



1907
1908
1909
 
# File 'lib/google/apis/people_v1/classes.rb', line 1907

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:



1912
1913
1914
 
# File 'lib/google/apis/people_v1/classes.rb', line 1912

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:



1917
1918
1919
 
# File 'lib/google/apis/people_v1/classes.rb', line 1917

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:



1922
1923
1924
 
# File 'lib/google/apis/people_v1/classes.rb', line 1922

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:



1927
1928
1929
 
# File 'lib/google/apis/people_v1/classes.rb', line 1927

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:



1932
1933
1934
 
# File 'lib/google/apis/people_v1/classes.rb', line 1932

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:



1937
1938
1939
 
# File 'lib/google/apis/people_v1/classes.rb', line 1937

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) 


1943
1944
1945
 
# File 'lib/google/apis/people_v1/classes.rb', line 1943

def etag
  @etag
end

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

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

Returns:



1948
1949
1950
 
# File 'lib/google/apis/people_v1/classes.rb', line 1948

def events
  @events
end

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

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

Returns:



1953
1954
1955
 
# File 'lib/google/apis/people_v1/classes.rb', line 1953

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:



1958
1959
1960
 
# File 'lib/google/apis/people_v1/classes.rb', line 1958

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:



1963
1964
1965
 
# File 'lib/google/apis/people_v1/classes.rb', line 1963

def genders
  @genders
end

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

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

Returns:



1968
1969
1970
 
# File 'lib/google/apis/people_v1/classes.rb', line 1968

def im_clients
  @im_clients
end

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

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

Returns:



1973
1974
1975
 
# File 'lib/google/apis/people_v1/classes.rb', line 1973

def interests
  @interests
end

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

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

Returns:



1978
1979
1980
 
# File 'lib/google/apis/people_v1/classes.rb', line 1978

def locales
  @locales
end

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

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

Returns:



1983
1984
1985
 
# File 'lib/google/apis/people_v1/classes.rb', line 1983

def locations
  @locations
end

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

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

Returns:



1988
1989
1990
 
# File 'lib/google/apis/people_v1/classes.rb', line 1988

def memberships
  @memberships
end

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

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

Returns:



1993
1994
1995
 
# File 'lib/google/apis/people_v1/classes.rb', line 1993

def metadata
  @metadata
end

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

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

Returns:



1998
1999
2000
 
# File 'lib/google/apis/people_v1/classes.rb', line 1998

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:



2003
2004
2005
 
# File 'lib/google/apis/people_v1/classes.rb', line 2003

def names
  @names
end

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

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

Returns:



2008
2009
2010
 
# File 'lib/google/apis/people_v1/classes.rb', line 2008

def nicknames
  @nicknames
end

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

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

Returns:



2013
2014
2015
 
# File 'lib/google/apis/people_v1/classes.rb', line 2013

def occupations
  @occupations
end

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

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

Returns:



2018
2019
2020
 
# File 'lib/google/apis/people_v1/classes.rb', line 2018

def organizations
  @organizations
end

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

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

Returns:



2023
2024
2025
 
# File 'lib/google/apis/people_v1/classes.rb', line 2023

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:



2028
2029
2030
 
# File 'lib/google/apis/people_v1/classes.rb', line 2028

def photos
  @photos
end

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

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

Returns:



2033
2034
2035
 
# File 'lib/google/apis/people_v1/classes.rb', line 2033

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:



2039
2040
2041
 
# File 'lib/google/apis/people_v1/classes.rb', line 2039

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:



2045
2046
2047
 
# File 'lib/google/apis/people_v1/classes.rb', line 2045

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:



2051
2052
2053
 
# File 'lib/google/apis/people_v1/classes.rb', line 2051

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) 


2057
2058
2059
 
# File 'lib/google/apis/people_v1/classes.rb', line 2057

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:



2062
2063
2064
 
# File 'lib/google/apis/people_v1/classes.rb', line 2062

def sip_addresses
  @sip_addresses
end

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

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

Returns:



2067
2068
2069
 
# File 'lib/google/apis/people_v1/classes.rb', line 2067

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:



2072
2073
2074
 
# File 'lib/google/apis/people_v1/classes.rb', line 2072

def taglines
  @taglines
end

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

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

Returns:



2077
2078
2079
 
# File 'lib/google/apis/people_v1/classes.rb', line 2077

def urls
  @urls
end

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

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

Returns:



2082
2083
2084
 
# File 'lib/google/apis/people_v1/classes.rb', line 2082

def user_defined
  @user_defined
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
 
# File 'lib/google/apis/people_v1/classes.rb', line 2089

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