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



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

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:



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

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) 


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

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:



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

def age_ranges
  @age_ranges
end

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

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

Returns:



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

def biographies
  @biographies
end

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

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

Returns:



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

def birthdays
  @birthdays
end

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

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

Returns:



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

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:



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

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:



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

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) 


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

def etag
  @etag
end

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

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

Returns:



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

def events
  @events
end

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

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

Returns:



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

def genders
  @genders
end

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

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

Returns:



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

def im_clients
  @im_clients
end

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

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

Returns:



1393
1394
1395
 
# File 'generated/google/apis/people_v1/classes.rb', line 1393

def interests
  @interests
end

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

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

Returns:



1398
1399
1400
 
# File 'generated/google/apis/people_v1/classes.rb', line 1398

def locales
  @locales
end

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

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

Returns:



1403
1404
1405
 
# File 'generated/google/apis/people_v1/classes.rb', line 1403

def memberships
  @memberships
end

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

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

Returns:



1408
1409
1410
 
# File 'generated/google/apis/people_v1/classes.rb', line 1408

def metadata
  @metadata
end

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

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

Returns:



1413
1414
1415
 
# File 'generated/google/apis/people_v1/classes.rb', line 1413

def names
  @names
end

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

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

Returns:



1418
1419
1420
 
# File 'generated/google/apis/people_v1/classes.rb', line 1418

def nicknames
  @nicknames
end

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

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

Returns:



1423
1424
1425
 
# File 'generated/google/apis/people_v1/classes.rb', line 1423

def occupations
  @occupations
end

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

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

Returns:



1428
1429
1430
 
# File 'generated/google/apis/people_v1/classes.rb', line 1428

def organizations
  @organizations
end

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

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

Returns:



1433
1434
1435
 
# File 'generated/google/apis/people_v1/classes.rb', line 1433

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:



1438
1439
1440
 
# File 'generated/google/apis/people_v1/classes.rb', line 1438

def photos
  @photos
end

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

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

Returns:



1443
1444
1445
 
# File 'generated/google/apis/people_v1/classes.rb', line 1443

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:



1448
1449
1450
 
# File 'generated/google/apis/people_v1/classes.rb', line 1448

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:



1453
1454
1455
 
# File 'generated/google/apis/people_v1/classes.rb', line 1453

def relationship_statuses
  @relationship_statuses
end

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

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

Returns:



1458
1459
1460
 
# File 'generated/google/apis/people_v1/classes.rb', line 1458

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) 


1465
1466
1467
 
# File 'generated/google/apis/people_v1/classes.rb', line 1465

def resource_name
  @resource_name
end

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

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

Returns:



1470
1471
1472
 
# File 'generated/google/apis/people_v1/classes.rb', line 1470

def skills
  @skills
end

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

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

Returns:



1475
1476
1477
 
# File 'generated/google/apis/people_v1/classes.rb', line 1475

def taglines
  @taglines
end

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

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

Returns:



1480
1481
1482
 
# File 'generated/google/apis/people_v1/classes.rb', line 1480

def urls
  @urls
end

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

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

Returns:



1485
1486
1487
 
# File 'generated/google/apis/people_v1/classes.rb', line 1485

def user_defined
  @user_defined
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1492
1493
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
 
# File 'generated/google/apis/people_v1/classes.rb', line 1492

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