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



1489
1490
1491
 
# File 'generated/google/apis/people_v1/classes.rb', line 1489

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:



1332
1333
1334
 
# File 'generated/google/apis/people_v1/classes.rb', line 1332

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) 


1338
1339
1340
 
# File 'generated/google/apis/people_v1/classes.rb', line 1338

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:



1343
1344
1345
 
# File 'generated/google/apis/people_v1/classes.rb', line 1343

def age_ranges
  @age_ranges
end

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

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

Returns:



1348
1349
1350
 
# File 'generated/google/apis/people_v1/classes.rb', line 1348

def biographies
  @biographies
end

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

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

Returns:



1353
1354
1355
 
# File 'generated/google/apis/people_v1/classes.rb', line 1353

def birthdays
  @birthdays
end

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

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

Returns:



1358
1359
1360
 
# File 'generated/google/apis/people_v1/classes.rb', line 1358

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:



1363
1364
1365
 
# File 'generated/google/apis/people_v1/classes.rb', line 1363

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:



1368
1369
1370
 
# File 'generated/google/apis/people_v1/classes.rb', line 1368

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) 


1374
1375
1376
 
# File 'generated/google/apis/people_v1/classes.rb', line 1374

def etag
  @etag
end

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

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

Returns:



1379
1380
1381
 
# File 'generated/google/apis/people_v1/classes.rb', line 1379

def events
  @events
end

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

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

Returns:



1384
1385
1386
 
# File 'generated/google/apis/people_v1/classes.rb', line 1384

def genders
  @genders
end

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

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

Returns:



1389
1390
1391
 
# File 'generated/google/apis/people_v1/classes.rb', line 1389

def im_clients
  @im_clients
end

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

The person's interests. DEPRECATED (No values will be returned.) Corresponds to the JSON property interests

Returns:



1395
1396
1397
 
# File 'generated/google/apis/people_v1/classes.rb', line 1395

def interests
  @interests
end

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

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

Returns:



1400
1401
1402
 
# File 'generated/google/apis/people_v1/classes.rb', line 1400

def locales
  @locales
end

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

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

Returns:



1405
1406
1407
 
# File 'generated/google/apis/people_v1/classes.rb', line 1405

def memberships
  @memberships
end

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

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

Returns:



1410
1411
1412
 
# File 'generated/google/apis/people_v1/classes.rb', line 1410

def metadata
  @metadata
end

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

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

Returns:



1415
1416
1417
 
# File 'generated/google/apis/people_v1/classes.rb', line 1415

def names
  @names
end

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

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

Returns:



1420
1421
1422
 
# File 'generated/google/apis/people_v1/classes.rb', line 1420

def nicknames
  @nicknames
end

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

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

Returns:



1425
1426
1427
 
# File 'generated/google/apis/people_v1/classes.rb', line 1425

def occupations
  @occupations
end

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

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

Returns:



1430
1431
1432
 
# File 'generated/google/apis/people_v1/classes.rb', line 1430

def organizations
  @organizations
end

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

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

Returns:



1435
1436
1437
 
# File 'generated/google/apis/people_v1/classes.rb', line 1435

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:



1440
1441
1442
 
# File 'generated/google/apis/people_v1/classes.rb', line 1440

def photos
  @photos
end

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

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

Returns:



1445
1446
1447
 
# File 'generated/google/apis/people_v1/classes.rb', line 1445

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:



1450
1451
1452
 
# File 'generated/google/apis/people_v1/classes.rb', line 1450

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:



1455
1456
1457
 
# File 'generated/google/apis/people_v1/classes.rb', line 1455

def relationship_statuses
  @relationship_statuses
end

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

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

Returns:



1460
1461
1462
 
# File 'generated/google/apis/people_v1/classes.rb', line 1460

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) 


1467
1468
1469
 
# File 'generated/google/apis/people_v1/classes.rb', line 1467

def resource_name
  @resource_name
end

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

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

Returns:



1472
1473
1474
 
# File 'generated/google/apis/people_v1/classes.rb', line 1472

def skills
  @skills
end

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

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

Returns:



1477
1478
1479
 
# File 'generated/google/apis/people_v1/classes.rb', line 1477

def taglines
  @taglines
end

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

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

Returns:



1482
1483
1484
 
# File 'generated/google/apis/people_v1/classes.rb', line 1482

def urls
  @urls
end

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

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

Returns:



1487
1488
1489
 
# File 'generated/google/apis/people_v1/classes.rb', line 1487

def user_defined
  @user_defined
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
 
# File 'generated/google/apis/people_v1/classes.rb', line 1494

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)
  @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)
  @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)
  @memberships = args[:memberships] if args.key?(:memberships)
  @metadata = args[:metadata] if args.key?(:metadata)
  @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)
  @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