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



1280
1281
1282
 
# File 'generated/google/apis/people_v1/classes.rb', line 1280

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:



1253
1254
1255
 
# File 'generated/google/apis/people_v1/classes.rb', line 1253

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) 


1238
1239
1240
 
# File 'generated/google/apis/people_v1/classes.rb', line 1238

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:



1248
1249
1250
 
# File 'generated/google/apis/people_v1/classes.rb', line 1248

def age_ranges
  @age_ranges
end

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

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

Returns:



1218
1219
1220
 
# File 'generated/google/apis/people_v1/classes.rb', line 1218

def biographies
  @biographies
end

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

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

Returns:



1131
1132
1133
 
# File 'generated/google/apis/people_v1/classes.rb', line 1131

def birthdays
  @birthdays
end

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

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

Returns:



1187
1188
1189
 
# File 'generated/google/apis/people_v1/classes.rb', line 1187

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:



1273
1274
1275
 
# File 'generated/google/apis/people_v1/classes.rb', line 1273

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:



1171
1172
1173
 
# File 'generated/google/apis/people_v1/classes.rb', line 1171

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) 


1182
1183
1184
 
# File 'generated/google/apis/people_v1/classes.rb', line 1182

def etag
  @etag
end

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

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

Returns:



1258
1259
1260
 
# File 'generated/google/apis/people_v1/classes.rb', line 1258

def events
  @events
end

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

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

Returns:



1202
1203
1204
 
# File 'generated/google/apis/people_v1/classes.rb', line 1202

def genders
  @genders
end

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

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

Returns:



1278
1279
1280
 
# File 'generated/google/apis/people_v1/classes.rb', line 1278

def im_clients
  @im_clients
end

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

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

Returns:



1207
1208
1209
 
# File 'generated/google/apis/people_v1/classes.rb', line 1207

def interests
  @interests
end

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

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

Returns:



1136
1137
1138
 
# File 'generated/google/apis/people_v1/classes.rb', line 1136

def locales
  @locales
end

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

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

Returns:



1263
1264
1265
 
# File 'generated/google/apis/people_v1/classes.rb', line 1263

def memberships
  @memberships
end

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

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

Returns:



1192
1193
1194
 
# File 'generated/google/apis/people_v1/classes.rb', line 1192

def metadata
  @metadata
end

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

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

Returns:



1161
1162
1163
 
# File 'generated/google/apis/people_v1/classes.rb', line 1161

def names
  @names
end

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

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

Returns:



1151
1152
1153
 
# File 'generated/google/apis/people_v1/classes.rb', line 1151

def nicknames
  @nicknames
end

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

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

Returns:



1166
1167
1168
 
# File 'generated/google/apis/people_v1/classes.rb', line 1166

def occupations
  @occupations
end

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

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

Returns:



1176
1177
1178
 
# File 'generated/google/apis/people_v1/classes.rb', line 1176

def organizations
  @organizations
end

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

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

Returns:



1268
1269
1270
 
# File 'generated/google/apis/people_v1/classes.rb', line 1268

def phone_numbers
  @phone_numbers
end

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

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

Returns:



1233
1234
1235
 
# File 'generated/google/apis/people_v1/classes.rb', line 1233

def photos
  @photos
end

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

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

Returns:



1156
1157
1158
 
# File 'generated/google/apis/people_v1/classes.rb', line 1156

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:



1141
1142
1143
 
# File 'generated/google/apis/people_v1/classes.rb', line 1141

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:



1228
1229
1230
 
# File 'generated/google/apis/people_v1/classes.rb', line 1228

def relationship_statuses
  @relationship_statuses
end

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

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

Returns:



1197
1198
1199
 
# File 'generated/google/apis/people_v1/classes.rb', line 1197

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) 


1213
1214
1215
 
# File 'generated/google/apis/people_v1/classes.rb', line 1213

def resource_name
  @resource_name
end

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

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

Returns:



1223
1224
1225
 
# File 'generated/google/apis/people_v1/classes.rb', line 1223

def skills
  @skills
end

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

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

Returns:



1243
1244
1245
 
# File 'generated/google/apis/people_v1/classes.rb', line 1243

def taglines
  @taglines
end

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

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

Returns:



1146
1147
1148
 
# File 'generated/google/apis/people_v1/classes.rb', line 1146

def urls
  @urls
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'generated/google/apis/people_v1/classes.rb', line 1285

def update!(**args)
  @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)
  @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)
end