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