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. Fields other than IDs, metadata, and group memberships are user-edited. 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. NEXT_ID: 31

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



421
422
423
 
# File 'generated/google/apis/people_v1/classes.rb', line 421

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:



404
405
406
 
# File 'generated/google/apis/people_v1/classes.rb', line 404

def addresses
  @addresses
end

#age_range ⇒ String

DEPRECATED(Please read person.age_ranges instead). The person's age range. Corresponds to the JSON property ageRange

Returns:

  • (String) 


389
390
391
 
# File 'generated/google/apis/people_v1/classes.rb', line 389

def age_range
  @age_range
end

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

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

Returns:



399
400
401
 
# File 'generated/google/apis/people_v1/classes.rb', line 399

def age_ranges
  @age_ranges
end

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

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

Returns:



369
370
371
 
# File 'generated/google/apis/people_v1/classes.rb', line 369

def biographies
  @biographies
end

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

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

Returns:



282
283
284
 
# File 'generated/google/apis/people_v1/classes.rb', line 282

def birthdays
  @birthdays
end

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

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

Returns:



338
339
340
 
# File 'generated/google/apis/people_v1/classes.rb', line 338

def bragging_rights
  @bragging_rights
end

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

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

Returns:



272
273
274
 
# File 'generated/google/apis/people_v1/classes.rb', line 272

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:



322
323
324
 
# File 'generated/google/apis/people_v1/classes.rb', line 322

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) 


333
334
335
 
# File 'generated/google/apis/people_v1/classes.rb', line 333

def etag
  @etag
end

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

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

Returns:



409
410
411
 
# File 'generated/google/apis/people_v1/classes.rb', line 409

def events
  @events
end

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

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

Returns:



353
354
355
 
# File 'generated/google/apis/people_v1/classes.rb', line 353

def genders
  @genders
end

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

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

Returns:



277
278
279
 
# File 'generated/google/apis/people_v1/classes.rb', line 277

def im_clients
  @im_clients
end

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

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

Returns:



364
365
366
 
# File 'generated/google/apis/people_v1/classes.rb', line 364

def interests
  @interests
end

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

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

Returns:



287
288
289
 
# File 'generated/google/apis/people_v1/classes.rb', line 287

def locales
  @locales
end

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

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

Returns:



414
415
416
 
# File 'generated/google/apis/people_v1/classes.rb', line 414

def memberships
  @memberships
end

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

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

Returns:



343
344
345
 
# File 'generated/google/apis/people_v1/classes.rb', line 343

def metadata
  @metadata
end

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

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

Returns:



312
313
314
 
# File 'generated/google/apis/people_v1/classes.rb', line 312

def names
  @names
end

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

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

Returns:



302
303
304
 
# File 'generated/google/apis/people_v1/classes.rb', line 302

def nicknames
  @nicknames
end

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

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

Returns:



317
318
319
 
# File 'generated/google/apis/people_v1/classes.rb', line 317

def occupations
  @occupations
end

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

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

Returns:



327
328
329
 
# File 'generated/google/apis/people_v1/classes.rb', line 327

def organizations
  @organizations
end

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

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

Returns:



419
420
421
 
# File 'generated/google/apis/people_v1/classes.rb', line 419

def phone_numbers
  @phone_numbers
end

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

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

Returns:



384
385
386
 
# File 'generated/google/apis/people_v1/classes.rb', line 384

def photos
  @photos
end

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

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

Returns:



307
308
309
 
# File 'generated/google/apis/people_v1/classes.rb', line 307

def relations
  @relations
end

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

The kind of relationship the person is looking for. Corresponds to the JSON property relationshipInterests

Returns:



292
293
294
 
# File 'generated/google/apis/people_v1/classes.rb', line 292

def relationship_interests
  @relationship_interests
end

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

The person's relationship statuses. Corresponds to the JSON property relationshipStatuses

Returns:



379
380
381
 
# File 'generated/google/apis/people_v1/classes.rb', line 379

def relationship_statuses
  @relationship_statuses
end

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

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

Returns:



348
349
350
 
# File 'generated/google/apis/people_v1/classes.rb', line 348

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. Always starts with people/. Corresponds to the JSON property resourceName

Returns:

  • (String) 


359
360
361
 
# File 'generated/google/apis/people_v1/classes.rb', line 359

def resource_name
  @resource_name
end

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

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

Returns:



374
375
376
 
# File 'generated/google/apis/people_v1/classes.rb', line 374

def skills
  @skills
end

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

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

Returns:



394
395
396
 
# File 'generated/google/apis/people_v1/classes.rb', line 394

def taglines
  @taglines
end

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

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

Returns:



297
298
299
 
# File 'generated/google/apis/people_v1/classes.rb', line 297

def urls
  @urls
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'generated/google/apis/people_v1/classes.rb', line 426

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