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.



2117
2118
2119
 
# File 'lib/google/apis/people_v1/classes.rb', line 2117

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:



1920
1921
1922
 
# File 'lib/google/apis/people_v1/classes.rb', line 1920

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) 


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

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:



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

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:



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

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:



1941
1942
1943
 
# File 'lib/google/apis/people_v1/classes.rb', line 1941

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:



1946
1947
1948
 
# File 'lib/google/apis/people_v1/classes.rb', line 1946

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:



1951
1952
1953
 
# File 'lib/google/apis/people_v1/classes.rb', line 1951

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:



1956
1957
1958
 
# File 'lib/google/apis/people_v1/classes.rb', line 1956

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:



1961
1962
1963
 
# File 'lib/google/apis/people_v1/classes.rb', line 1961

def cover_photos
  @cover_photos
end

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

The person's email addresses. For people.connections.list and otherContacts. list the number of email addresses is limited to 100. If a Person has more email addresses the entire set can be obtained by calling GetPeople. Corresponds to the JSON property emailAddresses

Returns:



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

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) 


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

def etag
  @etag
end

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

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

Returns:



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

def events
  @events
end

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

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

Returns:



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

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:



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

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:



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

def genders
  @genders
end

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

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

Returns:



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

def im_clients
  @im_clients
end

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

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

Returns:



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

def interests
  @interests
end

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

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

Returns:



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

def locales
  @locales
end

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

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

Returns:



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

def locations
  @locations
end

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

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

Returns:



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

def memberships
  @memberships
end

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

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

Returns:



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

def metadata
  @metadata
end

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

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

Returns:



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

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:



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

def names
  @names
end

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

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

Returns:



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

def nicknames
  @nicknames
end

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

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

Returns:



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

def occupations
  @occupations
end

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

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

Returns:



2049
2050
2051
 
# File 'lib/google/apis/people_v1/classes.rb', line 2049

def organizations
  @organizations
end

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

The person's phone numbers. For people.connections.list and otherContacts. list the number of phone numbers is limited to 100. If a Person has more phone numbers the entire set can be obtained by calling GetPeople. Corresponds to the JSON property phoneNumbers

Returns:



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

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:



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

def photos
  @photos
end

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

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

Returns:



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

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:



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

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:



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

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:



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

def residences
  @residences
end

#resource_name ⇒ String

The resource name for the person, assigned by the server. An ASCII string in the form of people/person_id`. Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


2090
2091
2092
 
# File 'lib/google/apis/people_v1/classes.rb', line 2090

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:



2095
2096
2097
 
# File 'lib/google/apis/people_v1/classes.rb', line 2095

def sip_addresses
  @sip_addresses
end

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

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

Returns:



2100
2101
2102
 
# File 'lib/google/apis/people_v1/classes.rb', line 2100

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:



2105
2106
2107
 
# File 'lib/google/apis/people_v1/classes.rb', line 2105

def taglines
  @taglines
end

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

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

Returns:



2110
2111
2112
 
# File 'lib/google/apis/people_v1/classes.rb', line 2110

def urls
  @urls
end

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

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

Returns:



2115
2116
2117
 
# File 'lib/google/apis/people_v1/classes.rb', line 2115

def user_defined
  @user_defined
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
 
# File 'lib/google/apis/people_v1/classes.rb', line 2122

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