Class: Google::Apis::PeopleV1::Person
- Inherits:
-
Object
- Object
- Google::Apis::PeopleV1::Person
- 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
-
#addresses ⇒ Array<Google::Apis::PeopleV1::Address>
The person's street addresses.
-
#age_range ⇒ String
Output only.
-
#age_ranges ⇒ Array<Google::Apis::PeopleV1::AgeRangeType>
Output only.
-
#biographies ⇒ Array<Google::Apis::PeopleV1::Biography>
The person's biographies.
-
#birthdays ⇒ Array<Google::Apis::PeopleV1::Birthday>
The person's birthdays.
-
#bragging_rights ⇒ Array<Google::Apis::PeopleV1::BraggingRights>
DEPRECATED: No data will be returned The person's bragging rights.
-
#calendar_urls ⇒ Array<Google::Apis::PeopleV1::CalendarUrl>
The person's calendar URLs.
-
#client_data ⇒ Array<Google::Apis::PeopleV1::ClientData>
The person's client data.
-
#cover_photos ⇒ Array<Google::Apis::PeopleV1::CoverPhoto>
Output only.
-
#email_addresses ⇒ Array<Google::Apis::PeopleV1::EmailAddress>
The person's email addresses.
-
#etag ⇒ String
The HTTP entity tag of the resource.
-
#events ⇒ Array<Google::Apis::PeopleV1::Event>
The person's events.
-
#external_ids ⇒ Array<Google::Apis::PeopleV1::ExternalId>
The person's external IDs.
-
#file_ases ⇒ Array<Google::Apis::PeopleV1::FileAs>
The person's file-ases.
-
#genders ⇒ Array<Google::Apis::PeopleV1::Gender>
The person's genders.
-
#im_clients ⇒ Array<Google::Apis::PeopleV1::ImClient>
The person's instant messaging clients.
-
#interests ⇒ Array<Google::Apis::PeopleV1::Interest>
The person's interests.
-
#locales ⇒ Array<Google::Apis::PeopleV1::Locale>
The person's locale preferences.
-
#locations ⇒ Array<Google::Apis::PeopleV1::Location>
The person's locations.
-
#memberships ⇒ Array<Google::Apis::PeopleV1::Membership>
The person's group memberships.
-
#metadata ⇒ Google::Apis::PeopleV1::PersonMetadata
The metadata about a person.
-
#misc_keywords ⇒ Array<Google::Apis::PeopleV1::MiscKeyword>
The person's miscellaneous keywords.
-
#names ⇒ Array<Google::Apis::PeopleV1::Name>
The person's names.
-
#nicknames ⇒ Array<Google::Apis::PeopleV1::Nickname>
The person's nicknames.
-
#occupations ⇒ Array<Google::Apis::PeopleV1::Occupation>
The person's occupations.
-
#organizations ⇒ Array<Google::Apis::PeopleV1::Organization>
The person's past or current organizations.
-
#phone_numbers ⇒ Array<Google::Apis::PeopleV1::PhoneNumber>
The person's phone numbers.
-
#photos ⇒ Array<Google::Apis::PeopleV1::Photo>
Output only.
-
#relations ⇒ Array<Google::Apis::PeopleV1::Relation>
The person's relations.
-
#relationship_interests ⇒ Array<Google::Apis::PeopleV1::RelationshipInterest>
Output only.
-
#relationship_statuses ⇒ Array<Google::Apis::PeopleV1::RelationshipStatus>
Output only.
-
#residences ⇒ Array<Google::Apis::PeopleV1::Residence>
DEPRECATED: (Please use
person.locations
instead) The person's residences. -
#resource_name ⇒ String
The resource name for the person, assigned by the server.
-
#sip_addresses ⇒ Array<Google::Apis::PeopleV1::SipAddress>
The person's SIP addresses.
-
#skills ⇒ Array<Google::Apis::PeopleV1::Skill>
The person's skills.
-
#taglines ⇒ Array<Google::Apis::PeopleV1::Tagline>
Output only.
-
#urls ⇒ Array<Google::Apis::PeopleV1::Url>
The person's associated URLs.
-
#user_defined ⇒ Array<Google::Apis::PeopleV1::UserDefined>
The person's user defined data.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Person
constructor
A new instance of Person.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Person
Returns a new instance of Person.
2078 2079 2080 |
# File 'lib/google/apis/people_v1/classes.rb', line 2078 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
1885 1886 1887 |
# File 'lib/google/apis/people_v1/classes.rb', line 1885 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
1891 1892 1893 |
# File 'lib/google/apis/people_v1/classes.rb', line 1891 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
1896 1897 1898 |
# File 'lib/google/apis/people_v1/classes.rb', line 1896 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
1901 1902 1903 |
# File 'lib/google/apis/people_v1/classes.rb', line 1901 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
1906 1907 1908 |
# File 'lib/google/apis/people_v1/classes.rb', line 1906 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
1911 1912 1913 |
# File 'lib/google/apis/people_v1/classes.rb', line 1911 def bragging_rights @bragging_rights end |
#calendar_urls ⇒ Array<Google::Apis::PeopleV1::CalendarUrl>
The person's calendar URLs.
Corresponds to the JSON property calendarUrls
1916 1917 1918 |
# File 'lib/google/apis/people_v1/classes.rb', line 1916 def calendar_urls @calendar_urls end |
#client_data ⇒ Array<Google::Apis::PeopleV1::ClientData>
The person's client data.
Corresponds to the JSON property clientData
1921 1922 1923 |
# File 'lib/google/apis/people_v1/classes.rb', line 1921 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
1926 1927 1928 |
# File 'lib/google/apis/people_v1/classes.rb', line 1926 def cover_photos @cover_photos end |
#email_addresses ⇒ Array<Google::Apis::PeopleV1::EmailAddress>
The person's email addresses.
Corresponds to the JSON property emailAddresses
1931 1932 1933 |
# File 'lib/google/apis/people_v1/classes.rb', line 1931 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
1937 1938 1939 |
# File 'lib/google/apis/people_v1/classes.rb', line 1937 def etag @etag end |
#events ⇒ Array<Google::Apis::PeopleV1::Event>
The person's events.
Corresponds to the JSON property events
1942 1943 1944 |
# File 'lib/google/apis/people_v1/classes.rb', line 1942 def events @events end |
#external_ids ⇒ Array<Google::Apis::PeopleV1::ExternalId>
The person's external IDs.
Corresponds to the JSON property externalIds
1947 1948 1949 |
# File 'lib/google/apis/people_v1/classes.rb', line 1947 def external_ids @external_ids end |
#file_ases ⇒ Array<Google::Apis::PeopleV1::FileAs>
The person's file-ases.
Corresponds to the JSON property fileAses
1952 1953 1954 |
# File 'lib/google/apis/people_v1/classes.rb', line 1952 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
1957 1958 1959 |
# File 'lib/google/apis/people_v1/classes.rb', line 1957 def genders @genders end |
#im_clients ⇒ Array<Google::Apis::PeopleV1::ImClient>
The person's instant messaging clients.
Corresponds to the JSON property imClients
1962 1963 1964 |
# File 'lib/google/apis/people_v1/classes.rb', line 1962 def im_clients @im_clients end |
#interests ⇒ Array<Google::Apis::PeopleV1::Interest>
The person's interests.
Corresponds to the JSON property interests
1967 1968 1969 |
# File 'lib/google/apis/people_v1/classes.rb', line 1967 def interests @interests end |
#locales ⇒ Array<Google::Apis::PeopleV1::Locale>
The person's locale preferences.
Corresponds to the JSON property locales
1972 1973 1974 |
# File 'lib/google/apis/people_v1/classes.rb', line 1972 def locales @locales end |
#locations ⇒ Array<Google::Apis::PeopleV1::Location>
The person's locations.
Corresponds to the JSON property locations
1977 1978 1979 |
# File 'lib/google/apis/people_v1/classes.rb', line 1977 def locations @locations end |
#memberships ⇒ Array<Google::Apis::PeopleV1::Membership>
The person's group memberships.
Corresponds to the JSON property memberships
1982 1983 1984 |
# File 'lib/google/apis/people_v1/classes.rb', line 1982 def memberships @memberships end |
#metadata ⇒ Google::Apis::PeopleV1::PersonMetadata
The metadata about a person.
Corresponds to the JSON property metadata
1987 1988 1989 |
# File 'lib/google/apis/people_v1/classes.rb', line 1987 def @metadata end |
#misc_keywords ⇒ Array<Google::Apis::PeopleV1::MiscKeyword>
The person's miscellaneous keywords.
Corresponds to the JSON property miscKeywords
1992 1993 1994 |
# File 'lib/google/apis/people_v1/classes.rb', line 1992 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
1997 1998 1999 |
# File 'lib/google/apis/people_v1/classes.rb', line 1997 def names @names end |
#nicknames ⇒ Array<Google::Apis::PeopleV1::Nickname>
The person's nicknames.
Corresponds to the JSON property nicknames
2002 2003 2004 |
# File 'lib/google/apis/people_v1/classes.rb', line 2002 def nicknames @nicknames end |
#occupations ⇒ Array<Google::Apis::PeopleV1::Occupation>
The person's occupations.
Corresponds to the JSON property occupations
2007 2008 2009 |
# File 'lib/google/apis/people_v1/classes.rb', line 2007 def occupations @occupations end |
#organizations ⇒ Array<Google::Apis::PeopleV1::Organization>
The person's past or current organizations.
Corresponds to the JSON property organizations
2012 2013 2014 |
# File 'lib/google/apis/people_v1/classes.rb', line 2012 def organizations @organizations end |
#phone_numbers ⇒ Array<Google::Apis::PeopleV1::PhoneNumber>
The person's phone numbers.
Corresponds to the JSON property phoneNumbers
2017 2018 2019 |
# File 'lib/google/apis/people_v1/classes.rb', line 2017 def phone_numbers @phone_numbers end |
#photos ⇒ Array<Google::Apis::PeopleV1::Photo>
Output only. The person's photos.
Corresponds to the JSON property photos
2022 2023 2024 |
# File 'lib/google/apis/people_v1/classes.rb', line 2022 def photos @photos end |
#relations ⇒ Array<Google::Apis::PeopleV1::Relation>
The person's relations.
Corresponds to the JSON property relations
2027 2028 2029 |
# File 'lib/google/apis/people_v1/classes.rb', line 2027 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
2033 2034 2035 |
# File 'lib/google/apis/people_v1/classes.rb', line 2033 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
2039 2040 2041 |
# File 'lib/google/apis/people_v1/classes.rb', line 2039 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
2045 2046 2047 |
# File 'lib/google/apis/people_v1/classes.rb', line 2045 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`
2051 2052 2053 |
# File 'lib/google/apis/people_v1/classes.rb', line 2051 def resource_name @resource_name end |
#sip_addresses ⇒ Array<Google::Apis::PeopleV1::SipAddress>
The person's SIP addresses.
Corresponds to the JSON property sipAddresses
2056 2057 2058 |
# File 'lib/google/apis/people_v1/classes.rb', line 2056 def sip_addresses @sip_addresses end |
#skills ⇒ Array<Google::Apis::PeopleV1::Skill>
The person's skills.
Corresponds to the JSON property skills
2061 2062 2063 |
# File 'lib/google/apis/people_v1/classes.rb', line 2061 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
2066 2067 2068 |
# File 'lib/google/apis/people_v1/classes.rb', line 2066 def taglines @taglines end |
#urls ⇒ Array<Google::Apis::PeopleV1::Url>
The person's associated URLs.
Corresponds to the JSON property urls
2071 2072 2073 |
# File 'lib/google/apis/people_v1/classes.rb', line 2071 def urls @urls end |
#user_defined ⇒ Array<Google::Apis::PeopleV1::UserDefined>
The person's user defined data.
Corresponds to the JSON property userDefined
2076 2077 2078 |
# File 'lib/google/apis/people_v1/classes.rb', line 2076 def user_defined @user_defined end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2083 2084 2085 2086 2087 2088 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 |
# File 'lib/google/apis/people_v1/classes.rb', line 2083 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 |