Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / people_v1.people.html
blob: b0dadbcb14e58beec4fd283c575dfc8885d3ab71 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="people_v1.html">People API</a> . <a href="people_v1.people.html">people</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="people_v1.people.connections.html">connections()</a></code>
79</p>
80<p class="firstline">Returns the connections Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]83 <code><a href="#createContact">createContact(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Create a new contact and return the person resource for that contact.</p>
85<p class="toc_element">
86 <code><a href="#deleteContact">deleteContact(resourceName, x__xgafv=None)</a></code></p>
87<p class="firstline">Delete a contact person. Any non-contact data will not be deleted.</p>
88<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]89 <code><a href="#deleteContactPhoto">deleteContactPhoto(resourceName, x__xgafv=None, personFields=None)</a></code></p>
90<p class="firstline">Delete a contact's photo.</p>
91<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92 <code><a href="#get">get(resourceName, x__xgafv=None, requestMask_includeField=None, personFields=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]93<p class="firstline">Provides information about a person by specifying a resource name. Use</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]94<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95 <code><a href="#getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None, personFields=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]96<p class="firstline">Provides information about a list of specific people by specifying a list</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]98 <code><a href="#updateContact">updateContact(resourceName, body=None, x__xgafv=None, updatePersonFields=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99<p class="firstline">Update contact data for an existing contact person. Any non-contact data</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]100<p class="toc_element">
101 <code><a href="#updateContactPhoto">updateContactPhoto(resourceName, body=None, x__xgafv=None)</a></code></p>
102<p class="firstline">Update a contact's photo.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]103<h3>Method Details</h3>
104<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 <code class="details" id="createContact">createContact(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 <pre>Create a new contact and return the person resource for that contact.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]107
108Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]109 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 The object takes the form of:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]111
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112{ # Information about a person merged from various data sources such as the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]113 # authenticated user's contacts and profile data.
114 #
115 # Most fields can have multiple items. The items in a field have no guaranteed
116 # order, but each non-empty field is guaranteed to have exactly one field with
117 # `metadata.primary` set to true.
118 "sipAddresses": [ # The person's SIP addresses.
119 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
120 # communications to make voice or video calls over the internet.
121 "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
122 # viewer's account locale or the `Accept-Language` HTTP header locale.
123 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
124 # predefined values:
125 #
126 # * `home`
127 # * `work`
128 # * `mobile`
129 # * `other`
130 "value": "A String", # The SIP address in the
131 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
132 # format.
133 "metadata": { # Metadata about a field. # Metadata about the SIP address.
134 "source": { # The source of a field. # The source of the field.
135 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
136 #
137 # Last update timestamp of this source.
138 "etag": "A String", # **Only populated in `person.metadata.sources`.**
139 #
140 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
141 # source. Used for web cache validation.
142 "type": "A String", # The source type.
143 "id": "A String", # The unique identifier within the source type generated by the server.
144 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
145 #
146 # Metadata about a source of type PROFILE.
147 "userTypes": [ # Output only. The user types.
148 "A String",
149 ],
150 "objectType": "A String", # Output only. The profile object type.
151 },
152 },
153 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
154 # verified field is typically a name, email address, phone number, or
155 # website that has been confirmed to be owned by the person.
156 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
157 # field.
158 },
159 },
160 ],
161 "braggingRights": [ # **DEPRECATED**: No data will be returned
162 # The person's bragging rights.
163 { # **DEPRECATED**: No data will be returned
164 # A person's bragging rights.
165 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
166 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
167 "source": { # The source of a field. # The source of the field.
168 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
169 #
170 # Last update timestamp of this source.
171 "etag": "A String", # **Only populated in `person.metadata.sources`.**
172 #
173 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
174 # source. Used for web cache validation.
175 "type": "A String", # The source type.
176 "id": "A String", # The unique identifier within the source type generated by the server.
177 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
178 #
179 # Metadata about a source of type PROFILE.
180 "userTypes": [ # Output only. The user types.
181 "A String",
182 ],
183 "objectType": "A String", # Output only. The profile object type.
184 },
185 },
186 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
187 # verified field is typically a name, email address, phone number, or
188 # website that has been confirmed to be owned by the person.
189 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
190 # field.
191 },
192 },
193 ],
194 "addresses": [ # The person's street addresses.
195 { # A person's physical address. May be a P.O. box or street address. All fields
196 # are optional.
197 "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's
198 # account locale or the `Accept-Language` HTTP header locale.
199 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
200 # code of the address.
201 "city": "A String", # The city of the address.
202 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
203 # will be automatically constructed from structured values.
204 "region": "A String", # The region of the address; for example, the state or province.
205 "poBox": "A String", # The P.O. box of the address.
206 "streetAddress": "A String", # The street address.
207 "country": "A String", # The country of the address.
208 "postalCode": "A String", # The postal code of the address.
209 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
210 "type": "A String", # The type of the address. The type can be custom or one of these predefined
211 # values:
212 #
213 # * `home`
214 # * `work`
215 # * `other`
216 "metadata": { # Metadata about a field. # Metadata about the address.
217 "source": { # The source of a field. # The source of the field.
218 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
219 #
220 # Last update timestamp of this source.
221 "etag": "A String", # **Only populated in `person.metadata.sources`.**
222 #
223 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
224 # source. Used for web cache validation.
225 "type": "A String", # The source type.
226 "id": "A String", # The unique identifier within the source type generated by the server.
227 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
228 #
229 # Metadata about a source of type PROFILE.
230 "userTypes": [ # Output only. The user types.
231 "A String",
232 ],
233 "objectType": "A String", # Output only. The profile object type.
234 },
235 },
236 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
237 # verified field is typically a name, email address, phone number, or
238 # website that has been confirmed to be owned by the person.
239 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
240 # field.
241 },
242 },
243 ],
244 "nicknames": [ # The person's nicknames.
245 { # A person's nickname.
246 "type": "A String", # The type of the nickname.
247 "value": "A String", # The nickname.
248 "metadata": { # Metadata about a field. # Metadata about the nickname.
249 "source": { # The source of a field. # The source of the field.
250 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
251 #
252 # Last update timestamp of this source.
253 "etag": "A String", # **Only populated in `person.metadata.sources`.**
254 #
255 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
256 # source. Used for web cache validation.
257 "type": "A String", # The source type.
258 "id": "A String", # The unique identifier within the source type generated by the server.
259 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
260 #
261 # Metadata about a source of type PROFILE.
262 "userTypes": [ # Output only. The user types.
263 "A String",
264 ],
265 "objectType": "A String", # Output only. The profile object type.
266 },
267 },
268 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
269 # verified field is typically a name, email address, phone number, or
270 # website that has been confirmed to be owned by the person.
271 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
272 # field.
273 },
274 },
275 ],
276 "occupations": [ # The person's occupations.
277 { # A person's occupation.
278 "value": "A String", # The occupation; for example, `carpenter`.
279 "metadata": { # Metadata about a field. # Metadata about the occupation.
280 "source": { # The source of a field. # The source of the field.
281 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
282 #
283 # Last update timestamp of this source.
284 "etag": "A String", # **Only populated in `person.metadata.sources`.**
285 #
286 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
287 # source. Used for web cache validation.
288 "type": "A String", # The source type.
289 "id": "A String", # The unique identifier within the source type generated by the server.
290 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
291 #
292 # Metadata about a source of type PROFILE.
293 "userTypes": [ # Output only. The user types.
294 "A String",
295 ],
296 "objectType": "A String", # Output only. The profile object type.
297 },
298 },
299 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
300 # verified field is typically a name, email address, phone number, or
301 # website that has been confirmed to be owned by the person.
302 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
303 # field.
304 },
305 },
306 ],
307 "phoneNumbers": [ # The person's phone numbers.
308 { # A person's phone number.
309 "canonicalForm": "A String", # Output only. The canonicalized [ITU-T
310 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
311 # form of the phone number.
312 "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the
313 # viewer's account locale or the `Accept-Language` HTTP header locale.
314 "type": "A String", # The type of the phone number. The type can be custom or one of these
315 # predefined values:
316 #
317 # * `home`
318 # * `work`
319 # * `mobile`
320 # * `homeFax`
321 # * `workFax`
322 # * `otherFax`
323 # * `pager`
324 # * `workMobile`
325 # * `workPager`
326 # * `main`
327 # * `googleVoice`
328 # * `other`
329 "value": "A String", # The phone number.
330 "metadata": { # Metadata about a field. # Metadata about the phone number.
331 "source": { # The source of a field. # The source of the field.
332 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
333 #
334 # Last update timestamp of this source.
335 "etag": "A String", # **Only populated in `person.metadata.sources`.**
336 #
337 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
338 # source. Used for web cache validation.
339 "type": "A String", # The source type.
340 "id": "A String", # The unique identifier within the source type generated by the server.
341 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
342 #
343 # Metadata about a source of type PROFILE.
344 "userTypes": [ # Output only. The user types.
345 "A String",
346 ],
347 "objectType": "A String", # Output only. The profile object type.
348 },
349 },
350 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
351 # verified field is typically a name, email address, phone number, or
352 # website that has been confirmed to be owned by the person.
353 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
354 # field.
355 },
356 },
357 ],
358 "names": [ # The person's names.
359 { # A person's name. If the name is a mononym, the family name is empty.
360 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
361 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
362 "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to
363 # the locale specified by the viewer's account or the
364 # `Accept-Language` HTTP header.
365 "displayName": "A String", # Output only. The display name formatted according to the locale specified by
366 # the viewer's account or the `Accept-Language` HTTP header.
367 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
368 "middleName": "A String", # The middle name(s).
369 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
370 "familyName": "A String", # The family name.
371 "phoneticFullName": "A String", # The full name spelled as it sounds.
372 "phoneticGivenName": "A String", # The given name spelled as it sounds.
373 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
374 "givenName": "A String", # The given name.
375 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
376 "metadata": { # Metadata about a field. # Metadata about the name.
377 "source": { # The source of a field. # The source of the field.
378 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
379 #
380 # Last update timestamp of this source.
381 "etag": "A String", # **Only populated in `person.metadata.sources`.**
382 #
383 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
384 # source. Used for web cache validation.
385 "type": "A String", # The source type.
386 "id": "A String", # The unique identifier within the source type generated by the server.
387 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
388 #
389 # Metadata about a source of type PROFILE.
390 "userTypes": [ # Output only. The user types.
391 "A String",
392 ],
393 "objectType": "A String", # Output only. The profile object type.
394 },
395 },
396 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
397 # verified field is typically a name, email address, phone number, or
398 # website that has been confirmed to be owned by the person.
399 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
400 # field.
401 },
402 },
403 ],
404 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
405 # with a max length of 27 characters, in the form of
406 # `people/{person_id}`.
407 "ageRanges": [ # Output only. The person's age ranges.
408 { # A person's age range.
409 "ageRange": "A String", # The age range.
410 "metadata": { # Metadata about a field. # Metadata about the age range.
411 "source": { # The source of a field. # The source of the field.
412 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
413 #
414 # Last update timestamp of this source.
415 "etag": "A String", # **Only populated in `person.metadata.sources`.**
416 #
417 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
418 # source. Used for web cache validation.
419 "type": "A String", # The source type.
420 "id": "A String", # The unique identifier within the source type generated by the server.
421 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
422 #
423 # Metadata about a source of type PROFILE.
424 "userTypes": [ # Output only. The user types.
425 "A String",
426 ],
427 "objectType": "A String", # Output only. The profile object type.
428 },
429 },
430 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
431 # verified field is typically a name, email address, phone number, or
432 # website that has been confirmed to be owned by the person.
433 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
434 # field.
435 },
436 },
437 ],
438 "birthdays": [ # The person's birthdays.
439 { # A person's birthday. At least one of the `date` and `text` fields are
440 # specified. The `date` and `text` fields typically represent the same
441 # date, but are not guaranteed to.
442 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
443 # and time zone are either specified elsewhere or are not significant. The date
444 # is relative to the Proleptic Gregorian Calendar. This can represent:
445 #
446 # * A full date, with non-zero year, month and day values
447 # * A month and day value, with a zero year, e.g. an anniversary
448 # * A year on its own, with zero month and day values
449 # * A year and month value, with a zero day, e.g. a credit card expiration date
450 #
451 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
452 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
453 # month and day.
454 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
455 # if specifying a year by itself or a year and month where the day is not
456 # significant.
457 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
458 # a year.
459 },
460 "text": "A String", # A free-form string representing the user's birthday.
461 "metadata": { # Metadata about a field. # Metadata about the birthday.
462 "source": { # The source of a field. # The source of the field.
463 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
464 #
465 # Last update timestamp of this source.
466 "etag": "A String", # **Only populated in `person.metadata.sources`.**
467 #
468 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
469 # source. Used for web cache validation.
470 "type": "A String", # The source type.
471 "id": "A String", # The unique identifier within the source type generated by the server.
472 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
473 #
474 # Metadata about a source of type PROFILE.
475 "userTypes": [ # Output only. The user types.
476 "A String",
477 ],
478 "objectType": "A String", # Output only. The profile object type.
479 },
480 },
481 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
482 # verified field is typically a name, email address, phone number, or
483 # website that has been confirmed to be owned by the person.
484 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
485 # field.
486 },
487 },
488 ],
489 "relations": [ # The person's relations.
490 { # A person's relation to another person.
491 "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
492 # account locale or the locale specified in the Accept-Language HTTP header.
493 "metadata": { # Metadata about a field. # Metadata about the relation.
494 "source": { # The source of a field. # The source of the field.
495 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
496 #
497 # Last update timestamp of this source.
498 "etag": "A String", # **Only populated in `person.metadata.sources`.**
499 #
500 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
501 # source. Used for web cache validation.
502 "type": "A String", # The source type.
503 "id": "A String", # The unique identifier within the source type generated by the server.
504 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
505 #
506 # Metadata about a source of type PROFILE.
507 "userTypes": [ # Output only. The user types.
508 "A String",
509 ],
510 "objectType": "A String", # Output only. The profile object type.
511 },
512 },
513 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
514 # verified field is typically a name, email address, phone number, or
515 # website that has been confirmed to be owned by the person.
516 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
517 # field.
518 },
519 "type": "A String", # The person's relation to the other person. The type can be custom or one of
520 # these predefined values:
521 #
522 # * `spouse`
523 # * `child`
524 # * `mother`
525 # * `father`
526 # * `parent`
527 # * `brother`
528 # * `sister`
529 # * `friend`
530 # * `relative`
531 # * `domesticPartner`
532 # * `manager`
533 # * `assistant`
534 # * `referredBy`
535 # * `partner`
536 "person": "A String", # The name of the other person this relation refers to.
537 },
538 ],
539 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
540 # resource. Used for web cache validation.
541 "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
542 # The person's relationship statuses.
543 { # **DEPRECATED**: No data will be returned
544 # A person's relationship status.
545 "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
546 # the viewer's account locale or the `Accept-Language` HTTP header locale.
547 "value": "A String", # The relationship status. The value can be custom or one of these
548 # predefined values:
549 #
550 # * `single`
551 # * `inARelationship`
552 # * `engaged`
553 # * `married`
554 # * `itsComplicated`
555 # * `openRelationship`
556 # * `widowed`
557 # * `inDomesticPartnership`
558 # * `inCivilUnion`
559 "metadata": { # Metadata about a field. # Metadata about the relationship status.
560 "source": { # The source of a field. # The source of the field.
561 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
562 #
563 # Last update timestamp of this source.
564 "etag": "A String", # **Only populated in `person.metadata.sources`.**
565 #
566 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
567 # source. Used for web cache validation.
568 "type": "A String", # The source type.
569 "id": "A String", # The unique identifier within the source type generated by the server.
570 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
571 #
572 # Metadata about a source of type PROFILE.
573 "userTypes": [ # Output only. The user types.
574 "A String",
575 ],
576 "objectType": "A String", # Output only. The profile object type.
577 },
578 },
579 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
580 # verified field is typically a name, email address, phone number, or
581 # website that has been confirmed to be owned by the person.
582 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
583 # field.
584 },
585 },
586 ],
587 "skills": [ # The person's skills.
588 { # A skill that the person has.
589 "value": "A String", # The skill; for example, `underwater basket weaving`.
590 "metadata": { # Metadata about a field. # Metadata about the skill.
591 "source": { # The source of a field. # The source of the field.
592 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
593 #
594 # Last update timestamp of this source.
595 "etag": "A String", # **Only populated in `person.metadata.sources`.**
596 #
597 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
598 # source. Used for web cache validation.
599 "type": "A String", # The source type.
600 "id": "A String", # The unique identifier within the source type generated by the server.
601 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
602 #
603 # Metadata about a source of type PROFILE.
604 "userTypes": [ # Output only. The user types.
605 "A String",
606 ],
607 "objectType": "A String", # Output only. The profile object type.
608 },
609 },
610 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
611 # verified field is typically a name, email address, phone number, or
612 # website that has been confirmed to be owned by the person.
613 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
614 # field.
615 },
616 },
617 ],
618 "imClients": [ # The person's instant messaging clients.
619 { # A person's instant messaging client.
620 "username": "A String", # The user name used in the IM client.
621 "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
622 # viewer's account locale or the `Accept-Language` HTTP header locale.
623 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
624 # predefined values:
625 #
626 # * `aim`
627 # * `msn`
628 # * `yahoo`
629 # * `skype`
630 # * `qq`
631 # * `googleTalk`
632 # * `icq`
633 # * `jabber`
634 # * `netMeeting`
635 "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account
636 # locale or the `Accept-Language` HTTP header locale.
637 "type": "A String", # The type of the IM client. The type can be custom or one of these
638 # predefined values:
639 #
640 # * `home`
641 # * `work`
642 # * `other`
643 "metadata": { # Metadata about a field. # Metadata about the IM client.
644 "source": { # The source of a field. # The source of the field.
645 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
646 #
647 # Last update timestamp of this source.
648 "etag": "A String", # **Only populated in `person.metadata.sources`.**
649 #
650 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
651 # source. Used for web cache validation.
652 "type": "A String", # The source type.
653 "id": "A String", # The unique identifier within the source type generated by the server.
654 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
655 #
656 # Metadata about a source of type PROFILE.
657 "userTypes": [ # Output only. The user types.
658 "A String",
659 ],
660 "objectType": "A String", # Output only. The profile object type.
661 },
662 },
663 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
664 # verified field is typically a name, email address, phone number, or
665 # website that has been confirmed to be owned by the person.
666 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
667 # field.
668 },
669 },
670 ],
671 "events": [ # The person's events.
672 { # An event related to the person.
673 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
674 # and time zone are either specified elsewhere or are not significant. The date
675 # is relative to the Proleptic Gregorian Calendar. This can represent:
676 #
677 # * A full date, with non-zero year, month and day values
678 # * A month and day value, with a zero year, e.g. an anniversary
679 # * A year on its own, with zero month and day values
680 # * A year and month value, with a zero day, e.g. a credit card expiration date
681 #
682 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
683 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
684 # month and day.
685 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
686 # if specifying a year by itself or a year and month where the day is not
687 # significant.
688 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
689 # a year.
690 },
691 "formattedType": "A String", # Output only. The type of the event translated and formatted in the
692 # viewer's account locale or the `Accept-Language` HTTP header locale.
693 "type": "A String", # The type of the event. The type can be custom or one of these predefined
694 # values:
695 #
696 # * `anniversary`
697 # * `other`
698 "metadata": { # Metadata about a field. # Metadata about the event.
699 "source": { # The source of a field. # The source of the field.
700 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
701 #
702 # Last update timestamp of this source.
703 "etag": "A String", # **Only populated in `person.metadata.sources`.**
704 #
705 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
706 # source. Used for web cache validation.
707 "type": "A String", # The source type.
708 "id": "A String", # The unique identifier within the source type generated by the server.
709 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
710 #
711 # Metadata about a source of type PROFILE.
712 "userTypes": [ # Output only. The user types.
713 "A String",
714 ],
715 "objectType": "A String", # Output only. The profile object type.
716 },
717 },
718 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
719 # verified field is typically a name, email address, phone number, or
720 # website that has been confirmed to be owned by the person.
721 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
722 # field.
723 },
724 },
725 ],
726 "metadata": { # The metadata about a person. # Output only. Metadata about the person.
727 "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for
728 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
729 # that include a sync token.
730 "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for
731 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
732 # that include a sync token.
733 #
734 # The resource name may change when adding or removing fields that link a
735 # contact and profile such as a verified email, verified phone number, or
736 # profile URL.
737 "A String",
738 ],
739 "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
740 "A String",
741 ],
742 "sources": [ # The sources of data for the person.
743 { # The source of a field.
744 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
745 #
746 # Last update timestamp of this source.
747 "etag": "A String", # **Only populated in `person.metadata.sources`.**
748 #
749 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
750 # source. Used for web cache validation.
751 "type": "A String", # The source type.
752 "id": "A String", # The unique identifier within the source type generated by the server.
753 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
754 #
755 # Metadata about a source of type PROFILE.
756 "userTypes": [ # Output only. The user types.
757 "A String",
758 ],
759 "objectType": "A String", # Output only. The profile object type.
760 },
761 },
762 ],
763 "objectType": "A String", # Output only. **DEPRECATED** (Please use
764 # `person.metadata.sources.profileMetadata.objectType` instead)
765 #
766 # The type of the person object.
767 },
768 "interests": [ # The person's interests.
769 { # One of the person's interests.
770 "value": "A String", # The interest; for example, `stargazing`.
771 "metadata": { # Metadata about a field. # Metadata about the interest.
772 "source": { # The source of a field. # The source of the field.
773 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
774 #
775 # Last update timestamp of this source.
776 "etag": "A String", # **Only populated in `person.metadata.sources`.**
777 #
778 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
779 # source. Used for web cache validation.
780 "type": "A String", # The source type.
781 "id": "A String", # The unique identifier within the source type generated by the server.
782 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
783 #
784 # Metadata about a source of type PROFILE.
785 "userTypes": [ # Output only. The user types.
786 "A String",
787 ],
788 "objectType": "A String", # Output only. The profile object type.
789 },
790 },
791 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
792 # verified field is typically a name, email address, phone number, or
793 # website that has been confirmed to be owned by the person.
794 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
795 # field.
796 },
797 },
798 ],
799 "photos": [ # Output only. The person's photos.
800 { # A person's photo. A picture shown next to the person's name to
801 # help others recognize the person.
802 "default": True or False, # True if the photo is a default photo;
803 # false if the photo is a user-provided photo.
804 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
805 # parameter `sz={size}` at the end of the url, where {size} is the size in
806 # pixels. Example:
807 # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
808 "metadata": { # Metadata about a field. # Metadata about the photo.
809 "source": { # The source of a field. # The source of the field.
810 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
811 #
812 # Last update timestamp of this source.
813 "etag": "A String", # **Only populated in `person.metadata.sources`.**
814 #
815 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
816 # source. Used for web cache validation.
817 "type": "A String", # The source type.
818 "id": "A String", # The unique identifier within the source type generated by the server.
819 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
820 #
821 # Metadata about a source of type PROFILE.
822 "userTypes": [ # Output only. The user types.
823 "A String",
824 ],
825 "objectType": "A String", # Output only. The profile object type.
826 },
827 },
828 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
829 # verified field is typically a name, email address, phone number, or
830 # website that has been confirmed to be owned by the person.
831 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
832 # field.
833 },
834 },
835 ],
836 "residences": [ # The person's residences.
837 { # A person's past or current residence.
838 "current": True or False, # True if the residence is the person's current residence;
839 # false if the residence is a past residence.
840 "value": "A String", # The address of the residence.
841 "metadata": { # Metadata about a field. # Metadata about the residence.
842 "source": { # The source of a field. # The source of the field.
843 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
844 #
845 # Last update timestamp of this source.
846 "etag": "A String", # **Only populated in `person.metadata.sources`.**
847 #
848 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
849 # source. Used for web cache validation.
850 "type": "A String", # The source type.
851 "id": "A String", # The unique identifier within the source type generated by the server.
852 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
853 #
854 # Metadata about a source of type PROFILE.
855 "userTypes": [ # Output only. The user types.
856 "A String",
857 ],
858 "objectType": "A String", # Output only. The profile object type.
859 },
860 },
861 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
862 # verified field is typically a name, email address, phone number, or
863 # website that has been confirmed to be owned by the person.
864 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
865 # field.
866 },
867 },
868 ],
869 "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
870 # The person's relationship interests.
871 { # **DEPRECATED**: No data will be returned
872 # A person's relationship interest .
873 "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
874 # in the viewer's account locale or the locale specified in the
875 # Accept-Language HTTP header.
876 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
877 # or one of these predefined values:
878 #
879 # * `friend`
880 # * `date`
881 # * `relationship`
882 # * `networking`
883 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
884 "source": { # The source of a field. # The source of the field.
885 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
886 #
887 # Last update timestamp of this source.
888 "etag": "A String", # **Only populated in `person.metadata.sources`.**
889 #
890 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
891 # source. Used for web cache validation.
892 "type": "A String", # The source type.
893 "id": "A String", # The unique identifier within the source type generated by the server.
894 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
895 #
896 # Metadata about a source of type PROFILE.
897 "userTypes": [ # Output only. The user types.
898 "A String",
899 ],
900 "objectType": "A String", # Output only. The profile object type.
901 },
902 },
903 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
904 # verified field is typically a name, email address, phone number, or
905 # website that has been confirmed to be owned by the person.
906 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
907 # field.
908 },
909 },
910 ],
911 "coverPhotos": [ # Output only. The person's cover photos.
912 { # A person's cover photo. A large image shown on the person's
913 # profile page that represents who they are or what they care about.
914 "default": True or False, # True if the cover photo is the default cover photo;
915 # false if the cover photo is a user-provided cover photo.
916 "url": "A String", # The URL of the cover photo.
917 "metadata": { # Metadata about a field. # Metadata about the cover photo.
918 "source": { # The source of a field. # The source of the field.
919 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
920 #
921 # Last update timestamp of this source.
922 "etag": "A String", # **Only populated in `person.metadata.sources`.**
923 #
924 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
925 # source. Used for web cache validation.
926 "type": "A String", # The source type.
927 "id": "A String", # The unique identifier within the source type generated by the server.
928 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
929 #
930 # Metadata about a source of type PROFILE.
931 "userTypes": [ # Output only. The user types.
932 "A String",
933 ],
934 "objectType": "A String", # Output only. The profile object type.
935 },
936 },
937 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
938 # verified field is typically a name, email address, phone number, or
939 # website that has been confirmed to be owned by the person.
940 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
941 # field.
942 },
943 },
944 ],
945 "locales": [ # The person's locale preferences.
946 { # A person's locale preference.
947 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
948 # language tag representing the locale.
949 "metadata": { # Metadata about a field. # Metadata about the locale.
950 "source": { # The source of a field. # The source of the field.
951 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
952 #
953 # Last update timestamp of this source.
954 "etag": "A String", # **Only populated in `person.metadata.sources`.**
955 #
956 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
957 # source. Used for web cache validation.
958 "type": "A String", # The source type.
959 "id": "A String", # The unique identifier within the source type generated by the server.
960 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
961 #
962 # Metadata about a source of type PROFILE.
963 "userTypes": [ # Output only. The user types.
964 "A String",
965 ],
966 "objectType": "A String", # Output only. The profile object type.
967 },
968 },
969 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
970 # verified field is typically a name, email address, phone number, or
971 # website that has been confirmed to be owned by the person.
972 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
973 # field.
974 },
975 },
976 ],
977 "organizations": [ # The person's past or current organizations.
978 { # A person's past or current organization. Overlapping date ranges are
979 # permitted.
980 "formattedType": "A String", # Output only. The type of the organization translated and formatted in the
981 # viewer's account locale or the `Accept-Language` HTTP header locale.
982 "domain": "A String", # The domain name associated with the organization; for example,
983 # `google.com`.
984 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.
985 # and time zone are either specified elsewhere or are not significant. The date
986 # is relative to the Proleptic Gregorian Calendar. This can represent:
987 #
988 # * A full date, with non-zero year, month and day values
989 # * A month and day value, with a zero year, e.g. an anniversary
990 # * A year on its own, with zero month and day values
991 # * A year and month value, with a zero day, e.g. a credit card expiration date
992 #
993 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
994 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
995 # month and day.
996 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
997 # if specifying a year by itself or a year and month where the day is not
998 # significant.
999 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1000 # a year.
1001 },
1002 "name": "A String", # The name of the organization.
1003 "title": "A String", # The person's job title at the organization.
1004 "type": "A String", # The type of the organization. The type can be custom or one of these
1005 # predefined values:
1006 #
1007 # * `work`
1008 # * `school`
1009 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
1010 # symbol, abbreviation, or acronym.
1011 "current": True or False, # True if the organization is the person's current organization;
1012 # false if the organization is a past organization.
1013 "jobDescription": "A String", # The person's job description at the organization.
1014 "location": "A String", # The location of the organization office the person works at.
1015 "department": "A String", # The person's department at the organization.
1016 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.
1017 # and time zone are either specified elsewhere or are not significant. The date
1018 # is relative to the Proleptic Gregorian Calendar. This can represent:
1019 #
1020 # * A full date, with non-zero year, month and day values
1021 # * A month and day value, with a zero year, e.g. an anniversary
1022 # * A year on its own, with zero month and day values
1023 # * A year and month value, with a zero day, e.g. a credit card expiration date
1024 #
1025 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
1026 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1027 # month and day.
1028 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1029 # if specifying a year by itself or a year and month where the day is not
1030 # significant.
1031 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1032 # a year.
1033 },
1034 "phoneticName": "A String", # The phonetic name of the organization.
1035 "metadata": { # Metadata about a field. # Metadata about the organization.
1036 "source": { # The source of a field. # The source of the field.
1037 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
1038 #
1039 # Last update timestamp of this source.
1040 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1041 #
1042 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1043 # source. Used for web cache validation.
1044 "type": "A String", # The source type.
1045 "id": "A String", # The unique identifier within the source type generated by the server.
1046 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
1047 #
1048 # Metadata about a source of type PROFILE.
1049 "userTypes": [ # Output only. The user types.
1050 "A String",
1051 ],
1052 "objectType": "A String", # Output only. The profile object type.
1053 },
1054 },
1055 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
1056 # verified field is typically a name, email address, phone number, or
1057 # website that has been confirmed to be owned by the person.
1058 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1059 # field.
1060 },
1061 },
1062 ],
1063 "userDefined": [ # The person's user defined data.
1064 { # Arbitrary user data that is populated by the end users.
1065 "key": "A String", # The end user specified key of the user defined data.
1066 "value": "A String", # The end user specified value of the user defined data.
1067 "metadata": { # Metadata about a field. # Metadata about the user defined data.
1068 "source": { # The source of a field. # The source of the field.
1069 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
1070 #
1071 # Last update timestamp of this source.
1072 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1073 #
1074 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1075 # source. Used for web cache validation.
1076 "type": "A String", # The source type.
1077 "id": "A String", # The unique identifier within the source type generated by the server.
1078 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
1079 #
1080 # Metadata about a source of type PROFILE.
1081 "userTypes": [ # Output only. The user types.
1082 "A String",
1083 ],
1084 "objectType": "A String", # Output only. The profile object type.
1085 },
1086 },
1087 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
1088 # verified field is typically a name, email address, phone number, or
1089 # website that has been confirmed to be owned by the person.
1090 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1091 # field.
1092 },
1093 },
1094 ],
1095 "biographies": [ # The person's biographies.
1096 { # A person's short biography.
1097 "contentType": "A String", # The content type of the biography.
1098 "value": "A String", # The short biography.
1099 "metadata": { # Metadata about a field. # Metadata about the biography.
1100 "source": { # The source of a field. # The source of the field.
1101 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
1102 #
1103 # Last update timestamp of this source.
1104 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1105 #
1106 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1107 # source. Used for web cache validation.
1108 "type": "A String", # The source type.
1109 "id": "A String", # The unique identifier within the source type generated by the server.
1110 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
1111 #
1112 # Metadata about a source of type PROFILE.
1113 "userTypes": [ # Output only. The user types.
1114 "A String",
1115 ],
1116 "objectType": "A String", # Output only. The profile object type.
1117 },
1118 },
1119 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
1120 # verified field is typically a name, email address, phone number, or
1121 # website that has been confirmed to be owned by the person.
1122 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1123 # field.
1124 },
1125 },
1126 ],
1127 "memberships": [ # The person's group memberships.
1128 { # A person's membership in a group. Only contact group memberships can be
1129 # modified.
1130 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
1131 "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
1132 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
1133 # string, in the form of `contactGroups/{contact_group_id}`.
1134 # Only contact_group_resource_name can be used for modifying memberships.
1135 # Any contact group membership can be removed, but only user group or
1136 # "myContacts" or "starred" system groups memberships can be added. A
1137 # contact must always have at least one contact group membership.
1138 },
1139 "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
1140 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
1141 },
1142 "metadata": { # Metadata about a field. # Metadata about the membership.
1143 "source": { # The source of a field. # The source of the field.
1144 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
1145 #
1146 # Last update timestamp of this source.
1147 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1148 #
1149 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1150 # source. Used for web cache validation.
1151 "type": "A String", # The source type.
1152 "id": "A String", # The unique identifier within the source type generated by the server.
1153 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
1154 #
1155 # Metadata about a source of type PROFILE.
1156 "userTypes": [ # Output only. The user types.
1157 "A String",
1158 ],
1159 "objectType": "A String", # Output only. The profile object type.
1160 },
1161 },
1162 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
1163 # verified field is typically a name, email address, phone number, or
1164 # website that has been confirmed to be owned by the person.
1165 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1166 # field.
1167 },
1168 },
1169 ],
1170 "taglines": [ # Output only. **DEPRECATED**: No data will be returned
1171 # The person's taglines.
1172 { # **DEPRECATED**: No data will be returned
1173 # A brief one-line description of the person.
1174 "value": "A String", # The tagline.
1175 "metadata": { # Metadata about a field. # Metadata about the tagline.
1176 "source": { # The source of a field. # The source of the field.
1177 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
1178 #
1179 # Last update timestamp of this source.
1180 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1181 #
1182 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1183 # source. Used for web cache validation.
1184 "type": "A String", # The source type.
1185 "id": "A String", # The unique identifier within the source type generated by the server.
1186 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
1187 #
1188 # Metadata about a source of type PROFILE.
1189 "userTypes": [ # Output only. The user types.
1190 "A String",
1191 ],
1192 "objectType": "A String", # Output only. The profile object type.
1193 },
1194 },
1195 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
1196 # verified field is typically a name, email address, phone number, or
1197 # website that has been confirmed to be owned by the person.
1198 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1199 # field.
1200 },
1201 },
1202 ],
1203 "urls": [ # The person's associated URLs.
1204 { # A person's associated URLs.
1205 "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
1206 # account locale or the `Accept-Language` HTTP header locale.
1207 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
1208 # values:
1209 #
1210 # * `home`
1211 # * `work`
1212 # * `blog`
1213 # * `profile`
1214 # * `homePage`
1215 # * `ftp`
1216 # * `reservations`
1217 # * `appInstallPage`: website for a Google+ application.
1218 # * `other`
1219 "value": "A String", # The URL.
1220 "metadata": { # Metadata about a field. # Metadata about the URL.
1221 "source": { # The source of a field. # The source of the field.
1222 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
1223 #
1224 # Last update timestamp of this source.
1225 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1226 #
1227 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1228 # source. Used for web cache validation.
1229 "type": "A String", # The source type.
1230 "id": "A String", # The unique identifier within the source type generated by the server.
1231 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
1232 #
1233 # Metadata about a source of type PROFILE.
1234 "userTypes": [ # Output only. The user types.
1235 "A String",
1236 ],
1237 "objectType": "A String", # Output only. The profile object type.
1238 },
1239 },
1240 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
1241 # verified field is typically a name, email address, phone number, or
1242 # website that has been confirmed to be owned by the person.
1243 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1244 # field.
1245 },
1246 },
1247 ],
1248 "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1249 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1250 # The person's age range.
1251 "genders": [ # The person's genders.
1252 { # A person's gender.
1253 "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account
1254 # locale or the `Accept-Language` HTTP header locale. Unspecified or custom
1255 # value are not localized.
1256 "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value
1257 # can be custom or one of these predefined values:
1258 #
1259 # * `male`
1260 # * `female`
1261 # * `other`
1262 "value": "A String", # The gender for the person. The gender can be custom or one of these
1263 # predefined values:
1264 #
1265 # * `male`
1266 # * `female`
1267 # * `unspecified`
1268 "metadata": { # Metadata about a field. # Metadata about the gender.
1269 "source": { # The source of a field. # The source of the field.
1270 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
1271 #
1272 # Last update timestamp of this source.
1273 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1274 #
1275 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1276 # source. Used for web cache validation.
1277 "type": "A String", # The source type.
1278 "id": "A String", # The unique identifier within the source type generated by the server.
1279 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
1280 #
1281 # Metadata about a source of type PROFILE.
1282 "userTypes": [ # Output only. The user types.
1283 "A String",
1284 ],
1285 "objectType": "A String", # Output only. The profile object type.
1286 },
1287 },
1288 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
1289 # verified field is typically a name, email address, phone number, or
1290 # website that has been confirmed to be owned by the person.
1291 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1292 # field.
1293 },
1294 },
1295 ],
1296 "emailAddresses": [ # The person's email addresses.
1297 { # A person's email address.
1298 "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
1299 # viewer's account locale or the `Accept-Language` HTTP header locale.
1300 "metadata": { # Metadata about a field. # Metadata about the email address.
1301 "source": { # The source of a field. # The source of the field.
1302 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
1303 #
1304 # Last update timestamp of this source.
1305 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1306 #
1307 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1308 # source. Used for web cache validation.
1309 "type": "A String", # The source type.
1310 "id": "A String", # The unique identifier within the source type generated by the server.
1311 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
1312 #
1313 # Metadata about a source of type PROFILE.
1314 "userTypes": [ # Output only. The user types.
1315 "A String",
1316 ],
1317 "objectType": "A String", # Output only. The profile object type.
1318 },
1319 },
1320 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
1321 # verified field is typically a name, email address, phone number, or
1322 # website that has been confirmed to be owned by the person.
1323 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1324 # field.
1325 },
1326 "displayName": "A String", # The display name of the email.
1327 "value": "A String", # The email address.
1328 "type": "A String", # The type of the email address. The type can be custom or one of these
1329 # predefined values:
1330 #
1331 # * `home`
1332 # * `work`
1333 # * `other`
1334 },
1335 ],
1336}
1337
1338 x__xgafv: string, V1 error format.
1339 Allowed values
1340 1 - v1 error format
1341 2 - v2 error format
1342
1343Returns:
1344 An object of the form:
1345
1346 { # Information about a person merged from various data sources such as the
1347 # authenticated user's contacts and profile data.
1348 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1349 # Most fields can have multiple items. The items in a field have no guaranteed
1350 # order, but each non-empty field is guaranteed to have exactly one field with
1351 # `metadata.primary` set to true.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1352 "sipAddresses": [ # The person's SIP addresses.
1353 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
1354 # communications to make voice or video calls over the internet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1355 "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1356 # viewer's account locale or the `Accept-Language` HTTP header locale.
1357 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
1358 # predefined values:
1359 #
1360 # * `home`
1361 # * `work`
1362 # * `mobile`
1363 # * `other`
1364 "value": "A String", # The SIP address in the
1365 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
1366 # format.
1367 "metadata": { # Metadata about a field. # Metadata about the SIP address.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1368 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1369 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1370 #
1371 # Last update timestamp of this source.
1372 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1373 #
1374 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1375 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1376 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1377 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1378 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1379 #
1380 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1381 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1382 "A String",
1383 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1384 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1385 },
1386 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1387 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1388 # verified field is typically a name, email address, phone number, or
1389 # website that has been confirmed to be owned by the person.
1390 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1391 # field.
1392 },
1393 },
1394 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1395 "braggingRights": [ # **DEPRECATED**: No data will be returned
1396 # The person's bragging rights.
1397 { # **DEPRECATED**: No data will be returned
1398 # A person's bragging rights.
1399 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
1400 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1401 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1402 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1403 #
1404 # Last update timestamp of this source.
1405 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1406 #
1407 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1408 # source. Used for web cache validation.
1409 "type": "A String", # The source type.
1410 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1411 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1412 #
1413 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1414 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1415 "A String",
1416 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1417 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1418 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1419 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1420 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1421 # verified field is typically a name, email address, phone number, or
1422 # website that has been confirmed to be owned by the person.
1423 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1424 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1425 },
1426 },
1427 ],
1428 "addresses": [ # The person's street addresses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1429 { # A person's physical address. May be a P.O. box or street address. All fields
1430 # are optional.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1431 "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1432 # account locale or the `Accept-Language` HTTP header locale.
1433 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
1434 # code of the address.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1435 "city": "A String", # The city of the address.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1436 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
1437 # will be automatically constructed from structured values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1438 "region": "A String", # The region of the address; for example, the state or province.
1439 "poBox": "A String", # The P.O. box of the address.
1440 "streetAddress": "A String", # The street address.
1441 "country": "A String", # The country of the address.
1442 "postalCode": "A String", # The postal code of the address.
1443 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1444 "type": "A String", # The type of the address. The type can be custom or one of these predefined
1445 # values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1446 #
1447 # * `home`
1448 # * `work`
1449 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1450 "metadata": { # Metadata about a field. # Metadata about the address.
1451 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1452 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1453 #
1454 # Last update timestamp of this source.
1455 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1456 #
1457 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1458 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1459 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1460 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1461 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1462 #
1463 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1464 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1465 "A String",
1466 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1467 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1468 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1469 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1470 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1471 # verified field is typically a name, email address, phone number, or
1472 # website that has been confirmed to be owned by the person.
1473 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1474 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1475 },
1476 },
1477 ],
1478 "nicknames": [ # The person's nicknames.
1479 { # A person's nickname.
1480 "type": "A String", # The type of the nickname.
1481 "value": "A String", # The nickname.
1482 "metadata": { # Metadata about a field. # Metadata about the nickname.
1483 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1484 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1485 #
1486 # Last update timestamp of this source.
1487 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1488 #
1489 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1490 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1491 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1492 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1493 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1494 #
1495 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1496 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1497 "A String",
1498 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1499 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1500 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1501 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1502 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1503 # verified field is typically a name, email address, phone number, or
1504 # website that has been confirmed to be owned by the person.
1505 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1506 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1507 },
1508 },
1509 ],
1510 "occupations": [ # The person's occupations.
1511 { # A person's occupation.
1512 "value": "A String", # The occupation; for example, `carpenter`.
1513 "metadata": { # Metadata about a field. # Metadata about the occupation.
1514 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1515 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1516 #
1517 # Last update timestamp of this source.
1518 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1519 #
1520 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1521 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1522 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1523 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1524 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1525 #
1526 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1527 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1528 "A String",
1529 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1530 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1531 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1532 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1533 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1534 # verified field is typically a name, email address, phone number, or
1535 # website that has been confirmed to be owned by the person.
1536 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1537 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1538 },
1539 },
1540 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1541 "phoneNumbers": [ # The person's phone numbers.
1542 { # A person's phone number.
1543 "canonicalForm": "A String", # Output only. The canonicalized [ITU-T
1544 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
1545 # form of the phone number.
1546 "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the
1547 # viewer's account locale or the `Accept-Language` HTTP header locale.
1548 "type": "A String", # The type of the phone number. The type can be custom or one of these
1549 # predefined values:
1550 #
1551 # * `home`
1552 # * `work`
1553 # * `mobile`
1554 # * `homeFax`
1555 # * `workFax`
1556 # * `otherFax`
1557 # * `pager`
1558 # * `workMobile`
1559 # * `workPager`
1560 # * `main`
1561 # * `googleVoice`
1562 # * `other`
1563 "value": "A String", # The phone number.
1564 "metadata": { # Metadata about a field. # Metadata about the phone number.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1565 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1566 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1567 #
1568 # Last update timestamp of this source.
1569 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1570 #
1571 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1572 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1573 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1574 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1575 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1576 #
1577 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1578 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1579 "A String",
1580 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1581 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1582 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1583 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1584 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1585 # verified field is typically a name, email address, phone number, or
1586 # website that has been confirmed to be owned by the person.
1587 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1588 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1589 },
1590 },
1591 ],
1592 "names": [ # The person's names.
1593 { # A person's name. If the name is a mononym, the family name is empty.
1594 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
1595 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1596 "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1597 # the locale specified by the viewer's account or the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1598 # `Accept-Language` HTTP header.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1599 "displayName": "A String", # Output only. The display name formatted according to the locale specified by
1600 # the viewer's account or the `Accept-Language` HTTP header.
1601 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1602 "middleName": "A String", # The middle name(s).
1603 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
1604 "familyName": "A String", # The family name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1605 "phoneticFullName": "A String", # The full name spelled as it sounds.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1606 "phoneticGivenName": "A String", # The given name spelled as it sounds.
1607 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
1608 "givenName": "A String", # The given name.
1609 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
1610 "metadata": { # Metadata about a field. # Metadata about the name.
1611 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1612 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1613 #
1614 # Last update timestamp of this source.
1615 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1616 #
1617 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1618 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1619 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1620 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1621 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1622 #
1623 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1624 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1625 "A String",
1626 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1627 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1628 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1629 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1630 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1631 # verified field is typically a name, email address, phone number, or
1632 # website that has been confirmed to be owned by the person.
1633 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1634 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1635 },
1636 },
1637 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1638 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1639 # with a max length of 27 characters, in the form of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1640 # `people/{person_id}`.
1641 "ageRanges": [ # Output only. The person's age ranges.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1642 { # A person's age range.
1643 "ageRange": "A String", # The age range.
1644 "metadata": { # Metadata about a field. # Metadata about the age range.
1645 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1646 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1647 #
1648 # Last update timestamp of this source.
1649 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1650 #
1651 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1652 # source. Used for web cache validation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1653 "type": "A String", # The source type.
1654 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1655 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1656 #
1657 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1658 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1659 "A String",
1660 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1661 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1662 },
1663 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1664 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1665 # verified field is typically a name, email address, phone number, or
1666 # website that has been confirmed to be owned by the person.
1667 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1668 # field.
1669 },
1670 },
1671 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1672 "birthdays": [ # The person's birthdays.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1673 { # A person's birthday. At least one of the `date` and `text` fields are
1674 # specified. The `date` and `text` fields typically represent the same
1675 # date, but are not guaranteed to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1676 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
1677 # and time zone are either specified elsewhere or are not significant. The date
1678 # is relative to the Proleptic Gregorian Calendar. This can represent:
1679 #
1680 # * A full date, with non-zero year, month and day values
1681 # * A month and day value, with a zero year, e.g. an anniversary
1682 # * A year on its own, with zero month and day values
1683 # * A year and month value, with a zero day, e.g. a credit card expiration date
1684 #
1685 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1686 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1687 # month and day.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1688 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1689 # if specifying a year by itself or a year and month where the day is not
1690 # significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1691 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1692 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1693 },
1694 "text": "A String", # A free-form string representing the user's birthday.
1695 "metadata": { # Metadata about a field. # Metadata about the birthday.
1696 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1697 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1698 #
1699 # Last update timestamp of this source.
1700 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1701 #
1702 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1703 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1704 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1705 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1706 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1707 #
1708 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1709 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1710 "A String",
1711 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1712 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1713 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1714 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1715 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1716 # verified field is typically a name, email address, phone number, or
1717 # website that has been confirmed to be owned by the person.
1718 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1719 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1720 },
1721 },
1722 ],
1723 "relations": [ # The person's relations.
1724 { # A person's relation to another person.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1725 "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
1726 # account locale or the locale specified in the Accept-Language HTTP header.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1727 "metadata": { # Metadata about a field. # Metadata about the relation.
1728 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1729 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1730 #
1731 # Last update timestamp of this source.
1732 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1733 #
1734 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1735 # source. Used for web cache validation.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1736 "type": "A String", # The source type.
1737 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1738 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1739 #
1740 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1741 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1742 "A String",
1743 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1744 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1745 },
1746 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1747 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1748 # verified field is typically a name, email address, phone number, or
1749 # website that has been confirmed to be owned by the person.
1750 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1751 # field.
1752 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1753 "type": "A String", # The person's relation to the other person. The type can be custom or one of
1754 # these predefined values:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1755 #
1756 # * `spouse`
1757 # * `child`
1758 # * `mother`
1759 # * `father`
1760 # * `parent`
1761 # * `brother`
1762 # * `sister`
1763 # * `friend`
1764 # * `relative`
1765 # * `domesticPartner`
1766 # * `manager`
1767 # * `assistant`
1768 # * `referredBy`
1769 # * `partner`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1770 "person": "A String", # The name of the other person this relation refers to.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1771 },
1772 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1773 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1774 # resource. Used for web cache validation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1775 "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
1776 # The person's relationship statuses.
1777 { # **DEPRECATED**: No data will be returned
1778 # A person's relationship status.
1779 "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1780 # the viewer's account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1781 "value": "A String", # The relationship status. The value can be custom or one of these
1782 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1783 #
1784 # * `single`
1785 # * `inARelationship`
1786 # * `engaged`
1787 # * `married`
1788 # * `itsComplicated`
1789 # * `openRelationship`
1790 # * `widowed`
1791 # * `inDomesticPartnership`
1792 # * `inCivilUnion`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1793 "metadata": { # Metadata about a field. # Metadata about the relationship status.
1794 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1795 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1796 #
1797 # Last update timestamp of this source.
1798 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1799 #
1800 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1801 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1802 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1803 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1804 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1805 #
1806 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1807 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1808 "A String",
1809 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1810 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1811 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1812 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1813 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
1814 # verified field is typically a name, email address, phone number, or
1815 # website that has been confirmed to be owned by the person.
1816 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1817 # field.
1818 },
1819 },
1820 ],
1821 "skills": [ # The person's skills.
1822 { # A skill that the person has.
1823 "value": "A String", # The skill; for example, `underwater basket weaving`.
1824 "metadata": { # Metadata about a field. # Metadata about the skill.
1825 "source": { # The source of a field. # The source of the field.
1826 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
1827 #
1828 # Last update timestamp of this source.
1829 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1830 #
1831 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1832 # source. Used for web cache validation.
1833 "type": "A String", # The source type.
1834 "id": "A String", # The unique identifier within the source type generated by the server.
1835 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
1836 #
1837 # Metadata about a source of type PROFILE.
1838 "userTypes": [ # Output only. The user types.
1839 "A String",
1840 ],
1841 "objectType": "A String", # Output only. The profile object type.
1842 },
1843 },
1844 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1845 # verified field is typically a name, email address, phone number, or
1846 # website that has been confirmed to be owned by the person.
1847 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1848 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1849 },
1850 },
1851 ],
1852 "imClients": [ # The person's instant messaging clients.
1853 { # A person's instant messaging client.
1854 "username": "A String", # The user name used in the IM client.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1855 "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1856 # viewer's account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1857 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
1858 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1859 #
1860 # * `aim`
1861 # * `msn`
1862 # * `yahoo`
1863 # * `skype`
1864 # * `qq`
1865 # * `googleTalk`
1866 # * `icq`
1867 # * `jabber`
1868 # * `netMeeting`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1869 "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1870 # locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1871 "type": "A String", # The type of the IM client. The type can be custom or one of these
1872 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1873 #
1874 # * `home`
1875 # * `work`
1876 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1877 "metadata": { # Metadata about a field. # Metadata about the IM client.
1878 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1879 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1880 #
1881 # Last update timestamp of this source.
1882 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1883 #
1884 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1885 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1886 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1887 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1888 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1889 #
1890 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1891 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1892 "A String",
1893 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1894 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1895 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1896 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1897 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1898 # verified field is typically a name, email address, phone number, or
1899 # website that has been confirmed to be owned by the person.
1900 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1901 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1902 },
1903 },
1904 ],
1905 "events": [ # The person's events.
1906 { # An event related to the person.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1907 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
1908 # and time zone are either specified elsewhere or are not significant. The date
1909 # is relative to the Proleptic Gregorian Calendar. This can represent:
1910 #
1911 # * A full date, with non-zero year, month and day values
1912 # * A month and day value, with a zero year, e.g. an anniversary
1913 # * A year on its own, with zero month and day values
1914 # * A year and month value, with a zero day, e.g. a credit card expiration date
1915 #
1916 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1917 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1918 # month and day.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1919 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1920 # if specifying a year by itself or a year and month where the day is not
1921 # significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1922 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1923 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1924 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1925 "formattedType": "A String", # Output only. The type of the event translated and formatted in the
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1926 # viewer's account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1927 "type": "A String", # The type of the event. The type can be custom or one of these predefined
1928 # values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1929 #
1930 # * `anniversary`
1931 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1932 "metadata": { # Metadata about a field. # Metadata about the event.
1933 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1934 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1935 #
1936 # Last update timestamp of this source.
1937 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1938 #
1939 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1940 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1941 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1942 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1943 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1944 #
1945 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1946 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1947 "A String",
1948 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1949 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1950 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1951 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1952 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1953 # verified field is typically a name, email address, phone number, or
1954 # website that has been confirmed to be owned by the person.
1955 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1956 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1957 },
1958 },
1959 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1960 "metadata": { # The metadata about a person. # Output only. Metadata about the person.
1961 "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for
1962 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
1963 # that include a sync token.
1964 "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1965 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
1966 # that include a sync token.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1967 #
1968 # The resource name may change when adding or removing fields that link a
1969 # contact and profile such as a verified email, verified phone number, or
1970 # profile URL.
1971 "A String",
1972 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1973 "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
1974 "A String",
1975 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1976 "sources": [ # The sources of data for the person.
1977 { # The source of a field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1978 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1979 #
1980 # Last update timestamp of this source.
1981 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1982 #
1983 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1984 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1985 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1986 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1987 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1988 #
1989 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1990 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1991 "A String",
1992 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1993 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1994 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1995 },
1996 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1997 "objectType": "A String", # Output only. **DEPRECATED** (Please use
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1998 # `person.metadata.sources.profileMetadata.objectType` instead)
1999 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2000 # The type of the person object.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2001 },
2002 "interests": [ # The person's interests.
2003 { # One of the person's interests.
2004 "value": "A String", # The interest; for example, `stargazing`.
2005 "metadata": { # Metadata about a field. # Metadata about the interest.
2006 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2007 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2008 #
2009 # Last update timestamp of this source.
2010 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2011 #
2012 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2013 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2014 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2015 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2016 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2017 #
2018 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2019 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2020 "A String",
2021 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2022 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2023 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2024 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2025 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2026 # verified field is typically a name, email address, phone number, or
2027 # website that has been confirmed to be owned by the person.
2028 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2029 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2030 },
2031 },
2032 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2033 "photos": [ # Output only. The person's photos.
2034 { # A person's photo. A picture shown next to the person's name to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2035 # help others recognize the person.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2036 "default": True or False, # True if the photo is a default photo;
2037 # false if the photo is a user-provided photo.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2038 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2039 # parameter `sz={size}` at the end of the url, where {size} is the size in
2040 # pixels. Example:
2041 # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2042 "metadata": { # Metadata about a field. # Metadata about the photo.
2043 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2044 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2045 #
2046 # Last update timestamp of this source.
2047 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2048 #
2049 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2050 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2051 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2052 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2053 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2054 #
2055 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2056 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2057 "A String",
2058 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2059 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2060 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2061 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2062 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2063 # verified field is typically a name, email address, phone number, or
2064 # website that has been confirmed to be owned by the person.
2065 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2066 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2067 },
2068 },
2069 ],
2070 "residences": [ # The person's residences.
2071 { # A person's past or current residence.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2072 "current": True or False, # True if the residence is the person's current residence;
2073 # false if the residence is a past residence.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2074 "value": "A String", # The address of the residence.
2075 "metadata": { # Metadata about a field. # Metadata about the residence.
2076 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2077 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2078 #
2079 # Last update timestamp of this source.
2080 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2081 #
2082 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2083 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2084 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2085 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2086 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2087 #
2088 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2089 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2090 "A String",
2091 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2092 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2093 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2094 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2095 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2096 # verified field is typically a name, email address, phone number, or
2097 # website that has been confirmed to be owned by the person.
2098 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2099 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2100 },
2101 },
2102 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2103 "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
2104 # The person's relationship interests.
2105 { # **DEPRECATED**: No data will be returned
2106 # A person's relationship interest .
2107 "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
2108 # in the viewer's account locale or the locale specified in the
2109 # Accept-Language HTTP header.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2110 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2111 # or one of these predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2112 #
2113 # * `friend`
2114 # * `date`
2115 # * `relationship`
2116 # * `networking`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2117 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
2118 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2119 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2120 #
2121 # Last update timestamp of this source.
2122 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2123 #
2124 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2125 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2126 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2127 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2128 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2129 #
2130 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2131 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2132 "A String",
2133 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2134 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2135 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2136 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2137 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2138 # verified field is typically a name, email address, phone number, or
2139 # website that has been confirmed to be owned by the person.
2140 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2141 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2142 },
2143 },
2144 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2145 "coverPhotos": [ # Output only. The person's cover photos.
2146 { # A person's cover photo. A large image shown on the person's
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2147 # profile page that represents who they are or what they care about.
2148 "default": True or False, # True if the cover photo is the default cover photo;
2149 # false if the cover photo is a user-provided cover photo.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2150 "url": "A String", # The URL of the cover photo.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2151 "metadata": { # Metadata about a field. # Metadata about the cover photo.
2152 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2153 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2154 #
2155 # Last update timestamp of this source.
2156 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2157 #
2158 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2159 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2160 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2161 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2162 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2163 #
2164 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2165 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2166 "A String",
2167 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2168 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2169 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2170 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2171 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2172 # verified field is typically a name, email address, phone number, or
2173 # website that has been confirmed to be owned by the person.
2174 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2175 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2176 },
2177 },
2178 ],
2179 "locales": [ # The person's locale preferences.
2180 { # A person's locale preference.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2181 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
2182 # language tag representing the locale.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2183 "metadata": { # Metadata about a field. # Metadata about the locale.
2184 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2185 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2186 #
2187 # Last update timestamp of this source.
2188 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2189 #
2190 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2191 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2192 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2193 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2194 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2195 #
2196 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2197 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2198 "A String",
2199 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2200 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2201 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2202 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2203 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2204 # verified field is typically a name, email address, phone number, or
2205 # website that has been confirmed to be owned by the person.
2206 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2207 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2208 },
2209 },
2210 ],
2211 "organizations": [ # The person's past or current organizations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2212 { # A person's past or current organization. Overlapping date ranges are
2213 # permitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2214 "formattedType": "A String", # Output only. The type of the organization translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2215 # viewer's account locale or the `Accept-Language` HTTP header locale.
2216 "domain": "A String", # The domain name associated with the organization; for example,
2217 # `google.com`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2218 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.
2219 # and time zone are either specified elsewhere or are not significant. The date
2220 # is relative to the Proleptic Gregorian Calendar. This can represent:
2221 #
2222 # * A full date, with non-zero year, month and day values
2223 # * A month and day value, with a zero year, e.g. an anniversary
2224 # * A year on its own, with zero month and day values
2225 # * A year and month value, with a zero day, e.g. a credit card expiration date
2226 #
2227 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2228 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
2229 # month and day.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2230 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2231 # if specifying a year by itself or a year and month where the day is not
2232 # significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]2233 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
2234 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2235 },
2236 "name": "A String", # The name of the organization.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]2237 "title": "A String", # The person's job title at the organization.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2238 "type": "A String", # The type of the organization. The type can be custom or one of these
2239 # predefined values:
2240 #
2241 # * `work`
2242 # * `school`
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2243 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
2244 # symbol, abbreviation, or acronym.
2245 "current": True or False, # True if the organization is the person's current organization;
2246 # false if the organization is a past organization.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2247 "jobDescription": "A String", # The person's job description at the organization.
2248 "location": "A String", # The location of the organization office the person works at.
2249 "department": "A String", # The person's department at the organization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2250 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.
2251 # and time zone are either specified elsewhere or are not significant. The date
2252 # is relative to the Proleptic Gregorian Calendar. This can represent:
2253 #
2254 # * A full date, with non-zero year, month and day values
2255 # * A month and day value, with a zero year, e.g. an anniversary
2256 # * A year on its own, with zero month and day values
2257 # * A year and month value, with a zero day, e.g. a credit card expiration date
2258 #
2259 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2260 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
2261 # month and day.
2262 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
2263 # if specifying a year by itself or a year and month where the day is not
2264 # significant.
2265 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
2266 # a year.
2267 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2268 "phoneticName": "A String", # The phonetic name of the organization.
2269 "metadata": { # Metadata about a field. # Metadata about the organization.
2270 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2271 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2272 #
2273 # Last update timestamp of this source.
2274 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2275 #
2276 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2277 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2278 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2279 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2280 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2281 #
2282 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2283 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2284 "A String",
2285 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2286 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2287 },
2288 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2289 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2290 # verified field is typically a name, email address, phone number, or
2291 # website that has been confirmed to be owned by the person.
2292 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2293 # field.
2294 },
2295 },
2296 ],
2297 "userDefined": [ # The person's user defined data.
2298 { # Arbitrary user data that is populated by the end users.
2299 "key": "A String", # The end user specified key of the user defined data.
2300 "value": "A String", # The end user specified value of the user defined data.
2301 "metadata": { # Metadata about a field. # Metadata about the user defined data.
2302 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2303 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2304 #
2305 # Last update timestamp of this source.
2306 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2307 #
2308 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2309 # source. Used for web cache validation.
2310 "type": "A String", # The source type.
2311 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2312 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2313 #
2314 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2315 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2316 "A String",
2317 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2318 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2319 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2320 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2321 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2322 # verified field is typically a name, email address, phone number, or
2323 # website that has been confirmed to be owned by the person.
2324 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2325 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2326 },
2327 },
2328 ],
2329 "biographies": [ # The person's biographies.
2330 { # A person's short biography.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2331 "contentType": "A String", # The content type of the biography.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2332 "value": "A String", # The short biography.
2333 "metadata": { # Metadata about a field. # Metadata about the biography.
2334 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2335 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2336 #
2337 # Last update timestamp of this source.
2338 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2339 #
2340 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2341 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2342 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2343 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2344 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2345 #
2346 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2347 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2348 "A String",
2349 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2350 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2351 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2352 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2353 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2354 # verified field is typically a name, email address, phone number, or
2355 # website that has been confirmed to be owned by the person.
2356 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2357 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2358 },
2359 },
2360 ],
2361 "memberships": [ # The person's group memberships.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2362 { # A person's membership in a group. Only contact group memberships can be
2363 # modified.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2364 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2365 "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2366 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2367 # string, in the form of `contactGroups/{contact_group_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2368 # Only contact_group_resource_name can be used for modifying memberships.
2369 # Any contact group membership can be removed, but only user group or
2370 # "myContacts" or "starred" system groups memberships can be added. A
2371 # contact must always have at least one contact group membership.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2372 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2373 "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2374 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2375 },
2376 "metadata": { # Metadata about a field. # Metadata about the membership.
2377 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2378 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2379 #
2380 # Last update timestamp of this source.
2381 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2382 #
2383 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2384 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2385 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2386 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2387 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2388 #
2389 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2390 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2391 "A String",
2392 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2393 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2394 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2395 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2396 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2397 # verified field is typically a name, email address, phone number, or
2398 # website that has been confirmed to be owned by the person.
2399 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2400 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2401 },
2402 },
2403 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2404 "taglines": [ # Output only. **DEPRECATED**: No data will be returned
2405 # The person's taglines.
2406 { # **DEPRECATED**: No data will be returned
2407 # A brief one-line description of the person.
2408 "value": "A String", # The tagline.
2409 "metadata": { # Metadata about a field. # Metadata about the tagline.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2410 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2411 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2412 #
2413 # Last update timestamp of this source.
2414 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2415 #
2416 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2417 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2418 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2419 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2420 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2421 #
2422 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2423 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2424 "A String",
2425 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2426 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2427 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2428 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2429 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2430 # verified field is typically a name, email address, phone number, or
2431 # website that has been confirmed to be owned by the person.
2432 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2433 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2434 },
2435 },
2436 ],
2437 "urls": [ # The person's associated URLs.
2438 { # A person's associated URLs.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2439 "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2440 # account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2441 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
2442 # values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2443 #
2444 # * `home`
2445 # * `work`
2446 # * `blog`
2447 # * `profile`
2448 # * `homePage`
2449 # * `ftp`
2450 # * `reservations`
2451 # * `appInstallPage`: website for a Google+ application.
2452 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2453 "value": "A String", # The URL.
2454 "metadata": { # Metadata about a field. # Metadata about the URL.
2455 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2456 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2457 #
2458 # Last update timestamp of this source.
2459 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2460 #
2461 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2462 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2463 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2464 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2465 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2466 #
2467 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2468 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2469 "A String",
2470 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2471 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2472 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2473 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2474 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2475 # verified field is typically a name, email address, phone number, or
2476 # website that has been confirmed to be owned by the person.
2477 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2478 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2479 },
2480 },
2481 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2482 "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
2483 #
2484 # The person's age range.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2485 "genders": [ # The person's genders.
2486 { # A person's gender.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2487 "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account
2488 # locale or the `Accept-Language` HTTP header locale. Unspecified or custom
2489 # value are not localized.
2490 "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value
2491 # can be custom or one of these predefined values:
2492 #
2493 # * `male`
2494 # * `female`
2495 # * `other`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2496 "value": "A String", # The gender for the person. The gender can be custom or one of these
2497 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2498 #
2499 # * `male`
2500 # * `female`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2501 # * `unspecified`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2502 "metadata": { # Metadata about a field. # Metadata about the gender.
2503 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2504 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2505 #
2506 # Last update timestamp of this source.
2507 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2508 #
2509 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2510 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2511 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2512 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2513 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2514 #
2515 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2516 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2517 "A String",
2518 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2519 "objectType": "A String", # Output only. The profile object type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2520 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2521 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2522 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2523 # verified field is typically a name, email address, phone number, or
2524 # website that has been confirmed to be owned by the person.
2525 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2526 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2527 },
2528 },
2529 ],
2530 "emailAddresses": [ # The person's email addresses.
2531 { # A person's email address.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2532 "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
2533 # viewer's account locale or the `Accept-Language` HTTP header locale.
2534 "metadata": { # Metadata about a field. # Metadata about the email address.
2535 "source": { # The source of a field. # The source of the field.
2536 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
2537 #
2538 # Last update timestamp of this source.
2539 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2540 #
2541 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2542 # source. Used for web cache validation.
2543 "type": "A String", # The source type.
2544 "id": "A String", # The unique identifier within the source type generated by the server.
2545 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
2546 #
2547 # Metadata about a source of type PROFILE.
2548 "userTypes": [ # Output only. The user types.
2549 "A String",
2550 ],
2551 "objectType": "A String", # Output only. The profile object type.
2552 },
2553 },
2554 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
2555 # verified field is typically a name, email address, phone number, or
2556 # website that has been confirmed to be owned by the person.
2557 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2558 # field.
2559 },
2560 "displayName": "A String", # The display name of the email.
2561 "value": "A String", # The email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2562 "type": "A String", # The type of the email address. The type can be custom or one of these
2563 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]2564 #
2565 # * `home`
2566 # * `work`
2567 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]2568 },
2569 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2570 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2571</div>
2572
2573<div class="method">
2574 <code class="details" id="deleteContact">deleteContact(resourceName, x__xgafv=None)</code>
2575 <pre>Delete a contact person. Any non-contact data will not be deleted.
2576
2577Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2578 resourceName: string, Required. The resource name of the contact to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2579 x__xgafv: string, V1 error format.
2580 Allowed values
2581 1 - v1 error format
2582 2 - v2 error format
2583
2584Returns:
2585 An object of the form:
2586
2587 { # A generic empty message that you can re-use to avoid defining duplicated
2588 # empty messages in your APIs. A typical example is to use it as the request
2589 # or the response type of an API method. For instance:
2590 #
2591 # service Foo {
2592 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
2593 # }
2594 #
2595 # The JSON representation for `Empty` is empty JSON object `{}`.
2596 }</pre>
2597</div>
2598
2599<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2600 <code class="details" id="deleteContactPhoto">deleteContactPhoto(resourceName, x__xgafv=None, personFields=None)</code>
2601 <pre>Delete a contact's photo.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2602
2603Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2604 resourceName: string, Required. The resource name of the contact whose photo will be deleted. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2605 x__xgafv: string, V1 error format.
2606 Allowed values
2607 1 - v1 error format
2608 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2609 personFields: string, Optional. A field mask to restrict which fields on the person are returned. Multiple
2610fields can be specified by separating them with commas. Defaults to empty
2611if not set, which will skip the post mutate get. Valid values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2612
2613* addresses
2614* ageRanges
2615* biographies
2616* birthdays
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2617* coverPhotos
2618* emailAddresses
2619* events
2620* genders
2621* imClients
2622* interests
2623* locales
2624* memberships
2625* metadata
2626* names
2627* nicknames
2628* occupations
2629* organizations
2630* phoneNumbers
2631* photos
2632* relations
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2633* residences
2634* sipAddresses
2635* skills
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2636* urls
2637* userDefined
2638
2639Returns:
2640 An object of the form:
2641
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2642 { # The response for deleteing a contact's photo.
2643 "person": { # Information about a person merged from various data sources such as the # The updated person, if person_fields is set in the
2644 # DeleteContactPhotoRequest; otherwise this will be unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2645 # authenticated user's contacts and profile data.
2646 #
2647 # Most fields can have multiple items. The items in a field have no guaranteed
2648 # order, but each non-empty field is guaranteed to have exactly one field with
2649 # `metadata.primary` set to true.
2650 "sipAddresses": [ # The person's SIP addresses.
2651 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
2652 # communications to make voice or video calls over the internet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2653 "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2654 # viewer's account locale or the `Accept-Language` HTTP header locale.
2655 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
2656 # predefined values:
2657 #
2658 # * `home`
2659 # * `work`
2660 # * `mobile`
2661 # * `other`
2662 "value": "A String", # The SIP address in the
2663 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
2664 # format.
2665 "metadata": { # Metadata about a field. # Metadata about the SIP address.
2666 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2667 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2668 #
2669 # Last update timestamp of this source.
2670 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2671 #
2672 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2673 # source. Used for web cache validation.
2674 "type": "A String", # The source type.
2675 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2676 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2677 #
2678 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2679 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2680 "A String",
2681 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2682 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2683 },
2684 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2685 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2686 # verified field is typically a name, email address, phone number, or
2687 # website that has been confirmed to be owned by the person.
2688 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2689 # field.
2690 },
2691 },
2692 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2693 "braggingRights": [ # **DEPRECATED**: No data will be returned
2694 # The person's bragging rights.
2695 { # **DEPRECATED**: No data will be returned
2696 # A person's bragging rights.
2697 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
2698 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2699 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2700 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2701 #
2702 # Last update timestamp of this source.
2703 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2704 #
2705 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2706 # source. Used for web cache validation.
2707 "type": "A String", # The source type.
2708 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2709 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2710 #
2711 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2712 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2713 "A String",
2714 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2715 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2716 },
2717 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2718 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2719 # verified field is typically a name, email address, phone number, or
2720 # website that has been confirmed to be owned by the person.
2721 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2722 # field.
2723 },
2724 },
2725 ],
2726 "addresses": [ # The person's street addresses.
2727 { # A person's physical address. May be a P.O. box or street address. All fields
2728 # are optional.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2729 "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2730 # account locale or the `Accept-Language` HTTP header locale.
2731 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
2732 # code of the address.
2733 "city": "A String", # The city of the address.
2734 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
2735 # will be automatically constructed from structured values.
2736 "region": "A String", # The region of the address; for example, the state or province.
2737 "poBox": "A String", # The P.O. box of the address.
2738 "streetAddress": "A String", # The street address.
2739 "country": "A String", # The country of the address.
2740 "postalCode": "A String", # The postal code of the address.
2741 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
2742 "type": "A String", # The type of the address. The type can be custom or one of these predefined
2743 # values:
2744 #
2745 # * `home`
2746 # * `work`
2747 # * `other`
2748 "metadata": { # Metadata about a field. # Metadata about the address.
2749 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2750 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2751 #
2752 # Last update timestamp of this source.
2753 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2754 #
2755 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2756 # source. Used for web cache validation.
2757 "type": "A String", # The source type.
2758 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2759 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2760 #
2761 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2762 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2763 "A String",
2764 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2765 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2766 },
2767 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2768 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2769 # verified field is typically a name, email address, phone number, or
2770 # website that has been confirmed to be owned by the person.
2771 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2772 # field.
2773 },
2774 },
2775 ],
2776 "nicknames": [ # The person's nicknames.
2777 { # A person's nickname.
2778 "type": "A String", # The type of the nickname.
2779 "value": "A String", # The nickname.
2780 "metadata": { # Metadata about a field. # Metadata about the nickname.
2781 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2782 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2783 #
2784 # Last update timestamp of this source.
2785 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2786 #
2787 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2788 # source. Used for web cache validation.
2789 "type": "A String", # The source type.
2790 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2791 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2792 #
2793 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2794 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2795 "A String",
2796 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2797 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2798 },
2799 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2800 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2801 # verified field is typically a name, email address, phone number, or
2802 # website that has been confirmed to be owned by the person.
2803 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2804 # field.
2805 },
2806 },
2807 ],
2808 "occupations": [ # The person's occupations.
2809 { # A person's occupation.
2810 "value": "A String", # The occupation; for example, `carpenter`.
2811 "metadata": { # Metadata about a field. # Metadata about the occupation.
2812 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2813 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2814 #
2815 # Last update timestamp of this source.
2816 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2817 #
2818 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2819 # source. Used for web cache validation.
2820 "type": "A String", # The source type.
2821 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2822 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2823 #
2824 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2825 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2826 "A String",
2827 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2828 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2829 },
2830 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2831 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2832 # verified field is typically a name, email address, phone number, or
2833 # website that has been confirmed to be owned by the person.
2834 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2835 # field.
2836 },
2837 },
2838 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2839 "phoneNumbers": [ # The person's phone numbers.
2840 { # A person's phone number.
2841 "canonicalForm": "A String", # Output only. The canonicalized [ITU-T
2842 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
2843 # form of the phone number.
2844 "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the
2845 # viewer's account locale or the `Accept-Language` HTTP header locale.
2846 "type": "A String", # The type of the phone number. The type can be custom or one of these
2847 # predefined values:
2848 #
2849 # * `home`
2850 # * `work`
2851 # * `mobile`
2852 # * `homeFax`
2853 # * `workFax`
2854 # * `otherFax`
2855 # * `pager`
2856 # * `workMobile`
2857 # * `workPager`
2858 # * `main`
2859 # * `googleVoice`
2860 # * `other`
2861 "value": "A String", # The phone number.
2862 "metadata": { # Metadata about a field. # Metadata about the phone number.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2863 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2864 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2865 #
2866 # Last update timestamp of this source.
2867 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2868 #
2869 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2870 # source. Used for web cache validation.
2871 "type": "A String", # The source type.
2872 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2873 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2874 #
2875 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2876 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2877 "A String",
2878 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2879 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2880 },
2881 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2882 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2883 # verified field is typically a name, email address, phone number, or
2884 # website that has been confirmed to be owned by the person.
2885 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2886 # field.
2887 },
2888 },
2889 ],
2890 "names": [ # The person's names.
2891 { # A person's name. If the name is a mononym, the family name is empty.
2892 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
2893 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2894 "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2895 # the locale specified by the viewer's account or the
2896 # `Accept-Language` HTTP header.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2897 "displayName": "A String", # Output only. The display name formatted according to the locale specified by
2898 # the viewer's account or the `Accept-Language` HTTP header.
2899 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2900 "middleName": "A String", # The middle name(s).
2901 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
2902 "familyName": "A String", # The family name.
2903 "phoneticFullName": "A String", # The full name spelled as it sounds.
2904 "phoneticGivenName": "A String", # The given name spelled as it sounds.
2905 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
2906 "givenName": "A String", # The given name.
2907 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
2908 "metadata": { # Metadata about a field. # Metadata about the name.
2909 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2910 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2911 #
2912 # Last update timestamp of this source.
2913 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2914 #
2915 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2916 # source. Used for web cache validation.
2917 "type": "A String", # The source type.
2918 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2919 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2920 #
2921 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2922 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2923 "A String",
2924 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2925 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2926 },
2927 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2928 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2929 # verified field is typically a name, email address, phone number, or
2930 # website that has been confirmed to be owned by the person.
2931 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2932 # field.
2933 },
2934 },
2935 ],
2936 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
2937 # with a max length of 27 characters, in the form of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2938 # `people/{person_id}`.
2939 "ageRanges": [ # Output only. The person's age ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2940 { # A person's age range.
2941 "ageRange": "A String", # The age range.
2942 "metadata": { # Metadata about a field. # Metadata about the age range.
2943 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2944 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2945 #
2946 # Last update timestamp of this source.
2947 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2948 #
2949 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2950 # source. Used for web cache validation.
2951 "type": "A String", # The source type.
2952 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2953 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2954 #
2955 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2956 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2957 "A String",
2958 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2959 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2960 },
2961 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2962 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2963 # verified field is typically a name, email address, phone number, or
2964 # website that has been confirmed to be owned by the person.
2965 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2966 # field.
2967 },
2968 },
2969 ],
2970 "birthdays": [ # The person's birthdays.
2971 { # A person's birthday. At least one of the `date` and `text` fields are
2972 # specified. The `date` and `text` fields typically represent the same
2973 # date, but are not guaranteed to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2974 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
2975 # and time zone are either specified elsewhere or are not significant. The date
2976 # is relative to the Proleptic Gregorian Calendar. This can represent:
2977 #
2978 # * A full date, with non-zero year, month and day values
2979 # * A month and day value, with a zero year, e.g. an anniversary
2980 # * A year on its own, with zero month and day values
2981 # * A year and month value, with a zero day, e.g. a credit card expiration date
2982 #
2983 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2984 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
2985 # month and day.
2986 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
2987 # if specifying a year by itself or a year and month where the day is not
2988 # significant.
2989 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
2990 # a year.
2991 },
2992 "text": "A String", # A free-form string representing the user's birthday.
2993 "metadata": { # Metadata about a field. # Metadata about the birthday.
2994 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2995 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2996 #
2997 # Last update timestamp of this source.
2998 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2999 #
3000 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3001 # source. Used for web cache validation.
3002 "type": "A String", # The source type.
3003 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3004 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3005 #
3006 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3007 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3008 "A String",
3009 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3010 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3011 },
3012 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3013 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3014 # verified field is typically a name, email address, phone number, or
3015 # website that has been confirmed to be owned by the person.
3016 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3017 # field.
3018 },
3019 },
3020 ],
3021 "relations": [ # The person's relations.
3022 { # A person's relation to another person.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3023 "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
3024 # account locale or the locale specified in the Accept-Language HTTP header.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3025 "metadata": { # Metadata about a field. # Metadata about the relation.
3026 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3027 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3028 #
3029 # Last update timestamp of this source.
3030 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3031 #
3032 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3033 # source. Used for web cache validation.
3034 "type": "A String", # The source type.
3035 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3036 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3037 #
3038 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3039 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3040 "A String",
3041 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3042 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3043 },
3044 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3045 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3046 # verified field is typically a name, email address, phone number, or
3047 # website that has been confirmed to be owned by the person.
3048 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3049 # field.
3050 },
3051 "type": "A String", # The person's relation to the other person. The type can be custom or one of
3052 # these predefined values:
3053 #
3054 # * `spouse`
3055 # * `child`
3056 # * `mother`
3057 # * `father`
3058 # * `parent`
3059 # * `brother`
3060 # * `sister`
3061 # * `friend`
3062 # * `relative`
3063 # * `domesticPartner`
3064 # * `manager`
3065 # * `assistant`
3066 # * `referredBy`
3067 # * `partner`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3068 "person": "A String", # The name of the other person this relation refers to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3069 },
3070 ],
3071 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3072 # resource. Used for web cache validation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3073 "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
3074 # The person's relationship statuses.
3075 { # **DEPRECATED**: No data will be returned
3076 # A person's relationship status.
3077 "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3078 # the viewer's account locale or the `Accept-Language` HTTP header locale.
3079 "value": "A String", # The relationship status. The value can be custom or one of these
3080 # predefined values:
3081 #
3082 # * `single`
3083 # * `inARelationship`
3084 # * `engaged`
3085 # * `married`
3086 # * `itsComplicated`
3087 # * `openRelationship`
3088 # * `widowed`
3089 # * `inDomesticPartnership`
3090 # * `inCivilUnion`
3091 "metadata": { # Metadata about a field. # Metadata about the relationship status.
3092 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3093 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3094 #
3095 # Last update timestamp of this source.
3096 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3097 #
3098 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3099 # source. Used for web cache validation.
3100 "type": "A String", # The source type.
3101 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3102 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3103 #
3104 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3105 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3106 "A String",
3107 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3108 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3109 },
3110 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3111 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
3112 # verified field is typically a name, email address, phone number, or
3113 # website that has been confirmed to be owned by the person.
3114 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3115 # field.
3116 },
3117 },
3118 ],
3119 "skills": [ # The person's skills.
3120 { # A skill that the person has.
3121 "value": "A String", # The skill; for example, `underwater basket weaving`.
3122 "metadata": { # Metadata about a field. # Metadata about the skill.
3123 "source": { # The source of a field. # The source of the field.
3124 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
3125 #
3126 # Last update timestamp of this source.
3127 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3128 #
3129 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3130 # source. Used for web cache validation.
3131 "type": "A String", # The source type.
3132 "id": "A String", # The unique identifier within the source type generated by the server.
3133 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
3134 #
3135 # Metadata about a source of type PROFILE.
3136 "userTypes": [ # Output only. The user types.
3137 "A String",
3138 ],
3139 "objectType": "A String", # Output only. The profile object type.
3140 },
3141 },
3142 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3143 # verified field is typically a name, email address, phone number, or
3144 # website that has been confirmed to be owned by the person.
3145 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3146 # field.
3147 },
3148 },
3149 ],
3150 "imClients": [ # The person's instant messaging clients.
3151 { # A person's instant messaging client.
3152 "username": "A String", # The user name used in the IM client.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3153 "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3154 # viewer's account locale or the `Accept-Language` HTTP header locale.
3155 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
3156 # predefined values:
3157 #
3158 # * `aim`
3159 # * `msn`
3160 # * `yahoo`
3161 # * `skype`
3162 # * `qq`
3163 # * `googleTalk`
3164 # * `icq`
3165 # * `jabber`
3166 # * `netMeeting`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3167 "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3168 # locale or the `Accept-Language` HTTP header locale.
3169 "type": "A String", # The type of the IM client. The type can be custom or one of these
3170 # predefined values:
3171 #
3172 # * `home`
3173 # * `work`
3174 # * `other`
3175 "metadata": { # Metadata about a field. # Metadata about the IM client.
3176 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3177 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3178 #
3179 # Last update timestamp of this source.
3180 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3181 #
3182 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3183 # source. Used for web cache validation.
3184 "type": "A String", # The source type.
3185 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3186 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3187 #
3188 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3189 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3190 "A String",
3191 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3192 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3193 },
3194 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3195 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3196 # verified field is typically a name, email address, phone number, or
3197 # website that has been confirmed to be owned by the person.
3198 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3199 # field.
3200 },
3201 },
3202 ],
3203 "events": [ # The person's events.
3204 { # An event related to the person.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3205 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
3206 # and time zone are either specified elsewhere or are not significant. The date
3207 # is relative to the Proleptic Gregorian Calendar. This can represent:
3208 #
3209 # * A full date, with non-zero year, month and day values
3210 # * A month and day value, with a zero year, e.g. an anniversary
3211 # * A year on its own, with zero month and day values
3212 # * A year and month value, with a zero day, e.g. a credit card expiration date
3213 #
3214 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3215 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
3216 # month and day.
3217 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
3218 # if specifying a year by itself or a year and month where the day is not
3219 # significant.
3220 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
3221 # a year.
3222 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3223 "formattedType": "A String", # Output only. The type of the event translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3224 # viewer's account locale or the `Accept-Language` HTTP header locale.
3225 "type": "A String", # The type of the event. The type can be custom or one of these predefined
3226 # values:
3227 #
3228 # * `anniversary`
3229 # * `other`
3230 "metadata": { # Metadata about a field. # Metadata about the event.
3231 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3232 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3233 #
3234 # Last update timestamp of this source.
3235 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3236 #
3237 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3238 # source. Used for web cache validation.
3239 "type": "A String", # The source type.
3240 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3241 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3242 #
3243 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3244 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3245 "A String",
3246 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3247 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3248 },
3249 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3250 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3251 # verified field is typically a name, email address, phone number, or
3252 # website that has been confirmed to be owned by the person.
3253 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3254 # field.
3255 },
3256 },
3257 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3258 "metadata": { # The metadata about a person. # Output only. Metadata about the person.
3259 "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for
3260 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
3261 # that include a sync token.
3262 "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3263 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
3264 # that include a sync token.
3265 #
3266 # The resource name may change when adding or removing fields that link a
3267 # contact and profile such as a verified email, verified phone number, or
3268 # profile URL.
3269 "A String",
3270 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3271 "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
3272 "A String",
3273 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3274 "sources": [ # The sources of data for the person.
3275 { # The source of a field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3276 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3277 #
3278 # Last update timestamp of this source.
3279 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3280 #
3281 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3282 # source. Used for web cache validation.
3283 "type": "A String", # The source type.
3284 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3285 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3286 #
3287 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3288 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3289 "A String",
3290 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3291 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3292 },
3293 },
3294 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3295 "objectType": "A String", # Output only. **DEPRECATED** (Please use
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3296 # `person.metadata.sources.profileMetadata.objectType` instead)
3297 #
3298 # The type of the person object.
3299 },
3300 "interests": [ # The person's interests.
3301 { # One of the person's interests.
3302 "value": "A String", # The interest; for example, `stargazing`.
3303 "metadata": { # Metadata about a field. # Metadata about the interest.
3304 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3305 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3306 #
3307 # Last update timestamp of this source.
3308 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3309 #
3310 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3311 # source. Used for web cache validation.
3312 "type": "A String", # The source type.
3313 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3314 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3315 #
3316 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3317 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3318 "A String",
3319 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3320 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3321 },
3322 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3323 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3324 # verified field is typically a name, email address, phone number, or
3325 # website that has been confirmed to be owned by the person.
3326 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3327 # field.
3328 },
3329 },
3330 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3331 "photos": [ # Output only. The person's photos.
3332 { # A person's photo. A picture shown next to the person's name to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3333 # help others recognize the person.
3334 "default": True or False, # True if the photo is a default photo;
3335 # false if the photo is a user-provided photo.
3336 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3337 # parameter `sz={size}` at the end of the url, where {size} is the size in
3338 # pixels. Example:
3339 # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3340 "metadata": { # Metadata about a field. # Metadata about the photo.
3341 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3342 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3343 #
3344 # Last update timestamp of this source.
3345 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3346 #
3347 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3348 # source. Used for web cache validation.
3349 "type": "A String", # The source type.
3350 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3351 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3352 #
3353 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3354 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3355 "A String",
3356 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3357 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3358 },
3359 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3360 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3361 # verified field is typically a name, email address, phone number, or
3362 # website that has been confirmed to be owned by the person.
3363 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3364 # field.
3365 },
3366 },
3367 ],
3368 "residences": [ # The person's residences.
3369 { # A person's past or current residence.
3370 "current": True or False, # True if the residence is the person's current residence;
3371 # false if the residence is a past residence.
3372 "value": "A String", # The address of the residence.
3373 "metadata": { # Metadata about a field. # Metadata about the residence.
3374 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3375 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3376 #
3377 # Last update timestamp of this source.
3378 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3379 #
3380 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3381 # source. Used for web cache validation.
3382 "type": "A String", # The source type.
3383 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3384 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3385 #
3386 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3387 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3388 "A String",
3389 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3390 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3391 },
3392 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3393 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3394 # verified field is typically a name, email address, phone number, or
3395 # website that has been confirmed to be owned by the person.
3396 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3397 # field.
3398 },
3399 },
3400 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3401 "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
3402 # The person's relationship interests.
3403 { # **DEPRECATED**: No data will be returned
3404 # A person's relationship interest .
3405 "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
3406 # in the viewer's account locale or the locale specified in the
3407 # Accept-Language HTTP header.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3408 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
3409 # or one of these predefined values:
3410 #
3411 # * `friend`
3412 # * `date`
3413 # * `relationship`
3414 # * `networking`
3415 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
3416 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3417 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3418 #
3419 # Last update timestamp of this source.
3420 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3421 #
3422 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3423 # source. Used for web cache validation.
3424 "type": "A String", # The source type.
3425 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3426 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3427 #
3428 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3429 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3430 "A String",
3431 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3432 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3433 },
3434 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3435 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3436 # verified field is typically a name, email address, phone number, or
3437 # website that has been confirmed to be owned by the person.
3438 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3439 # field.
3440 },
3441 },
3442 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3443 "coverPhotos": [ # Output only. The person's cover photos.
3444 { # A person's cover photo. A large image shown on the person's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3445 # profile page that represents who they are or what they care about.
3446 "default": True or False, # True if the cover photo is the default cover photo;
3447 # false if the cover photo is a user-provided cover photo.
3448 "url": "A String", # The URL of the cover photo.
3449 "metadata": { # Metadata about a field. # Metadata about the cover photo.
3450 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3451 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3452 #
3453 # Last update timestamp of this source.
3454 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3455 #
3456 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3457 # source. Used for web cache validation.
3458 "type": "A String", # The source type.
3459 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3460 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3461 #
3462 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3463 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3464 "A String",
3465 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3466 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3467 },
3468 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3469 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3470 # verified field is typically a name, email address, phone number, or
3471 # website that has been confirmed to be owned by the person.
3472 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3473 # field.
3474 },
3475 },
3476 ],
3477 "locales": [ # The person's locale preferences.
3478 { # A person's locale preference.
3479 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
3480 # language tag representing the locale.
3481 "metadata": { # Metadata about a field. # Metadata about the locale.
3482 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3483 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3484 #
3485 # Last update timestamp of this source.
3486 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3487 #
3488 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3489 # source. Used for web cache validation.
3490 "type": "A String", # The source type.
3491 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3492 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3493 #
3494 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3495 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3496 "A String",
3497 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3498 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3499 },
3500 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3501 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3502 # verified field is typically a name, email address, phone number, or
3503 # website that has been confirmed to be owned by the person.
3504 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3505 # field.
3506 },
3507 },
3508 ],
3509 "organizations": [ # The person's past or current organizations.
3510 { # A person's past or current organization. Overlapping date ranges are
3511 # permitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3512 "formattedType": "A String", # Output only. The type of the organization translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3513 # viewer's account locale or the `Accept-Language` HTTP header locale.
3514 "domain": "A String", # The domain name associated with the organization; for example,
3515 # `google.com`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3516 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.
3517 # and time zone are either specified elsewhere or are not significant. The date
3518 # is relative to the Proleptic Gregorian Calendar. This can represent:
3519 #
3520 # * A full date, with non-zero year, month and day values
3521 # * A month and day value, with a zero year, e.g. an anniversary
3522 # * A year on its own, with zero month and day values
3523 # * A year and month value, with a zero day, e.g. a credit card expiration date
3524 #
3525 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3526 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
3527 # month and day.
3528 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
3529 # if specifying a year by itself or a year and month where the day is not
3530 # significant.
3531 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
3532 # a year.
3533 },
3534 "name": "A String", # The name of the organization.
3535 "title": "A String", # The person's job title at the organization.
3536 "type": "A String", # The type of the organization. The type can be custom or one of these
3537 # predefined values:
3538 #
3539 # * `work`
3540 # * `school`
3541 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
3542 # symbol, abbreviation, or acronym.
3543 "current": True or False, # True if the organization is the person's current organization;
3544 # false if the organization is a past organization.
3545 "jobDescription": "A String", # The person's job description at the organization.
3546 "location": "A String", # The location of the organization office the person works at.
3547 "department": "A String", # The person's department at the organization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3548 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.
3549 # and time zone are either specified elsewhere or are not significant. The date
3550 # is relative to the Proleptic Gregorian Calendar. This can represent:
3551 #
3552 # * A full date, with non-zero year, month and day values
3553 # * A month and day value, with a zero year, e.g. an anniversary
3554 # * A year on its own, with zero month and day values
3555 # * A year and month value, with a zero day, e.g. a credit card expiration date
3556 #
3557 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3558 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
3559 # month and day.
3560 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
3561 # if specifying a year by itself or a year and month where the day is not
3562 # significant.
3563 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
3564 # a year.
3565 },
3566 "phoneticName": "A String", # The phonetic name of the organization.
3567 "metadata": { # Metadata about a field. # Metadata about the organization.
3568 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3569 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3570 #
3571 # Last update timestamp of this source.
3572 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3573 #
3574 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3575 # source. Used for web cache validation.
3576 "type": "A String", # The source type.
3577 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3578 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3579 #
3580 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3581 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3582 "A String",
3583 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3584 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3585 },
3586 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3587 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3588 # verified field is typically a name, email address, phone number, or
3589 # website that has been confirmed to be owned by the person.
3590 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3591 # field.
3592 },
3593 },
3594 ],
3595 "userDefined": [ # The person's user defined data.
3596 { # Arbitrary user data that is populated by the end users.
3597 "key": "A String", # The end user specified key of the user defined data.
3598 "value": "A String", # The end user specified value of the user defined data.
3599 "metadata": { # Metadata about a field. # Metadata about the user defined data.
3600 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3601 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3602 #
3603 # Last update timestamp of this source.
3604 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3605 #
3606 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3607 # source. Used for web cache validation.
3608 "type": "A String", # The source type.
3609 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3610 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3611 #
3612 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3613 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3614 "A String",
3615 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3616 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3617 },
3618 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3619 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3620 # verified field is typically a name, email address, phone number, or
3621 # website that has been confirmed to be owned by the person.
3622 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3623 # field.
3624 },
3625 },
3626 ],
3627 "biographies": [ # The person's biographies.
3628 { # A person's short biography.
3629 "contentType": "A String", # The content type of the biography.
3630 "value": "A String", # The short biography.
3631 "metadata": { # Metadata about a field. # Metadata about the biography.
3632 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3633 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3634 #
3635 # Last update timestamp of this source.
3636 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3637 #
3638 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3639 # source. Used for web cache validation.
3640 "type": "A String", # The source type.
3641 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3642 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3643 #
3644 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3645 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3646 "A String",
3647 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3648 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3649 },
3650 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3651 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3652 # verified field is typically a name, email address, phone number, or
3653 # website that has been confirmed to be owned by the person.
3654 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3655 # field.
3656 },
3657 },
3658 ],
3659 "memberships": [ # The person's group memberships.
3660 { # A person's membership in a group. Only contact group memberships can be
3661 # modified.
3662 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3663 "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3664 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3665 # string, in the form of `contactGroups/{contact_group_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3666 # Only contact_group_resource_name can be used for modifying memberships.
3667 # Any contact group membership can be removed, but only user group or
3668 # "myContacts" or "starred" system groups memberships can be added. A
3669 # contact must always have at least one contact group membership.
3670 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3671 "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3672 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
3673 },
3674 "metadata": { # Metadata about a field. # Metadata about the membership.
3675 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3676 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3677 #
3678 # Last update timestamp of this source.
3679 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3680 #
3681 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3682 # source. Used for web cache validation.
3683 "type": "A String", # The source type.
3684 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3685 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3686 #
3687 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3688 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3689 "A String",
3690 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3691 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3692 },
3693 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3694 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3695 # verified field is typically a name, email address, phone number, or
3696 # website that has been confirmed to be owned by the person.
3697 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3698 # field.
3699 },
3700 },
3701 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3702 "taglines": [ # Output only. **DEPRECATED**: No data will be returned
3703 # The person's taglines.
3704 { # **DEPRECATED**: No data will be returned
3705 # A brief one-line description of the person.
3706 "value": "A String", # The tagline.
3707 "metadata": { # Metadata about a field. # Metadata about the tagline.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3708 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3709 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3710 #
3711 # Last update timestamp of this source.
3712 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3713 #
3714 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3715 # source. Used for web cache validation.
3716 "type": "A String", # The source type.
3717 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3718 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3719 #
3720 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3721 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3722 "A String",
3723 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3724 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3725 },
3726 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3727 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3728 # verified field is typically a name, email address, phone number, or
3729 # website that has been confirmed to be owned by the person.
3730 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3731 # field.
3732 },
3733 },
3734 ],
3735 "urls": [ # The person's associated URLs.
3736 { # A person's associated URLs.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3737 "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3738 # account locale or the `Accept-Language` HTTP header locale.
3739 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
3740 # values:
3741 #
3742 # * `home`
3743 # * `work`
3744 # * `blog`
3745 # * `profile`
3746 # * `homePage`
3747 # * `ftp`
3748 # * `reservations`
3749 # * `appInstallPage`: website for a Google+ application.
3750 # * `other`
3751 "value": "A String", # The URL.
3752 "metadata": { # Metadata about a field. # Metadata about the URL.
3753 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3754 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3755 #
3756 # Last update timestamp of this source.
3757 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3758 #
3759 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3760 # source. Used for web cache validation.
3761 "type": "A String", # The source type.
3762 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3763 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3764 #
3765 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3766 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3767 "A String",
3768 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3769 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3770 },
3771 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3772 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3773 # verified field is typically a name, email address, phone number, or
3774 # website that has been confirmed to be owned by the person.
3775 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3776 # field.
3777 },
3778 },
3779 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3780 "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3781 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3782 # The person's age range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3783 "genders": [ # The person's genders.
3784 { # A person's gender.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3785 "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account
3786 # locale or the `Accept-Language` HTTP header locale. Unspecified or custom
3787 # value are not localized.
3788 "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value
3789 # can be custom or one of these predefined values:
3790 #
3791 # * `male`
3792 # * `female`
3793 # * `other`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3794 "value": "A String", # The gender for the person. The gender can be custom or one of these
3795 # predefined values:
3796 #
3797 # * `male`
3798 # * `female`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3799 # * `unspecified`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3800 "metadata": { # Metadata about a field. # Metadata about the gender.
3801 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3802 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3803 #
3804 # Last update timestamp of this source.
3805 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3806 #
3807 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3808 # source. Used for web cache validation.
3809 "type": "A String", # The source type.
3810 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3811 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3812 #
3813 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3814 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3815 "A String",
3816 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3817 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3818 },
3819 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3820 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3821 # verified field is typically a name, email address, phone number, or
3822 # website that has been confirmed to be owned by the person.
3823 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3824 # field.
3825 },
3826 },
3827 ],
3828 "emailAddresses": [ # The person's email addresses.
3829 { # A person's email address.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3830 "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3831 # viewer's account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3832 "metadata": { # Metadata about a field. # Metadata about the email address.
3833 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3834 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3835 #
3836 # Last update timestamp of this source.
3837 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3838 #
3839 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3840 # source. Used for web cache validation.
3841 "type": "A String", # The source type.
3842 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3843 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3844 #
3845 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3846 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3847 "A String",
3848 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3849 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3850 },
3851 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3852 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3853 # verified field is typically a name, email address, phone number, or
3854 # website that has been confirmed to be owned by the person.
3855 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3856 # field.
3857 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3858 "displayName": "A String", # The display name of the email.
3859 "value": "A String", # The email address.
3860 "type": "A String", # The type of the email address. The type can be custom or one of these
3861 # predefined values:
3862 #
3863 # * `home`
3864 # * `work`
3865 # * `other`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3866 },
3867 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3868 },
3869 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3870</div>
3871
3872<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3873 <code class="details" id="get">get(resourceName, x__xgafv=None, requestMask_includeField=None, personFields=None)</code>
3874 <pre>Provides information about a person by specifying a resource name. Use
3875`people/me` to indicate the authenticated user.
3876
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3877The request throws a 400 error if 'personFields' is not specified.
3878
3879Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3880 resourceName: string, Required. The resource name of the person to provide information about.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3881
3882- To get information about the authenticated user, specify `people/me`.
3883- To get information about a google account, specify
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3884 `people/{account_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3885- To get information about a contact, specify the resource name that
3886 identifies the contact as returned by
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3887[`people.connections.list`](/people/api/rest/v1/people.connections/list). (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3888 x__xgafv: string, V1 error format.
3889 Allowed values
3890 1 - v1 error format
3891 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3892 requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each
3893path should start with `person.`: for example, `person.names` or
3894`person.photos`.
3895 personFields: string, Required. A field mask to restrict which fields on the person are returned. Multiple
3896fields can be specified by separating them with commas. Valid values are:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3897
3898* addresses
3899* ageRanges
3900* biographies
3901* birthdays
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3902* coverPhotos
3903* emailAddresses
3904* events
3905* genders
3906* imClients
3907* interests
3908* locales
3909* memberships
3910* metadata
3911* names
3912* nicknames
3913* occupations
3914* organizations
3915* phoneNumbers
3916* photos
3917* relations
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3918* residences
3919* sipAddresses
3920* skills
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3921* urls
3922* userDefined
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]3923
3924Returns:
3925 An object of the form:
3926
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3927 { # Information about a person merged from various data sources such as the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3928 # authenticated user's contacts and profile data.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3929 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3930 # Most fields can have multiple items. The items in a field have no guaranteed
3931 # order, but each non-empty field is guaranteed to have exactly one field with
3932 # `metadata.primary` set to true.
3933 "sipAddresses": [ # The person's SIP addresses.
3934 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
3935 # communications to make voice or video calls over the internet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3936 "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3937 # viewer's account locale or the `Accept-Language` HTTP header locale.
3938 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
3939 # predefined values:
3940 #
3941 # * `home`
3942 # * `work`
3943 # * `mobile`
3944 # * `other`
3945 "value": "A String", # The SIP address in the
3946 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
3947 # format.
3948 "metadata": { # Metadata about a field. # Metadata about the SIP address.
3949 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3950 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3951 #
3952 # Last update timestamp of this source.
3953 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3954 #
3955 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3956 # source. Used for web cache validation.
3957 "type": "A String", # The source type.
3958 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3959 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3960 #
3961 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3962 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3963 "A String",
3964 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3965 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3966 },
3967 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3968 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3969 # verified field is typically a name, email address, phone number, or
3970 # website that has been confirmed to be owned by the person.
3971 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3972 # field.
3973 },
3974 },
3975 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3976 "braggingRights": [ # **DEPRECATED**: No data will be returned
3977 # The person's bragging rights.
3978 { # **DEPRECATED**: No data will be returned
3979 # A person's bragging rights.
3980 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
3981 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3982 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3983 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3984 #
3985 # Last update timestamp of this source.
3986 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3987 #
3988 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3989 # source. Used for web cache validation.
3990 "type": "A String", # The source type.
3991 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3992 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3993 #
3994 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3995 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3996 "A String",
3997 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3998 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3999 },
4000 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4001 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4002 # verified field is typically a name, email address, phone number, or
4003 # website that has been confirmed to be owned by the person.
4004 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4005 # field.
4006 },
4007 },
4008 ],
4009 "addresses": [ # The person's street addresses.
4010 { # A person's physical address. May be a P.O. box or street address. All fields
4011 # are optional.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4012 "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4013 # account locale or the `Accept-Language` HTTP header locale.
4014 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
4015 # code of the address.
4016 "city": "A String", # The city of the address.
4017 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
4018 # will be automatically constructed from structured values.
4019 "region": "A String", # The region of the address; for example, the state or province.
4020 "poBox": "A String", # The P.O. box of the address.
4021 "streetAddress": "A String", # The street address.
4022 "country": "A String", # The country of the address.
4023 "postalCode": "A String", # The postal code of the address.
4024 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
4025 "type": "A String", # The type of the address. The type can be custom or one of these predefined
4026 # values:
4027 #
4028 # * `home`
4029 # * `work`
4030 # * `other`
4031 "metadata": { # Metadata about a field. # Metadata about the address.
4032 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4033 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4034 #
4035 # Last update timestamp of this source.
4036 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4037 #
4038 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4039 # source. Used for web cache validation.
4040 "type": "A String", # The source type.
4041 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4042 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4043 #
4044 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4045 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4046 "A String",
4047 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4048 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4049 },
4050 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4051 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4052 # verified field is typically a name, email address, phone number, or
4053 # website that has been confirmed to be owned by the person.
4054 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4055 # field.
4056 },
4057 },
4058 ],
4059 "nicknames": [ # The person's nicknames.
4060 { # A person's nickname.
4061 "type": "A String", # The type of the nickname.
4062 "value": "A String", # The nickname.
4063 "metadata": { # Metadata about a field. # Metadata about the nickname.
4064 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4065 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4066 #
4067 # Last update timestamp of this source.
4068 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4069 #
4070 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4071 # source. Used for web cache validation.
4072 "type": "A String", # The source type.
4073 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4074 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4075 #
4076 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4077 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4078 "A String",
4079 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4080 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4081 },
4082 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4083 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4084 # verified field is typically a name, email address, phone number, or
4085 # website that has been confirmed to be owned by the person.
4086 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4087 # field.
4088 },
4089 },
4090 ],
4091 "occupations": [ # The person's occupations.
4092 { # A person's occupation.
4093 "value": "A String", # The occupation; for example, `carpenter`.
4094 "metadata": { # Metadata about a field. # Metadata about the occupation.
4095 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4096 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4097 #
4098 # Last update timestamp of this source.
4099 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4100 #
4101 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4102 # source. Used for web cache validation.
4103 "type": "A String", # The source type.
4104 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4105 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4106 #
4107 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4108 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4109 "A String",
4110 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4111 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4112 },
4113 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4114 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4115 # verified field is typically a name, email address, phone number, or
4116 # website that has been confirmed to be owned by the person.
4117 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4118 # field.
4119 },
4120 },
4121 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4122 "phoneNumbers": [ # The person's phone numbers.
4123 { # A person's phone number.
4124 "canonicalForm": "A String", # Output only. The canonicalized [ITU-T
4125 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
4126 # form of the phone number.
4127 "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the
4128 # viewer's account locale or the `Accept-Language` HTTP header locale.
4129 "type": "A String", # The type of the phone number. The type can be custom or one of these
4130 # predefined values:
4131 #
4132 # * `home`
4133 # * `work`
4134 # * `mobile`
4135 # * `homeFax`
4136 # * `workFax`
4137 # * `otherFax`
4138 # * `pager`
4139 # * `workMobile`
4140 # * `workPager`
4141 # * `main`
4142 # * `googleVoice`
4143 # * `other`
4144 "value": "A String", # The phone number.
4145 "metadata": { # Metadata about a field. # Metadata about the phone number.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4146 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4147 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4148 #
4149 # Last update timestamp of this source.
4150 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4151 #
4152 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4153 # source. Used for web cache validation.
4154 "type": "A String", # The source type.
4155 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4156 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4157 #
4158 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4159 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4160 "A String",
4161 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4162 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4163 },
4164 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4165 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4166 # verified field is typically a name, email address, phone number, or
4167 # website that has been confirmed to be owned by the person.
4168 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4169 # field.
4170 },
4171 },
4172 ],
4173 "names": [ # The person's names.
4174 { # A person's name. If the name is a mononym, the family name is empty.
4175 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
4176 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4177 "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4178 # the locale specified by the viewer's account or the
4179 # `Accept-Language` HTTP header.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4180 "displayName": "A String", # Output only. The display name formatted according to the locale specified by
4181 # the viewer's account or the `Accept-Language` HTTP header.
4182 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4183 "middleName": "A String", # The middle name(s).
4184 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
4185 "familyName": "A String", # The family name.
4186 "phoneticFullName": "A String", # The full name spelled as it sounds.
4187 "phoneticGivenName": "A String", # The given name spelled as it sounds.
4188 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
4189 "givenName": "A String", # The given name.
4190 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
4191 "metadata": { # Metadata about a field. # Metadata about the name.
4192 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4193 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4194 #
4195 # Last update timestamp of this source.
4196 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4197 #
4198 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4199 # source. Used for web cache validation.
4200 "type": "A String", # The source type.
4201 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4202 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4203 #
4204 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4205 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4206 "A String",
4207 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4208 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4209 },
4210 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4211 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4212 # verified field is typically a name, email address, phone number, or
4213 # website that has been confirmed to be owned by the person.
4214 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4215 # field.
4216 },
4217 },
4218 ],
4219 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
4220 # with a max length of 27 characters, in the form of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4221 # `people/{person_id}`.
4222 "ageRanges": [ # Output only. The person's age ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4223 { # A person's age range.
4224 "ageRange": "A String", # The age range.
4225 "metadata": { # Metadata about a field. # Metadata about the age range.
4226 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4227 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4228 #
4229 # Last update timestamp of this source.
4230 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4231 #
4232 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4233 # source. Used for web cache validation.
4234 "type": "A String", # The source type.
4235 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4236 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4237 #
4238 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4239 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4240 "A String",
4241 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4242 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4243 },
4244 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4245 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4246 # verified field is typically a name, email address, phone number, or
4247 # website that has been confirmed to be owned by the person.
4248 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4249 # field.
4250 },
4251 },
4252 ],
4253 "birthdays": [ # The person's birthdays.
4254 { # A person's birthday. At least one of the `date` and `text` fields are
4255 # specified. The `date` and `text` fields typically represent the same
4256 # date, but are not guaranteed to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4257 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
4258 # and time zone are either specified elsewhere or are not significant. The date
4259 # is relative to the Proleptic Gregorian Calendar. This can represent:
4260 #
4261 # * A full date, with non-zero year, month and day values
4262 # * A month and day value, with a zero year, e.g. an anniversary
4263 # * A year on its own, with zero month and day values
4264 # * A year and month value, with a zero day, e.g. a credit card expiration date
4265 #
4266 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4267 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4268 # month and day.
4269 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4270 # if specifying a year by itself or a year and month where the day is not
4271 # significant.
4272 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4273 # a year.
4274 },
4275 "text": "A String", # A free-form string representing the user's birthday.
4276 "metadata": { # Metadata about a field. # Metadata about the birthday.
4277 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4278 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4279 #
4280 # Last update timestamp of this source.
4281 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4282 #
4283 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4284 # source. Used for web cache validation.
4285 "type": "A String", # The source type.
4286 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4287 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4288 #
4289 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4290 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4291 "A String",
4292 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4293 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4294 },
4295 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4296 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4297 # verified field is typically a name, email address, phone number, or
4298 # website that has been confirmed to be owned by the person.
4299 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4300 # field.
4301 },
4302 },
4303 ],
4304 "relations": [ # The person's relations.
4305 { # A person's relation to another person.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4306 "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
4307 # account locale or the locale specified in the Accept-Language HTTP header.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4308 "metadata": { # Metadata about a field. # Metadata about the relation.
4309 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4310 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4311 #
4312 # Last update timestamp of this source.
4313 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4314 #
4315 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4316 # source. Used for web cache validation.
4317 "type": "A String", # The source type.
4318 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4319 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4320 #
4321 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4322 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4323 "A String",
4324 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4325 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4326 },
4327 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4328 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4329 # verified field is typically a name, email address, phone number, or
4330 # website that has been confirmed to be owned by the person.
4331 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4332 # field.
4333 },
4334 "type": "A String", # The person's relation to the other person. The type can be custom or one of
4335 # these predefined values:
4336 #
4337 # * `spouse`
4338 # * `child`
4339 # * `mother`
4340 # * `father`
4341 # * `parent`
4342 # * `brother`
4343 # * `sister`
4344 # * `friend`
4345 # * `relative`
4346 # * `domesticPartner`
4347 # * `manager`
4348 # * `assistant`
4349 # * `referredBy`
4350 # * `partner`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4351 "person": "A String", # The name of the other person this relation refers to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4352 },
4353 ],
4354 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4355 # resource. Used for web cache validation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4356 "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
4357 # The person's relationship statuses.
4358 { # **DEPRECATED**: No data will be returned
4359 # A person's relationship status.
4360 "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4361 # the viewer's account locale or the `Accept-Language` HTTP header locale.
4362 "value": "A String", # The relationship status. The value can be custom or one of these
4363 # predefined values:
4364 #
4365 # * `single`
4366 # * `inARelationship`
4367 # * `engaged`
4368 # * `married`
4369 # * `itsComplicated`
4370 # * `openRelationship`
4371 # * `widowed`
4372 # * `inDomesticPartnership`
4373 # * `inCivilUnion`
4374 "metadata": { # Metadata about a field. # Metadata about the relationship status.
4375 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4376 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4377 #
4378 # Last update timestamp of this source.
4379 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4380 #
4381 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4382 # source. Used for web cache validation.
4383 "type": "A String", # The source type.
4384 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4385 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4386 #
4387 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4388 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4389 "A String",
4390 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4391 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4392 },
4393 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4394 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
4395 # verified field is typically a name, email address, phone number, or
4396 # website that has been confirmed to be owned by the person.
4397 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4398 # field.
4399 },
4400 },
4401 ],
4402 "skills": [ # The person's skills.
4403 { # A skill that the person has.
4404 "value": "A String", # The skill; for example, `underwater basket weaving`.
4405 "metadata": { # Metadata about a field. # Metadata about the skill.
4406 "source": { # The source of a field. # The source of the field.
4407 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
4408 #
4409 # Last update timestamp of this source.
4410 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4411 #
4412 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4413 # source. Used for web cache validation.
4414 "type": "A String", # The source type.
4415 "id": "A String", # The unique identifier within the source type generated by the server.
4416 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
4417 #
4418 # Metadata about a source of type PROFILE.
4419 "userTypes": [ # Output only. The user types.
4420 "A String",
4421 ],
4422 "objectType": "A String", # Output only. The profile object type.
4423 },
4424 },
4425 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4426 # verified field is typically a name, email address, phone number, or
4427 # website that has been confirmed to be owned by the person.
4428 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4429 # field.
4430 },
4431 },
4432 ],
4433 "imClients": [ # The person's instant messaging clients.
4434 { # A person's instant messaging client.
4435 "username": "A String", # The user name used in the IM client.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4436 "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4437 # viewer's account locale or the `Accept-Language` HTTP header locale.
4438 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
4439 # predefined values:
4440 #
4441 # * `aim`
4442 # * `msn`
4443 # * `yahoo`
4444 # * `skype`
4445 # * `qq`
4446 # * `googleTalk`
4447 # * `icq`
4448 # * `jabber`
4449 # * `netMeeting`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4450 "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4451 # locale or the `Accept-Language` HTTP header locale.
4452 "type": "A String", # The type of the IM client. The type can be custom or one of these
4453 # predefined values:
4454 #
4455 # * `home`
4456 # * `work`
4457 # * `other`
4458 "metadata": { # Metadata about a field. # Metadata about the IM client.
4459 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4460 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4461 #
4462 # Last update timestamp of this source.
4463 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4464 #
4465 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4466 # source. Used for web cache validation.
4467 "type": "A String", # The source type.
4468 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4469 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4470 #
4471 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4472 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4473 "A String",
4474 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4475 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4476 },
4477 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4478 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4479 # verified field is typically a name, email address, phone number, or
4480 # website that has been confirmed to be owned by the person.
4481 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4482 # field.
4483 },
4484 },
4485 ],
4486 "events": [ # The person's events.
4487 { # An event related to the person.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4488 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
4489 # and time zone are either specified elsewhere or are not significant. The date
4490 # is relative to the Proleptic Gregorian Calendar. This can represent:
4491 #
4492 # * A full date, with non-zero year, month and day values
4493 # * A month and day value, with a zero year, e.g. an anniversary
4494 # * A year on its own, with zero month and day values
4495 # * A year and month value, with a zero day, e.g. a credit card expiration date
4496 #
4497 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4498 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4499 # month and day.
4500 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4501 # if specifying a year by itself or a year and month where the day is not
4502 # significant.
4503 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4504 # a year.
4505 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4506 "formattedType": "A String", # Output only. The type of the event translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4507 # viewer's account locale or the `Accept-Language` HTTP header locale.
4508 "type": "A String", # The type of the event. The type can be custom or one of these predefined
4509 # values:
4510 #
4511 # * `anniversary`
4512 # * `other`
4513 "metadata": { # Metadata about a field. # Metadata about the event.
4514 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4515 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4516 #
4517 # Last update timestamp of this source.
4518 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4519 #
4520 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4521 # source. Used for web cache validation.
4522 "type": "A String", # The source type.
4523 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4524 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4525 #
4526 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4527 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4528 "A String",
4529 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4530 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4531 },
4532 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4533 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4534 # verified field is typically a name, email address, phone number, or
4535 # website that has been confirmed to be owned by the person.
4536 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4537 # field.
4538 },
4539 },
4540 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4541 "metadata": { # The metadata about a person. # Output only. Metadata about the person.
4542 "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for
4543 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
4544 # that include a sync token.
4545 "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4546 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
4547 # that include a sync token.
4548 #
4549 # The resource name may change when adding or removing fields that link a
4550 # contact and profile such as a verified email, verified phone number, or
4551 # profile URL.
4552 "A String",
4553 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4554 "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
4555 "A String",
4556 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4557 "sources": [ # The sources of data for the person.
4558 { # The source of a field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4559 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4560 #
4561 # Last update timestamp of this source.
4562 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4563 #
4564 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4565 # source. Used for web cache validation.
4566 "type": "A String", # The source type.
4567 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4568 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4569 #
4570 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4571 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4572 "A String",
4573 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4574 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4575 },
4576 },
4577 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4578 "objectType": "A String", # Output only. **DEPRECATED** (Please use
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4579 # `person.metadata.sources.profileMetadata.objectType` instead)
4580 #
4581 # The type of the person object.
4582 },
4583 "interests": [ # The person's interests.
4584 { # One of the person's interests.
4585 "value": "A String", # The interest; for example, `stargazing`.
4586 "metadata": { # Metadata about a field. # Metadata about the interest.
4587 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4588 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4589 #
4590 # Last update timestamp of this source.
4591 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4592 #
4593 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4594 # source. Used for web cache validation.
4595 "type": "A String", # The source type.
4596 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4597 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4598 #
4599 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4600 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4601 "A String",
4602 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4603 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4604 },
4605 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4606 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4607 # verified field is typically a name, email address, phone number, or
4608 # website that has been confirmed to be owned by the person.
4609 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4610 # field.
4611 },
4612 },
4613 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4614 "photos": [ # Output only. The person's photos.
4615 { # A person's photo. A picture shown next to the person's name to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4616 # help others recognize the person.
4617 "default": True or False, # True if the photo is a default photo;
4618 # false if the photo is a user-provided photo.
4619 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4620 # parameter `sz={size}` at the end of the url, where {size} is the size in
4621 # pixels. Example:
4622 # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4623 "metadata": { # Metadata about a field. # Metadata about the photo.
4624 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4625 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4626 #
4627 # Last update timestamp of this source.
4628 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4629 #
4630 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4631 # source. Used for web cache validation.
4632 "type": "A String", # The source type.
4633 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4634 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4635 #
4636 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4637 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4638 "A String",
4639 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4640 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4641 },
4642 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4643 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4644 # verified field is typically a name, email address, phone number, or
4645 # website that has been confirmed to be owned by the person.
4646 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4647 # field.
4648 },
4649 },
4650 ],
4651 "residences": [ # The person's residences.
4652 { # A person's past or current residence.
4653 "current": True or False, # True if the residence is the person's current residence;
4654 # false if the residence is a past residence.
4655 "value": "A String", # The address of the residence.
4656 "metadata": { # Metadata about a field. # Metadata about the residence.
4657 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4658 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4659 #
4660 # Last update timestamp of this source.
4661 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4662 #
4663 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4664 # source. Used for web cache validation.
4665 "type": "A String", # The source type.
4666 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4667 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4668 #
4669 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4670 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4671 "A String",
4672 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4673 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4674 },
4675 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4676 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4677 # verified field is typically a name, email address, phone number, or
4678 # website that has been confirmed to be owned by the person.
4679 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4680 # field.
4681 },
4682 },
4683 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4684 "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
4685 # The person's relationship interests.
4686 { # **DEPRECATED**: No data will be returned
4687 # A person's relationship interest .
4688 "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
4689 # in the viewer's account locale or the locale specified in the
4690 # Accept-Language HTTP header.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4691 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
4692 # or one of these predefined values:
4693 #
4694 # * `friend`
4695 # * `date`
4696 # * `relationship`
4697 # * `networking`
4698 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
4699 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4700 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4701 #
4702 # Last update timestamp of this source.
4703 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4704 #
4705 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4706 # source. Used for web cache validation.
4707 "type": "A String", # The source type.
4708 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4709 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4710 #
4711 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4712 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4713 "A String",
4714 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4715 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4716 },
4717 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4718 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4719 # verified field is typically a name, email address, phone number, or
4720 # website that has been confirmed to be owned by the person.
4721 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4722 # field.
4723 },
4724 },
4725 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4726 "coverPhotos": [ # Output only. The person's cover photos.
4727 { # A person's cover photo. A large image shown on the person's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4728 # profile page that represents who they are or what they care about.
4729 "default": True or False, # True if the cover photo is the default cover photo;
4730 # false if the cover photo is a user-provided cover photo.
4731 "url": "A String", # The URL of the cover photo.
4732 "metadata": { # Metadata about a field. # Metadata about the cover photo.
4733 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4734 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4735 #
4736 # Last update timestamp of this source.
4737 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4738 #
4739 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4740 # source. Used for web cache validation.
4741 "type": "A String", # The source type.
4742 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4743 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4744 #
4745 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4746 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4747 "A String",
4748 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4749 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4750 },
4751 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4752 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4753 # verified field is typically a name, email address, phone number, or
4754 # website that has been confirmed to be owned by the person.
4755 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4756 # field.
4757 },
4758 },
4759 ],
4760 "locales": [ # The person's locale preferences.
4761 { # A person's locale preference.
4762 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
4763 # language tag representing the locale.
4764 "metadata": { # Metadata about a field. # Metadata about the locale.
4765 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4766 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4767 #
4768 # Last update timestamp of this source.
4769 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4770 #
4771 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4772 # source. Used for web cache validation.
4773 "type": "A String", # The source type.
4774 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4775 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4776 #
4777 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4778 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4779 "A String",
4780 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4781 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4782 },
4783 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4784 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4785 # verified field is typically a name, email address, phone number, or
4786 # website that has been confirmed to be owned by the person.
4787 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4788 # field.
4789 },
4790 },
4791 ],
4792 "organizations": [ # The person's past or current organizations.
4793 { # A person's past or current organization. Overlapping date ranges are
4794 # permitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4795 "formattedType": "A String", # Output only. The type of the organization translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4796 # viewer's account locale or the `Accept-Language` HTTP header locale.
4797 "domain": "A String", # The domain name associated with the organization; for example,
4798 # `google.com`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4799 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.
4800 # and time zone are either specified elsewhere or are not significant. The date
4801 # is relative to the Proleptic Gregorian Calendar. This can represent:
4802 #
4803 # * A full date, with non-zero year, month and day values
4804 # * A month and day value, with a zero year, e.g. an anniversary
4805 # * A year on its own, with zero month and day values
4806 # * A year and month value, with a zero day, e.g. a credit card expiration date
4807 #
4808 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4809 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4810 # month and day.
4811 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4812 # if specifying a year by itself or a year and month where the day is not
4813 # significant.
4814 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4815 # a year.
4816 },
4817 "name": "A String", # The name of the organization.
4818 "title": "A String", # The person's job title at the organization.
4819 "type": "A String", # The type of the organization. The type can be custom or one of these
4820 # predefined values:
4821 #
4822 # * `work`
4823 # * `school`
4824 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
4825 # symbol, abbreviation, or acronym.
4826 "current": True or False, # True if the organization is the person's current organization;
4827 # false if the organization is a past organization.
4828 "jobDescription": "A String", # The person's job description at the organization.
4829 "location": "A String", # The location of the organization office the person works at.
4830 "department": "A String", # The person's department at the organization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4831 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.
4832 # and time zone are either specified elsewhere or are not significant. The date
4833 # is relative to the Proleptic Gregorian Calendar. This can represent:
4834 #
4835 # * A full date, with non-zero year, month and day values
4836 # * A month and day value, with a zero year, e.g. an anniversary
4837 # * A year on its own, with zero month and day values
4838 # * A year and month value, with a zero day, e.g. a credit card expiration date
4839 #
4840 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4841 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4842 # month and day.
4843 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4844 # if specifying a year by itself or a year and month where the day is not
4845 # significant.
4846 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4847 # a year.
4848 },
4849 "phoneticName": "A String", # The phonetic name of the organization.
4850 "metadata": { # Metadata about a field. # Metadata about the organization.
4851 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4852 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4853 #
4854 # Last update timestamp of this source.
4855 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4856 #
4857 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4858 # source. Used for web cache validation.
4859 "type": "A String", # The source type.
4860 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4861 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4862 #
4863 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4864 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4865 "A String",
4866 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4867 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4868 },
4869 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4870 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4871 # verified field is typically a name, email address, phone number, or
4872 # website that has been confirmed to be owned by the person.
4873 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4874 # field.
4875 },
4876 },
4877 ],
4878 "userDefined": [ # The person's user defined data.
4879 { # Arbitrary user data that is populated by the end users.
4880 "key": "A String", # The end user specified key of the user defined data.
4881 "value": "A String", # The end user specified value of the user defined data.
4882 "metadata": { # Metadata about a field. # Metadata about the user defined data.
4883 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4884 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4885 #
4886 # Last update timestamp of this source.
4887 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4888 #
4889 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4890 # source. Used for web cache validation.
4891 "type": "A String", # The source type.
4892 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4893 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4894 #
4895 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4896 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4897 "A String",
4898 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4899 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4900 },
4901 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4902 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4903 # verified field is typically a name, email address, phone number, or
4904 # website that has been confirmed to be owned by the person.
4905 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4906 # field.
4907 },
4908 },
4909 ],
4910 "biographies": [ # The person's biographies.
4911 { # A person's short biography.
4912 "contentType": "A String", # The content type of the biography.
4913 "value": "A String", # The short biography.
4914 "metadata": { # Metadata about a field. # Metadata about the biography.
4915 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4916 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4917 #
4918 # Last update timestamp of this source.
4919 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4920 #
4921 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4922 # source. Used for web cache validation.
4923 "type": "A String", # The source type.
4924 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4925 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4926 #
4927 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4928 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4929 "A String",
4930 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4931 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4932 },
4933 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4934 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4935 # verified field is typically a name, email address, phone number, or
4936 # website that has been confirmed to be owned by the person.
4937 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4938 # field.
4939 },
4940 },
4941 ],
4942 "memberships": [ # The person's group memberships.
4943 { # A person's membership in a group. Only contact group memberships can be
4944 # modified.
4945 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4946 "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4947 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4948 # string, in the form of `contactGroups/{contact_group_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4949 # Only contact_group_resource_name can be used for modifying memberships.
4950 # Any contact group membership can be removed, but only user group or
4951 # "myContacts" or "starred" system groups memberships can be added. A
4952 # contact must always have at least one contact group membership.
4953 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4954 "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4955 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
4956 },
4957 "metadata": { # Metadata about a field. # Metadata about the membership.
4958 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4959 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4960 #
4961 # Last update timestamp of this source.
4962 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4963 #
4964 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4965 # source. Used for web cache validation.
4966 "type": "A String", # The source type.
4967 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4968 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4969 #
4970 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4971 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4972 "A String",
4973 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4974 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4975 },
4976 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4977 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4978 # verified field is typically a name, email address, phone number, or
4979 # website that has been confirmed to be owned by the person.
4980 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4981 # field.
4982 },
4983 },
4984 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4985 "taglines": [ # Output only. **DEPRECATED**: No data will be returned
4986 # The person's taglines.
4987 { # **DEPRECATED**: No data will be returned
4988 # A brief one-line description of the person.
4989 "value": "A String", # The tagline.
4990 "metadata": { # Metadata about a field. # Metadata about the tagline.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4991 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4992 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4993 #
4994 # Last update timestamp of this source.
4995 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4996 #
4997 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4998 # source. Used for web cache validation.
4999 "type": "A String", # The source type.
5000 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5001 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5002 #
5003 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5004 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5005 "A String",
5006 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5007 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5008 },
5009 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5010 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5011 # verified field is typically a name, email address, phone number, or
5012 # website that has been confirmed to be owned by the person.
5013 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5014 # field.
5015 },
5016 },
5017 ],
5018 "urls": [ # The person's associated URLs.
5019 { # A person's associated URLs.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5020 "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5021 # account locale or the `Accept-Language` HTTP header locale.
5022 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
5023 # values:
5024 #
5025 # * `home`
5026 # * `work`
5027 # * `blog`
5028 # * `profile`
5029 # * `homePage`
5030 # * `ftp`
5031 # * `reservations`
5032 # * `appInstallPage`: website for a Google+ application.
5033 # * `other`
5034 "value": "A String", # The URL.
5035 "metadata": { # Metadata about a field. # Metadata about the URL.
5036 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5037 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5038 #
5039 # Last update timestamp of this source.
5040 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5041 #
5042 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5043 # source. Used for web cache validation.
5044 "type": "A String", # The source type.
5045 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5046 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5047 #
5048 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5049 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5050 "A String",
5051 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5052 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5053 },
5054 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5055 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5056 # verified field is typically a name, email address, phone number, or
5057 # website that has been confirmed to be owned by the person.
5058 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5059 # field.
5060 },
5061 },
5062 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5063 "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
5064 #
5065 # The person's age range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5066 "genders": [ # The person's genders.
5067 { # A person's gender.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5068 "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account
5069 # locale or the `Accept-Language` HTTP header locale. Unspecified or custom
5070 # value are not localized.
5071 "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value
5072 # can be custom or one of these predefined values:
5073 #
5074 # * `male`
5075 # * `female`
5076 # * `other`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5077 "value": "A String", # The gender for the person. The gender can be custom or one of these
5078 # predefined values:
5079 #
5080 # * `male`
5081 # * `female`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5082 # * `unspecified`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5083 "metadata": { # Metadata about a field. # Metadata about the gender.
5084 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5085 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5086 #
5087 # Last update timestamp of this source.
5088 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5089 #
5090 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5091 # source. Used for web cache validation.
5092 "type": "A String", # The source type.
5093 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5094 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5095 #
5096 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5097 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5098 "A String",
5099 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5100 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5101 },
5102 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5103 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5104 # verified field is typically a name, email address, phone number, or
5105 # website that has been confirmed to be owned by the person.
5106 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5107 # field.
5108 },
5109 },
5110 ],
5111 "emailAddresses": [ # The person's email addresses.
5112 { # A person's email address.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5113 "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5114 # viewer's account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5115 "metadata": { # Metadata about a field. # Metadata about the email address.
5116 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5117 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5118 #
5119 # Last update timestamp of this source.
5120 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5121 #
5122 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5123 # source. Used for web cache validation.
5124 "type": "A String", # The source type.
5125 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5126 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5127 #
5128 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5129 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5130 "A String",
5131 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5132 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5133 },
5134 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5135 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5136 # verified field is typically a name, email address, phone number, or
5137 # website that has been confirmed to be owned by the person.
5138 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5139 # field.
5140 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5141 "displayName": "A String", # The display name of the email.
5142 "value": "A String", # The email address.
5143 "type": "A String", # The type of the email address. The type can be custom or one of these
5144 # predefined values:
5145 #
5146 # * `home`
5147 # * `work`
5148 # * `other`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5149 },
5150 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5151 }</pre>
5152</div>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5153
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]5154<div class="method">
5155 <code class="details" id="getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None, personFields=None)</code>
5156 <pre>Provides information about a list of specific people by specifying a list
5157of requested resource names. Use `people/me` to indicate the authenticated
5158user.
5159
5160The request throws a 400 error if 'personFields' is not specified.
5161
5162Args:
5163 resourceNames: string, Required. The resource names of the people to provide information about.
5164
5165- To get information about the authenticated user, specify `people/me`.
5166- To get information about a google account, specify
5167 `people/{account_id}`.
5168- To get information about a contact, specify the resource name that
5169 identifies the contact as returned by
5170[`people.connections.list`](/people/api/rest/v1/people.connections/list).
5171
5172You can include up to 50 resource names in one request. (repeated)
5173 x__xgafv: string, V1 error format.
5174 Allowed values
5175 1 - v1 error format
5176 2 - v2 error format
5177 requestMask_includeField: string, Required. Comma-separated list of person fields to be included in the response. Each
5178path should start with `person.`: for example, `person.names` or
5179`person.photos`.
5180 personFields: string, Required. A field mask to restrict which fields on each person are returned. Multiple
5181fields can be specified by separating them with commas. Valid values are:
5182
5183* addresses
5184* ageRanges
5185* biographies
5186* birthdays
5187* coverPhotos
5188* emailAddresses
5189* events
5190* genders
5191* imClients
5192* interests
5193* locales
5194* memberships
5195* metadata
5196* names
5197* nicknames
5198* occupations
5199* organizations
5200* phoneNumbers
5201* photos
5202* relations
5203* residences
5204* sipAddresses
5205* skills
5206* urls
5207* userDefined
5208
5209Returns:
5210 An object of the form:
5211
5212 { # The response to a get request for a list of people by resource name.
5213 "responses": [ # The response for each requested resource name.
5214 { # The response for a single person
5215 "status": { # The `Status` type defines a logical error model that is suitable for # The status of the response.
5216 # different programming environments, including REST APIs and RPC APIs. It is
5217 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
5218 # three pieces of data: error code, error message, and error details.
5219 #
5220 # You can find out more about this error model and how to work with it in the
5221 # [API Design Guide](https://cloud.google.com/apis/design/errors).
5222 "message": "A String", # A developer-facing error message, which should be in English. Any
5223 # user-facing error message should be localized and sent in the
5224 # google.rpc.Status.details field, or localized by the client.
5225 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
5226 "details": [ # A list of messages that carry the error details. There is a common set of
5227 # message types for APIs to use.
5228 {
5229 "a_key": "", # Properties of the object. Contains field @type with type URL.
5230 },
5231 ],
5232 },
5233 "person": { # Information about a person merged from various data sources such as the # The person.
5234 # authenticated user's contacts and profile data.
5235 #
5236 # Most fields can have multiple items. The items in a field have no guaranteed
5237 # order, but each non-empty field is guaranteed to have exactly one field with
5238 # `metadata.primary` set to true.
5239 "sipAddresses": [ # The person's SIP addresses.
5240 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
5241 # communications to make voice or video calls over the internet.
5242 "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
5243 # viewer's account locale or the `Accept-Language` HTTP header locale.
5244 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
5245 # predefined values:
5246 #
5247 # * `home`
5248 # * `work`
5249 # * `mobile`
5250 # * `other`
5251 "value": "A String", # The SIP address in the
5252 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
5253 # format.
5254 "metadata": { # Metadata about a field. # Metadata about the SIP address.
5255 "source": { # The source of a field. # The source of the field.
5256 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5257 #
5258 # Last update timestamp of this source.
5259 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5260 #
5261 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5262 # source. Used for web cache validation.
5263 "type": "A String", # The source type.
5264 "id": "A String", # The unique identifier within the source type generated by the server.
5265 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5266 #
5267 # Metadata about a source of type PROFILE.
5268 "userTypes": [ # Output only. The user types.
5269 "A String",
5270 ],
5271 "objectType": "A String", # Output only. The profile object type.
5272 },
5273 },
5274 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5275 # verified field is typically a name, email address, phone number, or
5276 # website that has been confirmed to be owned by the person.
5277 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5278 # field.
5279 },
5280 },
5281 ],
5282 "braggingRights": [ # **DEPRECATED**: No data will be returned
5283 # The person's bragging rights.
5284 { # **DEPRECATED**: No data will be returned
5285 # A person's bragging rights.
5286 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
5287 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
5288 "source": { # The source of a field. # The source of the field.
5289 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5290 #
5291 # Last update timestamp of this source.
5292 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5293 #
5294 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5295 # source. Used for web cache validation.
5296 "type": "A String", # The source type.
5297 "id": "A String", # The unique identifier within the source type generated by the server.
5298 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5299 #
5300 # Metadata about a source of type PROFILE.
5301 "userTypes": [ # Output only. The user types.
5302 "A String",
5303 ],
5304 "objectType": "A String", # Output only. The profile object type.
5305 },
5306 },
5307 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5308 # verified field is typically a name, email address, phone number, or
5309 # website that has been confirmed to be owned by the person.
5310 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5311 # field.
5312 },
5313 },
5314 ],
5315 "addresses": [ # The person's street addresses.
5316 { # A person's physical address. May be a P.O. box or street address. All fields
5317 # are optional.
5318 "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's
5319 # account locale or the `Accept-Language` HTTP header locale.
5320 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
5321 # code of the address.
5322 "city": "A String", # The city of the address.
5323 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
5324 # will be automatically constructed from structured values.
5325 "region": "A String", # The region of the address; for example, the state or province.
5326 "poBox": "A String", # The P.O. box of the address.
5327 "streetAddress": "A String", # The street address.
5328 "country": "A String", # The country of the address.
5329 "postalCode": "A String", # The postal code of the address.
5330 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
5331 "type": "A String", # The type of the address. The type can be custom or one of these predefined
5332 # values:
5333 #
5334 # * `home`
5335 # * `work`
5336 # * `other`
5337 "metadata": { # Metadata about a field. # Metadata about the address.
5338 "source": { # The source of a field. # The source of the field.
5339 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5340 #
5341 # Last update timestamp of this source.
5342 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5343 #
5344 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5345 # source. Used for web cache validation.
5346 "type": "A String", # The source type.
5347 "id": "A String", # The unique identifier within the source type generated by the server.
5348 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5349 #
5350 # Metadata about a source of type PROFILE.
5351 "userTypes": [ # Output only. The user types.
5352 "A String",
5353 ],
5354 "objectType": "A String", # Output only. The profile object type.
5355 },
5356 },
5357 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5358 # verified field is typically a name, email address, phone number, or
5359 # website that has been confirmed to be owned by the person.
5360 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5361 # field.
5362 },
5363 },
5364 ],
5365 "nicknames": [ # The person's nicknames.
5366 { # A person's nickname.
5367 "type": "A String", # The type of the nickname.
5368 "value": "A String", # The nickname.
5369 "metadata": { # Metadata about a field. # Metadata about the nickname.
5370 "source": { # The source of a field. # The source of the field.
5371 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5372 #
5373 # Last update timestamp of this source.
5374 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5375 #
5376 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5377 # source. Used for web cache validation.
5378 "type": "A String", # The source type.
5379 "id": "A String", # The unique identifier within the source type generated by the server.
5380 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5381 #
5382 # Metadata about a source of type PROFILE.
5383 "userTypes": [ # Output only. The user types.
5384 "A String",
5385 ],
5386 "objectType": "A String", # Output only. The profile object type.
5387 },
5388 },
5389 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5390 # verified field is typically a name, email address, phone number, or
5391 # website that has been confirmed to be owned by the person.
5392 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5393 # field.
5394 },
5395 },
5396 ],
5397 "occupations": [ # The person's occupations.
5398 { # A person's occupation.
5399 "value": "A String", # The occupation; for example, `carpenter`.
5400 "metadata": { # Metadata about a field. # Metadata about the occupation.
5401 "source": { # The source of a field. # The source of the field.
5402 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5403 #
5404 # Last update timestamp of this source.
5405 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5406 #
5407 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5408 # source. Used for web cache validation.
5409 "type": "A String", # The source type.
5410 "id": "A String", # The unique identifier within the source type generated by the server.
5411 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5412 #
5413 # Metadata about a source of type PROFILE.
5414 "userTypes": [ # Output only. The user types.
5415 "A String",
5416 ],
5417 "objectType": "A String", # Output only. The profile object type.
5418 },
5419 },
5420 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5421 # verified field is typically a name, email address, phone number, or
5422 # website that has been confirmed to be owned by the person.
5423 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5424 # field.
5425 },
5426 },
5427 ],
5428 "phoneNumbers": [ # The person's phone numbers.
5429 { # A person's phone number.
5430 "canonicalForm": "A String", # Output only. The canonicalized [ITU-T
5431 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
5432 # form of the phone number.
5433 "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the
5434 # viewer's account locale or the `Accept-Language` HTTP header locale.
5435 "type": "A String", # The type of the phone number. The type can be custom or one of these
5436 # predefined values:
5437 #
5438 # * `home`
5439 # * `work`
5440 # * `mobile`
5441 # * `homeFax`
5442 # * `workFax`
5443 # * `otherFax`
5444 # * `pager`
5445 # * `workMobile`
5446 # * `workPager`
5447 # * `main`
5448 # * `googleVoice`
5449 # * `other`
5450 "value": "A String", # The phone number.
5451 "metadata": { # Metadata about a field. # Metadata about the phone number.
5452 "source": { # The source of a field. # The source of the field.
5453 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5454 #
5455 # Last update timestamp of this source.
5456 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5457 #
5458 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5459 # source. Used for web cache validation.
5460 "type": "A String", # The source type.
5461 "id": "A String", # The unique identifier within the source type generated by the server.
5462 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5463 #
5464 # Metadata about a source of type PROFILE.
5465 "userTypes": [ # Output only. The user types.
5466 "A String",
5467 ],
5468 "objectType": "A String", # Output only. The profile object type.
5469 },
5470 },
5471 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5472 # verified field is typically a name, email address, phone number, or
5473 # website that has been confirmed to be owned by the person.
5474 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5475 # field.
5476 },
5477 },
5478 ],
5479 "names": [ # The person's names.
5480 { # A person's name. If the name is a mononym, the family name is empty.
5481 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
5482 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
5483 "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to
5484 # the locale specified by the viewer's account or the
5485 # `Accept-Language` HTTP header.
5486 "displayName": "A String", # Output only. The display name formatted according to the locale specified by
5487 # the viewer's account or the `Accept-Language` HTTP header.
5488 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
5489 "middleName": "A String", # The middle name(s).
5490 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
5491 "familyName": "A String", # The family name.
5492 "phoneticFullName": "A String", # The full name spelled as it sounds.
5493 "phoneticGivenName": "A String", # The given name spelled as it sounds.
5494 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
5495 "givenName": "A String", # The given name.
5496 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
5497 "metadata": { # Metadata about a field. # Metadata about the name.
5498 "source": { # The source of a field. # The source of the field.
5499 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5500 #
5501 # Last update timestamp of this source.
5502 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5503 #
5504 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5505 # source. Used for web cache validation.
5506 "type": "A String", # The source type.
5507 "id": "A String", # The unique identifier within the source type generated by the server.
5508 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5509 #
5510 # Metadata about a source of type PROFILE.
5511 "userTypes": [ # Output only. The user types.
5512 "A String",
5513 ],
5514 "objectType": "A String", # Output only. The profile object type.
5515 },
5516 },
5517 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5518 # verified field is typically a name, email address, phone number, or
5519 # website that has been confirmed to be owned by the person.
5520 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5521 # field.
5522 },
5523 },
5524 ],
5525 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
5526 # with a max length of 27 characters, in the form of
5527 # `people/{person_id}`.
5528 "ageRanges": [ # Output only. The person's age ranges.
5529 { # A person's age range.
5530 "ageRange": "A String", # The age range.
5531 "metadata": { # Metadata about a field. # Metadata about the age range.
5532 "source": { # The source of a field. # The source of the field.
5533 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5534 #
5535 # Last update timestamp of this source.
5536 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5537 #
5538 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5539 # source. Used for web cache validation.
5540 "type": "A String", # The source type.
5541 "id": "A String", # The unique identifier within the source type generated by the server.
5542 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5543 #
5544 # Metadata about a source of type PROFILE.
5545 "userTypes": [ # Output only. The user types.
5546 "A String",
5547 ],
5548 "objectType": "A String", # Output only. The profile object type.
5549 },
5550 },
5551 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5552 # verified field is typically a name, email address, phone number, or
5553 # website that has been confirmed to be owned by the person.
5554 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5555 # field.
5556 },
5557 },
5558 ],
5559 "birthdays": [ # The person's birthdays.
5560 { # A person's birthday. At least one of the `date` and `text` fields are
5561 # specified. The `date` and `text` fields typically represent the same
5562 # date, but are not guaranteed to.
5563 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
5564 # and time zone are either specified elsewhere or are not significant. The date
5565 # is relative to the Proleptic Gregorian Calendar. This can represent:
5566 #
5567 # * A full date, with non-zero year, month and day values
5568 # * A month and day value, with a zero year, e.g. an anniversary
5569 # * A year on its own, with zero month and day values
5570 # * A year and month value, with a zero day, e.g. a credit card expiration date
5571 #
5572 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
5573 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
5574 # month and day.
5575 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
5576 # if specifying a year by itself or a year and month where the day is not
5577 # significant.
5578 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
5579 # a year.
5580 },
5581 "text": "A String", # A free-form string representing the user's birthday.
5582 "metadata": { # Metadata about a field. # Metadata about the birthday.
5583 "source": { # The source of a field. # The source of the field.
5584 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5585 #
5586 # Last update timestamp of this source.
5587 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5588 #
5589 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5590 # source. Used for web cache validation.
5591 "type": "A String", # The source type.
5592 "id": "A String", # The unique identifier within the source type generated by the server.
5593 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5594 #
5595 # Metadata about a source of type PROFILE.
5596 "userTypes": [ # Output only. The user types.
5597 "A String",
5598 ],
5599 "objectType": "A String", # Output only. The profile object type.
5600 },
5601 },
5602 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5603 # verified field is typically a name, email address, phone number, or
5604 # website that has been confirmed to be owned by the person.
5605 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5606 # field.
5607 },
5608 },
5609 ],
5610 "relations": [ # The person's relations.
5611 { # A person's relation to another person.
5612 "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
5613 # account locale or the locale specified in the Accept-Language HTTP header.
5614 "metadata": { # Metadata about a field. # Metadata about the relation.
5615 "source": { # The source of a field. # The source of the field.
5616 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5617 #
5618 # Last update timestamp of this source.
5619 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5620 #
5621 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5622 # source. Used for web cache validation.
5623 "type": "A String", # The source type.
5624 "id": "A String", # The unique identifier within the source type generated by the server.
5625 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5626 #
5627 # Metadata about a source of type PROFILE.
5628 "userTypes": [ # Output only. The user types.
5629 "A String",
5630 ],
5631 "objectType": "A String", # Output only. The profile object type.
5632 },
5633 },
5634 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5635 # verified field is typically a name, email address, phone number, or
5636 # website that has been confirmed to be owned by the person.
5637 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5638 # field.
5639 },
5640 "type": "A String", # The person's relation to the other person. The type can be custom or one of
5641 # these predefined values:
5642 #
5643 # * `spouse`
5644 # * `child`
5645 # * `mother`
5646 # * `father`
5647 # * `parent`
5648 # * `brother`
5649 # * `sister`
5650 # * `friend`
5651 # * `relative`
5652 # * `domesticPartner`
5653 # * `manager`
5654 # * `assistant`
5655 # * `referredBy`
5656 # * `partner`
5657 "person": "A String", # The name of the other person this relation refers to.
5658 },
5659 ],
5660 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5661 # resource. Used for web cache validation.
5662 "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
5663 # The person's relationship statuses.
5664 { # **DEPRECATED**: No data will be returned
5665 # A person's relationship status.
5666 "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
5667 # the viewer's account locale or the `Accept-Language` HTTP header locale.
5668 "value": "A String", # The relationship status. The value can be custom or one of these
5669 # predefined values:
5670 #
5671 # * `single`
5672 # * `inARelationship`
5673 # * `engaged`
5674 # * `married`
5675 # * `itsComplicated`
5676 # * `openRelationship`
5677 # * `widowed`
5678 # * `inDomesticPartnership`
5679 # * `inCivilUnion`
5680 "metadata": { # Metadata about a field. # Metadata about the relationship status.
5681 "source": { # The source of a field. # The source of the field.
5682 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5683 #
5684 # Last update timestamp of this source.
5685 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5686 #
5687 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5688 # source. Used for web cache validation.
5689 "type": "A String", # The source type.
5690 "id": "A String", # The unique identifier within the source type generated by the server.
5691 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5692 #
5693 # Metadata about a source of type PROFILE.
5694 "userTypes": [ # Output only. The user types.
5695 "A String",
5696 ],
5697 "objectType": "A String", # Output only. The profile object type.
5698 },
5699 },
5700 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5701 # verified field is typically a name, email address, phone number, or
5702 # website that has been confirmed to be owned by the person.
5703 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5704 # field.
5705 },
5706 },
5707 ],
5708 "skills": [ # The person's skills.
5709 { # A skill that the person has.
5710 "value": "A String", # The skill; for example, `underwater basket weaving`.
5711 "metadata": { # Metadata about a field. # Metadata about the skill.
5712 "source": { # The source of a field. # The source of the field.
5713 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5714 #
5715 # Last update timestamp of this source.
5716 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5717 #
5718 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5719 # source. Used for web cache validation.
5720 "type": "A String", # The source type.
5721 "id": "A String", # The unique identifier within the source type generated by the server.
5722 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5723 #
5724 # Metadata about a source of type PROFILE.
5725 "userTypes": [ # Output only. The user types.
5726 "A String",
5727 ],
5728 "objectType": "A String", # Output only. The profile object type.
5729 },
5730 },
5731 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5732 # verified field is typically a name, email address, phone number, or
5733 # website that has been confirmed to be owned by the person.
5734 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5735 # field.
5736 },
5737 },
5738 ],
5739 "imClients": [ # The person's instant messaging clients.
5740 { # A person's instant messaging client.
5741 "username": "A String", # The user name used in the IM client.
5742 "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
5743 # viewer's account locale or the `Accept-Language` HTTP header locale.
5744 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
5745 # predefined values:
5746 #
5747 # * `aim`
5748 # * `msn`
5749 # * `yahoo`
5750 # * `skype`
5751 # * `qq`
5752 # * `googleTalk`
5753 # * `icq`
5754 # * `jabber`
5755 # * `netMeeting`
5756 "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account
5757 # locale or the `Accept-Language` HTTP header locale.
5758 "type": "A String", # The type of the IM client. The type can be custom or one of these
5759 # predefined values:
5760 #
5761 # * `home`
5762 # * `work`
5763 # * `other`
5764 "metadata": { # Metadata about a field. # Metadata about the IM client.
5765 "source": { # The source of a field. # The source of the field.
5766 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5767 #
5768 # Last update timestamp of this source.
5769 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5770 #
5771 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5772 # source. Used for web cache validation.
5773 "type": "A String", # The source type.
5774 "id": "A String", # The unique identifier within the source type generated by the server.
5775 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5776 #
5777 # Metadata about a source of type PROFILE.
5778 "userTypes": [ # Output only. The user types.
5779 "A String",
5780 ],
5781 "objectType": "A String", # Output only. The profile object type.
5782 },
5783 },
5784 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5785 # verified field is typically a name, email address, phone number, or
5786 # website that has been confirmed to be owned by the person.
5787 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5788 # field.
5789 },
5790 },
5791 ],
5792 "events": [ # The person's events.
5793 { # An event related to the person.
5794 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
5795 # and time zone are either specified elsewhere or are not significant. The date
5796 # is relative to the Proleptic Gregorian Calendar. This can represent:
5797 #
5798 # * A full date, with non-zero year, month and day values
5799 # * A month and day value, with a zero year, e.g. an anniversary
5800 # * A year on its own, with zero month and day values
5801 # * A year and month value, with a zero day, e.g. a credit card expiration date
5802 #
5803 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
5804 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
5805 # month and day.
5806 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
5807 # if specifying a year by itself or a year and month where the day is not
5808 # significant.
5809 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
5810 # a year.
5811 },
5812 "formattedType": "A String", # Output only. The type of the event translated and formatted in the
5813 # viewer's account locale or the `Accept-Language` HTTP header locale.
5814 "type": "A String", # The type of the event. The type can be custom or one of these predefined
5815 # values:
5816 #
5817 # * `anniversary`
5818 # * `other`
5819 "metadata": { # Metadata about a field. # Metadata about the event.
5820 "source": { # The source of a field. # The source of the field.
5821 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5822 #
5823 # Last update timestamp of this source.
5824 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5825 #
5826 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5827 # source. Used for web cache validation.
5828 "type": "A String", # The source type.
5829 "id": "A String", # The unique identifier within the source type generated by the server.
5830 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5831 #
5832 # Metadata about a source of type PROFILE.
5833 "userTypes": [ # Output only. The user types.
5834 "A String",
5835 ],
5836 "objectType": "A String", # Output only. The profile object type.
5837 },
5838 },
5839 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5840 # verified field is typically a name, email address, phone number, or
5841 # website that has been confirmed to be owned by the person.
5842 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5843 # field.
5844 },
5845 },
5846 ],
5847 "metadata": { # The metadata about a person. # Output only. Metadata about the person.
5848 "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for
5849 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
5850 # that include a sync token.
5851 "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for
5852 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
5853 # that include a sync token.
5854 #
5855 # The resource name may change when adding or removing fields that link a
5856 # contact and profile such as a verified email, verified phone number, or
5857 # profile URL.
5858 "A String",
5859 ],
5860 "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
5861 "A String",
5862 ],
5863 "sources": [ # The sources of data for the person.
5864 { # The source of a field.
5865 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5866 #
5867 # Last update timestamp of this source.
5868 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5869 #
5870 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5871 # source. Used for web cache validation.
5872 "type": "A String", # The source type.
5873 "id": "A String", # The unique identifier within the source type generated by the server.
5874 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5875 #
5876 # Metadata about a source of type PROFILE.
5877 "userTypes": [ # Output only. The user types.
5878 "A String",
5879 ],
5880 "objectType": "A String", # Output only. The profile object type.
5881 },
5882 },
5883 ],
5884 "objectType": "A String", # Output only. **DEPRECATED** (Please use
5885 # `person.metadata.sources.profileMetadata.objectType` instead)
5886 #
5887 # The type of the person object.
5888 },
5889 "interests": [ # The person's interests.
5890 { # One of the person's interests.
5891 "value": "A String", # The interest; for example, `stargazing`.
5892 "metadata": { # Metadata about a field. # Metadata about the interest.
5893 "source": { # The source of a field. # The source of the field.
5894 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5895 #
5896 # Last update timestamp of this source.
5897 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5898 #
5899 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5900 # source. Used for web cache validation.
5901 "type": "A String", # The source type.
5902 "id": "A String", # The unique identifier within the source type generated by the server.
5903 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5904 #
5905 # Metadata about a source of type PROFILE.
5906 "userTypes": [ # Output only. The user types.
5907 "A String",
5908 ],
5909 "objectType": "A String", # Output only. The profile object type.
5910 },
5911 },
5912 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5913 # verified field is typically a name, email address, phone number, or
5914 # website that has been confirmed to be owned by the person.
5915 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5916 # field.
5917 },
5918 },
5919 ],
5920 "photos": [ # Output only. The person's photos.
5921 { # A person's photo. A picture shown next to the person's name to
5922 # help others recognize the person.
5923 "default": True or False, # True if the photo is a default photo;
5924 # false if the photo is a user-provided photo.
5925 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
5926 # parameter `sz={size}` at the end of the url, where {size} is the size in
5927 # pixels. Example:
5928 # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
5929 "metadata": { # Metadata about a field. # Metadata about the photo.
5930 "source": { # The source of a field. # The source of the field.
5931 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5932 #
5933 # Last update timestamp of this source.
5934 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5935 #
5936 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5937 # source. Used for web cache validation.
5938 "type": "A String", # The source type.
5939 "id": "A String", # The unique identifier within the source type generated by the server.
5940 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5941 #
5942 # Metadata about a source of type PROFILE.
5943 "userTypes": [ # Output only. The user types.
5944 "A String",
5945 ],
5946 "objectType": "A String", # Output only. The profile object type.
5947 },
5948 },
5949 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5950 # verified field is typically a name, email address, phone number, or
5951 # website that has been confirmed to be owned by the person.
5952 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5953 # field.
5954 },
5955 },
5956 ],
5957 "residences": [ # The person's residences.
5958 { # A person's past or current residence.
5959 "current": True or False, # True if the residence is the person's current residence;
5960 # false if the residence is a past residence.
5961 "value": "A String", # The address of the residence.
5962 "metadata": { # Metadata about a field. # Metadata about the residence.
5963 "source": { # The source of a field. # The source of the field.
5964 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
5965 #
5966 # Last update timestamp of this source.
5967 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5968 #
5969 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5970 # source. Used for web cache validation.
5971 "type": "A String", # The source type.
5972 "id": "A String", # The unique identifier within the source type generated by the server.
5973 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
5974 #
5975 # Metadata about a source of type PROFILE.
5976 "userTypes": [ # Output only. The user types.
5977 "A String",
5978 ],
5979 "objectType": "A String", # Output only. The profile object type.
5980 },
5981 },
5982 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
5983 # verified field is typically a name, email address, phone number, or
5984 # website that has been confirmed to be owned by the person.
5985 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5986 # field.
5987 },
5988 },
5989 ],
5990 "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
5991 # The person's relationship interests.
5992 { # **DEPRECATED**: No data will be returned
5993 # A person's relationship interest .
5994 "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
5995 # in the viewer's account locale or the locale specified in the
5996 # Accept-Language HTTP header.
5997 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
5998 # or one of these predefined values:
5999 #
6000 # * `friend`
6001 # * `date`
6002 # * `relationship`
6003 # * `networking`
6004 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
6005 "source": { # The source of a field. # The source of the field.
6006 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6007 #
6008 # Last update timestamp of this source.
6009 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6010 #
6011 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6012 # source. Used for web cache validation.
6013 "type": "A String", # The source type.
6014 "id": "A String", # The unique identifier within the source type generated by the server.
6015 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6016 #
6017 # Metadata about a source of type PROFILE.
6018 "userTypes": [ # Output only. The user types.
6019 "A String",
6020 ],
6021 "objectType": "A String", # Output only. The profile object type.
6022 },
6023 },
6024 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6025 # verified field is typically a name, email address, phone number, or
6026 # website that has been confirmed to be owned by the person.
6027 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6028 # field.
6029 },
6030 },
6031 ],
6032 "coverPhotos": [ # Output only. The person's cover photos.
6033 { # A person's cover photo. A large image shown on the person's
6034 # profile page that represents who they are or what they care about.
6035 "default": True or False, # True if the cover photo is the default cover photo;
6036 # false if the cover photo is a user-provided cover photo.
6037 "url": "A String", # The URL of the cover photo.
6038 "metadata": { # Metadata about a field. # Metadata about the cover photo.
6039 "source": { # The source of a field. # The source of the field.
6040 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6041 #
6042 # Last update timestamp of this source.
6043 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6044 #
6045 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6046 # source. Used for web cache validation.
6047 "type": "A String", # The source type.
6048 "id": "A String", # The unique identifier within the source type generated by the server.
6049 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6050 #
6051 # Metadata about a source of type PROFILE.
6052 "userTypes": [ # Output only. The user types.
6053 "A String",
6054 ],
6055 "objectType": "A String", # Output only. The profile object type.
6056 },
6057 },
6058 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6059 # verified field is typically a name, email address, phone number, or
6060 # website that has been confirmed to be owned by the person.
6061 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6062 # field.
6063 },
6064 },
6065 ],
6066 "locales": [ # The person's locale preferences.
6067 { # A person's locale preference.
6068 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
6069 # language tag representing the locale.
6070 "metadata": { # Metadata about a field. # Metadata about the locale.
6071 "source": { # The source of a field. # The source of the field.
6072 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6073 #
6074 # Last update timestamp of this source.
6075 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6076 #
6077 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6078 # source. Used for web cache validation.
6079 "type": "A String", # The source type.
6080 "id": "A String", # The unique identifier within the source type generated by the server.
6081 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6082 #
6083 # Metadata about a source of type PROFILE.
6084 "userTypes": [ # Output only. The user types.
6085 "A String",
6086 ],
6087 "objectType": "A String", # Output only. The profile object type.
6088 },
6089 },
6090 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6091 # verified field is typically a name, email address, phone number, or
6092 # website that has been confirmed to be owned by the person.
6093 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6094 # field.
6095 },
6096 },
6097 ],
6098 "organizations": [ # The person's past or current organizations.
6099 { # A person's past or current organization. Overlapping date ranges are
6100 # permitted.
6101 "formattedType": "A String", # Output only. The type of the organization translated and formatted in the
6102 # viewer's account locale or the `Accept-Language` HTTP header locale.
6103 "domain": "A String", # The domain name associated with the organization; for example,
6104 # `google.com`.
6105 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.
6106 # and time zone are either specified elsewhere or are not significant. The date
6107 # is relative to the Proleptic Gregorian Calendar. This can represent:
6108 #
6109 # * A full date, with non-zero year, month and day values
6110 # * A month and day value, with a zero year, e.g. an anniversary
6111 # * A year on its own, with zero month and day values
6112 # * A year and month value, with a zero day, e.g. a credit card expiration date
6113 #
6114 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
6115 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
6116 # month and day.
6117 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
6118 # if specifying a year by itself or a year and month where the day is not
6119 # significant.
6120 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
6121 # a year.
6122 },
6123 "name": "A String", # The name of the organization.
6124 "title": "A String", # The person's job title at the organization.
6125 "type": "A String", # The type of the organization. The type can be custom or one of these
6126 # predefined values:
6127 #
6128 # * `work`
6129 # * `school`
6130 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
6131 # symbol, abbreviation, or acronym.
6132 "current": True or False, # True if the organization is the person's current organization;
6133 # false if the organization is a past organization.
6134 "jobDescription": "A String", # The person's job description at the organization.
6135 "location": "A String", # The location of the organization office the person works at.
6136 "department": "A String", # The person's department at the organization.
6137 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.
6138 # and time zone are either specified elsewhere or are not significant. The date
6139 # is relative to the Proleptic Gregorian Calendar. This can represent:
6140 #
6141 # * A full date, with non-zero year, month and day values
6142 # * A month and day value, with a zero year, e.g. an anniversary
6143 # * A year on its own, with zero month and day values
6144 # * A year and month value, with a zero day, e.g. a credit card expiration date
6145 #
6146 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
6147 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
6148 # month and day.
6149 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
6150 # if specifying a year by itself or a year and month where the day is not
6151 # significant.
6152 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
6153 # a year.
6154 },
6155 "phoneticName": "A String", # The phonetic name of the organization.
6156 "metadata": { # Metadata about a field. # Metadata about the organization.
6157 "source": { # The source of a field. # The source of the field.
6158 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6159 #
6160 # Last update timestamp of this source.
6161 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6162 #
6163 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6164 # source. Used for web cache validation.
6165 "type": "A String", # The source type.
6166 "id": "A String", # The unique identifier within the source type generated by the server.
6167 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6168 #
6169 # Metadata about a source of type PROFILE.
6170 "userTypes": [ # Output only. The user types.
6171 "A String",
6172 ],
6173 "objectType": "A String", # Output only. The profile object type.
6174 },
6175 },
6176 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6177 # verified field is typically a name, email address, phone number, or
6178 # website that has been confirmed to be owned by the person.
6179 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6180 # field.
6181 },
6182 },
6183 ],
6184 "userDefined": [ # The person's user defined data.
6185 { # Arbitrary user data that is populated by the end users.
6186 "key": "A String", # The end user specified key of the user defined data.
6187 "value": "A String", # The end user specified value of the user defined data.
6188 "metadata": { # Metadata about a field. # Metadata about the user defined data.
6189 "source": { # The source of a field. # The source of the field.
6190 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6191 #
6192 # Last update timestamp of this source.
6193 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6194 #
6195 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6196 # source. Used for web cache validation.
6197 "type": "A String", # The source type.
6198 "id": "A String", # The unique identifier within the source type generated by the server.
6199 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6200 #
6201 # Metadata about a source of type PROFILE.
6202 "userTypes": [ # Output only. The user types.
6203 "A String",
6204 ],
6205 "objectType": "A String", # Output only. The profile object type.
6206 },
6207 },
6208 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6209 # verified field is typically a name, email address, phone number, or
6210 # website that has been confirmed to be owned by the person.
6211 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6212 # field.
6213 },
6214 },
6215 ],
6216 "biographies": [ # The person's biographies.
6217 { # A person's short biography.
6218 "contentType": "A String", # The content type of the biography.
6219 "value": "A String", # The short biography.
6220 "metadata": { # Metadata about a field. # Metadata about the biography.
6221 "source": { # The source of a field. # The source of the field.
6222 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6223 #
6224 # Last update timestamp of this source.
6225 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6226 #
6227 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6228 # source. Used for web cache validation.
6229 "type": "A String", # The source type.
6230 "id": "A String", # The unique identifier within the source type generated by the server.
6231 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6232 #
6233 # Metadata about a source of type PROFILE.
6234 "userTypes": [ # Output only. The user types.
6235 "A String",
6236 ],
6237 "objectType": "A String", # Output only. The profile object type.
6238 },
6239 },
6240 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6241 # verified field is typically a name, email address, phone number, or
6242 # website that has been confirmed to be owned by the person.
6243 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6244 # field.
6245 },
6246 },
6247 ],
6248 "memberships": [ # The person's group memberships.
6249 { # A person's membership in a group. Only contact group memberships can be
6250 # modified.
6251 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
6252 "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
6253 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
6254 # string, in the form of `contactGroups/{contact_group_id}`.
6255 # Only contact_group_resource_name can be used for modifying memberships.
6256 # Any contact group membership can be removed, but only user group or
6257 # "myContacts" or "starred" system groups memberships can be added. A
6258 # contact must always have at least one contact group membership.
6259 },
6260 "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
6261 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
6262 },
6263 "metadata": { # Metadata about a field. # Metadata about the membership.
6264 "source": { # The source of a field. # The source of the field.
6265 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6266 #
6267 # Last update timestamp of this source.
6268 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6269 #
6270 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6271 # source. Used for web cache validation.
6272 "type": "A String", # The source type.
6273 "id": "A String", # The unique identifier within the source type generated by the server.
6274 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6275 #
6276 # Metadata about a source of type PROFILE.
6277 "userTypes": [ # Output only. The user types.
6278 "A String",
6279 ],
6280 "objectType": "A String", # Output only. The profile object type.
6281 },
6282 },
6283 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6284 # verified field is typically a name, email address, phone number, or
6285 # website that has been confirmed to be owned by the person.
6286 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6287 # field.
6288 },
6289 },
6290 ],
6291 "taglines": [ # Output only. **DEPRECATED**: No data will be returned
6292 # The person's taglines.
6293 { # **DEPRECATED**: No data will be returned
6294 # A brief one-line description of the person.
6295 "value": "A String", # The tagline.
6296 "metadata": { # Metadata about a field. # Metadata about the tagline.
6297 "source": { # The source of a field. # The source of the field.
6298 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6299 #
6300 # Last update timestamp of this source.
6301 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6302 #
6303 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6304 # source. Used for web cache validation.
6305 "type": "A String", # The source type.
6306 "id": "A String", # The unique identifier within the source type generated by the server.
6307 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6308 #
6309 # Metadata about a source of type PROFILE.
6310 "userTypes": [ # Output only. The user types.
6311 "A String",
6312 ],
6313 "objectType": "A String", # Output only. The profile object type.
6314 },
6315 },
6316 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6317 # verified field is typically a name, email address, phone number, or
6318 # website that has been confirmed to be owned by the person.
6319 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6320 # field.
6321 },
6322 },
6323 ],
6324 "urls": [ # The person's associated URLs.
6325 { # A person's associated URLs.
6326 "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
6327 # account locale or the `Accept-Language` HTTP header locale.
6328 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
6329 # values:
6330 #
6331 # * `home`
6332 # * `work`
6333 # * `blog`
6334 # * `profile`
6335 # * `homePage`
6336 # * `ftp`
6337 # * `reservations`
6338 # * `appInstallPage`: website for a Google+ application.
6339 # * `other`
6340 "value": "A String", # The URL.
6341 "metadata": { # Metadata about a field. # Metadata about the URL.
6342 "source": { # The source of a field. # The source of the field.
6343 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6344 #
6345 # Last update timestamp of this source.
6346 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6347 #
6348 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6349 # source. Used for web cache validation.
6350 "type": "A String", # The source type.
6351 "id": "A String", # The unique identifier within the source type generated by the server.
6352 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6353 #
6354 # Metadata about a source of type PROFILE.
6355 "userTypes": [ # Output only. The user types.
6356 "A String",
6357 ],
6358 "objectType": "A String", # Output only. The profile object type.
6359 },
6360 },
6361 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6362 # verified field is typically a name, email address, phone number, or
6363 # website that has been confirmed to be owned by the person.
6364 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6365 # field.
6366 },
6367 },
6368 ],
6369 "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
6370 #
6371 # The person's age range.
6372 "genders": [ # The person's genders.
6373 { # A person's gender.
6374 "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account
6375 # locale or the `Accept-Language` HTTP header locale. Unspecified or custom
6376 # value are not localized.
6377 "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value
6378 # can be custom or one of these predefined values:
6379 #
6380 # * `male`
6381 # * `female`
6382 # * `other`
6383 "value": "A String", # The gender for the person. The gender can be custom or one of these
6384 # predefined values:
6385 #
6386 # * `male`
6387 # * `female`
6388 # * `unspecified`
6389 "metadata": { # Metadata about a field. # Metadata about the gender.
6390 "source": { # The source of a field. # The source of the field.
6391 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6392 #
6393 # Last update timestamp of this source.
6394 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6395 #
6396 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6397 # source. Used for web cache validation.
6398 "type": "A String", # The source type.
6399 "id": "A String", # The unique identifier within the source type generated by the server.
6400 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6401 #
6402 # Metadata about a source of type PROFILE.
6403 "userTypes": [ # Output only. The user types.
6404 "A String",
6405 ],
6406 "objectType": "A String", # Output only. The profile object type.
6407 },
6408 },
6409 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6410 # verified field is typically a name, email address, phone number, or
6411 # website that has been confirmed to be owned by the person.
6412 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6413 # field.
6414 },
6415 },
6416 ],
6417 "emailAddresses": [ # The person's email addresses.
6418 { # A person's email address.
6419 "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
6420 # viewer's account locale or the `Accept-Language` HTTP header locale.
6421 "metadata": { # Metadata about a field. # Metadata about the email address.
6422 "source": { # The source of a field. # The source of the field.
6423 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6424 #
6425 # Last update timestamp of this source.
6426 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6427 #
6428 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6429 # source. Used for web cache validation.
6430 "type": "A String", # The source type.
6431 "id": "A String", # The unique identifier within the source type generated by the server.
6432 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6433 #
6434 # Metadata about a source of type PROFILE.
6435 "userTypes": [ # Output only. The user types.
6436 "A String",
6437 ],
6438 "objectType": "A String", # Output only. The profile object type.
6439 },
6440 },
6441 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6442 # verified field is typically a name, email address, phone number, or
6443 # website that has been confirmed to be owned by the person.
6444 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6445 # field.
6446 },
6447 "displayName": "A String", # The display name of the email.
6448 "value": "A String", # The email address.
6449 "type": "A String", # The type of the email address. The type can be custom or one of these
6450 # predefined values:
6451 #
6452 # * `home`
6453 # * `work`
6454 # * `other`
6455 },
6456 ],
6457 },
6458 "httpStatusCode": 42, # **DEPRECATED** (Please use status instead)
6459 #
6460 # [HTTP 1.1 status code]
6461 # (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
6462 "requestedResourceName": "A String", # The original requested resource name. May be different than the resource
6463 # name on the returned person.
6464 #
6465 # The resource name can change when adding or removing fields that link a
6466 # contact and profile such as a verified email, verified phone number, or a
6467 # profile URL.
6468 },
6469 ],
6470 }</pre>
6471</div>
6472
6473<div class="method">
6474 <code class="details" id="updateContact">updateContact(resourceName, body=None, x__xgafv=None, updatePersonFields=None)</code>
6475 <pre>Update contact data for an existing contact person. Any non-contact data
6476will not be modified.
6477
6478The request throws a 400 error if `updatePersonFields` is not specified.
6479
6480The request throws a 400 error if `person.metadata.sources` is not
6481specified for the contact to be updated.
6482
6483The request throws a 400 error with an error with reason
6484`"failedPrecondition"` if `person.metadata.sources.etag` is different than
6485the contact's etag, which indicates the contact has changed since its data
6486was read. Clients should get the latest person and re-apply their updates
6487to the latest person.
6488
6489Args:
6490 resourceName: string, The resource name for the person, assigned by the server. An ASCII string
6491with a max length of 27 characters, in the form of
6492`people/{person_id}`. (required)
6493 body: object, The request body.
6494 The object takes the form of:
6495
6496{ # Information about a person merged from various data sources such as the
6497 # authenticated user's contacts and profile data.
6498 #
6499 # Most fields can have multiple items. The items in a field have no guaranteed
6500 # order, but each non-empty field is guaranteed to have exactly one field with
6501 # `metadata.primary` set to true.
6502 "sipAddresses": [ # The person's SIP addresses.
6503 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
6504 # communications to make voice or video calls over the internet.
6505 "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
6506 # viewer's account locale or the `Accept-Language` HTTP header locale.
6507 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
6508 # predefined values:
6509 #
6510 # * `home`
6511 # * `work`
6512 # * `mobile`
6513 # * `other`
6514 "value": "A String", # The SIP address in the
6515 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
6516 # format.
6517 "metadata": { # Metadata about a field. # Metadata about the SIP address.
6518 "source": { # The source of a field. # The source of the field.
6519 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6520 #
6521 # Last update timestamp of this source.
6522 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6523 #
6524 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6525 # source. Used for web cache validation.
6526 "type": "A String", # The source type.
6527 "id": "A String", # The unique identifier within the source type generated by the server.
6528 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6529 #
6530 # Metadata about a source of type PROFILE.
6531 "userTypes": [ # Output only. The user types.
6532 "A String",
6533 ],
6534 "objectType": "A String", # Output only. The profile object type.
6535 },
6536 },
6537 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6538 # verified field is typically a name, email address, phone number, or
6539 # website that has been confirmed to be owned by the person.
6540 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6541 # field.
6542 },
6543 },
6544 ],
6545 "braggingRights": [ # **DEPRECATED**: No data will be returned
6546 # The person's bragging rights.
6547 { # **DEPRECATED**: No data will be returned
6548 # A person's bragging rights.
6549 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
6550 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
6551 "source": { # The source of a field. # The source of the field.
6552 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6553 #
6554 # Last update timestamp of this source.
6555 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6556 #
6557 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6558 # source. Used for web cache validation.
6559 "type": "A String", # The source type.
6560 "id": "A String", # The unique identifier within the source type generated by the server.
6561 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6562 #
6563 # Metadata about a source of type PROFILE.
6564 "userTypes": [ # Output only. The user types.
6565 "A String",
6566 ],
6567 "objectType": "A String", # Output only. The profile object type.
6568 },
6569 },
6570 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6571 # verified field is typically a name, email address, phone number, or
6572 # website that has been confirmed to be owned by the person.
6573 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6574 # field.
6575 },
6576 },
6577 ],
6578 "addresses": [ # The person's street addresses.
6579 { # A person's physical address. May be a P.O. box or street address. All fields
6580 # are optional.
6581 "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's
6582 # account locale or the `Accept-Language` HTTP header locale.
6583 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
6584 # code of the address.
6585 "city": "A String", # The city of the address.
6586 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
6587 # will be automatically constructed from structured values.
6588 "region": "A String", # The region of the address; for example, the state or province.
6589 "poBox": "A String", # The P.O. box of the address.
6590 "streetAddress": "A String", # The street address.
6591 "country": "A String", # The country of the address.
6592 "postalCode": "A String", # The postal code of the address.
6593 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
6594 "type": "A String", # The type of the address. The type can be custom or one of these predefined
6595 # values:
6596 #
6597 # * `home`
6598 # * `work`
6599 # * `other`
6600 "metadata": { # Metadata about a field. # Metadata about the address.
6601 "source": { # The source of a field. # The source of the field.
6602 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6603 #
6604 # Last update timestamp of this source.
6605 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6606 #
6607 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6608 # source. Used for web cache validation.
6609 "type": "A String", # The source type.
6610 "id": "A String", # The unique identifier within the source type generated by the server.
6611 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6612 #
6613 # Metadata about a source of type PROFILE.
6614 "userTypes": [ # Output only. The user types.
6615 "A String",
6616 ],
6617 "objectType": "A String", # Output only. The profile object type.
6618 },
6619 },
6620 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6621 # verified field is typically a name, email address, phone number, or
6622 # website that has been confirmed to be owned by the person.
6623 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6624 # field.
6625 },
6626 },
6627 ],
6628 "nicknames": [ # The person's nicknames.
6629 { # A person's nickname.
6630 "type": "A String", # The type of the nickname.
6631 "value": "A String", # The nickname.
6632 "metadata": { # Metadata about a field. # Metadata about the nickname.
6633 "source": { # The source of a field. # The source of the field.
6634 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6635 #
6636 # Last update timestamp of this source.
6637 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6638 #
6639 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6640 # source. Used for web cache validation.
6641 "type": "A String", # The source type.
6642 "id": "A String", # The unique identifier within the source type generated by the server.
6643 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6644 #
6645 # Metadata about a source of type PROFILE.
6646 "userTypes": [ # Output only. The user types.
6647 "A String",
6648 ],
6649 "objectType": "A String", # Output only. The profile object type.
6650 },
6651 },
6652 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6653 # verified field is typically a name, email address, phone number, or
6654 # website that has been confirmed to be owned by the person.
6655 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6656 # field.
6657 },
6658 },
6659 ],
6660 "occupations": [ # The person's occupations.
6661 { # A person's occupation.
6662 "value": "A String", # The occupation; for example, `carpenter`.
6663 "metadata": { # Metadata about a field. # Metadata about the occupation.
6664 "source": { # The source of a field. # The source of the field.
6665 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6666 #
6667 # Last update timestamp of this source.
6668 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6669 #
6670 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6671 # source. Used for web cache validation.
6672 "type": "A String", # The source type.
6673 "id": "A String", # The unique identifier within the source type generated by the server.
6674 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6675 #
6676 # Metadata about a source of type PROFILE.
6677 "userTypes": [ # Output only. The user types.
6678 "A String",
6679 ],
6680 "objectType": "A String", # Output only. The profile object type.
6681 },
6682 },
6683 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6684 # verified field is typically a name, email address, phone number, or
6685 # website that has been confirmed to be owned by the person.
6686 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6687 # field.
6688 },
6689 },
6690 ],
6691 "phoneNumbers": [ # The person's phone numbers.
6692 { # A person's phone number.
6693 "canonicalForm": "A String", # Output only. The canonicalized [ITU-T
6694 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
6695 # form of the phone number.
6696 "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the
6697 # viewer's account locale or the `Accept-Language` HTTP header locale.
6698 "type": "A String", # The type of the phone number. The type can be custom or one of these
6699 # predefined values:
6700 #
6701 # * `home`
6702 # * `work`
6703 # * `mobile`
6704 # * `homeFax`
6705 # * `workFax`
6706 # * `otherFax`
6707 # * `pager`
6708 # * `workMobile`
6709 # * `workPager`
6710 # * `main`
6711 # * `googleVoice`
6712 # * `other`
6713 "value": "A String", # The phone number.
6714 "metadata": { # Metadata about a field. # Metadata about the phone number.
6715 "source": { # The source of a field. # The source of the field.
6716 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6717 #
6718 # Last update timestamp of this source.
6719 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6720 #
6721 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6722 # source. Used for web cache validation.
6723 "type": "A String", # The source type.
6724 "id": "A String", # The unique identifier within the source type generated by the server.
6725 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6726 #
6727 # Metadata about a source of type PROFILE.
6728 "userTypes": [ # Output only. The user types.
6729 "A String",
6730 ],
6731 "objectType": "A String", # Output only. The profile object type.
6732 },
6733 },
6734 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6735 # verified field is typically a name, email address, phone number, or
6736 # website that has been confirmed to be owned by the person.
6737 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6738 # field.
6739 },
6740 },
6741 ],
6742 "names": [ # The person's names.
6743 { # A person's name. If the name is a mononym, the family name is empty.
6744 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
6745 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
6746 "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to
6747 # the locale specified by the viewer's account or the
6748 # `Accept-Language` HTTP header.
6749 "displayName": "A String", # Output only. The display name formatted according to the locale specified by
6750 # the viewer's account or the `Accept-Language` HTTP header.
6751 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
6752 "middleName": "A String", # The middle name(s).
6753 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
6754 "familyName": "A String", # The family name.
6755 "phoneticFullName": "A String", # The full name spelled as it sounds.
6756 "phoneticGivenName": "A String", # The given name spelled as it sounds.
6757 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
6758 "givenName": "A String", # The given name.
6759 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
6760 "metadata": { # Metadata about a field. # Metadata about the name.
6761 "source": { # The source of a field. # The source of the field.
6762 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6763 #
6764 # Last update timestamp of this source.
6765 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6766 #
6767 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6768 # source. Used for web cache validation.
6769 "type": "A String", # The source type.
6770 "id": "A String", # The unique identifier within the source type generated by the server.
6771 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6772 #
6773 # Metadata about a source of type PROFILE.
6774 "userTypes": [ # Output only. The user types.
6775 "A String",
6776 ],
6777 "objectType": "A String", # Output only. The profile object type.
6778 },
6779 },
6780 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6781 # verified field is typically a name, email address, phone number, or
6782 # website that has been confirmed to be owned by the person.
6783 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6784 # field.
6785 },
6786 },
6787 ],
6788 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
6789 # with a max length of 27 characters, in the form of
6790 # `people/{person_id}`.
6791 "ageRanges": [ # Output only. The person's age ranges.
6792 { # A person's age range.
6793 "ageRange": "A String", # The age range.
6794 "metadata": { # Metadata about a field. # Metadata about the age range.
6795 "source": { # The source of a field. # The source of the field.
6796 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6797 #
6798 # Last update timestamp of this source.
6799 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6800 #
6801 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6802 # source. Used for web cache validation.
6803 "type": "A String", # The source type.
6804 "id": "A String", # The unique identifier within the source type generated by the server.
6805 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6806 #
6807 # Metadata about a source of type PROFILE.
6808 "userTypes": [ # Output only. The user types.
6809 "A String",
6810 ],
6811 "objectType": "A String", # Output only. The profile object type.
6812 },
6813 },
6814 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6815 # verified field is typically a name, email address, phone number, or
6816 # website that has been confirmed to be owned by the person.
6817 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6818 # field.
6819 },
6820 },
6821 ],
6822 "birthdays": [ # The person's birthdays.
6823 { # A person's birthday. At least one of the `date` and `text` fields are
6824 # specified. The `date` and `text` fields typically represent the same
6825 # date, but are not guaranteed to.
6826 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
6827 # and time zone are either specified elsewhere or are not significant. The date
6828 # is relative to the Proleptic Gregorian Calendar. This can represent:
6829 #
6830 # * A full date, with non-zero year, month and day values
6831 # * A month and day value, with a zero year, e.g. an anniversary
6832 # * A year on its own, with zero month and day values
6833 # * A year and month value, with a zero day, e.g. a credit card expiration date
6834 #
6835 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
6836 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
6837 # month and day.
6838 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
6839 # if specifying a year by itself or a year and month where the day is not
6840 # significant.
6841 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
6842 # a year.
6843 },
6844 "text": "A String", # A free-form string representing the user's birthday.
6845 "metadata": { # Metadata about a field. # Metadata about the birthday.
6846 "source": { # The source of a field. # The source of the field.
6847 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6848 #
6849 # Last update timestamp of this source.
6850 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6851 #
6852 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6853 # source. Used for web cache validation.
6854 "type": "A String", # The source type.
6855 "id": "A String", # The unique identifier within the source type generated by the server.
6856 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6857 #
6858 # Metadata about a source of type PROFILE.
6859 "userTypes": [ # Output only. The user types.
6860 "A String",
6861 ],
6862 "objectType": "A String", # Output only. The profile object type.
6863 },
6864 },
6865 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6866 # verified field is typically a name, email address, phone number, or
6867 # website that has been confirmed to be owned by the person.
6868 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6869 # field.
6870 },
6871 },
6872 ],
6873 "relations": [ # The person's relations.
6874 { # A person's relation to another person.
6875 "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
6876 # account locale or the locale specified in the Accept-Language HTTP header.
6877 "metadata": { # Metadata about a field. # Metadata about the relation.
6878 "source": { # The source of a field. # The source of the field.
6879 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6880 #
6881 # Last update timestamp of this source.
6882 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6883 #
6884 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6885 # source. Used for web cache validation.
6886 "type": "A String", # The source type.
6887 "id": "A String", # The unique identifier within the source type generated by the server.
6888 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6889 #
6890 # Metadata about a source of type PROFILE.
6891 "userTypes": [ # Output only. The user types.
6892 "A String",
6893 ],
6894 "objectType": "A String", # Output only. The profile object type.
6895 },
6896 },
6897 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6898 # verified field is typically a name, email address, phone number, or
6899 # website that has been confirmed to be owned by the person.
6900 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6901 # field.
6902 },
6903 "type": "A String", # The person's relation to the other person. The type can be custom or one of
6904 # these predefined values:
6905 #
6906 # * `spouse`
6907 # * `child`
6908 # * `mother`
6909 # * `father`
6910 # * `parent`
6911 # * `brother`
6912 # * `sister`
6913 # * `friend`
6914 # * `relative`
6915 # * `domesticPartner`
6916 # * `manager`
6917 # * `assistant`
6918 # * `referredBy`
6919 # * `partner`
6920 "person": "A String", # The name of the other person this relation refers to.
6921 },
6922 ],
6923 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6924 # resource. Used for web cache validation.
6925 "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
6926 # The person's relationship statuses.
6927 { # **DEPRECATED**: No data will be returned
6928 # A person's relationship status.
6929 "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
6930 # the viewer's account locale or the `Accept-Language` HTTP header locale.
6931 "value": "A String", # The relationship status. The value can be custom or one of these
6932 # predefined values:
6933 #
6934 # * `single`
6935 # * `inARelationship`
6936 # * `engaged`
6937 # * `married`
6938 # * `itsComplicated`
6939 # * `openRelationship`
6940 # * `widowed`
6941 # * `inDomesticPartnership`
6942 # * `inCivilUnion`
6943 "metadata": { # Metadata about a field. # Metadata about the relationship status.
6944 "source": { # The source of a field. # The source of the field.
6945 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6946 #
6947 # Last update timestamp of this source.
6948 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6949 #
6950 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6951 # source. Used for web cache validation.
6952 "type": "A String", # The source type.
6953 "id": "A String", # The unique identifier within the source type generated by the server.
6954 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6955 #
6956 # Metadata about a source of type PROFILE.
6957 "userTypes": [ # Output only. The user types.
6958 "A String",
6959 ],
6960 "objectType": "A String", # Output only. The profile object type.
6961 },
6962 },
6963 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6964 # verified field is typically a name, email address, phone number, or
6965 # website that has been confirmed to be owned by the person.
6966 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6967 # field.
6968 },
6969 },
6970 ],
6971 "skills": [ # The person's skills.
6972 { # A skill that the person has.
6973 "value": "A String", # The skill; for example, `underwater basket weaving`.
6974 "metadata": { # Metadata about a field. # Metadata about the skill.
6975 "source": { # The source of a field. # The source of the field.
6976 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
6977 #
6978 # Last update timestamp of this source.
6979 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6980 #
6981 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6982 # source. Used for web cache validation.
6983 "type": "A String", # The source type.
6984 "id": "A String", # The unique identifier within the source type generated by the server.
6985 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
6986 #
6987 # Metadata about a source of type PROFILE.
6988 "userTypes": [ # Output only. The user types.
6989 "A String",
6990 ],
6991 "objectType": "A String", # Output only. The profile object type.
6992 },
6993 },
6994 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
6995 # verified field is typically a name, email address, phone number, or
6996 # website that has been confirmed to be owned by the person.
6997 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6998 # field.
6999 },
7000 },
7001 ],
7002 "imClients": [ # The person's instant messaging clients.
7003 { # A person's instant messaging client.
7004 "username": "A String", # The user name used in the IM client.
7005 "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
7006 # viewer's account locale or the `Accept-Language` HTTP header locale.
7007 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
7008 # predefined values:
7009 #
7010 # * `aim`
7011 # * `msn`
7012 # * `yahoo`
7013 # * `skype`
7014 # * `qq`
7015 # * `googleTalk`
7016 # * `icq`
7017 # * `jabber`
7018 # * `netMeeting`
7019 "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account
7020 # locale or the `Accept-Language` HTTP header locale.
7021 "type": "A String", # The type of the IM client. The type can be custom or one of these
7022 # predefined values:
7023 #
7024 # * `home`
7025 # * `work`
7026 # * `other`
7027 "metadata": { # Metadata about a field. # Metadata about the IM client.
7028 "source": { # The source of a field. # The source of the field.
7029 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7030 #
7031 # Last update timestamp of this source.
7032 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7033 #
7034 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7035 # source. Used for web cache validation.
7036 "type": "A String", # The source type.
7037 "id": "A String", # The unique identifier within the source type generated by the server.
7038 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7039 #
7040 # Metadata about a source of type PROFILE.
7041 "userTypes": [ # Output only. The user types.
7042 "A String",
7043 ],
7044 "objectType": "A String", # Output only. The profile object type.
7045 },
7046 },
7047 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7048 # verified field is typically a name, email address, phone number, or
7049 # website that has been confirmed to be owned by the person.
7050 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7051 # field.
7052 },
7053 },
7054 ],
7055 "events": [ # The person's events.
7056 { # An event related to the person.
7057 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
7058 # and time zone are either specified elsewhere or are not significant. The date
7059 # is relative to the Proleptic Gregorian Calendar. This can represent:
7060 #
7061 # * A full date, with non-zero year, month and day values
7062 # * A month and day value, with a zero year, e.g. an anniversary
7063 # * A year on its own, with zero month and day values
7064 # * A year and month value, with a zero day, e.g. a credit card expiration date
7065 #
7066 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
7067 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
7068 # month and day.
7069 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
7070 # if specifying a year by itself or a year and month where the day is not
7071 # significant.
7072 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
7073 # a year.
7074 },
7075 "formattedType": "A String", # Output only. The type of the event translated and formatted in the
7076 # viewer's account locale or the `Accept-Language` HTTP header locale.
7077 "type": "A String", # The type of the event. The type can be custom or one of these predefined
7078 # values:
7079 #
7080 # * `anniversary`
7081 # * `other`
7082 "metadata": { # Metadata about a field. # Metadata about the event.
7083 "source": { # The source of a field. # The source of the field.
7084 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7085 #
7086 # Last update timestamp of this source.
7087 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7088 #
7089 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7090 # source. Used for web cache validation.
7091 "type": "A String", # The source type.
7092 "id": "A String", # The unique identifier within the source type generated by the server.
7093 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7094 #
7095 # Metadata about a source of type PROFILE.
7096 "userTypes": [ # Output only. The user types.
7097 "A String",
7098 ],
7099 "objectType": "A String", # Output only. The profile object type.
7100 },
7101 },
7102 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7103 # verified field is typically a name, email address, phone number, or
7104 # website that has been confirmed to be owned by the person.
7105 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7106 # field.
7107 },
7108 },
7109 ],
7110 "metadata": { # The metadata about a person. # Output only. Metadata about the person.
7111 "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for
7112 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
7113 # that include a sync token.
7114 "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for
7115 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
7116 # that include a sync token.
7117 #
7118 # The resource name may change when adding or removing fields that link a
7119 # contact and profile such as a verified email, verified phone number, or
7120 # profile URL.
7121 "A String",
7122 ],
7123 "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
7124 "A String",
7125 ],
7126 "sources": [ # The sources of data for the person.
7127 { # The source of a field.
7128 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7129 #
7130 # Last update timestamp of this source.
7131 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7132 #
7133 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7134 # source. Used for web cache validation.
7135 "type": "A String", # The source type.
7136 "id": "A String", # The unique identifier within the source type generated by the server.
7137 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7138 #
7139 # Metadata about a source of type PROFILE.
7140 "userTypes": [ # Output only. The user types.
7141 "A String",
7142 ],
7143 "objectType": "A String", # Output only. The profile object type.
7144 },
7145 },
7146 ],
7147 "objectType": "A String", # Output only. **DEPRECATED** (Please use
7148 # `person.metadata.sources.profileMetadata.objectType` instead)
7149 #
7150 # The type of the person object.
7151 },
7152 "interests": [ # The person's interests.
7153 { # One of the person's interests.
7154 "value": "A String", # The interest; for example, `stargazing`.
7155 "metadata": { # Metadata about a field. # Metadata about the interest.
7156 "source": { # The source of a field. # The source of the field.
7157 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7158 #
7159 # Last update timestamp of this source.
7160 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7161 #
7162 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7163 # source. Used for web cache validation.
7164 "type": "A String", # The source type.
7165 "id": "A String", # The unique identifier within the source type generated by the server.
7166 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7167 #
7168 # Metadata about a source of type PROFILE.
7169 "userTypes": [ # Output only. The user types.
7170 "A String",
7171 ],
7172 "objectType": "A String", # Output only. The profile object type.
7173 },
7174 },
7175 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7176 # verified field is typically a name, email address, phone number, or
7177 # website that has been confirmed to be owned by the person.
7178 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7179 # field.
7180 },
7181 },
7182 ],
7183 "photos": [ # Output only. The person's photos.
7184 { # A person's photo. A picture shown next to the person's name to
7185 # help others recognize the person.
7186 "default": True or False, # True if the photo is a default photo;
7187 # false if the photo is a user-provided photo.
7188 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
7189 # parameter `sz={size}` at the end of the url, where {size} is the size in
7190 # pixels. Example:
7191 # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
7192 "metadata": { # Metadata about a field. # Metadata about the photo.
7193 "source": { # The source of a field. # The source of the field.
7194 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7195 #
7196 # Last update timestamp of this source.
7197 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7198 #
7199 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7200 # source. Used for web cache validation.
7201 "type": "A String", # The source type.
7202 "id": "A String", # The unique identifier within the source type generated by the server.
7203 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7204 #
7205 # Metadata about a source of type PROFILE.
7206 "userTypes": [ # Output only. The user types.
7207 "A String",
7208 ],
7209 "objectType": "A String", # Output only. The profile object type.
7210 },
7211 },
7212 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7213 # verified field is typically a name, email address, phone number, or
7214 # website that has been confirmed to be owned by the person.
7215 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7216 # field.
7217 },
7218 },
7219 ],
7220 "residences": [ # The person's residences.
7221 { # A person's past or current residence.
7222 "current": True or False, # True if the residence is the person's current residence;
7223 # false if the residence is a past residence.
7224 "value": "A String", # The address of the residence.
7225 "metadata": { # Metadata about a field. # Metadata about the residence.
7226 "source": { # The source of a field. # The source of the field.
7227 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7228 #
7229 # Last update timestamp of this source.
7230 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7231 #
7232 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7233 # source. Used for web cache validation.
7234 "type": "A String", # The source type.
7235 "id": "A String", # The unique identifier within the source type generated by the server.
7236 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7237 #
7238 # Metadata about a source of type PROFILE.
7239 "userTypes": [ # Output only. The user types.
7240 "A String",
7241 ],
7242 "objectType": "A String", # Output only. The profile object type.
7243 },
7244 },
7245 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7246 # verified field is typically a name, email address, phone number, or
7247 # website that has been confirmed to be owned by the person.
7248 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7249 # field.
7250 },
7251 },
7252 ],
7253 "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
7254 # The person's relationship interests.
7255 { # **DEPRECATED**: No data will be returned
7256 # A person's relationship interest .
7257 "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
7258 # in the viewer's account locale or the locale specified in the
7259 # Accept-Language HTTP header.
7260 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
7261 # or one of these predefined values:
7262 #
7263 # * `friend`
7264 # * `date`
7265 # * `relationship`
7266 # * `networking`
7267 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
7268 "source": { # The source of a field. # The source of the field.
7269 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7270 #
7271 # Last update timestamp of this source.
7272 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7273 #
7274 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7275 # source. Used for web cache validation.
7276 "type": "A String", # The source type.
7277 "id": "A String", # The unique identifier within the source type generated by the server.
7278 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7279 #
7280 # Metadata about a source of type PROFILE.
7281 "userTypes": [ # Output only. The user types.
7282 "A String",
7283 ],
7284 "objectType": "A String", # Output only. The profile object type.
7285 },
7286 },
7287 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7288 # verified field is typically a name, email address, phone number, or
7289 # website that has been confirmed to be owned by the person.
7290 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7291 # field.
7292 },
7293 },
7294 ],
7295 "coverPhotos": [ # Output only. The person's cover photos.
7296 { # A person's cover photo. A large image shown on the person's
7297 # profile page that represents who they are or what they care about.
7298 "default": True or False, # True if the cover photo is the default cover photo;
7299 # false if the cover photo is a user-provided cover photo.
7300 "url": "A String", # The URL of the cover photo.
7301 "metadata": { # Metadata about a field. # Metadata about the cover photo.
7302 "source": { # The source of a field. # The source of the field.
7303 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7304 #
7305 # Last update timestamp of this source.
7306 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7307 #
7308 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7309 # source. Used for web cache validation.
7310 "type": "A String", # The source type.
7311 "id": "A String", # The unique identifier within the source type generated by the server.
7312 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7313 #
7314 # Metadata about a source of type PROFILE.
7315 "userTypes": [ # Output only. The user types.
7316 "A String",
7317 ],
7318 "objectType": "A String", # Output only. The profile object type.
7319 },
7320 },
7321 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7322 # verified field is typically a name, email address, phone number, or
7323 # website that has been confirmed to be owned by the person.
7324 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7325 # field.
7326 },
7327 },
7328 ],
7329 "locales": [ # The person's locale preferences.
7330 { # A person's locale preference.
7331 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
7332 # language tag representing the locale.
7333 "metadata": { # Metadata about a field. # Metadata about the locale.
7334 "source": { # The source of a field. # The source of the field.
7335 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7336 #
7337 # Last update timestamp of this source.
7338 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7339 #
7340 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7341 # source. Used for web cache validation.
7342 "type": "A String", # The source type.
7343 "id": "A String", # The unique identifier within the source type generated by the server.
7344 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7345 #
7346 # Metadata about a source of type PROFILE.
7347 "userTypes": [ # Output only. The user types.
7348 "A String",
7349 ],
7350 "objectType": "A String", # Output only. The profile object type.
7351 },
7352 },
7353 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7354 # verified field is typically a name, email address, phone number, or
7355 # website that has been confirmed to be owned by the person.
7356 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7357 # field.
7358 },
7359 },
7360 ],
7361 "organizations": [ # The person's past or current organizations.
7362 { # A person's past or current organization. Overlapping date ranges are
7363 # permitted.
7364 "formattedType": "A String", # Output only. The type of the organization translated and formatted in the
7365 # viewer's account locale or the `Accept-Language` HTTP header locale.
7366 "domain": "A String", # The domain name associated with the organization; for example,
7367 # `google.com`.
7368 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.
7369 # and time zone are either specified elsewhere or are not significant. The date
7370 # is relative to the Proleptic Gregorian Calendar. This can represent:
7371 #
7372 # * A full date, with non-zero year, month and day values
7373 # * A month and day value, with a zero year, e.g. an anniversary
7374 # * A year on its own, with zero month and day values
7375 # * A year and month value, with a zero day, e.g. a credit card expiration date
7376 #
7377 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
7378 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
7379 # month and day.
7380 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
7381 # if specifying a year by itself or a year and month where the day is not
7382 # significant.
7383 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
7384 # a year.
7385 },
7386 "name": "A String", # The name of the organization.
7387 "title": "A String", # The person's job title at the organization.
7388 "type": "A String", # The type of the organization. The type can be custom or one of these
7389 # predefined values:
7390 #
7391 # * `work`
7392 # * `school`
7393 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
7394 # symbol, abbreviation, or acronym.
7395 "current": True or False, # True if the organization is the person's current organization;
7396 # false if the organization is a past organization.
7397 "jobDescription": "A String", # The person's job description at the organization.
7398 "location": "A String", # The location of the organization office the person works at.
7399 "department": "A String", # The person's department at the organization.
7400 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.
7401 # and time zone are either specified elsewhere or are not significant. The date
7402 # is relative to the Proleptic Gregorian Calendar. This can represent:
7403 #
7404 # * A full date, with non-zero year, month and day values
7405 # * A month and day value, with a zero year, e.g. an anniversary
7406 # * A year on its own, with zero month and day values
7407 # * A year and month value, with a zero day, e.g. a credit card expiration date
7408 #
7409 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
7410 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
7411 # month and day.
7412 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
7413 # if specifying a year by itself or a year and month where the day is not
7414 # significant.
7415 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
7416 # a year.
7417 },
7418 "phoneticName": "A String", # The phonetic name of the organization.
7419 "metadata": { # Metadata about a field. # Metadata about the organization.
7420 "source": { # The source of a field. # The source of the field.
7421 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7422 #
7423 # Last update timestamp of this source.
7424 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7425 #
7426 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7427 # source. Used for web cache validation.
7428 "type": "A String", # The source type.
7429 "id": "A String", # The unique identifier within the source type generated by the server.
7430 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7431 #
7432 # Metadata about a source of type PROFILE.
7433 "userTypes": [ # Output only. The user types.
7434 "A String",
7435 ],
7436 "objectType": "A String", # Output only. The profile object type.
7437 },
7438 },
7439 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7440 # verified field is typically a name, email address, phone number, or
7441 # website that has been confirmed to be owned by the person.
7442 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7443 # field.
7444 },
7445 },
7446 ],
7447 "userDefined": [ # The person's user defined data.
7448 { # Arbitrary user data that is populated by the end users.
7449 "key": "A String", # The end user specified key of the user defined data.
7450 "value": "A String", # The end user specified value of the user defined data.
7451 "metadata": { # Metadata about a field. # Metadata about the user defined data.
7452 "source": { # The source of a field. # The source of the field.
7453 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7454 #
7455 # Last update timestamp of this source.
7456 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7457 #
7458 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7459 # source. Used for web cache validation.
7460 "type": "A String", # The source type.
7461 "id": "A String", # The unique identifier within the source type generated by the server.
7462 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7463 #
7464 # Metadata about a source of type PROFILE.
7465 "userTypes": [ # Output only. The user types.
7466 "A String",
7467 ],
7468 "objectType": "A String", # Output only. The profile object type.
7469 },
7470 },
7471 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7472 # verified field is typically a name, email address, phone number, or
7473 # website that has been confirmed to be owned by the person.
7474 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7475 # field.
7476 },
7477 },
7478 ],
7479 "biographies": [ # The person's biographies.
7480 { # A person's short biography.
7481 "contentType": "A String", # The content type of the biography.
7482 "value": "A String", # The short biography.
7483 "metadata": { # Metadata about a field. # Metadata about the biography.
7484 "source": { # The source of a field. # The source of the field.
7485 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7486 #
7487 # Last update timestamp of this source.
7488 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7489 #
7490 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7491 # source. Used for web cache validation.
7492 "type": "A String", # The source type.
7493 "id": "A String", # The unique identifier within the source type generated by the server.
7494 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7495 #
7496 # Metadata about a source of type PROFILE.
7497 "userTypes": [ # Output only. The user types.
7498 "A String",
7499 ],
7500 "objectType": "A String", # Output only. The profile object type.
7501 },
7502 },
7503 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7504 # verified field is typically a name, email address, phone number, or
7505 # website that has been confirmed to be owned by the person.
7506 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7507 # field.
7508 },
7509 },
7510 ],
7511 "memberships": [ # The person's group memberships.
7512 { # A person's membership in a group. Only contact group memberships can be
7513 # modified.
7514 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
7515 "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
7516 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
7517 # string, in the form of `contactGroups/{contact_group_id}`.
7518 # Only contact_group_resource_name can be used for modifying memberships.
7519 # Any contact group membership can be removed, but only user group or
7520 # "myContacts" or "starred" system groups memberships can be added. A
7521 # contact must always have at least one contact group membership.
7522 },
7523 "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
7524 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
7525 },
7526 "metadata": { # Metadata about a field. # Metadata about the membership.
7527 "source": { # The source of a field. # The source of the field.
7528 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7529 #
7530 # Last update timestamp of this source.
7531 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7532 #
7533 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7534 # source. Used for web cache validation.
7535 "type": "A String", # The source type.
7536 "id": "A String", # The unique identifier within the source type generated by the server.
7537 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7538 #
7539 # Metadata about a source of type PROFILE.
7540 "userTypes": [ # Output only. The user types.
7541 "A String",
7542 ],
7543 "objectType": "A String", # Output only. The profile object type.
7544 },
7545 },
7546 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7547 # verified field is typically a name, email address, phone number, or
7548 # website that has been confirmed to be owned by the person.
7549 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7550 # field.
7551 },
7552 },
7553 ],
7554 "taglines": [ # Output only. **DEPRECATED**: No data will be returned
7555 # The person's taglines.
7556 { # **DEPRECATED**: No data will be returned
7557 # A brief one-line description of the person.
7558 "value": "A String", # The tagline.
7559 "metadata": { # Metadata about a field. # Metadata about the tagline.
7560 "source": { # The source of a field. # The source of the field.
7561 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7562 #
7563 # Last update timestamp of this source.
7564 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7565 #
7566 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7567 # source. Used for web cache validation.
7568 "type": "A String", # The source type.
7569 "id": "A String", # The unique identifier within the source type generated by the server.
7570 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7571 #
7572 # Metadata about a source of type PROFILE.
7573 "userTypes": [ # Output only. The user types.
7574 "A String",
7575 ],
7576 "objectType": "A String", # Output only. The profile object type.
7577 },
7578 },
7579 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7580 # verified field is typically a name, email address, phone number, or
7581 # website that has been confirmed to be owned by the person.
7582 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7583 # field.
7584 },
7585 },
7586 ],
7587 "urls": [ # The person's associated URLs.
7588 { # A person's associated URLs.
7589 "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
7590 # account locale or the `Accept-Language` HTTP header locale.
7591 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
7592 # values:
7593 #
7594 # * `home`
7595 # * `work`
7596 # * `blog`
7597 # * `profile`
7598 # * `homePage`
7599 # * `ftp`
7600 # * `reservations`
7601 # * `appInstallPage`: website for a Google+ application.
7602 # * `other`
7603 "value": "A String", # The URL.
7604 "metadata": { # Metadata about a field. # Metadata about the URL.
7605 "source": { # The source of a field. # The source of the field.
7606 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7607 #
7608 # Last update timestamp of this source.
7609 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7610 #
7611 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7612 # source. Used for web cache validation.
7613 "type": "A String", # The source type.
7614 "id": "A String", # The unique identifier within the source type generated by the server.
7615 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7616 #
7617 # Metadata about a source of type PROFILE.
7618 "userTypes": [ # Output only. The user types.
7619 "A String",
7620 ],
7621 "objectType": "A String", # Output only. The profile object type.
7622 },
7623 },
7624 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7625 # verified field is typically a name, email address, phone number, or
7626 # website that has been confirmed to be owned by the person.
7627 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7628 # field.
7629 },
7630 },
7631 ],
7632 "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
7633 #
7634 # The person's age range.
7635 "genders": [ # The person's genders.
7636 { # A person's gender.
7637 "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account
7638 # locale or the `Accept-Language` HTTP header locale. Unspecified or custom
7639 # value are not localized.
7640 "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value
7641 # can be custom or one of these predefined values:
7642 #
7643 # * `male`
7644 # * `female`
7645 # * `other`
7646 "value": "A String", # The gender for the person. The gender can be custom or one of these
7647 # predefined values:
7648 #
7649 # * `male`
7650 # * `female`
7651 # * `unspecified`
7652 "metadata": { # Metadata about a field. # Metadata about the gender.
7653 "source": { # The source of a field. # The source of the field.
7654 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7655 #
7656 # Last update timestamp of this source.
7657 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7658 #
7659 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7660 # source. Used for web cache validation.
7661 "type": "A String", # The source type.
7662 "id": "A String", # The unique identifier within the source type generated by the server.
7663 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7664 #
7665 # Metadata about a source of type PROFILE.
7666 "userTypes": [ # Output only. The user types.
7667 "A String",
7668 ],
7669 "objectType": "A String", # Output only. The profile object type.
7670 },
7671 },
7672 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7673 # verified field is typically a name, email address, phone number, or
7674 # website that has been confirmed to be owned by the person.
7675 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7676 # field.
7677 },
7678 },
7679 ],
7680 "emailAddresses": [ # The person's email addresses.
7681 { # A person's email address.
7682 "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
7683 # viewer's account locale or the `Accept-Language` HTTP header locale.
7684 "metadata": { # Metadata about a field. # Metadata about the email address.
7685 "source": { # The source of a field. # The source of the field.
7686 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7687 #
7688 # Last update timestamp of this source.
7689 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7690 #
7691 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7692 # source. Used for web cache validation.
7693 "type": "A String", # The source type.
7694 "id": "A String", # The unique identifier within the source type generated by the server.
7695 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7696 #
7697 # Metadata about a source of type PROFILE.
7698 "userTypes": [ # Output only. The user types.
7699 "A String",
7700 ],
7701 "objectType": "A String", # Output only. The profile object type.
7702 },
7703 },
7704 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7705 # verified field is typically a name, email address, phone number, or
7706 # website that has been confirmed to be owned by the person.
7707 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7708 # field.
7709 },
7710 "displayName": "A String", # The display name of the email.
7711 "value": "A String", # The email address.
7712 "type": "A String", # The type of the email address. The type can be custom or one of these
7713 # predefined values:
7714 #
7715 # * `home`
7716 # * `work`
7717 # * `other`
7718 },
7719 ],
7720}
7721
7722 x__xgafv: string, V1 error format.
7723 Allowed values
7724 1 - v1 error format
7725 2 - v2 error format
7726 updatePersonFields: string, Required. A field mask to restrict which fields on the person are updated. Multiple
7727fields can be specified by separating them with commas.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]7728All updated fields will be replaced. Valid values are:
7729
7730* addresses
7731* biographies
7732* birthdays
7733* emailAddresses
7734* events
7735* genders
7736* imClients
7737* interests
7738* locales
7739* memberships
7740* names
7741* nicknames
7742* occupations
7743* organizations
7744* phoneNumbers
7745* relations
7746* residences
7747* sipAddresses
7748* urls
7749* userDefined
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]7750
7751Returns:
7752 An object of the form:
7753
7754 { # Information about a person merged from various data sources such as the
7755 # authenticated user's contacts and profile data.
7756 #
7757 # Most fields can have multiple items. The items in a field have no guaranteed
7758 # order, but each non-empty field is guaranteed to have exactly one field with
7759 # `metadata.primary` set to true.
7760 "sipAddresses": [ # The person's SIP addresses.
7761 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
7762 # communications to make voice or video calls over the internet.
7763 "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
7764 # viewer's account locale or the `Accept-Language` HTTP header locale.
7765 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
7766 # predefined values:
7767 #
7768 # * `home`
7769 # * `work`
7770 # * `mobile`
7771 # * `other`
7772 "value": "A String", # The SIP address in the
7773 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
7774 # format.
7775 "metadata": { # Metadata about a field. # Metadata about the SIP address.
7776 "source": { # The source of a field. # The source of the field.
7777 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7778 #
7779 # Last update timestamp of this source.
7780 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7781 #
7782 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7783 # source. Used for web cache validation.
7784 "type": "A String", # The source type.
7785 "id": "A String", # The unique identifier within the source type generated by the server.
7786 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7787 #
7788 # Metadata about a source of type PROFILE.
7789 "userTypes": [ # Output only. The user types.
7790 "A String",
7791 ],
7792 "objectType": "A String", # Output only. The profile object type.
7793 },
7794 },
7795 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7796 # verified field is typically a name, email address, phone number, or
7797 # website that has been confirmed to be owned by the person.
7798 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7799 # field.
7800 },
7801 },
7802 ],
7803 "braggingRights": [ # **DEPRECATED**: No data will be returned
7804 # The person's bragging rights.
7805 { # **DEPRECATED**: No data will be returned
7806 # A person's bragging rights.
7807 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
7808 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
7809 "source": { # The source of a field. # The source of the field.
7810 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7811 #
7812 # Last update timestamp of this source.
7813 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7814 #
7815 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7816 # source. Used for web cache validation.
7817 "type": "A String", # The source type.
7818 "id": "A String", # The unique identifier within the source type generated by the server.
7819 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7820 #
7821 # Metadata about a source of type PROFILE.
7822 "userTypes": [ # Output only. The user types.
7823 "A String",
7824 ],
7825 "objectType": "A String", # Output only. The profile object type.
7826 },
7827 },
7828 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7829 # verified field is typically a name, email address, phone number, or
7830 # website that has been confirmed to be owned by the person.
7831 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7832 # field.
7833 },
7834 },
7835 ],
7836 "addresses": [ # The person's street addresses.
7837 { # A person's physical address. May be a P.O. box or street address. All fields
7838 # are optional.
7839 "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's
7840 # account locale or the `Accept-Language` HTTP header locale.
7841 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
7842 # code of the address.
7843 "city": "A String", # The city of the address.
7844 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
7845 # will be automatically constructed from structured values.
7846 "region": "A String", # The region of the address; for example, the state or province.
7847 "poBox": "A String", # The P.O. box of the address.
7848 "streetAddress": "A String", # The street address.
7849 "country": "A String", # The country of the address.
7850 "postalCode": "A String", # The postal code of the address.
7851 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
7852 "type": "A String", # The type of the address. The type can be custom or one of these predefined
7853 # values:
7854 #
7855 # * `home`
7856 # * `work`
7857 # * `other`
7858 "metadata": { # Metadata about a field. # Metadata about the address.
7859 "source": { # The source of a field. # The source of the field.
7860 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7861 #
7862 # Last update timestamp of this source.
7863 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7864 #
7865 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7866 # source. Used for web cache validation.
7867 "type": "A String", # The source type.
7868 "id": "A String", # The unique identifier within the source type generated by the server.
7869 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7870 #
7871 # Metadata about a source of type PROFILE.
7872 "userTypes": [ # Output only. The user types.
7873 "A String",
7874 ],
7875 "objectType": "A String", # Output only. The profile object type.
7876 },
7877 },
7878 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7879 # verified field is typically a name, email address, phone number, or
7880 # website that has been confirmed to be owned by the person.
7881 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7882 # field.
7883 },
7884 },
7885 ],
7886 "nicknames": [ # The person's nicknames.
7887 { # A person's nickname.
7888 "type": "A String", # The type of the nickname.
7889 "value": "A String", # The nickname.
7890 "metadata": { # Metadata about a field. # Metadata about the nickname.
7891 "source": { # The source of a field. # The source of the field.
7892 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7893 #
7894 # Last update timestamp of this source.
7895 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7896 #
7897 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7898 # source. Used for web cache validation.
7899 "type": "A String", # The source type.
7900 "id": "A String", # The unique identifier within the source type generated by the server.
7901 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7902 #
7903 # Metadata about a source of type PROFILE.
7904 "userTypes": [ # Output only. The user types.
7905 "A String",
7906 ],
7907 "objectType": "A String", # Output only. The profile object type.
7908 },
7909 },
7910 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7911 # verified field is typically a name, email address, phone number, or
7912 # website that has been confirmed to be owned by the person.
7913 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7914 # field.
7915 },
7916 },
7917 ],
7918 "occupations": [ # The person's occupations.
7919 { # A person's occupation.
7920 "value": "A String", # The occupation; for example, `carpenter`.
7921 "metadata": { # Metadata about a field. # Metadata about the occupation.
7922 "source": { # The source of a field. # The source of the field.
7923 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7924 #
7925 # Last update timestamp of this source.
7926 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7927 #
7928 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7929 # source. Used for web cache validation.
7930 "type": "A String", # The source type.
7931 "id": "A String", # The unique identifier within the source type generated by the server.
7932 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7933 #
7934 # Metadata about a source of type PROFILE.
7935 "userTypes": [ # Output only. The user types.
7936 "A String",
7937 ],
7938 "objectType": "A String", # Output only. The profile object type.
7939 },
7940 },
7941 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7942 # verified field is typically a name, email address, phone number, or
7943 # website that has been confirmed to be owned by the person.
7944 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7945 # field.
7946 },
7947 },
7948 ],
7949 "phoneNumbers": [ # The person's phone numbers.
7950 { # A person's phone number.
7951 "canonicalForm": "A String", # Output only. The canonicalized [ITU-T
7952 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
7953 # form of the phone number.
7954 "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the
7955 # viewer's account locale or the `Accept-Language` HTTP header locale.
7956 "type": "A String", # The type of the phone number. The type can be custom or one of these
7957 # predefined values:
7958 #
7959 # * `home`
7960 # * `work`
7961 # * `mobile`
7962 # * `homeFax`
7963 # * `workFax`
7964 # * `otherFax`
7965 # * `pager`
7966 # * `workMobile`
7967 # * `workPager`
7968 # * `main`
7969 # * `googleVoice`
7970 # * `other`
7971 "value": "A String", # The phone number.
7972 "metadata": { # Metadata about a field. # Metadata about the phone number.
7973 "source": { # The source of a field. # The source of the field.
7974 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
7975 #
7976 # Last update timestamp of this source.
7977 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7978 #
7979 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7980 # source. Used for web cache validation.
7981 "type": "A String", # The source type.
7982 "id": "A String", # The unique identifier within the source type generated by the server.
7983 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
7984 #
7985 # Metadata about a source of type PROFILE.
7986 "userTypes": [ # Output only. The user types.
7987 "A String",
7988 ],
7989 "objectType": "A String", # Output only. The profile object type.
7990 },
7991 },
7992 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
7993 # verified field is typically a name, email address, phone number, or
7994 # website that has been confirmed to be owned by the person.
7995 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7996 # field.
7997 },
7998 },
7999 ],
8000 "names": [ # The person's names.
8001 { # A person's name. If the name is a mononym, the family name is empty.
8002 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
8003 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
8004 "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to
8005 # the locale specified by the viewer's account or the
8006 # `Accept-Language` HTTP header.
8007 "displayName": "A String", # Output only. The display name formatted according to the locale specified by
8008 # the viewer's account or the `Accept-Language` HTTP header.
8009 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
8010 "middleName": "A String", # The middle name(s).
8011 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
8012 "familyName": "A String", # The family name.
8013 "phoneticFullName": "A String", # The full name spelled as it sounds.
8014 "phoneticGivenName": "A String", # The given name spelled as it sounds.
8015 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
8016 "givenName": "A String", # The given name.
8017 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
8018 "metadata": { # Metadata about a field. # Metadata about the name.
8019 "source": { # The source of a field. # The source of the field.
8020 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8021 #
8022 # Last update timestamp of this source.
8023 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8024 #
8025 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8026 # source. Used for web cache validation.
8027 "type": "A String", # The source type.
8028 "id": "A String", # The unique identifier within the source type generated by the server.
8029 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8030 #
8031 # Metadata about a source of type PROFILE.
8032 "userTypes": [ # Output only. The user types.
8033 "A String",
8034 ],
8035 "objectType": "A String", # Output only. The profile object type.
8036 },
8037 },
8038 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8039 # verified field is typically a name, email address, phone number, or
8040 # website that has been confirmed to be owned by the person.
8041 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8042 # field.
8043 },
8044 },
8045 ],
8046 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
8047 # with a max length of 27 characters, in the form of
8048 # `people/{person_id}`.
8049 "ageRanges": [ # Output only. The person's age ranges.
8050 { # A person's age range.
8051 "ageRange": "A String", # The age range.
8052 "metadata": { # Metadata about a field. # Metadata about the age range.
8053 "source": { # The source of a field. # The source of the field.
8054 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8055 #
8056 # Last update timestamp of this source.
8057 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8058 #
8059 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8060 # source. Used for web cache validation.
8061 "type": "A String", # The source type.
8062 "id": "A String", # The unique identifier within the source type generated by the server.
8063 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8064 #
8065 # Metadata about a source of type PROFILE.
8066 "userTypes": [ # Output only. The user types.
8067 "A String",
8068 ],
8069 "objectType": "A String", # Output only. The profile object type.
8070 },
8071 },
8072 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8073 # verified field is typically a name, email address, phone number, or
8074 # website that has been confirmed to be owned by the person.
8075 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8076 # field.
8077 },
8078 },
8079 ],
8080 "birthdays": [ # The person's birthdays.
8081 { # A person's birthday. At least one of the `date` and `text` fields are
8082 # specified. The `date` and `text` fields typically represent the same
8083 # date, but are not guaranteed to.
8084 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
8085 # and time zone are either specified elsewhere or are not significant. The date
8086 # is relative to the Proleptic Gregorian Calendar. This can represent:
8087 #
8088 # * A full date, with non-zero year, month and day values
8089 # * A month and day value, with a zero year, e.g. an anniversary
8090 # * A year on its own, with zero month and day values
8091 # * A year and month value, with a zero day, e.g. a credit card expiration date
8092 #
8093 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
8094 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
8095 # month and day.
8096 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
8097 # if specifying a year by itself or a year and month where the day is not
8098 # significant.
8099 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
8100 # a year.
8101 },
8102 "text": "A String", # A free-form string representing the user's birthday.
8103 "metadata": { # Metadata about a field. # Metadata about the birthday.
8104 "source": { # The source of a field. # The source of the field.
8105 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8106 #
8107 # Last update timestamp of this source.
8108 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8109 #
8110 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8111 # source. Used for web cache validation.
8112 "type": "A String", # The source type.
8113 "id": "A String", # The unique identifier within the source type generated by the server.
8114 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8115 #
8116 # Metadata about a source of type PROFILE.
8117 "userTypes": [ # Output only. The user types.
8118 "A String",
8119 ],
8120 "objectType": "A String", # Output only. The profile object type.
8121 },
8122 },
8123 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8124 # verified field is typically a name, email address, phone number, or
8125 # website that has been confirmed to be owned by the person.
8126 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8127 # field.
8128 },
8129 },
8130 ],
8131 "relations": [ # The person's relations.
8132 { # A person's relation to another person.
8133 "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
8134 # account locale or the locale specified in the Accept-Language HTTP header.
8135 "metadata": { # Metadata about a field. # Metadata about the relation.
8136 "source": { # The source of a field. # The source of the field.
8137 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8138 #
8139 # Last update timestamp of this source.
8140 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8141 #
8142 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8143 # source. Used for web cache validation.
8144 "type": "A String", # The source type.
8145 "id": "A String", # The unique identifier within the source type generated by the server.
8146 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8147 #
8148 # Metadata about a source of type PROFILE.
8149 "userTypes": [ # Output only. The user types.
8150 "A String",
8151 ],
8152 "objectType": "A String", # Output only. The profile object type.
8153 },
8154 },
8155 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8156 # verified field is typically a name, email address, phone number, or
8157 # website that has been confirmed to be owned by the person.
8158 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8159 # field.
8160 },
8161 "type": "A String", # The person's relation to the other person. The type can be custom or one of
8162 # these predefined values:
8163 #
8164 # * `spouse`
8165 # * `child`
8166 # * `mother`
8167 # * `father`
8168 # * `parent`
8169 # * `brother`
8170 # * `sister`
8171 # * `friend`
8172 # * `relative`
8173 # * `domesticPartner`
8174 # * `manager`
8175 # * `assistant`
8176 # * `referredBy`
8177 # * `partner`
8178 "person": "A String", # The name of the other person this relation refers to.
8179 },
8180 ],
8181 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8182 # resource. Used for web cache validation.
8183 "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
8184 # The person's relationship statuses.
8185 { # **DEPRECATED**: No data will be returned
8186 # A person's relationship status.
8187 "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
8188 # the viewer's account locale or the `Accept-Language` HTTP header locale.
8189 "value": "A String", # The relationship status. The value can be custom or one of these
8190 # predefined values:
8191 #
8192 # * `single`
8193 # * `inARelationship`
8194 # * `engaged`
8195 # * `married`
8196 # * `itsComplicated`
8197 # * `openRelationship`
8198 # * `widowed`
8199 # * `inDomesticPartnership`
8200 # * `inCivilUnion`
8201 "metadata": { # Metadata about a field. # Metadata about the relationship status.
8202 "source": { # The source of a field. # The source of the field.
8203 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8204 #
8205 # Last update timestamp of this source.
8206 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8207 #
8208 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8209 # source. Used for web cache validation.
8210 "type": "A String", # The source type.
8211 "id": "A String", # The unique identifier within the source type generated by the server.
8212 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8213 #
8214 # Metadata about a source of type PROFILE.
8215 "userTypes": [ # Output only. The user types.
8216 "A String",
8217 ],
8218 "objectType": "A String", # Output only. The profile object type.
8219 },
8220 },
8221 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8222 # verified field is typically a name, email address, phone number, or
8223 # website that has been confirmed to be owned by the person.
8224 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8225 # field.
8226 },
8227 },
8228 ],
8229 "skills": [ # The person's skills.
8230 { # A skill that the person has.
8231 "value": "A String", # The skill; for example, `underwater basket weaving`.
8232 "metadata": { # Metadata about a field. # Metadata about the skill.
8233 "source": { # The source of a field. # The source of the field.
8234 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8235 #
8236 # Last update timestamp of this source.
8237 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8238 #
8239 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8240 # source. Used for web cache validation.
8241 "type": "A String", # The source type.
8242 "id": "A String", # The unique identifier within the source type generated by the server.
8243 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8244 #
8245 # Metadata about a source of type PROFILE.
8246 "userTypes": [ # Output only. The user types.
8247 "A String",
8248 ],
8249 "objectType": "A String", # Output only. The profile object type.
8250 },
8251 },
8252 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8253 # verified field is typically a name, email address, phone number, or
8254 # website that has been confirmed to be owned by the person.
8255 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8256 # field.
8257 },
8258 },
8259 ],
8260 "imClients": [ # The person's instant messaging clients.
8261 { # A person's instant messaging client.
8262 "username": "A String", # The user name used in the IM client.
8263 "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
8264 # viewer's account locale or the `Accept-Language` HTTP header locale.
8265 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
8266 # predefined values:
8267 #
8268 # * `aim`
8269 # * `msn`
8270 # * `yahoo`
8271 # * `skype`
8272 # * `qq`
8273 # * `googleTalk`
8274 # * `icq`
8275 # * `jabber`
8276 # * `netMeeting`
8277 "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account
8278 # locale or the `Accept-Language` HTTP header locale.
8279 "type": "A String", # The type of the IM client. The type can be custom or one of these
8280 # predefined values:
8281 #
8282 # * `home`
8283 # * `work`
8284 # * `other`
8285 "metadata": { # Metadata about a field. # Metadata about the IM client.
8286 "source": { # The source of a field. # The source of the field.
8287 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8288 #
8289 # Last update timestamp of this source.
8290 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8291 #
8292 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8293 # source. Used for web cache validation.
8294 "type": "A String", # The source type.
8295 "id": "A String", # The unique identifier within the source type generated by the server.
8296 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8297 #
8298 # Metadata about a source of type PROFILE.
8299 "userTypes": [ # Output only. The user types.
8300 "A String",
8301 ],
8302 "objectType": "A String", # Output only. The profile object type.
8303 },
8304 },
8305 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8306 # verified field is typically a name, email address, phone number, or
8307 # website that has been confirmed to be owned by the person.
8308 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8309 # field.
8310 },
8311 },
8312 ],
8313 "events": [ # The person's events.
8314 { # An event related to the person.
8315 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
8316 # and time zone are either specified elsewhere or are not significant. The date
8317 # is relative to the Proleptic Gregorian Calendar. This can represent:
8318 #
8319 # * A full date, with non-zero year, month and day values
8320 # * A month and day value, with a zero year, e.g. an anniversary
8321 # * A year on its own, with zero month and day values
8322 # * A year and month value, with a zero day, e.g. a credit card expiration date
8323 #
8324 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
8325 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
8326 # month and day.
8327 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
8328 # if specifying a year by itself or a year and month where the day is not
8329 # significant.
8330 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
8331 # a year.
8332 },
8333 "formattedType": "A String", # Output only. The type of the event translated and formatted in the
8334 # viewer's account locale or the `Accept-Language` HTTP header locale.
8335 "type": "A String", # The type of the event. The type can be custom or one of these predefined
8336 # values:
8337 #
8338 # * `anniversary`
8339 # * `other`
8340 "metadata": { # Metadata about a field. # Metadata about the event.
8341 "source": { # The source of a field. # The source of the field.
8342 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8343 #
8344 # Last update timestamp of this source.
8345 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8346 #
8347 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8348 # source. Used for web cache validation.
8349 "type": "A String", # The source type.
8350 "id": "A String", # The unique identifier within the source type generated by the server.
8351 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8352 #
8353 # Metadata about a source of type PROFILE.
8354 "userTypes": [ # Output only. The user types.
8355 "A String",
8356 ],
8357 "objectType": "A String", # Output only. The profile object type.
8358 },
8359 },
8360 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8361 # verified field is typically a name, email address, phone number, or
8362 # website that has been confirmed to be owned by the person.
8363 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8364 # field.
8365 },
8366 },
8367 ],
8368 "metadata": { # The metadata about a person. # Output only. Metadata about the person.
8369 "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for
8370 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
8371 # that include a sync token.
8372 "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for
8373 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
8374 # that include a sync token.
8375 #
8376 # The resource name may change when adding or removing fields that link a
8377 # contact and profile such as a verified email, verified phone number, or
8378 # profile URL.
8379 "A String",
8380 ],
8381 "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
8382 "A String",
8383 ],
8384 "sources": [ # The sources of data for the person.
8385 { # The source of a field.
8386 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8387 #
8388 # Last update timestamp of this source.
8389 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8390 #
8391 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8392 # source. Used for web cache validation.
8393 "type": "A String", # The source type.
8394 "id": "A String", # The unique identifier within the source type generated by the server.
8395 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8396 #
8397 # Metadata about a source of type PROFILE.
8398 "userTypes": [ # Output only. The user types.
8399 "A String",
8400 ],
8401 "objectType": "A String", # Output only. The profile object type.
8402 },
8403 },
8404 ],
8405 "objectType": "A String", # Output only. **DEPRECATED** (Please use
8406 # `person.metadata.sources.profileMetadata.objectType` instead)
8407 #
8408 # The type of the person object.
8409 },
8410 "interests": [ # The person's interests.
8411 { # One of the person's interests.
8412 "value": "A String", # The interest; for example, `stargazing`.
8413 "metadata": { # Metadata about a field. # Metadata about the interest.
8414 "source": { # The source of a field. # The source of the field.
8415 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8416 #
8417 # Last update timestamp of this source.
8418 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8419 #
8420 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8421 # source. Used for web cache validation.
8422 "type": "A String", # The source type.
8423 "id": "A String", # The unique identifier within the source type generated by the server.
8424 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8425 #
8426 # Metadata about a source of type PROFILE.
8427 "userTypes": [ # Output only. The user types.
8428 "A String",
8429 ],
8430 "objectType": "A String", # Output only. The profile object type.
8431 },
8432 },
8433 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8434 # verified field is typically a name, email address, phone number, or
8435 # website that has been confirmed to be owned by the person.
8436 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8437 # field.
8438 },
8439 },
8440 ],
8441 "photos": [ # Output only. The person's photos.
8442 { # A person's photo. A picture shown next to the person's name to
8443 # help others recognize the person.
8444 "default": True or False, # True if the photo is a default photo;
8445 # false if the photo is a user-provided photo.
8446 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
8447 # parameter `sz={size}` at the end of the url, where {size} is the size in
8448 # pixels. Example:
8449 # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
8450 "metadata": { # Metadata about a field. # Metadata about the photo.
8451 "source": { # The source of a field. # The source of the field.
8452 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8453 #
8454 # Last update timestamp of this source.
8455 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8456 #
8457 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8458 # source. Used for web cache validation.
8459 "type": "A String", # The source type.
8460 "id": "A String", # The unique identifier within the source type generated by the server.
8461 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8462 #
8463 # Metadata about a source of type PROFILE.
8464 "userTypes": [ # Output only. The user types.
8465 "A String",
8466 ],
8467 "objectType": "A String", # Output only. The profile object type.
8468 },
8469 },
8470 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8471 # verified field is typically a name, email address, phone number, or
8472 # website that has been confirmed to be owned by the person.
8473 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8474 # field.
8475 },
8476 },
8477 ],
8478 "residences": [ # The person's residences.
8479 { # A person's past or current residence.
8480 "current": True or False, # True if the residence is the person's current residence;
8481 # false if the residence is a past residence.
8482 "value": "A String", # The address of the residence.
8483 "metadata": { # Metadata about a field. # Metadata about the residence.
8484 "source": { # The source of a field. # The source of the field.
8485 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8486 #
8487 # Last update timestamp of this source.
8488 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8489 #
8490 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8491 # source. Used for web cache validation.
8492 "type": "A String", # The source type.
8493 "id": "A String", # The unique identifier within the source type generated by the server.
8494 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8495 #
8496 # Metadata about a source of type PROFILE.
8497 "userTypes": [ # Output only. The user types.
8498 "A String",
8499 ],
8500 "objectType": "A String", # Output only. The profile object type.
8501 },
8502 },
8503 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8504 # verified field is typically a name, email address, phone number, or
8505 # website that has been confirmed to be owned by the person.
8506 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8507 # field.
8508 },
8509 },
8510 ],
8511 "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
8512 # The person's relationship interests.
8513 { # **DEPRECATED**: No data will be returned
8514 # A person's relationship interest .
8515 "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
8516 # in the viewer's account locale or the locale specified in the
8517 # Accept-Language HTTP header.
8518 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
8519 # or one of these predefined values:
8520 #
8521 # * `friend`
8522 # * `date`
8523 # * `relationship`
8524 # * `networking`
8525 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
8526 "source": { # The source of a field. # The source of the field.
8527 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8528 #
8529 # Last update timestamp of this source.
8530 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8531 #
8532 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8533 # source. Used for web cache validation.
8534 "type": "A String", # The source type.
8535 "id": "A String", # The unique identifier within the source type generated by the server.
8536 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8537 #
8538 # Metadata about a source of type PROFILE.
8539 "userTypes": [ # Output only. The user types.
8540 "A String",
8541 ],
8542 "objectType": "A String", # Output only. The profile object type.
8543 },
8544 },
8545 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8546 # verified field is typically a name, email address, phone number, or
8547 # website that has been confirmed to be owned by the person.
8548 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8549 # field.
8550 },
8551 },
8552 ],
8553 "coverPhotos": [ # Output only. The person's cover photos.
8554 { # A person's cover photo. A large image shown on the person's
8555 # profile page that represents who they are or what they care about.
8556 "default": True or False, # True if the cover photo is the default cover photo;
8557 # false if the cover photo is a user-provided cover photo.
8558 "url": "A String", # The URL of the cover photo.
8559 "metadata": { # Metadata about a field. # Metadata about the cover photo.
8560 "source": { # The source of a field. # The source of the field.
8561 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8562 #
8563 # Last update timestamp of this source.
8564 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8565 #
8566 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8567 # source. Used for web cache validation.
8568 "type": "A String", # The source type.
8569 "id": "A String", # The unique identifier within the source type generated by the server.
8570 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8571 #
8572 # Metadata about a source of type PROFILE.
8573 "userTypes": [ # Output only. The user types.
8574 "A String",
8575 ],
8576 "objectType": "A String", # Output only. The profile object type.
8577 },
8578 },
8579 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8580 # verified field is typically a name, email address, phone number, or
8581 # website that has been confirmed to be owned by the person.
8582 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8583 # field.
8584 },
8585 },
8586 ],
8587 "locales": [ # The person's locale preferences.
8588 { # A person's locale preference.
8589 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
8590 # language tag representing the locale.
8591 "metadata": { # Metadata about a field. # Metadata about the locale.
8592 "source": { # The source of a field. # The source of the field.
8593 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8594 #
8595 # Last update timestamp of this source.
8596 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8597 #
8598 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8599 # source. Used for web cache validation.
8600 "type": "A String", # The source type.
8601 "id": "A String", # The unique identifier within the source type generated by the server.
8602 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8603 #
8604 # Metadata about a source of type PROFILE.
8605 "userTypes": [ # Output only. The user types.
8606 "A String",
8607 ],
8608 "objectType": "A String", # Output only. The profile object type.
8609 },
8610 },
8611 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8612 # verified field is typically a name, email address, phone number, or
8613 # website that has been confirmed to be owned by the person.
8614 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8615 # field.
8616 },
8617 },
8618 ],
8619 "organizations": [ # The person's past or current organizations.
8620 { # A person's past or current organization. Overlapping date ranges are
8621 # permitted.
8622 "formattedType": "A String", # Output only. The type of the organization translated and formatted in the
8623 # viewer's account locale or the `Accept-Language` HTTP header locale.
8624 "domain": "A String", # The domain name associated with the organization; for example,
8625 # `google.com`.
8626 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.
8627 # and time zone are either specified elsewhere or are not significant. The date
8628 # is relative to the Proleptic Gregorian Calendar. This can represent:
8629 #
8630 # * A full date, with non-zero year, month and day values
8631 # * A month and day value, with a zero year, e.g. an anniversary
8632 # * A year on its own, with zero month and day values
8633 # * A year and month value, with a zero day, e.g. a credit card expiration date
8634 #
8635 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
8636 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
8637 # month and day.
8638 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
8639 # if specifying a year by itself or a year and month where the day is not
8640 # significant.
8641 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
8642 # a year.
8643 },
8644 "name": "A String", # The name of the organization.
8645 "title": "A String", # The person's job title at the organization.
8646 "type": "A String", # The type of the organization. The type can be custom or one of these
8647 # predefined values:
8648 #
8649 # * `work`
8650 # * `school`
8651 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
8652 # symbol, abbreviation, or acronym.
8653 "current": True or False, # True if the organization is the person's current organization;
8654 # false if the organization is a past organization.
8655 "jobDescription": "A String", # The person's job description at the organization.
8656 "location": "A String", # The location of the organization office the person works at.
8657 "department": "A String", # The person's department at the organization.
8658 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.
8659 # and time zone are either specified elsewhere or are not significant. The date
8660 # is relative to the Proleptic Gregorian Calendar. This can represent:
8661 #
8662 # * A full date, with non-zero year, month and day values
8663 # * A month and day value, with a zero year, e.g. an anniversary
8664 # * A year on its own, with zero month and day values
8665 # * A year and month value, with a zero day, e.g. a credit card expiration date
8666 #
8667 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
8668 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
8669 # month and day.
8670 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
8671 # if specifying a year by itself or a year and month where the day is not
8672 # significant.
8673 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
8674 # a year.
8675 },
8676 "phoneticName": "A String", # The phonetic name of the organization.
8677 "metadata": { # Metadata about a field. # Metadata about the organization.
8678 "source": { # The source of a field. # The source of the field.
8679 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8680 #
8681 # Last update timestamp of this source.
8682 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8683 #
8684 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8685 # source. Used for web cache validation.
8686 "type": "A String", # The source type.
8687 "id": "A String", # The unique identifier within the source type generated by the server.
8688 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8689 #
8690 # Metadata about a source of type PROFILE.
8691 "userTypes": [ # Output only. The user types.
8692 "A String",
8693 ],
8694 "objectType": "A String", # Output only. The profile object type.
8695 },
8696 },
8697 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8698 # verified field is typically a name, email address, phone number, or
8699 # website that has been confirmed to be owned by the person.
8700 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8701 # field.
8702 },
8703 },
8704 ],
8705 "userDefined": [ # The person's user defined data.
8706 { # Arbitrary user data that is populated by the end users.
8707 "key": "A String", # The end user specified key of the user defined data.
8708 "value": "A String", # The end user specified value of the user defined data.
8709 "metadata": { # Metadata about a field. # Metadata about the user defined data.
8710 "source": { # The source of a field. # The source of the field.
8711 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8712 #
8713 # Last update timestamp of this source.
8714 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8715 #
8716 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8717 # source. Used for web cache validation.
8718 "type": "A String", # The source type.
8719 "id": "A String", # The unique identifier within the source type generated by the server.
8720 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8721 #
8722 # Metadata about a source of type PROFILE.
8723 "userTypes": [ # Output only. The user types.
8724 "A String",
8725 ],
8726 "objectType": "A String", # Output only. The profile object type.
8727 },
8728 },
8729 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8730 # verified field is typically a name, email address, phone number, or
8731 # website that has been confirmed to be owned by the person.
8732 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8733 # field.
8734 },
8735 },
8736 ],
8737 "biographies": [ # The person's biographies.
8738 { # A person's short biography.
8739 "contentType": "A String", # The content type of the biography.
8740 "value": "A String", # The short biography.
8741 "metadata": { # Metadata about a field. # Metadata about the biography.
8742 "source": { # The source of a field. # The source of the field.
8743 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8744 #
8745 # Last update timestamp of this source.
8746 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8747 #
8748 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8749 # source. Used for web cache validation.
8750 "type": "A String", # The source type.
8751 "id": "A String", # The unique identifier within the source type generated by the server.
8752 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8753 #
8754 # Metadata about a source of type PROFILE.
8755 "userTypes": [ # Output only. The user types.
8756 "A String",
8757 ],
8758 "objectType": "A String", # Output only. The profile object type.
8759 },
8760 },
8761 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8762 # verified field is typically a name, email address, phone number, or
8763 # website that has been confirmed to be owned by the person.
8764 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8765 # field.
8766 },
8767 },
8768 ],
8769 "memberships": [ # The person's group memberships.
8770 { # A person's membership in a group. Only contact group memberships can be
8771 # modified.
8772 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
8773 "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
8774 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
8775 # string, in the form of `contactGroups/{contact_group_id}`.
8776 # Only contact_group_resource_name can be used for modifying memberships.
8777 # Any contact group membership can be removed, but only user group or
8778 # "myContacts" or "starred" system groups memberships can be added. A
8779 # contact must always have at least one contact group membership.
8780 },
8781 "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
8782 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
8783 },
8784 "metadata": { # Metadata about a field. # Metadata about the membership.
8785 "source": { # The source of a field. # The source of the field.
8786 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8787 #
8788 # Last update timestamp of this source.
8789 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8790 #
8791 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8792 # source. Used for web cache validation.
8793 "type": "A String", # The source type.
8794 "id": "A String", # The unique identifier within the source type generated by the server.
8795 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8796 #
8797 # Metadata about a source of type PROFILE.
8798 "userTypes": [ # Output only. The user types.
8799 "A String",
8800 ],
8801 "objectType": "A String", # Output only. The profile object type.
8802 },
8803 },
8804 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8805 # verified field is typically a name, email address, phone number, or
8806 # website that has been confirmed to be owned by the person.
8807 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8808 # field.
8809 },
8810 },
8811 ],
8812 "taglines": [ # Output only. **DEPRECATED**: No data will be returned
8813 # The person's taglines.
8814 { # **DEPRECATED**: No data will be returned
8815 # A brief one-line description of the person.
8816 "value": "A String", # The tagline.
8817 "metadata": { # Metadata about a field. # Metadata about the tagline.
8818 "source": { # The source of a field. # The source of the field.
8819 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8820 #
8821 # Last update timestamp of this source.
8822 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8823 #
8824 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8825 # source. Used for web cache validation.
8826 "type": "A String", # The source type.
8827 "id": "A String", # The unique identifier within the source type generated by the server.
8828 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8829 #
8830 # Metadata about a source of type PROFILE.
8831 "userTypes": [ # Output only. The user types.
8832 "A String",
8833 ],
8834 "objectType": "A String", # Output only. The profile object type.
8835 },
8836 },
8837 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8838 # verified field is typically a name, email address, phone number, or
8839 # website that has been confirmed to be owned by the person.
8840 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8841 # field.
8842 },
8843 },
8844 ],
8845 "urls": [ # The person's associated URLs.
8846 { # A person's associated URLs.
8847 "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
8848 # account locale or the `Accept-Language` HTTP header locale.
8849 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
8850 # values:
8851 #
8852 # * `home`
8853 # * `work`
8854 # * `blog`
8855 # * `profile`
8856 # * `homePage`
8857 # * `ftp`
8858 # * `reservations`
8859 # * `appInstallPage`: website for a Google+ application.
8860 # * `other`
8861 "value": "A String", # The URL.
8862 "metadata": { # Metadata about a field. # Metadata about the URL.
8863 "source": { # The source of a field. # The source of the field.
8864 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8865 #
8866 # Last update timestamp of this source.
8867 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8868 #
8869 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8870 # source. Used for web cache validation.
8871 "type": "A String", # The source type.
8872 "id": "A String", # The unique identifier within the source type generated by the server.
8873 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8874 #
8875 # Metadata about a source of type PROFILE.
8876 "userTypes": [ # Output only. The user types.
8877 "A String",
8878 ],
8879 "objectType": "A String", # Output only. The profile object type.
8880 },
8881 },
8882 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8883 # verified field is typically a name, email address, phone number, or
8884 # website that has been confirmed to be owned by the person.
8885 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8886 # field.
8887 },
8888 },
8889 ],
8890 "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
8891 #
8892 # The person's age range.
8893 "genders": [ # The person's genders.
8894 { # A person's gender.
8895 "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account
8896 # locale or the `Accept-Language` HTTP header locale. Unspecified or custom
8897 # value are not localized.
8898 "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value
8899 # can be custom or one of these predefined values:
8900 #
8901 # * `male`
8902 # * `female`
8903 # * `other`
8904 "value": "A String", # The gender for the person. The gender can be custom or one of these
8905 # predefined values:
8906 #
8907 # * `male`
8908 # * `female`
8909 # * `unspecified`
8910 "metadata": { # Metadata about a field. # Metadata about the gender.
8911 "source": { # The source of a field. # The source of the field.
8912 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8913 #
8914 # Last update timestamp of this source.
8915 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8916 #
8917 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8918 # source. Used for web cache validation.
8919 "type": "A String", # The source type.
8920 "id": "A String", # The unique identifier within the source type generated by the server.
8921 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8922 #
8923 # Metadata about a source of type PROFILE.
8924 "userTypes": [ # Output only. The user types.
8925 "A String",
8926 ],
8927 "objectType": "A String", # Output only. The profile object type.
8928 },
8929 },
8930 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8931 # verified field is typically a name, email address, phone number, or
8932 # website that has been confirmed to be owned by the person.
8933 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8934 # field.
8935 },
8936 },
8937 ],
8938 "emailAddresses": [ # The person's email addresses.
8939 { # A person's email address.
8940 "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
8941 # viewer's account locale or the `Accept-Language` HTTP header locale.
8942 "metadata": { # Metadata about a field. # Metadata about the email address.
8943 "source": { # The source of a field. # The source of the field.
8944 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
8945 #
8946 # Last update timestamp of this source.
8947 "etag": "A String", # **Only populated in `person.metadata.sources`.**
8948 #
8949 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
8950 # source. Used for web cache validation.
8951 "type": "A String", # The source type.
8952 "id": "A String", # The unique identifier within the source type generated by the server.
8953 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
8954 #
8955 # Metadata about a source of type PROFILE.
8956 "userTypes": [ # Output only. The user types.
8957 "A String",
8958 ],
8959 "objectType": "A String", # Output only. The profile object type.
8960 },
8961 },
8962 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
8963 # verified field is typically a name, email address, phone number, or
8964 # website that has been confirmed to be owned by the person.
8965 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
8966 # field.
8967 },
8968 "displayName": "A String", # The display name of the email.
8969 "value": "A String", # The email address.
8970 "type": "A String", # The type of the email address. The type can be custom or one of these
8971 # predefined values:
8972 #
8973 # * `home`
8974 # * `work`
8975 # * `other`
8976 },
8977 ],
8978 }</pre>
8979</div>
8980
8981<div class="method">
8982 <code class="details" id="updateContactPhoto">updateContactPhoto(resourceName, body=None, x__xgafv=None)</code>
8983 <pre>Update a contact's photo.
8984
8985Args:
8986 resourceName: string, Required. Person resource name (required)
8987 body: object, The request body.
8988 The object takes the form of:
8989
8990{ # A request to update an existing contact's photo.
8991 # All requests must have a valid photo format: JPEG or PNG.
8992 "personFields": "A String", # Optional. A field mask to restrict which fields on the person are returned. Multiple
8993 # fields can be specified by separating them with commas. Defaults to empty
8994 # if not set, which will skip the post mutate get. Valid values are:
8995 #
8996 # * addresses
8997 # * ageRanges
8998 # * biographies
8999 # * birthdays
9000 # * coverPhotos
9001 # * emailAddresses
9002 # * events
9003 # * genders
9004 # * imClients
9005 # * interests
9006 # * locales
9007 # * memberships
9008 # * metadata
9009 # * names
9010 # * nicknames
9011 # * occupations
9012 # * organizations
9013 # * phoneNumbers
9014 # * photos
9015 # * relations
9016 # * residences
9017 # * sipAddresses
9018 # * skills
9019 # * urls
9020 # * userDefined
9021 "photoBytes": "A String", # Required. Raw photo bytes
9022 }
9023
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9024 x__xgafv: string, V1 error format.
9025 Allowed values
9026 1 - v1 error format
9027 2 - v2 error format
9028
9029Returns:
9030 An object of the form:
9031
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9032 { # The response for updating a contact's photo.
9033 "person": { # Information about a person merged from various data sources such as the # The updated person, if person_fields is set in the
9034 # UpdateContactPhotoRequest; otherwise this will be unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9035 # authenticated user's contacts and profile data.
9036 #
9037 # Most fields can have multiple items. The items in a field have no guaranteed
9038 # order, but each non-empty field is guaranteed to have exactly one field with
9039 # `metadata.primary` set to true.
9040 "sipAddresses": [ # The person's SIP addresses.
9041 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
9042 # communications to make voice or video calls over the internet.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9043 "formattedType": "A String", # Output only. The type of the SIP address translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9044 # viewer's account locale or the `Accept-Language` HTTP header locale.
9045 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
9046 # predefined values:
9047 #
9048 # * `home`
9049 # * `work`
9050 # * `mobile`
9051 # * `other`
9052 "value": "A String", # The SIP address in the
9053 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
9054 # format.
9055 "metadata": { # Metadata about a field. # Metadata about the SIP address.
9056 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9057 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9058 #
9059 # Last update timestamp of this source.
9060 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9061 #
9062 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9063 # source. Used for web cache validation.
9064 "type": "A String", # The source type.
9065 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9066 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9067 #
9068 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9069 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9070 "A String",
9071 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9072 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9073 },
9074 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9075 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9076 # verified field is typically a name, email address, phone number, or
9077 # website that has been confirmed to be owned by the person.
9078 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9079 # field.
9080 },
9081 },
9082 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9083 "braggingRights": [ # **DEPRECATED**: No data will be returned
9084 # The person's bragging rights.
9085 { # **DEPRECATED**: No data will be returned
9086 # A person's bragging rights.
9087 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
9088 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9089 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9090 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9091 #
9092 # Last update timestamp of this source.
9093 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9094 #
9095 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9096 # source. Used for web cache validation.
9097 "type": "A String", # The source type.
9098 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9099 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9100 #
9101 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9102 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9103 "A String",
9104 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9105 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9106 },
9107 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9108 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9109 # verified field is typically a name, email address, phone number, or
9110 # website that has been confirmed to be owned by the person.
9111 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9112 # field.
9113 },
9114 },
9115 ],
9116 "addresses": [ # The person's street addresses.
9117 { # A person's physical address. May be a P.O. box or street address. All fields
9118 # are optional.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9119 "formattedType": "A String", # Output only. The type of the address translated and formatted in the viewer's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9120 # account locale or the `Accept-Language` HTTP header locale.
9121 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
9122 # code of the address.
9123 "city": "A String", # The city of the address.
9124 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
9125 # will be automatically constructed from structured values.
9126 "region": "A String", # The region of the address; for example, the state or province.
9127 "poBox": "A String", # The P.O. box of the address.
9128 "streetAddress": "A String", # The street address.
9129 "country": "A String", # The country of the address.
9130 "postalCode": "A String", # The postal code of the address.
9131 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
9132 "type": "A String", # The type of the address. The type can be custom or one of these predefined
9133 # values:
9134 #
9135 # * `home`
9136 # * `work`
9137 # * `other`
9138 "metadata": { # Metadata about a field. # Metadata about the address.
9139 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9140 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9141 #
9142 # Last update timestamp of this source.
9143 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9144 #
9145 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9146 # source. Used for web cache validation.
9147 "type": "A String", # The source type.
9148 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9149 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9150 #
9151 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9152 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9153 "A String",
9154 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9155 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9156 },
9157 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9158 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9159 # verified field is typically a name, email address, phone number, or
9160 # website that has been confirmed to be owned by the person.
9161 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9162 # field.
9163 },
9164 },
9165 ],
9166 "nicknames": [ # The person's nicknames.
9167 { # A person's nickname.
9168 "type": "A String", # The type of the nickname.
9169 "value": "A String", # The nickname.
9170 "metadata": { # Metadata about a field. # Metadata about the nickname.
9171 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9172 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9173 #
9174 # Last update timestamp of this source.
9175 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9176 #
9177 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9178 # source. Used for web cache validation.
9179 "type": "A String", # The source type.
9180 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9181 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9182 #
9183 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9184 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9185 "A String",
9186 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9187 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9188 },
9189 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9190 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9191 # verified field is typically a name, email address, phone number, or
9192 # website that has been confirmed to be owned by the person.
9193 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9194 # field.
9195 },
9196 },
9197 ],
9198 "occupations": [ # The person's occupations.
9199 { # A person's occupation.
9200 "value": "A String", # The occupation; for example, `carpenter`.
9201 "metadata": { # Metadata about a field. # Metadata about the occupation.
9202 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9203 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9204 #
9205 # Last update timestamp of this source.
9206 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9207 #
9208 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9209 # source. Used for web cache validation.
9210 "type": "A String", # The source type.
9211 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9212 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9213 #
9214 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9215 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9216 "A String",
9217 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9218 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9219 },
9220 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9221 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9222 # verified field is typically a name, email address, phone number, or
9223 # website that has been confirmed to be owned by the person.
9224 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9225 # field.
9226 },
9227 },
9228 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9229 "phoneNumbers": [ # The person's phone numbers.
9230 { # A person's phone number.
9231 "canonicalForm": "A String", # Output only. The canonicalized [ITU-T
9232 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
9233 # form of the phone number.
9234 "formattedType": "A String", # Output only. The type of the phone number translated and formatted in the
9235 # viewer's account locale or the `Accept-Language` HTTP header locale.
9236 "type": "A String", # The type of the phone number. The type can be custom or one of these
9237 # predefined values:
9238 #
9239 # * `home`
9240 # * `work`
9241 # * `mobile`
9242 # * `homeFax`
9243 # * `workFax`
9244 # * `otherFax`
9245 # * `pager`
9246 # * `workMobile`
9247 # * `workPager`
9248 # * `main`
9249 # * `googleVoice`
9250 # * `other`
9251 "value": "A String", # The phone number.
9252 "metadata": { # Metadata about a field. # Metadata about the phone number.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9253 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9254 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9255 #
9256 # Last update timestamp of this source.
9257 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9258 #
9259 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9260 # source. Used for web cache validation.
9261 "type": "A String", # The source type.
9262 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9263 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9264 #
9265 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9266 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9267 "A String",
9268 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9269 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9270 },
9271 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9272 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9273 # verified field is typically a name, email address, phone number, or
9274 # website that has been confirmed to be owned by the person.
9275 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9276 # field.
9277 },
9278 },
9279 ],
9280 "names": [ # The person's names.
9281 { # A person's name. If the name is a mononym, the family name is empty.
9282 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
9283 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9284 "displayNameLastFirst": "A String", # Output only. The display name with the last name first formatted according to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9285 # the locale specified by the viewer's account or the
9286 # `Accept-Language` HTTP header.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9287 "displayName": "A String", # Output only. The display name formatted according to the locale specified by
9288 # the viewer's account or the `Accept-Language` HTTP header.
9289 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9290 "middleName": "A String", # The middle name(s).
9291 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
9292 "familyName": "A String", # The family name.
9293 "phoneticFullName": "A String", # The full name spelled as it sounds.
9294 "phoneticGivenName": "A String", # The given name spelled as it sounds.
9295 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
9296 "givenName": "A String", # The given name.
9297 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
9298 "metadata": { # Metadata about a field. # Metadata about the name.
9299 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9300 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9301 #
9302 # Last update timestamp of this source.
9303 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9304 #
9305 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9306 # source. Used for web cache validation.
9307 "type": "A String", # The source type.
9308 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9309 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9310 #
9311 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9312 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9313 "A String",
9314 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9315 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9316 },
9317 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9318 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9319 # verified field is typically a name, email address, phone number, or
9320 # website that has been confirmed to be owned by the person.
9321 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9322 # field.
9323 },
9324 },
9325 ],
9326 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
9327 # with a max length of 27 characters, in the form of
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9328 # `people/{person_id}`.
9329 "ageRanges": [ # Output only. The person's age ranges.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9330 { # A person's age range.
9331 "ageRange": "A String", # The age range.
9332 "metadata": { # Metadata about a field. # Metadata about the age range.
9333 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9334 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9335 #
9336 # Last update timestamp of this source.
9337 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9338 #
9339 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9340 # source. Used for web cache validation.
9341 "type": "A String", # The source type.
9342 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9343 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9344 #
9345 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9346 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9347 "A String",
9348 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9349 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9350 },
9351 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9352 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9353 # verified field is typically a name, email address, phone number, or
9354 # website that has been confirmed to be owned by the person.
9355 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9356 # field.
9357 },
9358 },
9359 ],
9360 "birthdays": [ # The person's birthdays.
9361 { # A person's birthday. At least one of the `date` and `text` fields are
9362 # specified. The `date` and `text` fields typically represent the same
9363 # date, but are not guaranteed to.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9364 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the birthday.
9365 # and time zone are either specified elsewhere or are not significant. The date
9366 # is relative to the Proleptic Gregorian Calendar. This can represent:
9367 #
9368 # * A full date, with non-zero year, month and day values
9369 # * A month and day value, with a zero year, e.g. an anniversary
9370 # * A year on its own, with zero month and day values
9371 # * A year and month value, with a zero day, e.g. a credit card expiration date
9372 #
9373 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9374 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
9375 # month and day.
9376 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
9377 # if specifying a year by itself or a year and month where the day is not
9378 # significant.
9379 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
9380 # a year.
9381 },
9382 "text": "A String", # A free-form string representing the user's birthday.
9383 "metadata": { # Metadata about a field. # Metadata about the birthday.
9384 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9385 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9386 #
9387 # Last update timestamp of this source.
9388 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9389 #
9390 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9391 # source. Used for web cache validation.
9392 "type": "A String", # The source type.
9393 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9394 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9395 #
9396 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9397 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9398 "A String",
9399 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9400 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9401 },
9402 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9403 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9404 # verified field is typically a name, email address, phone number, or
9405 # website that has been confirmed to be owned by the person.
9406 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9407 # field.
9408 },
9409 },
9410 ],
9411 "relations": [ # The person's relations.
9412 { # A person's relation to another person.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9413 "formattedType": "A String", # Output only. The type of the relation translated and formatted in the viewer's
9414 # account locale or the locale specified in the Accept-Language HTTP header.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9415 "metadata": { # Metadata about a field. # Metadata about the relation.
9416 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9417 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9418 #
9419 # Last update timestamp of this source.
9420 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9421 #
9422 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9423 # source. Used for web cache validation.
9424 "type": "A String", # The source type.
9425 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9426 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9427 #
9428 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9429 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9430 "A String",
9431 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9432 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9433 },
9434 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9435 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9436 # verified field is typically a name, email address, phone number, or
9437 # website that has been confirmed to be owned by the person.
9438 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9439 # field.
9440 },
9441 "type": "A String", # The person's relation to the other person. The type can be custom or one of
9442 # these predefined values:
9443 #
9444 # * `spouse`
9445 # * `child`
9446 # * `mother`
9447 # * `father`
9448 # * `parent`
9449 # * `brother`
9450 # * `sister`
9451 # * `friend`
9452 # * `relative`
9453 # * `domesticPartner`
9454 # * `manager`
9455 # * `assistant`
9456 # * `referredBy`
9457 # * `partner`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9458 "person": "A String", # The name of the other person this relation refers to.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9459 },
9460 ],
9461 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9462 # resource. Used for web cache validation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9463 "relationshipStatuses": [ # Output only. **DEPRECATED**: No data will be returned
9464 # The person's relationship statuses.
9465 { # **DEPRECATED**: No data will be returned
9466 # A person's relationship status.
9467 "formattedValue": "A String", # Output only. The value of the relationship status translated and formatted in
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9468 # the viewer's account locale or the `Accept-Language` HTTP header locale.
9469 "value": "A String", # The relationship status. The value can be custom or one of these
9470 # predefined values:
9471 #
9472 # * `single`
9473 # * `inARelationship`
9474 # * `engaged`
9475 # * `married`
9476 # * `itsComplicated`
9477 # * `openRelationship`
9478 # * `widowed`
9479 # * `inDomesticPartnership`
9480 # * `inCivilUnion`
9481 "metadata": { # Metadata about a field. # Metadata about the relationship status.
9482 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9483 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9484 #
9485 # Last update timestamp of this source.
9486 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9487 #
9488 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9489 # source. Used for web cache validation.
9490 "type": "A String", # The source type.
9491 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9492 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9493 #
9494 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9495 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9496 "A String",
9497 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9498 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9499 },
9500 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9501 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
9502 # verified field is typically a name, email address, phone number, or
9503 # website that has been confirmed to be owned by the person.
9504 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9505 # field.
9506 },
9507 },
9508 ],
9509 "skills": [ # The person's skills.
9510 { # A skill that the person has.
9511 "value": "A String", # The skill; for example, `underwater basket weaving`.
9512 "metadata": { # Metadata about a field. # Metadata about the skill.
9513 "source": { # The source of a field. # The source of the field.
9514 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
9515 #
9516 # Last update timestamp of this source.
9517 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9518 #
9519 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9520 # source. Used for web cache validation.
9521 "type": "A String", # The source type.
9522 "id": "A String", # The unique identifier within the source type generated by the server.
9523 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
9524 #
9525 # Metadata about a source of type PROFILE.
9526 "userTypes": [ # Output only. The user types.
9527 "A String",
9528 ],
9529 "objectType": "A String", # Output only. The profile object type.
9530 },
9531 },
9532 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9533 # verified field is typically a name, email address, phone number, or
9534 # website that has been confirmed to be owned by the person.
9535 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9536 # field.
9537 },
9538 },
9539 ],
9540 "imClients": [ # The person's instant messaging clients.
9541 { # A person's instant messaging client.
9542 "username": "A String", # The user name used in the IM client.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9543 "formattedType": "A String", # Output only. The type of the IM client translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9544 # viewer's account locale or the `Accept-Language` HTTP header locale.
9545 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
9546 # predefined values:
9547 #
9548 # * `aim`
9549 # * `msn`
9550 # * `yahoo`
9551 # * `skype`
9552 # * `qq`
9553 # * `googleTalk`
9554 # * `icq`
9555 # * `jabber`
9556 # * `netMeeting`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9557 "formattedProtocol": "A String", # Output only. The protocol of the IM client formatted in the viewer's account
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9558 # locale or the `Accept-Language` HTTP header locale.
9559 "type": "A String", # The type of the IM client. The type can be custom or one of these
9560 # predefined values:
9561 #
9562 # * `home`
9563 # * `work`
9564 # * `other`
9565 "metadata": { # Metadata about a field. # Metadata about the IM client.
9566 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9567 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9568 #
9569 # Last update timestamp of this source.
9570 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9571 #
9572 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9573 # source. Used for web cache validation.
9574 "type": "A String", # The source type.
9575 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9576 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9577 #
9578 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9579 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9580 "A String",
9581 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9582 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9583 },
9584 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9585 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9586 # verified field is typically a name, email address, phone number, or
9587 # website that has been confirmed to be owned by the person.
9588 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9589 # field.
9590 },
9591 },
9592 ],
9593 "events": [ # The person's events.
9594 { # An event related to the person.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9595 "date": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The date of the event.
9596 # and time zone are either specified elsewhere or are not significant. The date
9597 # is relative to the Proleptic Gregorian Calendar. This can represent:
9598 #
9599 # * A full date, with non-zero year, month and day values
9600 # * A month and day value, with a zero year, e.g. an anniversary
9601 # * A year on its own, with zero month and day values
9602 # * A year and month value, with a zero day, e.g. a credit card expiration date
9603 #
9604 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9605 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
9606 # month and day.
9607 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
9608 # if specifying a year by itself or a year and month where the day is not
9609 # significant.
9610 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
9611 # a year.
9612 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9613 "formattedType": "A String", # Output only. The type of the event translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9614 # viewer's account locale or the `Accept-Language` HTTP header locale.
9615 "type": "A String", # The type of the event. The type can be custom or one of these predefined
9616 # values:
9617 #
9618 # * `anniversary`
9619 # * `other`
9620 "metadata": { # Metadata about a field. # Metadata about the event.
9621 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9622 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9623 #
9624 # Last update timestamp of this source.
9625 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9626 #
9627 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9628 # source. Used for web cache validation.
9629 "type": "A String", # The source type.
9630 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9631 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9632 #
9633 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9634 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9635 "A String",
9636 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9637 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9638 },
9639 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9640 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9641 # verified field is typically a name, email address, phone number, or
9642 # website that has been confirmed to be owned by the person.
9643 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9644 # field.
9645 },
9646 },
9647 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9648 "metadata": { # The metadata about a person. # Output only. Metadata about the person.
9649 "deleted": True or False, # Output only. True if the person resource has been deleted. Populated only for
9650 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
9651 # that include a sync token.
9652 "previousResourceNames": [ # Output only. Any former resource names this person has had. Populated only for
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9653 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
9654 # that include a sync token.
9655 #
9656 # The resource name may change when adding or removing fields that link a
9657 # contact and profile such as a verified email, verified phone number, or
9658 # profile URL.
9659 "A String",
9660 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9661 "linkedPeopleResourceNames": [ # Output only. Resource names of people linked to this resource.
9662 "A String",
9663 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9664 "sources": [ # The sources of data for the person.
9665 { # The source of a field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9666 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9667 #
9668 # Last update timestamp of this source.
9669 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9670 #
9671 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9672 # source. Used for web cache validation.
9673 "type": "A String", # The source type.
9674 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9675 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9676 #
9677 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9678 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9679 "A String",
9680 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9681 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9682 },
9683 },
9684 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9685 "objectType": "A String", # Output only. **DEPRECATED** (Please use
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9686 # `person.metadata.sources.profileMetadata.objectType` instead)
9687 #
9688 # The type of the person object.
9689 },
9690 "interests": [ # The person's interests.
9691 { # One of the person's interests.
9692 "value": "A String", # The interest; for example, `stargazing`.
9693 "metadata": { # Metadata about a field. # Metadata about the interest.
9694 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9695 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9696 #
9697 # Last update timestamp of this source.
9698 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9699 #
9700 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9701 # source. Used for web cache validation.
9702 "type": "A String", # The source type.
9703 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9704 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9705 #
9706 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9707 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9708 "A String",
9709 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9710 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9711 },
9712 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9713 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9714 # verified field is typically a name, email address, phone number, or
9715 # website that has been confirmed to be owned by the person.
9716 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9717 # field.
9718 },
9719 },
9720 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9721 "photos": [ # Output only. The person's photos.
9722 { # A person's photo. A picture shown next to the person's name to
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9723 # help others recognize the person.
9724 "default": True or False, # True if the photo is a default photo;
9725 # false if the photo is a user-provided photo.
9726 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9727 # parameter `sz={size}` at the end of the url, where {size} is the size in
9728 # pixels. Example:
9729 # https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9730 "metadata": { # Metadata about a field. # Metadata about the photo.
9731 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9732 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9733 #
9734 # Last update timestamp of this source.
9735 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9736 #
9737 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9738 # source. Used for web cache validation.
9739 "type": "A String", # The source type.
9740 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9741 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9742 #
9743 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9744 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9745 "A String",
9746 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9747 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9748 },
9749 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9750 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9751 # verified field is typically a name, email address, phone number, or
9752 # website that has been confirmed to be owned by the person.
9753 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9754 # field.
9755 },
9756 },
9757 ],
9758 "residences": [ # The person's residences.
9759 { # A person's past or current residence.
9760 "current": True or False, # True if the residence is the person's current residence;
9761 # false if the residence is a past residence.
9762 "value": "A String", # The address of the residence.
9763 "metadata": { # Metadata about a field. # Metadata about the residence.
9764 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9765 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9766 #
9767 # Last update timestamp of this source.
9768 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9769 #
9770 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9771 # source. Used for web cache validation.
9772 "type": "A String", # The source type.
9773 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9774 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9775 #
9776 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9777 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9778 "A String",
9779 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9780 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9781 },
9782 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9783 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9784 # verified field is typically a name, email address, phone number, or
9785 # website that has been confirmed to be owned by the person.
9786 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9787 # field.
9788 },
9789 },
9790 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9791 "relationshipInterests": [ # Output only. **DEPRECATED**: No data will be returned
9792 # The person's relationship interests.
9793 { # **DEPRECATED**: No data will be returned
9794 # A person's relationship interest .
9795 "formattedValue": "A String", # Output only. The value of the relationship interest translated and formatted
9796 # in the viewer's account locale or the locale specified in the
9797 # Accept-Language HTTP header.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9798 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
9799 # or one of these predefined values:
9800 #
9801 # * `friend`
9802 # * `date`
9803 # * `relationship`
9804 # * `networking`
9805 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
9806 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9807 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9808 #
9809 # Last update timestamp of this source.
9810 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9811 #
9812 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9813 # source. Used for web cache validation.
9814 "type": "A String", # The source type.
9815 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9816 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9817 #
9818 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9819 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9820 "A String",
9821 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9822 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9823 },
9824 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9825 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9826 # verified field is typically a name, email address, phone number, or
9827 # website that has been confirmed to be owned by the person.
9828 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9829 # field.
9830 },
9831 },
9832 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9833 "coverPhotos": [ # Output only. The person's cover photos.
9834 { # A person's cover photo. A large image shown on the person's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9835 # profile page that represents who they are or what they care about.
9836 "default": True or False, # True if the cover photo is the default cover photo;
9837 # false if the cover photo is a user-provided cover photo.
9838 "url": "A String", # The URL of the cover photo.
9839 "metadata": { # Metadata about a field. # Metadata about the cover photo.
9840 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9841 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9842 #
9843 # Last update timestamp of this source.
9844 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9845 #
9846 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9847 # source. Used for web cache validation.
9848 "type": "A String", # The source type.
9849 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9850 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9851 #
9852 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9853 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9854 "A String",
9855 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9856 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9857 },
9858 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9859 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9860 # verified field is typically a name, email address, phone number, or
9861 # website that has been confirmed to be owned by the person.
9862 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9863 # field.
9864 },
9865 },
9866 ],
9867 "locales": [ # The person's locale preferences.
9868 { # A person's locale preference.
9869 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
9870 # language tag representing the locale.
9871 "metadata": { # Metadata about a field. # Metadata about the locale.
9872 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9873 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9874 #
9875 # Last update timestamp of this source.
9876 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9877 #
9878 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9879 # source. Used for web cache validation.
9880 "type": "A String", # The source type.
9881 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9882 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9883 #
9884 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9885 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9886 "A String",
9887 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9888 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9889 },
9890 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9891 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9892 # verified field is typically a name, email address, phone number, or
9893 # website that has been confirmed to be owned by the person.
9894 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9895 # field.
9896 },
9897 },
9898 ],
9899 "organizations": [ # The person's past or current organizations.
9900 { # A person's past or current organization. Overlapping date ranges are
9901 # permitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9902 "formattedType": "A String", # Output only. The type of the organization translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9903 # viewer's account locale or the `Accept-Language` HTTP header locale.
9904 "domain": "A String", # The domain name associated with the organization; for example,
9905 # `google.com`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9906 "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The end date when the person left the organization.
9907 # and time zone are either specified elsewhere or are not significant. The date
9908 # is relative to the Proleptic Gregorian Calendar. This can represent:
9909 #
9910 # * A full date, with non-zero year, month and day values
9911 # * A month and day value, with a zero year, e.g. an anniversary
9912 # * A year on its own, with zero month and day values
9913 # * A year and month value, with a zero day, e.g. a credit card expiration date
9914 #
9915 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9916 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
9917 # month and day.
9918 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
9919 # if specifying a year by itself or a year and month where the day is not
9920 # significant.
9921 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
9922 # a year.
9923 },
9924 "name": "A String", # The name of the organization.
9925 "title": "A String", # The person's job title at the organization.
9926 "type": "A String", # The type of the organization. The type can be custom or one of these
9927 # predefined values:
9928 #
9929 # * `work`
9930 # * `school`
9931 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
9932 # symbol, abbreviation, or acronym.
9933 "current": True or False, # True if the organization is the person's current organization;
9934 # false if the organization is a past organization.
9935 "jobDescription": "A String", # The person's job description at the organization.
9936 "location": "A String", # The location of the organization office the person works at.
9937 "department": "A String", # The person's department at the organization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9938 "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The start date when the person joined the organization.
9939 # and time zone are either specified elsewhere or are not significant. The date
9940 # is relative to the Proleptic Gregorian Calendar. This can represent:
9941 #
9942 # * A full date, with non-zero year, month and day values
9943 # * A month and day value, with a zero year, e.g. an anniversary
9944 # * A year on its own, with zero month and day values
9945 # * A year and month value, with a zero day, e.g. a credit card expiration date
9946 #
9947 # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9948 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
9949 # month and day.
9950 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
9951 # if specifying a year by itself or a year and month where the day is not
9952 # significant.
9953 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
9954 # a year.
9955 },
9956 "phoneticName": "A String", # The phonetic name of the organization.
9957 "metadata": { # Metadata about a field. # Metadata about the organization.
9958 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9959 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9960 #
9961 # Last update timestamp of this source.
9962 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9963 #
9964 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9965 # source. Used for web cache validation.
9966 "type": "A String", # The source type.
9967 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9968 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9969 #
9970 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9971 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9972 "A String",
9973 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9974 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9975 },
9976 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9977 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9978 # verified field is typically a name, email address, phone number, or
9979 # website that has been confirmed to be owned by the person.
9980 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
9981 # field.
9982 },
9983 },
9984 ],
9985 "userDefined": [ # The person's user defined data.
9986 { # Arbitrary user data that is populated by the end users.
9987 "key": "A String", # The end user specified key of the user defined data.
9988 "value": "A String", # The end user specified value of the user defined data.
9989 "metadata": { # Metadata about a field. # Metadata about the user defined data.
9990 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]9991 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]9992 #
9993 # Last update timestamp of this source.
9994 "etag": "A String", # **Only populated in `person.metadata.sources`.**
9995 #
9996 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
9997 # source. Used for web cache validation.
9998 "type": "A String", # The source type.
9999 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10000 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10001 #
10002 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10003 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10004 "A String",
10005 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10006 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10007 },
10008 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10009 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10010 # verified field is typically a name, email address, phone number, or
10011 # website that has been confirmed to be owned by the person.
10012 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
10013 # field.
10014 },
10015 },
10016 ],
10017 "biographies": [ # The person's biographies.
10018 { # A person's short biography.
10019 "contentType": "A String", # The content type of the biography.
10020 "value": "A String", # The short biography.
10021 "metadata": { # Metadata about a field. # Metadata about the biography.
10022 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10023 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10024 #
10025 # Last update timestamp of this source.
10026 "etag": "A String", # **Only populated in `person.metadata.sources`.**
10027 #
10028 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
10029 # source. Used for web cache validation.
10030 "type": "A String", # The source type.
10031 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10032 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10033 #
10034 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10035 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10036 "A String",
10037 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10038 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10039 },
10040 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10041 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10042 # verified field is typically a name, email address, phone number, or
10043 # website that has been confirmed to be owned by the person.
10044 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
10045 # field.
10046 },
10047 },
10048 ],
10049 "memberships": [ # The person's group memberships.
10050 { # A person's membership in a group. Only contact group memberships can be
10051 # modified.
10052 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10053 "contactGroupId": "A String", # Output only. The contact group ID for the contact group membership.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10054 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10055 # string, in the form of `contactGroups/{contact_group_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10056 # Only contact_group_resource_name can be used for modifying memberships.
10057 # Any contact group membership can be removed, but only user group or
10058 # "myContacts" or "starred" system groups memberships can be added. A
10059 # contact must always have at least one contact group membership.
10060 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10061 "domainMembership": { # A G Suite Domain membership. # Output only. The domain membership.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10062 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
10063 },
10064 "metadata": { # Metadata about a field. # Metadata about the membership.
10065 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10066 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10067 #
10068 # Last update timestamp of this source.
10069 "etag": "A String", # **Only populated in `person.metadata.sources`.**
10070 #
10071 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
10072 # source. Used for web cache validation.
10073 "type": "A String", # The source type.
10074 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10075 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10076 #
10077 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10078 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10079 "A String",
10080 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10081 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10082 },
10083 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10084 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10085 # verified field is typically a name, email address, phone number, or
10086 # website that has been confirmed to be owned by the person.
10087 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
10088 # field.
10089 },
10090 },
10091 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10092 "taglines": [ # Output only. **DEPRECATED**: No data will be returned
10093 # The person's taglines.
10094 { # **DEPRECATED**: No data will be returned
10095 # A brief one-line description of the person.
10096 "value": "A String", # The tagline.
10097 "metadata": { # Metadata about a field. # Metadata about the tagline.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10098 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10099 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10100 #
10101 # Last update timestamp of this source.
10102 "etag": "A String", # **Only populated in `person.metadata.sources`.**
10103 #
10104 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
10105 # source. Used for web cache validation.
10106 "type": "A String", # The source type.
10107 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10108 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10109 #
10110 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10111 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10112 "A String",
10113 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10114 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10115 },
10116 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10117 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10118 # verified field is typically a name, email address, phone number, or
10119 # website that has been confirmed to be owned by the person.
10120 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
10121 # field.
10122 },
10123 },
10124 ],
10125 "urls": [ # The person's associated URLs.
10126 { # A person's associated URLs.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10127 "formattedType": "A String", # Output only. The type of the URL translated and formatted in the viewer's
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10128 # account locale or the `Accept-Language` HTTP header locale.
10129 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
10130 # values:
10131 #
10132 # * `home`
10133 # * `work`
10134 # * `blog`
10135 # * `profile`
10136 # * `homePage`
10137 # * `ftp`
10138 # * `reservations`
10139 # * `appInstallPage`: website for a Google+ application.
10140 # * `other`
10141 "value": "A String", # The URL.
10142 "metadata": { # Metadata about a field. # Metadata about the URL.
10143 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10144 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10145 #
10146 # Last update timestamp of this source.
10147 "etag": "A String", # **Only populated in `person.metadata.sources`.**
10148 #
10149 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
10150 # source. Used for web cache validation.
10151 "type": "A String", # The source type.
10152 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10153 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10154 #
10155 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10156 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10157 "A String",
10158 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10159 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10160 },
10161 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10162 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10163 # verified field is typically a name, email address, phone number, or
10164 # website that has been confirmed to be owned by the person.
10165 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
10166 # field.
10167 },
10168 },
10169 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10170 "ageRange": "A String", # Output only. **DEPRECATED** (Please use `person.ageRanges` instead)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10171 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10172 # The person's age range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10173 "genders": [ # The person's genders.
10174 { # A person's gender.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10175 "formattedValue": "A String", # Output only. The value of the gender translated and formatted in the viewer's account
10176 # locale or the `Accept-Language` HTTP header locale. Unspecified or custom
10177 # value are not localized.
10178 "addressMeAs": "A String", # The type of pronouns that should be used to address the person. The value
10179 # can be custom or one of these predefined values:
10180 #
10181 # * `male`
10182 # * `female`
10183 # * `other`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10184 "value": "A String", # The gender for the person. The gender can be custom or one of these
10185 # predefined values:
10186 #
10187 # * `male`
10188 # * `female`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10189 # * `unspecified`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10190 "metadata": { # Metadata about a field. # Metadata about the gender.
10191 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10192 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10193 #
10194 # Last update timestamp of this source.
10195 "etag": "A String", # **Only populated in `person.metadata.sources`.**
10196 #
10197 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
10198 # source. Used for web cache validation.
10199 "type": "A String", # The source type.
10200 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10201 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10202 #
10203 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10204 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10205 "A String",
10206 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10207 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10208 },
10209 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10210 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10211 # verified field is typically a name, email address, phone number, or
10212 # website that has been confirmed to be owned by the person.
10213 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
10214 # field.
10215 },
10216 },
10217 ],
10218 "emailAddresses": [ # The person's email addresses.
10219 { # A person's email address.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10220 "formattedType": "A String", # Output only. The type of the email address translated and formatted in the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10221 # viewer's account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10222 "metadata": { # Metadata about a field. # Metadata about the email address.
10223 "source": { # The source of a field. # The source of the field.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10224 "updateTime": "A String", # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10225 #
10226 # Last update timestamp of this source.
10227 "etag": "A String", # **Only populated in `person.metadata.sources`.**
10228 #
10229 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
10230 # source. Used for web cache validation.
10231 "type": "A String", # The source type.
10232 "id": "A String", # The unique identifier within the source type generated by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10233 "profileMetadata": { # The metadata about a profile. # Output only. **Only populated in `person.metadata.sources`.**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10234 #
10235 # Metadata about a source of type PROFILE.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10236 "userTypes": [ # Output only. The user types.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10237 "A String",
10238 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10239 "objectType": "A String", # Output only. The profile object type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10240 },
10241 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10242 "verified": True or False, # Output only. True if the field is verified; false if the field is unverified. A
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10243 # verified field is typically a name, email address, phone number, or
10244 # website that has been confirmed to be owned by the person.
10245 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
10246 # field.
10247 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10248 "displayName": "A String", # The display name of the email.
10249 "value": "A String", # The email address.
10250 "type": "A String", # The type of the email address. The type can be custom or one of these
10251 # predefined values:
10252 #
10253 # * `home`
10254 # * `work`
10255 # * `other`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10256 },
10257 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]10258 },
10259 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]10260</div>
10261
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]10262</body></html>