Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / people_v1.people.connections.html
blob: 205b53ac96cac2dcb1d13073451705a76cca3c91 [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> . <a href="people_v1.people.connections.html">connections</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]78 <code><a href="#list">list(resourceName, pageSize=None, x__xgafv=None, pageToken=None, sortOrder=None, personFields=None, requestSyncToken=None, syncToken=None, requestMask_includeField=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Provides a list of the authenticated user's contacts merged with any</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]85 <code class="details" id="list">list(resourceName, pageSize=None, x__xgafv=None, pageToken=None, sortOrder=None, personFields=None, requestSyncToken=None, syncToken=None, requestMask_includeField=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]86 <pre>Provides a list of the authenticated user's contacts merged with any
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]87connected profiles.
88<br>
89The request throws a 400 error if 'personFields' is not specified.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]90
91Args:
92 resourceName: string, The resource name to return connections for. Only `people/me` is valid. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]93 pageSize: integer, The number of connections to include in the response. Valid values are
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]94between 1 and 2000, inclusive. Defaults to 100.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]95 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]96 Allowed values
97 1 - v1 error format
98 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]99 pageToken: string, The token of the page to be returned.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]100 sortOrder: string, The order in which the connections should be sorted. Defaults to
101`LAST_MODIFIED_ASCENDING`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]102 personFields: string, **Required.** A field mask to restrict which fields on each person are
103returned. Multiple fields can be specified by separating them with commas.
104Valid values are:
105
106* addresses
107* ageRanges
108* biographies
109* birthdays
110* braggingRights
111* coverPhotos
112* emailAddresses
113* events
114* genders
115* imClients
116* interests
117* locales
118* memberships
119* metadata
120* names
121* nicknames
122* occupations
123* organizations
124* phoneNumbers
125* photos
126* relations
127* relationshipInterests
128* relationshipStatuses
129* residences
130* sipAddresses
131* skills
132* taglines
133* urls
134* userDefined
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]135 requestSyncToken: boolean, Whether the response should include a sync token, which can be used to get
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]136all changes since the last request. For subsequent sync requests use the
137`sync_token` param instead. Initial sync requests that specify
138`request_sync_token` have an additional rate limit.
139 syncToken: string, A sync token returned by a previous call to `people.connections.list`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]140Only resources changed since the sync token was created will be returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]141Sync requests that specify `sync_token` have an additional rate limit.
142 requestMask_includeField: string, **Required.** Comma-separated list of person fields to be included in the
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]143response. Each path should start with `person.`: for example,
144`person.names` or `person.photos`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]145
146Returns:
147 An object of the form:
148
149 {
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]150 "totalPeople": 42, # **DEPRECATED** (Please use totalItems)
151 # The total number of people in the list without pagination.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]152 "nextPageToken": "A String", # The token that can be used to retrieve the next page of results.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]153 "connections": [ # The list of people that the requestor is connected to.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]154 { # Information about a person merged from various data sources such as the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]155 # authenticated user's contacts and profile data.
156 #
157 # Most fields can have multiple items. The items in a field have no guaranteed
158 # order, but each non-empty field is guaranteed to have exactly one field with
159 # `metadata.primary` set to true.
160 "sipAddresses": [ # The person's SIP addresses.
161 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
162 # communications to make voice or video calls over the internet.
163 "formattedType": "A String", # The read-only type of the SIP address translated and formatted in the
164 # viewer's account locale or the `Accept-Language` HTTP header locale.
165 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
166 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]167 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]168 # * `home`
169 # * `work`
170 # * `mobile`
171 # * `other`
172 "value": "A String", # The SIP address in the
173 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
174 # format.
175 "metadata": { # Metadata about a field. # Metadata about the SIP address.
176 "source": { # The source of a field. # The source of the field.
177 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
178 #
179 # Last update timestamp of this source.
180 "etag": "A String", # **Only populated in `person.metadata.sources`.**
181 #
182 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
183 # source. Used for web cache validation.
184 "type": "A String", # The source type.
185 "id": "A String", # The unique identifier within the source type generated by the server.
186 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
187 #
188 # Metadata about a source of type PROFILE.
189 "userTypes": [ # The user types.
190 "A String",
191 ],
192 "objectType": "A String", # The profile object type.
193 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]194 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]195 "verified": True or False, # True if the field is verified; false if the field is unverified. A
196 # verified field is typically a name, email address, phone number, or
197 # website that has been confirmed to be owned by the person.
198 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
199 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]200 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]201 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]202 ],
203 "phoneNumbers": [ # The person's phone numbers.
204 { # A person's phone number.
205 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
206 # viewer's account locale or the `Accept-Language` HTTP header locale.
207 "canonicalForm": "A String", # The read-only canonicalized [ITU-T
208 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
209 # form of the phone number.
210 "type": "A String", # The type of the phone number. The type can be custom or one of these
211 # predefined values:
212 #
213 # * `home`
214 # * `work`
215 # * `mobile`
216 # * `homeFax`
217 # * `workFax`
218 # * `otherFax`
219 # * `pager`
220 # * `workMobile`
221 # * `workPager`
222 # * `main`
223 # * `googleVoice`
224 # * `other`
225 "value": "A String", # The phone number.
226 "metadata": { # Metadata about a field. # Metadata about the phone number.
227 "source": { # The source of a field. # The source of the field.
228 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
229 #
230 # Last update timestamp of this source.
231 "etag": "A String", # **Only populated in `person.metadata.sources`.**
232 #
233 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
234 # source. Used for web cache validation.
235 "type": "A String", # The source type.
236 "id": "A String", # The unique identifier within the source type generated by the server.
237 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
238 #
239 # Metadata about a source of type PROFILE.
240 "userTypes": [ # The user types.
241 "A String",
242 ],
243 "objectType": "A String", # The profile object type.
244 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]245 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]246 "verified": True or False, # True if the field is verified; false if the field is unverified. A
247 # verified field is typically a name, email address, phone number, or
248 # website that has been confirmed to be owned by the person.
249 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
250 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]251 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]252 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]253 ],
254 "addresses": [ # The person's street addresses.
255 { # A person's physical address. May be a P.O. box or street address. All fields
256 # are optional.
257 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
258 # account locale or the `Accept-Language` HTTP header locale.
259 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
260 # code of the address.
261 "city": "A String", # The city of the address.
262 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
263 # will be automatically constructed from structured values.
264 "region": "A String", # The region of the address; for example, the state or province.
265 "poBox": "A String", # The P.O. box of the address.
266 "streetAddress": "A String", # The street address.
267 "country": "A String", # The country of the address.
268 "postalCode": "A String", # The postal code of the address.
269 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
270 "type": "A String", # The type of the address. The type can be custom or one of these predefined
271 # values:
272 #
273 # * `home`
274 # * `work`
275 # * `other`
276 "metadata": { # Metadata about a field. # Metadata about the address.
277 "source": { # The source of a field. # The source of the field.
278 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
279 #
280 # Last update timestamp of this source.
281 "etag": "A String", # **Only populated in `person.metadata.sources`.**
282 #
283 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
284 # source. Used for web cache validation.
285 "type": "A String", # The source type.
286 "id": "A String", # The unique identifier within the source type generated by the server.
287 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
288 #
289 # Metadata about a source of type PROFILE.
290 "userTypes": [ # The user types.
291 "A String",
292 ],
293 "objectType": "A String", # The profile object type.
294 },
295 },
296 "verified": True or False, # True if the field is verified; false if the field is unverified. A
297 # verified field is typically a name, email address, phone number, or
298 # website that has been confirmed to be owned by the person.
299 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
300 # field.
301 },
302 },
303 ],
304 "nicknames": [ # The person's nicknames.
305 { # A person's nickname.
306 "type": "A String", # The type of the nickname.
307 "value": "A String", # The nickname.
308 "metadata": { # Metadata about a field. # Metadata about the nickname.
309 "source": { # The source of a field. # The source of the field.
310 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
311 #
312 # Last update timestamp of this source.
313 "etag": "A String", # **Only populated in `person.metadata.sources`.**
314 #
315 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
316 # source. Used for web cache validation.
317 "type": "A String", # The source type.
318 "id": "A String", # The unique identifier within the source type generated by the server.
319 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
320 #
321 # Metadata about a source of type PROFILE.
322 "userTypes": [ # The user types.
323 "A String",
324 ],
325 "objectType": "A String", # The profile object type.
326 },
327 },
328 "verified": True or False, # True if the field is verified; false if the field is unverified. A
329 # verified field is typically a name, email address, phone number, or
330 # website that has been confirmed to be owned by the person.
331 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
332 # field.
333 },
334 },
335 ],
336 "occupations": [ # The person's occupations.
337 { # A person's occupation.
338 "value": "A String", # The occupation; for example, `carpenter`.
339 "metadata": { # Metadata about a field. # Metadata about the occupation.
340 "source": { # The source of a field. # The source of the field.
341 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
342 #
343 # Last update timestamp of this source.
344 "etag": "A String", # **Only populated in `person.metadata.sources`.**
345 #
346 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
347 # source. Used for web cache validation.
348 "type": "A String", # The source type.
349 "id": "A String", # The unique identifier within the source type generated by the server.
350 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
351 #
352 # Metadata about a source of type PROFILE.
353 "userTypes": [ # The user types.
354 "A String",
355 ],
356 "objectType": "A String", # The profile object type.
357 },
358 },
359 "verified": True or False, # True if the field is verified; false if the field is unverified. A
360 # verified field is typically a name, email address, phone number, or
361 # website that has been confirmed to be owned by the person.
362 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
363 # field.
364 },
365 },
366 ],
367 "braggingRights": [ # The person's bragging rights.
368 { # A person's bragging rights.
369 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
370 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
371 "source": { # The source of a field. # The source of the field.
372 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
373 #
374 # Last update timestamp of this source.
375 "etag": "A String", # **Only populated in `person.metadata.sources`.**
376 #
377 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
378 # source. Used for web cache validation.
379 "type": "A String", # The source type.
380 "id": "A String", # The unique identifier within the source type generated by the server.
381 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
382 #
383 # Metadata about a source of type PROFILE.
384 "userTypes": [ # The user types.
385 "A String",
386 ],
387 "objectType": "A String", # The profile object type.
388 },
389 },
390 "verified": True or False, # True if the field is verified; false if the field is unverified. A
391 # verified field is typically a name, email address, phone number, or
392 # website that has been confirmed to be owned by the person.
393 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
394 # field.
395 },
396 },
397 ],
398 "names": [ # The person's names.
399 { # A person's name. If the name is a mononym, the family name is empty.
400 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
401 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
402 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
403 "displayName": "A String", # The read-only display name formatted according to the locale specified by
404 # the viewer's account or the `Accept-Language` HTTP header.
405 "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
406 # the locale specified by the viewer's account or the
407 # `Accept-Language` HTTP header.
408 "middleName": "A String", # The middle name(s).
409 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
410 "familyName": "A String", # The family name.
411 "phoneticFullName": "A String", # The full name spelled as it sounds.
412 "phoneticGivenName": "A String", # The given name spelled as it sounds.
413 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
414 "givenName": "A String", # The given name.
415 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
416 "metadata": { # Metadata about a field. # Metadata about the name.
417 "source": { # The source of a field. # The source of the field.
418 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
419 #
420 # Last update timestamp of this source.
421 "etag": "A String", # **Only populated in `person.metadata.sources`.**
422 #
423 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
424 # source. Used for web cache validation.
425 "type": "A String", # The source type.
426 "id": "A String", # The unique identifier within the source type generated by the server.
427 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
428 #
429 # Metadata about a source of type PROFILE.
430 "userTypes": [ # The user types.
431 "A String",
432 ],
433 "objectType": "A String", # The profile object type.
434 },
435 },
436 "verified": True or False, # True if the field is verified; false if the field is unverified. A
437 # verified field is typically a name, email address, phone number, or
438 # website that has been confirmed to be owned by the person.
439 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
440 # field.
441 },
442 },
443 ],
444 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
445 # with a max length of 27 characters, in the form of
446 # `people/`<var>person_id</var>.
447 "taglines": [ # The person's read-only taglines.
448 { # A read-only brief one-line description of the person.
449 "value": "A String", # The tagline.
450 "metadata": { # Metadata about a field. # Metadata about the tagline.
451 "source": { # The source of a field. # The source of the field.
452 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
453 #
454 # Last update timestamp of this source.
455 "etag": "A String", # **Only populated in `person.metadata.sources`.**
456 #
457 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
458 # source. Used for web cache validation.
459 "type": "A String", # The source type.
460 "id": "A String", # The unique identifier within the source type generated by the server.
461 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
462 #
463 # Metadata about a source of type PROFILE.
464 "userTypes": [ # The user types.
465 "A String",
466 ],
467 "objectType": "A String", # The profile object type.
468 },
469 },
470 "verified": True or False, # True if the field is verified; false if the field is unverified. A
471 # verified field is typically a name, email address, phone number, or
472 # website that has been confirmed to be owned by the person.
473 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
474 # field.
475 },
476 },
477 ],
478 "ageRanges": [ # The person's read-only age ranges.
479 { # A person's age range.
480 "ageRange": "A String", # The age range.
481 "metadata": { # Metadata about a field. # Metadata about the age range.
482 "source": { # The source of a field. # The source of the field.
483 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
484 #
485 # Last update timestamp of this source.
486 "etag": "A String", # **Only populated in `person.metadata.sources`.**
487 #
488 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
489 # source. Used for web cache validation.
490 "type": "A String", # The source type.
491 "id": "A String", # The unique identifier within the source type generated by the server.
492 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
493 #
494 # Metadata about a source of type PROFILE.
495 "userTypes": [ # The user types.
496 "A String",
497 ],
498 "objectType": "A String", # The profile object type.
499 },
500 },
501 "verified": True or False, # True if the field is verified; false if the field is unverified. A
502 # verified field is typically a name, email address, phone number, or
503 # website that has been confirmed to be owned by the person.
504 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
505 # field.
506 },
507 },
508 ],
509 "birthdays": [ # The person's birthdays.
510 { # A person's birthday. At least one of the `date` and `text` fields are
511 # specified. The `date` and `text` fields typically represent the same
512 # date, but are not guaranteed to.
513 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
514 # of day and time zone are either specified elsewhere or are not
515 # significant. The date is relative to the
516 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
517 # The day may be 0 to represent a year and month where the day is not
518 # significant. The year may be 0 to represent a month and day independent
519 # of year; for example, anniversary date.
520 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
521 # month and day.
522 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
523 # if specifying a year by itself or a year and month where the day is not
524 # significant.
525 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
526 # a year.
527 },
528 "text": "A String", # A free-form string representing the user's birthday.
529 "metadata": { # Metadata about a field. # Metadata about the birthday.
530 "source": { # The source of a field. # The source of the field.
531 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
532 #
533 # Last update timestamp of this source.
534 "etag": "A String", # **Only populated in `person.metadata.sources`.**
535 #
536 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
537 # source. Used for web cache validation.
538 "type": "A String", # The source type.
539 "id": "A String", # The unique identifier within the source type generated by the server.
540 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
541 #
542 # Metadata about a source of type PROFILE.
543 "userTypes": [ # The user types.
544 "A String",
545 ],
546 "objectType": "A String", # The profile object type.
547 },
548 },
549 "verified": True or False, # True if the field is verified; false if the field is unverified. A
550 # verified field is typically a name, email address, phone number, or
551 # website that has been confirmed to be owned by the person.
552 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
553 # field.
554 },
555 },
556 ],
557 "relations": [ # The person's relations.
558 { # A person's relation to another person.
559 "person": "A String", # The name of the other person this relation refers to.
560 "metadata": { # Metadata about a field. # Metadata about the relation.
561 "source": { # The source of a field. # The source of the field.
562 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
563 #
564 # Last update timestamp of this source.
565 "etag": "A String", # **Only populated in `person.metadata.sources`.**
566 #
567 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
568 # source. Used for web cache validation.
569 "type": "A String", # The source type.
570 "id": "A String", # The unique identifier within the source type generated by the server.
571 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
572 #
573 # Metadata about a source of type PROFILE.
574 "userTypes": [ # The user types.
575 "A String",
576 ],
577 "objectType": "A String", # The profile object type.
578 },
579 },
580 "verified": True or False, # True if the field is verified; false if the field is unverified. A
581 # verified field is typically a name, email address, phone number, or
582 # website that has been confirmed to be owned by the person.
583 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
584 # field.
585 },
586 "type": "A String", # The person's relation to the other person. The type can be custom or one of
587 # these predefined values:
588 #
589 # * `spouse`
590 # * `child`
591 # * `mother`
592 # * `father`
593 # * `parent`
594 # * `brother`
595 # * `sister`
596 # * `friend`
597 # * `relative`
598 # * `domesticPartner`
599 # * `manager`
600 # * `assistant`
601 # * `referredBy`
602 # * `partner`
603 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
604 # locale or the locale specified in the Accept-Language HTTP header.
605 },
606 ],
607 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
608 # resource. Used for web cache validation.
609 "relationshipStatuses": [ # The person's read-only relationship statuses.
610 { # A person's read-only relationship status.
611 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
612 # the viewer's account locale or the `Accept-Language` HTTP header locale.
613 "value": "A String", # The relationship status. The value can be custom or one of these
614 # predefined values:
615 #
616 # * `single`
617 # * `inARelationship`
618 # * `engaged`
619 # * `married`
620 # * `itsComplicated`
621 # * `openRelationship`
622 # * `widowed`
623 # * `inDomesticPartnership`
624 # * `inCivilUnion`
625 "metadata": { # Metadata about a field. # Metadata about the relationship status.
626 "source": { # The source of a field. # The source of the field.
627 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
628 #
629 # Last update timestamp of this source.
630 "etag": "A String", # **Only populated in `person.metadata.sources`.**
631 #
632 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
633 # source. Used for web cache validation.
634 "type": "A String", # The source type.
635 "id": "A String", # The unique identifier within the source type generated by the server.
636 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
637 #
638 # Metadata about a source of type PROFILE.
639 "userTypes": [ # The user types.
640 "A String",
641 ],
642 "objectType": "A String", # The profile object type.
643 },
644 },
645 "verified": True or False, # True if the field is verified; false if the field is unverified. A
646 # verified field is typically a name, email address, phone number, or
647 # website that has been confirmed to be owned by the person.
648 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
649 # field.
650 },
651 },
652 ],
653 "imClients": [ # The person's instant messaging clients.
654 { # A person's instant messaging client.
655 "username": "A String", # The user name used in the IM client.
656 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
657 # viewer's account locale or the `Accept-Language` HTTP header locale.
658 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
659 # predefined values:
660 #
661 # * `aim`
662 # * `msn`
663 # * `yahoo`
664 # * `skype`
665 # * `qq`
666 # * `googleTalk`
667 # * `icq`
668 # * `jabber`
669 # * `netMeeting`
670 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
671 # locale or the `Accept-Language` HTTP header locale.
672 "type": "A String", # The type of the IM client. The type can be custom or one of these
673 # predefined values:
674 #
675 # * `home`
676 # * `work`
677 # * `other`
678 "metadata": { # Metadata about a field. # Metadata about the IM client.
679 "source": { # The source of a field. # The source of the field.
680 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
681 #
682 # Last update timestamp of this source.
683 "etag": "A String", # **Only populated in `person.metadata.sources`.**
684 #
685 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
686 # source. Used for web cache validation.
687 "type": "A String", # The source type.
688 "id": "A String", # The unique identifier within the source type generated by the server.
689 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
690 #
691 # Metadata about a source of type PROFILE.
692 "userTypes": [ # The user types.
693 "A String",
694 ],
695 "objectType": "A String", # The profile object type.
696 },
697 },
698 "verified": True or False, # True if the field is verified; false if the field is unverified. A
699 # verified field is typically a name, email address, phone number, or
700 # website that has been confirmed to be owned by the person.
701 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
702 # field.
703 },
704 },
705 ],
706 "events": [ # The person's events.
707 { # An event related to the person.
708 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
709 # of day and time zone are either specified elsewhere or are not
710 # significant. The date is relative to the
711 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
712 # The day may be 0 to represent a year and month where the day is not
713 # significant. The year may be 0 to represent a month and day independent
714 # of year; for example, anniversary date.
715 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
716 # month and day.
717 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
718 # if specifying a year by itself or a year and month where the day is not
719 # significant.
720 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
721 # a year.
722 },
723 "formattedType": "A String", # The read-only type of the event translated and formatted in the
724 # viewer's account locale or the `Accept-Language` HTTP header locale.
725 "type": "A String", # The type of the event. The type can be custom or one of these predefined
726 # values:
727 #
728 # * `anniversary`
729 # * `other`
730 "metadata": { # Metadata about a field. # Metadata about the event.
731 "source": { # The source of a field. # The source of the field.
732 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
733 #
734 # Last update timestamp of this source.
735 "etag": "A String", # **Only populated in `person.metadata.sources`.**
736 #
737 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
738 # source. Used for web cache validation.
739 "type": "A String", # The source type.
740 "id": "A String", # The unique identifier within the source type generated by the server.
741 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
742 #
743 # Metadata about a source of type PROFILE.
744 "userTypes": [ # The user types.
745 "A String",
746 ],
747 "objectType": "A String", # The profile object type.
748 },
749 },
750 "verified": True or False, # True if the field is verified; false if the field is unverified. A
751 # verified field is typically a name, email address, phone number, or
752 # website that has been confirmed to be owned by the person.
753 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
754 # field.
755 },
756 },
757 ],
758 "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
759 "previousResourceNames": [ # Any former resource names this person has had. Populated only for
760 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
761 # that include a sync token.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]762 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]763 # The resource name may change when adding or removing fields that link a
764 # contact and profile such as a verified email, verified phone number, or
765 # profile URL.
766 "A String",
767 ],
768 "sources": [ # The sources of data for the person.
769 { # The source of a field.
770 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
771 #
772 # Last update timestamp of this source.
773 "etag": "A String", # **Only populated in `person.metadata.sources`.**
774 #
775 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
776 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]777 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]778 "id": "A String", # The unique identifier within the source type generated by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]779 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
780 #
781 # Metadata about a source of type PROFILE.
782 "userTypes": [ # The user types.
783 "A String",
784 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]785 "objectType": "A String", # The profile object type.
786 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]787 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]788 ],
789 "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
790 "A String",
791 ],
792 "deleted": True or False, # True if the person resource has been deleted. Populated only for
793 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
794 # that include a sync token.
795 "objectType": "A String", # **DEPRECATED** (Please use
796 # `person.metadata.sources.profileMetadata.objectType` instead)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]797 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]798 # The type of the person object.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]799 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]800 "interests": [ # The person's interests.
801 { # One of the person's interests.
802 "value": "A String", # The interest; for example, `stargazing`.
803 "metadata": { # Metadata about a field. # Metadata about the interest.
804 "source": { # The source of a field. # The source of the field.
805 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
806 #
807 # Last update timestamp of this source.
808 "etag": "A String", # **Only populated in `person.metadata.sources`.**
809 #
810 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
811 # source. Used for web cache validation.
812 "type": "A String", # The source type.
813 "id": "A String", # The unique identifier within the source type generated by the server.
814 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
815 #
816 # Metadata about a source of type PROFILE.
817 "userTypes": [ # The user types.
818 "A String",
819 ],
820 "objectType": "A String", # The profile object type.
821 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]822 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]823 "verified": True or False, # True if the field is verified; false if the field is unverified. A
824 # verified field is typically a name, email address, phone number, or
825 # website that has been confirmed to be owned by the person.
826 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
827 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]828 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]829 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]830 ],
831 "photos": [ # The person's read-only photos.
832 { # A person's read-only photo. A picture shown next to the person's name to
833 # help others recognize the person.
834 "default": True or False, # True if the photo is a default photo;
835 # false if the photo is a user-provided photo.
836 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
837 # parameter `sz=`<var>size</var> at the end of the url. Example:
838 # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
839 "metadata": { # Metadata about a field. # Metadata about the photo.
840 "source": { # The source of a field. # The source of the field.
841 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
842 #
843 # Last update timestamp of this source.
844 "etag": "A String", # **Only populated in `person.metadata.sources`.**
845 #
846 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
847 # source. Used for web cache validation.
848 "type": "A String", # The source type.
849 "id": "A String", # The unique identifier within the source type generated by the server.
850 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
851 #
852 # Metadata about a source of type PROFILE.
853 "userTypes": [ # The user types.
854 "A String",
855 ],
856 "objectType": "A String", # The profile object type.
857 },
858 },
859 "verified": True or False, # True if the field is verified; false if the field is unverified. A
860 # verified field is typically a name, email address, phone number, or
861 # website that has been confirmed to be owned by the person.
862 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
863 # field.
864 },
865 },
866 ],
867 "residences": [ # The person's residences.
868 { # A person's past or current residence.
869 "current": True or False, # True if the residence is the person's current residence;
870 # false if the residence is a past residence.
871 "value": "A String", # The address of the residence.
872 "metadata": { # Metadata about a field. # Metadata about the residence.
873 "source": { # The source of a field. # The source of the field.
874 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
875 #
876 # Last update timestamp of this source.
877 "etag": "A String", # **Only populated in `person.metadata.sources`.**
878 #
879 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
880 # source. Used for web cache validation.
881 "type": "A String", # The source type.
882 "id": "A String", # The unique identifier within the source type generated by the server.
883 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
884 #
885 # Metadata about a source of type PROFILE.
886 "userTypes": [ # The user types.
887 "A String",
888 ],
889 "objectType": "A String", # The profile object type.
890 },
891 },
892 "verified": True or False, # True if the field is verified; false if the field is unverified. A
893 # verified field is typically a name, email address, phone number, or
894 # website that has been confirmed to be owned by the person.
895 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
896 # field.
897 },
898 },
899 ],
900 "relationshipInterests": [ # The person's read-only relationship interests.
901 { # A person's read-only relationship interest .
902 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
903 # viewer's account locale or the locale specified in the Accept-Language
904 # HTTP header.
905 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
906 # or one of these predefined values:
907 #
908 # * `friend`
909 # * `date`
910 # * `relationship`
911 # * `networking`
912 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
913 "source": { # The source of a field. # The source of the field.
914 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
915 #
916 # Last update timestamp of this source.
917 "etag": "A String", # **Only populated in `person.metadata.sources`.**
918 #
919 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
920 # source. Used for web cache validation.
921 "type": "A String", # The source type.
922 "id": "A String", # The unique identifier within the source type generated by the server.
923 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
924 #
925 # Metadata about a source of type PROFILE.
926 "userTypes": [ # The user types.
927 "A String",
928 ],
929 "objectType": "A String", # The profile object type.
930 },
931 },
932 "verified": True or False, # True if the field is verified; false if the field is unverified. A
933 # verified field is typically a name, email address, phone number, or
934 # website that has been confirmed to be owned by the person.
935 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
936 # field.
937 },
938 },
939 ],
940 "coverPhotos": [ # The person's read-only cover photos.
941 { # A person's read-only cover photo. A large image shown on the person's
942 # profile page that represents who they are or what they care about.
943 "default": True or False, # True if the cover photo is the default cover photo;
944 # false if the cover photo is a user-provided cover photo.
945 "url": "A String", # The URL of the cover photo.
946 "metadata": { # Metadata about a field. # Metadata about the cover photo.
947 "source": { # The source of a field. # The source of the field.
948 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
949 #
950 # Last update timestamp of this source.
951 "etag": "A String", # **Only populated in `person.metadata.sources`.**
952 #
953 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
954 # source. Used for web cache validation.
955 "type": "A String", # The source type.
956 "id": "A String", # The unique identifier within the source type generated by the server.
957 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
958 #
959 # Metadata about a source of type PROFILE.
960 "userTypes": [ # The user types.
961 "A String",
962 ],
963 "objectType": "A String", # The profile object type.
964 },
965 },
966 "verified": True or False, # True if the field is verified; false if the field is unverified. A
967 # verified field is typically a name, email address, phone number, or
968 # website that has been confirmed to be owned by the person.
969 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
970 # field.
971 },
972 },
973 ],
974 "locales": [ # The person's locale preferences.
975 { # A person's locale preference.
976 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
977 # language tag representing the locale.
978 "metadata": { # Metadata about a field. # Metadata about the locale.
979 "source": { # The source of a field. # The source of the field.
980 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
981 #
982 # Last update timestamp of this source.
983 "etag": "A String", # **Only populated in `person.metadata.sources`.**
984 #
985 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
986 # source. Used for web cache validation.
987 "type": "A String", # The source type.
988 "id": "A String", # The unique identifier within the source type generated by the server.
989 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
990 #
991 # Metadata about a source of type PROFILE.
992 "userTypes": [ # The user types.
993 "A String",
994 ],
995 "objectType": "A String", # The profile object type.
996 },
997 },
998 "verified": True or False, # True if the field is verified; false if the field is unverified. A
999 # verified field is typically a name, email address, phone number, or
1000 # website that has been confirmed to be owned by the person.
1001 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1002 # field.
1003 },
1004 },
1005 ],
1006 "organizations": [ # The person's past or current organizations.
1007 { # A person's past or current organization. Overlapping date ranges are
1008 # permitted.
1009 "formattedType": "A String", # The read-only type of the organization translated and formatted in the
1010 # viewer's account locale or the `Accept-Language` HTTP header locale.
1011 "domain": "A String", # The domain name associated with the organization; for example,
1012 # `google.com`.
1013 "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
1014 # of day and time zone are either specified elsewhere or are not
1015 # significant. The date is relative to the
1016 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
1017 # The day may be 0 to represent a year and month where the day is not
1018 # significant. The year may be 0 to represent a month and day independent
1019 # of year; for example, anniversary date.
1020 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1021 # month and day.
1022 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1023 # if specifying a year by itself or a year and month where the day is not
1024 # significant.
1025 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1026 # a year.
1027 },
1028 "name": "A String", # The name of the organization.
1029 "title": "A String", # The person's job title at the organization.
1030 "type": "A String", # The type of the organization. The type can be custom or one of these
1031 # predefined values:
1032 #
1033 # * `work`
1034 # * `school`
1035 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
1036 # symbol, abbreviation, or acronym.
1037 "current": True or False, # True if the organization is the person's current organization;
1038 # false if the organization is a past organization.
1039 "jobDescription": "A String", # The person's job description at the organization.
1040 "location": "A String", # The location of the organization office the person works at.
1041 "department": "A String", # The person's department at the organization.
1042 "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
1043 # of day and time zone are either specified elsewhere or are not
1044 # significant. The date is relative to the
1045 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
1046 # The day may be 0 to represent a year and month where the day is not
1047 # significant. The year may be 0 to represent a month and day independent
1048 # of year; for example, anniversary date.
1049 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1050 # month and day.
1051 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1052 # if specifying a year by itself or a year and month where the day is not
1053 # significant.
1054 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1055 # a year.
1056 },
1057 "phoneticName": "A String", # The phonetic name of the organization.
1058 "metadata": { # Metadata about a field. # Metadata about the organization.
1059 "source": { # The source of a field. # The source of the field.
1060 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1061 #
1062 # Last update timestamp of this source.
1063 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1064 #
1065 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1066 # source. Used for web cache validation.
1067 "type": "A String", # The source type.
1068 "id": "A String", # The unique identifier within the source type generated by the server.
1069 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1070 #
1071 # Metadata about a source of type PROFILE.
1072 "userTypes": [ # The user types.
1073 "A String",
1074 ],
1075 "objectType": "A String", # The profile object type.
1076 },
1077 },
1078 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1079 # verified field is typically a name, email address, phone number, or
1080 # website that has been confirmed to be owned by the person.
1081 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1082 # field.
1083 },
1084 },
1085 ],
1086 "userDefined": [ # The person's user defined data.
1087 { # Arbitrary user data that is populated by the end users.
1088 "key": "A String", # The end user specified key of the user defined data.
1089 "value": "A String", # The end user specified value of the user defined data.
1090 "metadata": { # Metadata about a field. # Metadata about the user defined data.
1091 "source": { # The source of a field. # The source of the field.
1092 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1093 #
1094 # Last update timestamp of this source.
1095 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1096 #
1097 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1098 # source. Used for web cache validation.
1099 "type": "A String", # The source type.
1100 "id": "A String", # The unique identifier within the source type generated by the server.
1101 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1102 #
1103 # Metadata about a source of type PROFILE.
1104 "userTypes": [ # The user types.
1105 "A String",
1106 ],
1107 "objectType": "A String", # The profile object type.
1108 },
1109 },
1110 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1111 # verified field is typically a name, email address, phone number, or
1112 # website that has been confirmed to be owned by the person.
1113 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1114 # field.
1115 },
1116 },
1117 ],
1118 "biographies": [ # The person's biographies.
1119 { # A person's short biography.
1120 "contentType": "A String", # The content type of the biography.
1121 "value": "A String", # The short biography.
1122 "metadata": { # Metadata about a field. # Metadata about the biography.
1123 "source": { # The source of a field. # The source of the field.
1124 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1125 #
1126 # Last update timestamp of this source.
1127 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1128 #
1129 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1130 # source. Used for web cache validation.
1131 "type": "A String", # The source type.
1132 "id": "A String", # The unique identifier within the source type generated by the server.
1133 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1134 #
1135 # Metadata about a source of type PROFILE.
1136 "userTypes": [ # The user types.
1137 "A String",
1138 ],
1139 "objectType": "A String", # The profile object type.
1140 },
1141 },
1142 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1143 # verified field is typically a name, email address, phone number, or
1144 # website that has been confirmed to be owned by the person.
1145 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1146 # field.
1147 },
1148 },
1149 ],
1150 "memberships": [ # The person's group memberships.
1151 { # A person's membership in a group. Only contact group memberships can be
1152 # modified.
1153 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
1154 "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
1155 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
1156 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
1157 # Only contact_group_resource_name can be used for modifying memberships.
1158 # Any contact group membership can be removed, but only user group or
1159 # "myContacts" or "starred" system groups memberships can be added. A
1160 # contact must always have at least one contact group membership.
1161 },
1162 "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain membership.
1163 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
1164 },
1165 "metadata": { # Metadata about a field. # Metadata about the membership.
1166 "source": { # The source of a field. # The source of the field.
1167 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1168 #
1169 # Last update timestamp of this source.
1170 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1171 #
1172 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1173 # source. Used for web cache validation.
1174 "type": "A String", # The source type.
1175 "id": "A String", # The unique identifier within the source type generated by the server.
1176 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1177 #
1178 # Metadata about a source of type PROFILE.
1179 "userTypes": [ # The user types.
1180 "A String",
1181 ],
1182 "objectType": "A String", # The profile object type.
1183 },
1184 },
1185 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1186 # verified field is typically a name, email address, phone number, or
1187 # website that has been confirmed to be owned by the person.
1188 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1189 # field.
1190 },
1191 },
1192 ],
1193 "skills": [ # The person's skills.
1194 { # A skill that the person has.
1195 "value": "A String", # The skill; for example, `underwater basket weaving`.
1196 "metadata": { # Metadata about a field. # Metadata about the skill.
1197 "source": { # The source of a field. # The source of the field.
1198 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1199 #
1200 # Last update timestamp of this source.
1201 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1202 #
1203 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1204 # source. Used for web cache validation.
1205 "type": "A String", # The source type.
1206 "id": "A String", # The unique identifier within the source type generated by the server.
1207 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1208 #
1209 # Metadata about a source of type PROFILE.
1210 "userTypes": [ # The user types.
1211 "A String",
1212 ],
1213 "objectType": "A String", # The profile object type.
1214 },
1215 },
1216 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1217 # verified field is typically a name, email address, phone number, or
1218 # website that has been confirmed to be owned by the person.
1219 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1220 # field.
1221 },
1222 },
1223 ],
1224 "urls": [ # The person's associated URLs.
1225 { # A person's associated URLs.
1226 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
1227 # account locale or the `Accept-Language` HTTP header locale.
1228 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
1229 # values:
1230 #
1231 # * `home`
1232 # * `work`
1233 # * `blog`
1234 # * `profile`
1235 # * `homePage`
1236 # * `ftp`
1237 # * `reservations`
1238 # * `appInstallPage`: website for a Google+ application.
1239 # * `other`
1240 "value": "A String", # The URL.
1241 "metadata": { # Metadata about a field. # Metadata about the URL.
1242 "source": { # The source of a field. # The source of the field.
1243 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1244 #
1245 # Last update timestamp of this source.
1246 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1247 #
1248 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1249 # source. Used for web cache validation.
1250 "type": "A String", # The source type.
1251 "id": "A String", # The unique identifier within the source type generated by the server.
1252 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1253 #
1254 # Metadata about a source of type PROFILE.
1255 "userTypes": [ # The user types.
1256 "A String",
1257 ],
1258 "objectType": "A String", # The profile object type.
1259 },
1260 },
1261 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1262 # verified field is typically a name, email address, phone number, or
1263 # website that has been confirmed to be owned by the person.
1264 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1265 # field.
1266 },
1267 },
1268 ],
1269 "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
1270 #
1271 # The person's read-only age range.
1272 "genders": [ # The person's genders.
1273 { # A person's gender.
1274 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
1275 # account locale or the `Accept-Language` HTTP header locale.
1276 "value": "A String", # The gender for the person. The gender can be custom or one of these
1277 # predefined values:
1278 #
1279 # * `male`
1280 # * `female`
1281 # * `other`
1282 # * `unknown`
1283 "metadata": { # Metadata about a field. # Metadata about the gender.
1284 "source": { # The source of a field. # The source of the field.
1285 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1286 #
1287 # Last update timestamp of this source.
1288 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1289 #
1290 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1291 # source. Used for web cache validation.
1292 "type": "A String", # The source type.
1293 "id": "A String", # The unique identifier within the source type generated by the server.
1294 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1295 #
1296 # Metadata about a source of type PROFILE.
1297 "userTypes": [ # The user types.
1298 "A String",
1299 ],
1300 "objectType": "A String", # The profile object type.
1301 },
1302 },
1303 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1304 # verified field is typically a name, email address, phone number, or
1305 # website that has been confirmed to be owned by the person.
1306 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1307 # field.
1308 },
1309 },
1310 ],
1311 "emailAddresses": [ # The person's email addresses.
1312 { # A person's email address.
1313 "type": "A String", # The type of the email address. The type can be custom or one of these
1314 # predefined values:
1315 #
1316 # * `home`
1317 # * `work`
1318 # * `other`
1319 "formattedType": "A String", # The read-only type of the email address translated and formatted in the
1320 # viewer's account locale or the `Accept-Language` HTTP header locale.
1321 "displayName": "A String", # The display name of the email.
1322 "value": "A String", # The email address.
1323 "metadata": { # Metadata about a field. # Metadata about the email address.
1324 "source": { # The source of a field. # The source of the field.
1325 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1326 #
1327 # Last update timestamp of this source.
1328 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1329 #
1330 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1331 # source. Used for web cache validation.
1332 "type": "A String", # The source type.
1333 "id": "A String", # The unique identifier within the source type generated by the server.
1334 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1335 #
1336 # Metadata about a source of type PROFILE.
1337 "userTypes": [ # The user types.
1338 "A String",
1339 ],
1340 "objectType": "A String", # The profile object type.
1341 },
1342 },
1343 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1344 # verified field is typically a name, email address, phone number, or
1345 # website that has been confirmed to be owned by the person.
1346 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1347 # field.
1348 },
1349 },
1350 ],
1351 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1352 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1353 "nextSyncToken": "A String", # The token that can be used to retrieve changes since the last request.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1354 "totalItems": 42, # The total number of items in the list without pagination.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1355 }</pre>
1356</div>
1357
1358<div class="method">
1359 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1360 <pre>Retrieves the next page of results.
1361
1362Args:
1363 previous_request: The request for the previous page. (required)
1364 previous_response: The response from the request for the previous page. (required)
1365
1366Returns:
1367 A request object that you can call 'execute()' on to request the next
1368 page. Returns None if there are no more items in the collection.
1369 </pre>
1370</div>
1371
1372</body></html>