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



211
212
213
 
# File 'generated/google/apis/people_v1/classes.rb', line 211

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:



164
165
166
 
# File 'generated/google/apis/people_v1/classes.rb', line 164

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) 


149
150
151
 
# File 'generated/google/apis/people_v1/classes.rb', line 149

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:



159
160
161
 
# File 'generated/google/apis/people_v1/classes.rb', line 159

def age_ranges
  @age_ranges
end

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

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

Returns:



128
129
130
 
# File 'generated/google/apis/people_v1/classes.rb', line 128

def biographies
  @biographies
end

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

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

Returns:



194
195
196
 
# File 'generated/google/apis/people_v1/classes.rb', line 194

def birthdays
  @birthdays
end

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

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

Returns:



97
98
99
 
# File 'generated/google/apis/people_v1/classes.rb', line 97

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:



184
185
186
 
# File 'generated/google/apis/people_v1/classes.rb', line 184

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:



81
82
83
 
# File 'generated/google/apis/people_v1/classes.rb', line 81

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) 


92
93
94
 
# File 'generated/google/apis/people_v1/classes.rb', line 92

def etag
  @etag
end

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

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

Returns:



169
170
171
 
# File 'generated/google/apis/people_v1/classes.rb', line 169

def events
  @events
end

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

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

Returns:



112
113
114
 
# File 'generated/google/apis/people_v1/classes.rb', line 112

def genders
  @genders
end

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

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

Returns:



189
190
191
 
# File 'generated/google/apis/people_v1/classes.rb', line 189

def im_clients
  @im_clients
end

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

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

Returns:



117
118
119
 
# File 'generated/google/apis/people_v1/classes.rb', line 117

def interests
  @interests
end

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

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

Returns:



199
200
201
 
# File 'generated/google/apis/people_v1/classes.rb', line 199

def locales
  @locales
end

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

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

Returns:



174
175
176
 
# File 'generated/google/apis/people_v1/classes.rb', line 174

def memberships
  @memberships
end

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

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

Returns:



102
103
104
 
# File 'generated/google/apis/people_v1/classes.rb', line 102

def metadata
  @metadata
end

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

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

Returns:



71
72
73
 
# File 'generated/google/apis/people_v1/classes.rb', line 71

def names
  @names
end

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

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

Returns:



61
62
63
 
# File 'generated/google/apis/people_v1/classes.rb', line 61

def nicknames
  @nicknames
end

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

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

Returns:



76
77
78
 
# File 'generated/google/apis/people_v1/classes.rb', line 76

def occupations
  @occupations
end

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

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

Returns:



86
87
88
 
# File 'generated/google/apis/people_v1/classes.rb', line 86

def organizations
  @organizations
end

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

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

Returns:



179
180
181
 
# File 'generated/google/apis/people_v1/classes.rb', line 179

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:



143
144
145
 
# File 'generated/google/apis/people_v1/classes.rb', line 143

def photos
  @photos
end

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

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

Returns:



66
67
68
 
# File 'generated/google/apis/people_v1/classes.rb', line 66

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:



204
205
206
 
# File 'generated/google/apis/people_v1/classes.rb', line 204

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:



138
139
140
 
# File 'generated/google/apis/people_v1/classes.rb', line 138

def relationship_statuses
  @relationship_statuses
end

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

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

Returns:



107
108
109
 
# File 'generated/google/apis/people_v1/classes.rb', line 107

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) 


123
124
125
 
# File 'generated/google/apis/people_v1/classes.rb', line 123

def resource_name
  @resource_name
end

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

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

Returns:



133
134
135
 
# File 'generated/google/apis/people_v1/classes.rb', line 133

def skills
  @skills
end

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

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

Returns:



154
155
156
 
# File 'generated/google/apis/people_v1/classes.rb', line 154

def taglines
  @taglines
end

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

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

Returns:



209
210
211
 
# File 'generated/google/apis/people_v1/classes.rb', line 209

def urls
  @urls
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'generated/google/apis/people_v1/classes.rb', line 216

def update!(**args)
  @nicknames = args[:nicknames] if args.key?(:nicknames)
  @relations = args[:relations] if args.key?(:relations)
  @names = args[:names] if args.key?(:names)
  @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)
end