Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / people_v1.people.html
blob: fd86443be431ab556aa713b8cc3590463e469d42 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="people_v1.html">People API</a> . <a href="people_v1.people.html">people</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="people_v1.people.connections.html">connections()</a></code>
79</p>
80<p class="firstline">Returns the connections Resource.</p>
81
82<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83 <code><a href="#createContact">createContact(body, parent=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Create a new contact and return the person resource for that contact.</p>
85<p class="toc_element">
86 <code><a href="#deleteContact">deleteContact(resourceName, x__xgafv=None)</a></code></p>
87<p class="firstline">Delete a contact person. Any non-contact data will not be deleted.</p>
88<p class="toc_element">
89 <code><a href="#get">get(resourceName, x__xgafv=None, requestMask_includeField=None, personFields=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]90<p class="firstline">Provides information about a person by specifying a resource name. Use</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92 <code><a href="#getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None, personFields=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]93<p class="firstline">Provides information about a list of specific people by specifying a list</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="toc_element">
95 <code><a href="#updateContact">updateContact(resourceName, body, updatePersonFields=None, x__xgafv=None)</a></code></p>
96<p class="firstline">Update contact data for an existing contact person. Any non-contact data</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]97<h3>Method Details</h3>
98<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99 <code class="details" id="createContact">createContact(body, parent=None, x__xgafv=None)</code>
100 <pre>Create a new contact and return the person resource for that contact.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101
102Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103 body: object, The request body. (required)
104 The object takes the form of:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]105
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106{ # Information about a person merged from various data sources such as the
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]107 # authenticated user's contacts and profile data.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109 # Most fields can have multiple items. The items in a field have no guaranteed
110 # order, but each non-empty field is guaranteed to have exactly one field with
111 # `metadata.primary` set to true.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 "sipAddresses": [ # The person's SIP addresses.
113 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
114 # communications to make voice or video calls over the internet.
115 "formattedType": "A String", # The read-only type of the SIP address translated and formatted in the
116 # viewer's account locale or the `Accept-Language` HTTP header locale.
117 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
118 # predefined values:
119 #
120 # * `home`
121 # * `work`
122 # * `mobile`
123 # * `other`
124 "value": "A String", # The SIP address in the
125 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
126 # format.
127 "metadata": { # Metadata about a field. # Metadata about the SIP address.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]128 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
130 #
131 # Last update timestamp of this source.
132 "etag": "A String", # **Only populated in `person.metadata.sources`.**
133 #
134 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
135 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]136 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]137 "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]138 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
139 #
140 # Metadata about a source of type PROFILE.
141 "userTypes": [ # The user types.
142 "A String",
143 ],
144 "objectType": "A String", # The profile object type.
145 },
146 },
147 "verified": True or False, # True if the field is verified; false if the field is unverified. A
148 # verified field is typically a name, email address, phone number, or
149 # website that has been confirmed to be owned by the person.
150 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
151 # field.
152 },
153 },
154 ],
155 "phoneNumbers": [ # The person's phone numbers.
156 { # A person's phone number.
157 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
158 # viewer's account locale or the `Accept-Language` HTTP header locale.
159 "canonicalForm": "A String", # The read-only canonicalized [ITU-T
160 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
161 # form of the phone number.
162 "type": "A String", # The type of the phone number. The type can be custom or one of these
163 # predefined values:
164 #
165 # * `home`
166 # * `work`
167 # * `mobile`
168 # * `homeFax`
169 # * `workFax`
170 # * `otherFax`
171 # * `pager`
172 # * `workMobile`
173 # * `workPager`
174 # * `main`
175 # * `googleVoice`
176 # * `other`
177 "value": "A String", # The phone number.
178 "metadata": { # Metadata about a field. # Metadata about the phone number.
179 "source": { # The source of a field. # The source of the field.
180 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
181 #
182 # Last update timestamp of this source.
183 "etag": "A String", # **Only populated in `person.metadata.sources`.**
184 #
185 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
186 # source. Used for web cache validation.
187 "type": "A String", # The source type.
188 "id": "A String", # The unique identifier within the source type generated by the server.
189 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
190 #
191 # Metadata about a source of type PROFILE.
192 "userTypes": [ # The user types.
193 "A String",
194 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]195 "objectType": "A String", # The profile object type.
196 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]198 "verified": True or False, # True if the field is verified; false if the field is unverified. A
199 # verified field is typically a name, email address, phone number, or
200 # website that has been confirmed to be owned by the person.
201 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
202 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]203 },
204 },
205 ],
206 "addresses": [ # The person's street addresses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]207 { # A person's physical address. May be a P.O. box or street address. All fields
208 # are optional.
209 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
210 # account locale or the `Accept-Language` HTTP header locale.
211 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
212 # code of the address.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]213 "city": "A String", # The city of the address.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]214 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
215 # will be automatically constructed from structured values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]216 "region": "A String", # The region of the address; for example, the state or province.
217 "poBox": "A String", # The P.O. box of the address.
218 "streetAddress": "A String", # The street address.
219 "country": "A String", # The country of the address.
220 "postalCode": "A String", # The postal code of the address.
221 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 "type": "A String", # The type of the address. The type can be custom or one of these predefined
223 # values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]224 #
225 # * `home`
226 # * `work`
227 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]228 "metadata": { # Metadata about a field. # Metadata about the address.
229 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
231 #
232 # Last update timestamp of this source.
233 "etag": "A String", # **Only populated in `person.metadata.sources`.**
234 #
235 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
236 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]237 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]238 "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]239 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
240 #
241 # Metadata about a source of type PROFILE.
242 "userTypes": [ # The user types.
243 "A String",
244 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]245 "objectType": "A String", # The profile object type.
246 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]247 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]248 "verified": True or False, # True if the field is verified; false if the field is unverified. A
249 # verified field is typically a name, email address, phone number, or
250 # website that has been confirmed to be owned by the person.
251 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
252 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]253 },
254 },
255 ],
256 "nicknames": [ # The person's nicknames.
257 { # A person's nickname.
258 "type": "A String", # The type of the nickname.
259 "value": "A String", # The nickname.
260 "metadata": { # Metadata about a field. # Metadata about the nickname.
261 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 "updateTime": "A String", # **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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]269 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]270 "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]271 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
272 #
273 # Metadata about a source of type PROFILE.
274 "userTypes": [ # The user types.
275 "A String",
276 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]277 "objectType": "A String", # The profile object type.
278 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]279 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]280 "verified": True or False, # 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]285 },
286 },
287 ],
288 "occupations": [ # The person's occupations.
289 { # A person's occupation.
290 "value": "A String", # The occupation; for example, `carpenter`.
291 "metadata": { # Metadata about a field. # Metadata about the occupation.
292 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
294 #
295 # Last update timestamp of this source.
296 "etag": "A String", # **Only populated in `person.metadata.sources`.**
297 #
298 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
299 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]300 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]301 "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]302 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
303 #
304 # Metadata about a source of type PROFILE.
305 "userTypes": [ # The user types.
306 "A String",
307 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]308 "objectType": "A String", # The profile object type.
309 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]310 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]311 "verified": True or False, # True if the field is verified; false if the field is unverified. A
312 # verified field is typically a name, email address, phone number, or
313 # website that has been confirmed to be owned by the person.
314 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
315 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]316 },
317 },
318 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]319 "braggingRights": [ # The person's bragging rights.
320 { # A person's bragging rights.
321 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
322 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]323 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]324 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
325 #
326 # Last update timestamp of this source.
327 "etag": "A String", # **Only populated in `person.metadata.sources`.**
328 #
329 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
330 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]331 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]332 "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]333 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
334 #
335 # Metadata about a source of type PROFILE.
336 "userTypes": [ # The user types.
337 "A String",
338 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]339 "objectType": "A String", # The profile object type.
340 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]341 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]342 "verified": True or False, # True if the field is verified; false if the field is unverified. A
343 # verified field is typically a name, email address, phone number, or
344 # website that has been confirmed to be owned by the person.
345 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
346 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]347 },
348 },
349 ],
350 "names": [ # The person's names.
351 { # A person's name. If the name is a mononym, the family name is empty.
352 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
353 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
354 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]355 "displayName": "A String", # The read-only display name formatted according to the locale specified by
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]356 # the viewer's account or the `Accept-Language` HTTP header.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]357 "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
358 # the locale specified by the viewer's account or the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 # `Accept-Language` HTTP header.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]360 "middleName": "A String", # The middle name(s).
361 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
362 "familyName": "A String", # The family name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]363 "phoneticFullName": "A String", # The full name spelled as it sounds.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]364 "phoneticGivenName": "A String", # The given name spelled as it sounds.
365 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
366 "givenName": "A String", # The given name.
367 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
368 "metadata": { # Metadata about a field. # Metadata about the name.
369 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
371 #
372 # Last update timestamp of this source.
373 "etag": "A String", # **Only populated in `person.metadata.sources`.**
374 #
375 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
376 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]377 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]378 "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]379 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
380 #
381 # Metadata about a source of type PROFILE.
382 "userTypes": [ # The user types.
383 "A String",
384 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]385 "objectType": "A String", # The profile object type.
386 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]387 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]388 "verified": True or False, # True if the field is verified; false if the field is unverified. A
389 # verified field is typically a name, email address, phone number, or
390 # website that has been confirmed to be owned by the person.
391 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
392 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]393 },
394 },
395 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]396 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]397 # with a max length of 27 characters, in the form of
398 # `people/`<var>person_id</var>.
399 "taglines": [ # The person's read-only taglines.
400 { # A read-only brief one-line description of the person.
401 "value": "A String", # The tagline.
402 "metadata": { # Metadata about a field. # Metadata about the tagline.
403 "source": { # The source of a field. # The source of the field.
404 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
405 #
406 # Last update timestamp of this source.
407 "etag": "A String", # **Only populated in `person.metadata.sources`.**
408 #
409 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
410 # source. Used for web cache validation.
411 "type": "A String", # The source type.
412 "id": "A String", # The unique identifier within the source type generated by the server.
413 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
414 #
415 # Metadata about a source of type PROFILE.
416 "userTypes": [ # The user types.
417 "A String",
418 ],
419 "objectType": "A String", # The profile object type.
420 },
421 },
422 "verified": True or False, # True if the field is verified; false if the field is unverified. A
423 # verified field is typically a name, email address, phone number, or
424 # website that has been confirmed to be owned by the person.
425 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
426 # field.
427 },
428 },
429 ],
430 "ageRanges": [ # The person's read-only age ranges.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]431 { # A person's age range.
432 "ageRange": "A String", # The age range.
433 "metadata": { # Metadata about a field. # Metadata about the age range.
434 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]435 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
436 #
437 # Last update timestamp of this source.
438 "etag": "A String", # **Only populated in `person.metadata.sources`.**
439 #
440 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
441 # source. Used for web cache validation.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]442 "type": "A String", # The source type.
443 "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]444 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
445 #
446 # Metadata about a source of type PROFILE.
447 "userTypes": [ # The user types.
448 "A String",
449 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]450 "objectType": "A String", # The profile object type.
451 },
452 },
453 "verified": True or False, # True if the field is verified; false if the field is unverified. A
454 # verified field is typically a name, email address, phone number, or
455 # website that has been confirmed to be owned by the person.
456 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
457 # field.
458 },
459 },
460 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]461 "birthdays": [ # The person's birthdays.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]462 { # A person's birthday. At least one of the `date` and `text` fields are
463 # specified. The `date` and `text` fields typically represent the same
464 # date, but are not guaranteed to.
465 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
466 # of day and time zone are either specified elsewhere or are not
467 # significant. The date is relative to the
468 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
469 # The day may be 0 to represent a year and month where the day is not
470 # significant. The year may be 0 to represent a month and day independent
471 # of year; for example, anniversary date.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]472 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
473 # month and day.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]474 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]475 # if specifying a year by itself or a year and month where the day is not
476 # significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]477 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
478 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]479 },
480 "text": "A String", # A free-form string representing the user's birthday.
481 "metadata": { # Metadata about a field. # Metadata about the birthday.
482 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]490 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]491 "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]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 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]498 "objectType": "A String", # The profile object type.
499 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]500 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]506 },
507 },
508 ],
509 "relations": [ # The person's relations.
510 { # A person's relation to another person.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]511 "person": "A String", # The name of the other person this relation refers to.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]512 "metadata": { # Metadata about a field. # Metadata about the relation.
513 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]514 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
515 #
516 # Last update timestamp of this source.
517 "etag": "A String", # **Only populated in `person.metadata.sources`.**
518 #
519 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
520 # source. Used for web cache validation.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]521 "type": "A String", # The source type.
522 "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]523 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
524 #
525 # Metadata about a source of type PROFILE.
526 "userTypes": [ # The user types.
527 "A String",
528 ],
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]529 "objectType": "A String", # The profile object type.
530 },
531 },
532 "verified": True or False, # True if the field is verified; false if the field is unverified. A
533 # verified field is typically a name, email address, phone number, or
534 # website that has been confirmed to be owned by the person.
535 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
536 # field.
537 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]538 "type": "A String", # The person's relation to the other person. The type can be custom or one of
539 # these predefined values:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]540 #
541 # * `spouse`
542 # * `child`
543 # * `mother`
544 # * `father`
545 # * `parent`
546 # * `brother`
547 # * `sister`
548 # * `friend`
549 # * `relative`
550 # * `domesticPartner`
551 # * `manager`
552 # * `assistant`
553 # * `referredBy`
554 # * `partner`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]555 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
556 # locale or the locale specified in the Accept-Language HTTP header.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]557 },
558 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]559 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
560 # resource. Used for web cache validation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]561 "relationshipStatuses": [ # The person's read-only relationship statuses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]562 { # A person's read-only relationship status.
563 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
564 # the viewer's account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]565 "value": "A String", # The relationship status. The value can be custom or one of these
566 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]567 #
568 # * `single`
569 # * `inARelationship`
570 # * `engaged`
571 # * `married`
572 # * `itsComplicated`
573 # * `openRelationship`
574 # * `widowed`
575 # * `inDomesticPartnership`
576 # * `inCivilUnion`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]577 "metadata": { # Metadata about a field. # Metadata about the relationship status.
578 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]579 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
580 #
581 # Last update timestamp of this source.
582 "etag": "A String", # **Only populated in `person.metadata.sources`.**
583 #
584 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
585 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]586 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]587 "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]588 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
589 #
590 # Metadata about a source of type PROFILE.
591 "userTypes": [ # The user types.
592 "A String",
593 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]594 "objectType": "A String", # The profile object type.
595 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]596 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]597 "verified": True or False, # True if the field is verified; false if the field is unverified. A
598 # verified field is typically a name, email address, phone number, or
599 # website that has been confirmed to be owned by the person.
600 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
601 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]602 },
603 },
604 ],
605 "imClients": [ # The person's instant messaging clients.
606 { # A person's instant messaging client.
607 "username": "A String", # The user name used in the IM client.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]608 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
609 # viewer's account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]610 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
611 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]612 #
613 # * `aim`
614 # * `msn`
615 # * `yahoo`
616 # * `skype`
617 # * `qq`
618 # * `googleTalk`
619 # * `icq`
620 # * `jabber`
621 # * `netMeeting`
622 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
623 # locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]624 "type": "A String", # The type of the IM client. The type can be custom or one of these
625 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]626 #
627 # * `home`
628 # * `work`
629 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]630 "metadata": { # Metadata about a field. # Metadata about the IM client.
631 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]632 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
633 #
634 # Last update timestamp of this source.
635 "etag": "A String", # **Only populated in `person.metadata.sources`.**
636 #
637 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
638 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]639 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]640 "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]641 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
642 #
643 # Metadata about a source of type PROFILE.
644 "userTypes": [ # The user types.
645 "A String",
646 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]647 "objectType": "A String", # The profile object type.
648 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]649 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]650 "verified": True or False, # True if the field is verified; false if the field is unverified. A
651 # verified field is typically a name, email address, phone number, or
652 # website that has been confirmed to be owned by the person.
653 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
654 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]655 },
656 },
657 ],
658 "events": [ # The person's events.
659 { # An event related to the person.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]660 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
661 # of day and time zone are either specified elsewhere or are not
662 # significant. The date is relative to the
663 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
664 # The day may be 0 to represent a year and month where the day is not
665 # significant. The year may be 0 to represent a month and day independent
666 # of year; for example, anniversary date.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]667 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
668 # month and day.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]669 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]670 # if specifying a year by itself or a year and month where the day is not
671 # significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]672 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
673 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]674 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]675 "formattedType": "A String", # The read-only type of the event translated and formatted in the
676 # viewer's account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]677 "type": "A String", # The type of the event. The type can be custom or one of these predefined
678 # values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]679 #
680 # * `anniversary`
681 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]682 "metadata": { # Metadata about a field. # Metadata about the event.
683 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]684 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
685 #
686 # Last update timestamp of this source.
687 "etag": "A String", # **Only populated in `person.metadata.sources`.**
688 #
689 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
690 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]691 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]692 "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]693 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
694 #
695 # Metadata about a source of type PROFILE.
696 "userTypes": [ # The user types.
697 "A String",
698 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]699 "objectType": "A String", # The profile object type.
700 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]701 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]702 "verified": True or False, # True if the field is verified; false if the field is unverified. A
703 # verified field is typically a name, email address, phone number, or
704 # website that has been confirmed to be owned by the person.
705 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
706 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]707 },
708 },
709 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]710 "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]711 "previousResourceNames": [ # Any former resource names this person has had. Populated only for
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]712 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
713 # that include a sync token.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]714 #
715 # The resource name may change when adding or removing fields that link a
716 # contact and profile such as a verified email, verified phone number, or
717 # profile URL.
718 "A String",
719 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]720 "sources": [ # The sources of data for the person.
721 { # The source of a field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]722 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
723 #
724 # Last update timestamp of this source.
725 "etag": "A String", # **Only populated in `person.metadata.sources`.**
726 #
727 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
728 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]729 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]730 "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]731 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
732 #
733 # Metadata about a source of type PROFILE.
734 "userTypes": [ # The user types.
735 "A String",
736 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]737 "objectType": "A String", # The profile object type.
738 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]739 },
740 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]741 "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
742 "A String",
743 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]744 "deleted": True or False, # True if the person resource has been deleted. Populated only for
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]745 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
746 # that include a sync token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]747 "objectType": "A String", # **DEPRECATED** (Please use
748 # `person.metadata.sources.profileMetadata.objectType` instead)
749 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]750 # The type of the person object.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]751 },
752 "interests": [ # The person's interests.
753 { # One of the person's interests.
754 "value": "A String", # The interest; for example, `stargazing`.
755 "metadata": { # Metadata about a field. # Metadata about the interest.
756 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]757 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
758 #
759 # Last update timestamp of this source.
760 "etag": "A String", # **Only populated in `person.metadata.sources`.**
761 #
762 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
763 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]764 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]765 "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]766 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
767 #
768 # Metadata about a source of type PROFILE.
769 "userTypes": [ # The user types.
770 "A String",
771 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]772 "objectType": "A String", # The profile object type.
773 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]774 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]775 "verified": True or False, # True if the field is verified; false if the field is unverified. A
776 # verified field is typically a name, email address, phone number, or
777 # website that has been confirmed to be owned by the person.
778 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
779 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]780 },
781 },
782 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]783 "photos": [ # The person's read-only photos.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]784 { # A person's read-only photo. A picture shown next to the person's name to
785 # help others recognize the person.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]786 "default": True or False, # True if the photo is a default photo;
787 # false if the photo is a user-provided photo.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]788 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]789 # parameter `sz=`<var>size</var> at the end of the url. Example:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]790 # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]791 "metadata": { # Metadata about a field. # Metadata about the photo.
792 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]793 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
794 #
795 # Last update timestamp of this source.
796 "etag": "A String", # **Only populated in `person.metadata.sources`.**
797 #
798 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
799 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]800 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]801 "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]802 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
803 #
804 # Metadata about a source of type PROFILE.
805 "userTypes": [ # The user types.
806 "A String",
807 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]808 "objectType": "A String", # The profile object type.
809 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]810 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]811 "verified": True or False, # True if the field is verified; false if the field is unverified. A
812 # verified field is typically a name, email address, phone number, or
813 # website that has been confirmed to be owned by the person.
814 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
815 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]816 },
817 },
818 ],
819 "residences": [ # The person's residences.
820 { # A person's past or current residence.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]821 "current": True or False, # True if the residence is the person's current residence;
822 # false if the residence is a past residence.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]823 "value": "A String", # The address of the residence.
824 "metadata": { # Metadata about a field. # Metadata about the residence.
825 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]826 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
827 #
828 # Last update timestamp of this source.
829 "etag": "A String", # **Only populated in `person.metadata.sources`.**
830 #
831 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
832 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]833 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]834 "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]835 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
836 #
837 # Metadata about a source of type PROFILE.
838 "userTypes": [ # The user types.
839 "A String",
840 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]841 "objectType": "A String", # The profile object type.
842 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]843 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]844 "verified": True or False, # True if the field is verified; false if the field is unverified. A
845 # verified field is typically a name, email address, phone number, or
846 # website that has been confirmed to be owned by the person.
847 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
848 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]849 },
850 },
851 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]852 "relationshipInterests": [ # The person's read-only relationship interests.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]853 { # A person's read-only relationship interest .
854 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
855 # viewer's account locale or the locale specified in the Accept-Language
856 # HTTP header.
857 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]858 # or one of these predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]859 #
860 # * `friend`
861 # * `date`
862 # * `relationship`
863 # * `networking`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]864 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
865 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]866 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
867 #
868 # Last update timestamp of this source.
869 "etag": "A String", # **Only populated in `person.metadata.sources`.**
870 #
871 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
872 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]873 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]874 "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]875 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
876 #
877 # Metadata about a source of type PROFILE.
878 "userTypes": [ # The user types.
879 "A String",
880 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]881 "objectType": "A String", # The profile object type.
882 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]883 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]884 "verified": True or False, # True if the field is verified; false if the field is unverified. A
885 # verified field is typically a name, email address, phone number, or
886 # website that has been confirmed to be owned by the person.
887 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
888 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]889 },
890 },
891 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]892 "coverPhotos": [ # The person's read-only cover photos.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]893 { # A person's read-only cover photo. A large image shown on the person's
894 # profile page that represents who they are or what they care about.
895 "default": True or False, # True if the cover photo is the default cover photo;
896 # false if the cover photo is a user-provided cover photo.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]897 "url": "A String", # The URL of the cover photo.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]898 "metadata": { # Metadata about a field. # Metadata about the cover photo.
899 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]900 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
901 #
902 # Last update timestamp of this source.
903 "etag": "A String", # **Only populated in `person.metadata.sources`.**
904 #
905 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
906 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]907 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]908 "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]909 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
910 #
911 # Metadata about a source of type PROFILE.
912 "userTypes": [ # The user types.
913 "A String",
914 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]915 "objectType": "A String", # The profile object type.
916 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]917 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]918 "verified": True or False, # True if the field is verified; false if the field is unverified. A
919 # verified field is typically a name, email address, phone number, or
920 # website that has been confirmed to be owned by the person.
921 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
922 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]923 },
924 },
925 ],
926 "locales": [ # The person's locale preferences.
927 { # A person's locale preference.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]928 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
929 # language tag representing the locale.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]930 "metadata": { # Metadata about a field. # Metadata about the locale.
931 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]932 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
933 #
934 # Last update timestamp of this source.
935 "etag": "A String", # **Only populated in `person.metadata.sources`.**
936 #
937 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
938 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]939 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]940 "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]941 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
942 #
943 # Metadata about a source of type PROFILE.
944 "userTypes": [ # The user types.
945 "A String",
946 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]947 "objectType": "A String", # The profile object type.
948 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]949 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]950 "verified": True or False, # True if the field is verified; false if the field is unverified. A
951 # verified field is typically a name, email address, phone number, or
952 # website that has been confirmed to be owned by the person.
953 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
954 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]955 },
956 },
957 ],
958 "organizations": [ # The person's past or current organizations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]959 { # A person's past or current organization. Overlapping date ranges are
960 # permitted.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]961 "formattedType": "A String", # The read-only type of the organization translated and formatted in the
962 # viewer's account locale or the `Accept-Language` HTTP header locale.
963 "domain": "A String", # The domain name associated with the organization; for example,
964 # `google.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]965 "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
966 # of day and time zone are either specified elsewhere or are not
967 # significant. The date is relative to the
968 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
969 # The day may be 0 to represent a year and month where the day is not
970 # significant. The year may be 0 to represent a month and day independent
971 # of year; for example, anniversary date.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]972 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
973 # month and day.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]974 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]975 # if specifying a year by itself or a year and month where the day is not
976 # significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]977 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
978 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]979 },
980 "name": "A String", # The name of the organization.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]981 "title": "A String", # The person's job title at the organization.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]982 "type": "A String", # The type of the organization. The type can be custom or one of these
983 # predefined values:
984 #
985 # * `work`
986 # * `school`
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]987 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
988 # symbol, abbreviation, or acronym.
989 "current": True or False, # True if the organization is the person's current organization;
990 # false if the organization is a past organization.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]991 "jobDescription": "A String", # The person's job description at the organization.
992 "location": "A String", # The location of the organization office the person works at.
993 "department": "A String", # The person's department at the organization.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]994 "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
995 # of day and time zone are either specified elsewhere or are not
996 # significant. The date is relative to the
997 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
998 # The day may be 0 to represent a year and month where the day is not
999 # significant. The year may be 0 to represent a month and day independent
1000 # of year; for example, anniversary date.
1001 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1002 # month and day.
1003 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1004 # if specifying a year by itself or a year and month where the day is not
1005 # significant.
1006 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1007 # a year.
1008 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1009 "phoneticName": "A String", # The phonetic name of the organization.
1010 "metadata": { # Metadata about a field. # Metadata about the organization.
1011 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1012 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1013 #
1014 # Last update timestamp of this source.
1015 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1016 #
1017 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1018 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1019 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1020 "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]1021 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1022 #
1023 # Metadata about a source of type PROFILE.
1024 "userTypes": [ # The user types.
1025 "A String",
1026 ],
1027 "objectType": "A String", # The profile object type.
1028 },
1029 },
1030 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1031 # verified field is typically a name, email address, phone number, or
1032 # website that has been confirmed to be owned by the person.
1033 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1034 # field.
1035 },
1036 },
1037 ],
1038 "userDefined": [ # The person's user defined data.
1039 { # Arbitrary user data that is populated by the end users.
1040 "key": "A String", # The end user specified key of the user defined data.
1041 "value": "A String", # The end user specified value of the user defined data.
1042 "metadata": { # Metadata about a field. # Metadata about the user defined data.
1043 "source": { # The source of a field. # The source of the field.
1044 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1045 #
1046 # Last update timestamp of this source.
1047 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1048 #
1049 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1050 # source. Used for web cache validation.
1051 "type": "A String", # The source type.
1052 "id": "A String", # The unique identifier within the source type generated by the server.
1053 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1054 #
1055 # Metadata about a source of type PROFILE.
1056 "userTypes": [ # The user types.
1057 "A String",
1058 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1059 "objectType": "A String", # The profile object type.
1060 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1061 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1062 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1063 # verified field is typically a name, email address, phone number, or
1064 # website that has been confirmed to be owned by the person.
1065 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1066 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1067 },
1068 },
1069 ],
1070 "biographies": [ # The person's biographies.
1071 { # A person's short biography.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1072 "contentType": "A String", # The content type of the biography.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1073 "value": "A String", # The short biography.
1074 "metadata": { # Metadata about a field. # Metadata about the biography.
1075 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1076 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1077 #
1078 # Last update timestamp of this source.
1079 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1080 #
1081 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1082 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1083 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1084 "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]1085 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1086 #
1087 # Metadata about a source of type PROFILE.
1088 "userTypes": [ # The user types.
1089 "A String",
1090 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1091 "objectType": "A String", # The profile object type.
1092 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1093 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1094 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1095 # verified field is typically a name, email address, phone number, or
1096 # website that has been confirmed to be owned by the person.
1097 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1098 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1099 },
1100 },
1101 ],
1102 "memberships": [ # The person's group memberships.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1103 { # A person's membership in a group. Only contact group memberships can be
1104 # modified.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1105 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1106 "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
1107 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
1108 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
1109 # Only contact_group_resource_name can be used for modifying memberships.
1110 # Any contact group membership can be removed, but only user group or
1111 # "myContacts" or "starred" system groups memberships can be added. A
1112 # contact must always have at least one contact group membership.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1113 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1114 "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain membership.
1115 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1116 },
1117 "metadata": { # Metadata about a field. # Metadata about the membership.
1118 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1119 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1120 #
1121 # Last update timestamp of this source.
1122 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1123 #
1124 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1125 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1126 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1127 "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]1128 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1129 #
1130 # Metadata about a source of type PROFILE.
1131 "userTypes": [ # The user types.
1132 "A String",
1133 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1134 "objectType": "A String", # The profile object type.
1135 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1136 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1137 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1138 # verified field is typically a name, email address, phone number, or
1139 # website that has been confirmed to be owned by the person.
1140 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1141 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1142 },
1143 },
1144 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1145 "skills": [ # The person's skills.
1146 { # A skill that the person has.
1147 "value": "A String", # The skill; for example, `underwater basket weaving`.
1148 "metadata": { # Metadata about a field. # Metadata about the skill.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1149 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1150 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1151 #
1152 # Last update timestamp of this source.
1153 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1154 #
1155 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1156 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1157 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1158 "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]1159 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1160 #
1161 # Metadata about a source of type PROFILE.
1162 "userTypes": [ # The user types.
1163 "A String",
1164 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1165 "objectType": "A String", # The profile object type.
1166 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1167 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1168 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1169 # verified field is typically a name, email address, phone number, or
1170 # website that has been confirmed to be owned by the person.
1171 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1172 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1173 },
1174 },
1175 ],
1176 "urls": [ # The person's associated URLs.
1177 { # A person's associated URLs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1178 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
1179 # account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1180 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
1181 # values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1182 #
1183 # * `home`
1184 # * `work`
1185 # * `blog`
1186 # * `profile`
1187 # * `homePage`
1188 # * `ftp`
1189 # * `reservations`
1190 # * `appInstallPage`: website for a Google+ application.
1191 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1192 "value": "A String", # The URL.
1193 "metadata": { # Metadata about a field. # Metadata about the URL.
1194 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1195 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1196 #
1197 # Last update timestamp of this source.
1198 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1199 #
1200 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1201 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1202 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1203 "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]1204 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1205 #
1206 # Metadata about a source of type PROFILE.
1207 "userTypes": [ # The user types.
1208 "A String",
1209 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1210 "objectType": "A String", # The profile object type.
1211 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1212 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1213 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1214 # verified field is typically a name, email address, phone number, or
1215 # website that has been confirmed to be owned by the person.
1216 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1217 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1218 },
1219 },
1220 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1221 "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
1222 #
1223 # The person's read-only age range.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1224 "genders": [ # The person's genders.
1225 { # A person's gender.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1226 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
1227 # account locale or the `Accept-Language` HTTP header locale.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1228 "value": "A String", # The gender for the person. The gender can be custom or one of these
1229 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1230 #
1231 # * `male`
1232 # * `female`
1233 # * `other`
1234 # * `unknown`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1235 "metadata": { # Metadata about a field. # Metadata about the gender.
1236 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1237 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1238 #
1239 # Last update timestamp of this source.
1240 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1241 #
1242 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1243 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1244 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1245 "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]1246 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1247 #
1248 # Metadata about a source of type PROFILE.
1249 "userTypes": [ # The user types.
1250 "A String",
1251 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1252 "objectType": "A String", # The profile object type.
1253 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1254 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1255 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1256 # verified field is typically a name, email address, phone number, or
1257 # website that has been confirmed to be owned by the person.
1258 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1259 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1260 },
1261 },
1262 ],
1263 "emailAddresses": [ # The person's email addresses.
1264 { # A person's email address.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1265 "type": "A String", # The type of the email address. The type can be custom or one of these
1266 # predefined values:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1267 #
1268 # * `home`
1269 # * `work`
1270 # * `other`
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1271 "formattedType": "A String", # The read-only type of the email address translated and formatted in the
1272 # viewer's account locale or the `Accept-Language` HTTP header locale.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1273 "displayName": "A String", # The display name of the email.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1274 "value": "A String", # The email address.
1275 "metadata": { # Metadata about a field. # Metadata about the email address.
1276 "source": { # The source of a field. # The source of the field.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1277 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1278 #
1279 # Last update timestamp of this source.
1280 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1281 #
1282 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1283 # source. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1284 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1285 "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]1286 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1287 #
1288 # Metadata about a source of type PROFILE.
1289 "userTypes": [ # The user types.
1290 "A String",
1291 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1292 "objectType": "A String", # The profile object type.
1293 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1294 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1295 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1296 # verified field is typically a name, email address, phone number, or
1297 # website that has been confirmed to be owned by the person.
1298 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1299 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1300 },
1301 },
1302 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1303 }
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1304
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1305 parent: string, The resource name of the owning person resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1306 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1307 Allowed values
1308 1 - v1 error format
1309 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1310
1311Returns:
1312 An object of the form:
1313
1314 { # Information about a person merged from various data sources such as the
1315 # authenticated user's contacts and profile data.
1316 #
1317 # Most fields can have multiple items. The items in a field have no guaranteed
1318 # order, but each non-empty field is guaranteed to have exactly one field with
1319 # `metadata.primary` set to true.
1320 "sipAddresses": [ # The person's SIP addresses.
1321 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
1322 # communications to make voice or video calls over the internet.
1323 "formattedType": "A String", # The read-only type of the SIP address translated and formatted in the
1324 # viewer's account locale or the `Accept-Language` HTTP header locale.
1325 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
1326 # predefined values:
1327 #
1328 # * `home`
1329 # * `work`
1330 # * `mobile`
1331 # * `other`
1332 "value": "A String", # The SIP address in the
1333 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
1334 # format.
1335 "metadata": { # Metadata about a field. # Metadata about the SIP address.
1336 "source": { # The source of a field. # The source of the field.
1337 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1338 #
1339 # Last update timestamp of this source.
1340 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1341 #
1342 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1343 # source. Used for web cache validation.
1344 "type": "A String", # The source type.
1345 "id": "A String", # The unique identifier within the source type generated by the server.
1346 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1347 #
1348 # Metadata about a source of type PROFILE.
1349 "userTypes": [ # The user types.
1350 "A String",
1351 ],
1352 "objectType": "A String", # The profile object type.
1353 },
1354 },
1355 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1356 # verified field is typically a name, email address, phone number, or
1357 # website that has been confirmed to be owned by the person.
1358 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1359 # field.
1360 },
1361 },
1362 ],
1363 "phoneNumbers": [ # The person's phone numbers.
1364 { # A person's phone number.
1365 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
1366 # viewer's account locale or the `Accept-Language` HTTP header locale.
1367 "canonicalForm": "A String", # The read-only canonicalized [ITU-T
1368 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
1369 # form of the phone number.
1370 "type": "A String", # The type of the phone number. The type can be custom or one of these
1371 # predefined values:
1372 #
1373 # * `home`
1374 # * `work`
1375 # * `mobile`
1376 # * `homeFax`
1377 # * `workFax`
1378 # * `otherFax`
1379 # * `pager`
1380 # * `workMobile`
1381 # * `workPager`
1382 # * `main`
1383 # * `googleVoice`
1384 # * `other`
1385 "value": "A String", # The phone number.
1386 "metadata": { # Metadata about a field. # Metadata about the phone number.
1387 "source": { # The source of a field. # The source of the field.
1388 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1389 #
1390 # Last update timestamp of this source.
1391 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1392 #
1393 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1394 # source. Used for web cache validation.
1395 "type": "A String", # The source type.
1396 "id": "A String", # The unique identifier within the source type generated by the server.
1397 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1398 #
1399 # Metadata about a source of type PROFILE.
1400 "userTypes": [ # The user types.
1401 "A String",
1402 ],
1403 "objectType": "A String", # The profile object type.
1404 },
1405 },
1406 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1407 # verified field is typically a name, email address, phone number, or
1408 # website that has been confirmed to be owned by the person.
1409 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1410 # field.
1411 },
1412 },
1413 ],
1414 "addresses": [ # The person's street addresses.
1415 { # A person's physical address. May be a P.O. box or street address. All fields
1416 # are optional.
1417 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
1418 # account locale or the `Accept-Language` HTTP header locale.
1419 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
1420 # code of the address.
1421 "city": "A String", # The city of the address.
1422 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
1423 # will be automatically constructed from structured values.
1424 "region": "A String", # The region of the address; for example, the state or province.
1425 "poBox": "A String", # The P.O. box of the address.
1426 "streetAddress": "A String", # The street address.
1427 "country": "A String", # The country of the address.
1428 "postalCode": "A String", # The postal code of the address.
1429 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
1430 "type": "A String", # The type of the address. The type can be custom or one of these predefined
1431 # values:
1432 #
1433 # * `home`
1434 # * `work`
1435 # * `other`
1436 "metadata": { # Metadata about a field. # Metadata about the address.
1437 "source": { # The source of a field. # The source of the field.
1438 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1439 #
1440 # Last update timestamp of this source.
1441 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1442 #
1443 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1444 # source. Used for web cache validation.
1445 "type": "A String", # The source type.
1446 "id": "A String", # The unique identifier within the source type generated by the server.
1447 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1448 #
1449 # Metadata about a source of type PROFILE.
1450 "userTypes": [ # The user types.
1451 "A String",
1452 ],
1453 "objectType": "A String", # The profile object type.
1454 },
1455 },
1456 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1457 # verified field is typically a name, email address, phone number, or
1458 # website that has been confirmed to be owned by the person.
1459 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1460 # field.
1461 },
1462 },
1463 ],
1464 "nicknames": [ # The person's nicknames.
1465 { # A person's nickname.
1466 "type": "A String", # The type of the nickname.
1467 "value": "A String", # The nickname.
1468 "metadata": { # Metadata about a field. # Metadata about the nickname.
1469 "source": { # The source of a field. # The source of the field.
1470 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1471 #
1472 # Last update timestamp of this source.
1473 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1474 #
1475 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1476 # source. Used for web cache validation.
1477 "type": "A String", # The source type.
1478 "id": "A String", # The unique identifier within the source type generated by the server.
1479 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1480 #
1481 # Metadata about a source of type PROFILE.
1482 "userTypes": [ # The user types.
1483 "A String",
1484 ],
1485 "objectType": "A String", # The profile object type.
1486 },
1487 },
1488 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1489 # verified field is typically a name, email address, phone number, or
1490 # website that has been confirmed to be owned by the person.
1491 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1492 # field.
1493 },
1494 },
1495 ],
1496 "occupations": [ # The person's occupations.
1497 { # A person's occupation.
1498 "value": "A String", # The occupation; for example, `carpenter`.
1499 "metadata": { # Metadata about a field. # Metadata about the occupation.
1500 "source": { # The source of a field. # The source of the field.
1501 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1502 #
1503 # Last update timestamp of this source.
1504 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1505 #
1506 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1507 # source. Used for web cache validation.
1508 "type": "A String", # The source type.
1509 "id": "A String", # The unique identifier within the source type generated by the server.
1510 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1511 #
1512 # Metadata about a source of type PROFILE.
1513 "userTypes": [ # The user types.
1514 "A String",
1515 ],
1516 "objectType": "A String", # The profile object type.
1517 },
1518 },
1519 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1520 # verified field is typically a name, email address, phone number, or
1521 # website that has been confirmed to be owned by the person.
1522 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1523 # field.
1524 },
1525 },
1526 ],
1527 "braggingRights": [ # The person's bragging rights.
1528 { # A person's bragging rights.
1529 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
1530 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
1531 "source": { # The source of a field. # The source of the field.
1532 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1533 #
1534 # Last update timestamp of this source.
1535 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1536 #
1537 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1538 # source. Used for web cache validation.
1539 "type": "A String", # The source type.
1540 "id": "A String", # The unique identifier within the source type generated by the server.
1541 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1542 #
1543 # Metadata about a source of type PROFILE.
1544 "userTypes": [ # The user types.
1545 "A String",
1546 ],
1547 "objectType": "A String", # The profile object type.
1548 },
1549 },
1550 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1551 # verified field is typically a name, email address, phone number, or
1552 # website that has been confirmed to be owned by the person.
1553 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1554 # field.
1555 },
1556 },
1557 ],
1558 "names": [ # The person's names.
1559 { # A person's name. If the name is a mononym, the family name is empty.
1560 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
1561 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
1562 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
1563 "displayName": "A String", # The read-only display name formatted according to the locale specified by
1564 # the viewer's account or the `Accept-Language` HTTP header.
1565 "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
1566 # the locale specified by the viewer's account or the
1567 # `Accept-Language` HTTP header.
1568 "middleName": "A String", # The middle name(s).
1569 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
1570 "familyName": "A String", # The family name.
1571 "phoneticFullName": "A String", # The full name spelled as it sounds.
1572 "phoneticGivenName": "A String", # The given name spelled as it sounds.
1573 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
1574 "givenName": "A String", # The given name.
1575 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
1576 "metadata": { # Metadata about a field. # Metadata about the name.
1577 "source": { # The source of a field. # The source of the field.
1578 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1579 #
1580 # Last update timestamp of this source.
1581 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1582 #
1583 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1584 # source. Used for web cache validation.
1585 "type": "A String", # The source type.
1586 "id": "A String", # The unique identifier within the source type generated by the server.
1587 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1588 #
1589 # Metadata about a source of type PROFILE.
1590 "userTypes": [ # The user types.
1591 "A String",
1592 ],
1593 "objectType": "A String", # The profile object type.
1594 },
1595 },
1596 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1597 # verified field is typically a name, email address, phone number, or
1598 # website that has been confirmed to be owned by the person.
1599 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1600 # field.
1601 },
1602 },
1603 ],
1604 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
1605 # with a max length of 27 characters, in the form of
1606 # `people/`<var>person_id</var>.
1607 "taglines": [ # The person's read-only taglines.
1608 { # A read-only brief one-line description of the person.
1609 "value": "A String", # The tagline.
1610 "metadata": { # Metadata about a field. # Metadata about the tagline.
1611 "source": { # The source of a field. # The source of the field.
1612 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1613 #
1614 # Last update timestamp of this source.
1615 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1616 #
1617 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1618 # source. Used for web cache validation.
1619 "type": "A String", # The source type.
1620 "id": "A String", # The unique identifier within the source type generated by the server.
1621 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1622 #
1623 # Metadata about a source of type PROFILE.
1624 "userTypes": [ # The user types.
1625 "A String",
1626 ],
1627 "objectType": "A String", # The profile object type.
1628 },
1629 },
1630 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1631 # verified field is typically a name, email address, phone number, or
1632 # website that has been confirmed to be owned by the person.
1633 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1634 # field.
1635 },
1636 },
1637 ],
1638 "ageRanges": [ # The person's read-only age ranges.
1639 { # A person's age range.
1640 "ageRange": "A String", # The age range.
1641 "metadata": { # Metadata about a field. # Metadata about the age range.
1642 "source": { # The source of a field. # The source of the field.
1643 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1644 #
1645 # Last update timestamp of this source.
1646 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1647 #
1648 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1649 # source. Used for web cache validation.
1650 "type": "A String", # The source type.
1651 "id": "A String", # The unique identifier within the source type generated by the server.
1652 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1653 #
1654 # Metadata about a source of type PROFILE.
1655 "userTypes": [ # The user types.
1656 "A String",
1657 ],
1658 "objectType": "A String", # The profile object type.
1659 },
1660 },
1661 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1662 # verified field is typically a name, email address, phone number, or
1663 # website that has been confirmed to be owned by the person.
1664 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1665 # field.
1666 },
1667 },
1668 ],
1669 "birthdays": [ # The person's birthdays.
1670 { # A person's birthday. At least one of the `date` and `text` fields are
1671 # specified. The `date` and `text` fields typically represent the same
1672 # date, but are not guaranteed to.
1673 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
1674 # of day and time zone are either specified elsewhere or are not
1675 # significant. The date is relative to the
1676 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
1677 # The day may be 0 to represent a year and month where the day is not
1678 # significant. The year may be 0 to represent a month and day independent
1679 # of year; for example, anniversary date.
1680 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1681 # month and day.
1682 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1683 # if specifying a year by itself or a year and month where the day is not
1684 # significant.
1685 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1686 # a year.
1687 },
1688 "text": "A String", # A free-form string representing the user's birthday.
1689 "metadata": { # Metadata about a field. # Metadata about the birthday.
1690 "source": { # The source of a field. # The source of the field.
1691 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1692 #
1693 # Last update timestamp of this source.
1694 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1695 #
1696 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1697 # source. Used for web cache validation.
1698 "type": "A String", # The source type.
1699 "id": "A String", # The unique identifier within the source type generated by the server.
1700 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1701 #
1702 # Metadata about a source of type PROFILE.
1703 "userTypes": [ # The user types.
1704 "A String",
1705 ],
1706 "objectType": "A String", # The profile object type.
1707 },
1708 },
1709 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1710 # verified field is typically a name, email address, phone number, or
1711 # website that has been confirmed to be owned by the person.
1712 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1713 # field.
1714 },
1715 },
1716 ],
1717 "relations": [ # The person's relations.
1718 { # A person's relation to another person.
1719 "person": "A String", # The name of the other person this relation refers to.
1720 "metadata": { # Metadata about a field. # Metadata about the relation.
1721 "source": { # The source of a field. # The source of the field.
1722 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1723 #
1724 # Last update timestamp of this source.
1725 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1726 #
1727 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1728 # source. Used for web cache validation.
1729 "type": "A String", # The source type.
1730 "id": "A String", # The unique identifier within the source type generated by the server.
1731 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1732 #
1733 # Metadata about a source of type PROFILE.
1734 "userTypes": [ # The user types.
1735 "A String",
1736 ],
1737 "objectType": "A String", # The profile object type.
1738 },
1739 },
1740 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1741 # verified field is typically a name, email address, phone number, or
1742 # website that has been confirmed to be owned by the person.
1743 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1744 # field.
1745 },
1746 "type": "A String", # The person's relation to the other person. The type can be custom or one of
1747 # these predefined values:
1748 #
1749 # * `spouse`
1750 # * `child`
1751 # * `mother`
1752 # * `father`
1753 # * `parent`
1754 # * `brother`
1755 # * `sister`
1756 # * `friend`
1757 # * `relative`
1758 # * `domesticPartner`
1759 # * `manager`
1760 # * `assistant`
1761 # * `referredBy`
1762 # * `partner`
1763 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
1764 # locale or the locale specified in the Accept-Language HTTP header.
1765 },
1766 ],
1767 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1768 # resource. Used for web cache validation.
1769 "relationshipStatuses": [ # The person's read-only relationship statuses.
1770 { # A person's read-only relationship status.
1771 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
1772 # the viewer's account locale or the `Accept-Language` HTTP header locale.
1773 "value": "A String", # The relationship status. The value can be custom or one of these
1774 # predefined values:
1775 #
1776 # * `single`
1777 # * `inARelationship`
1778 # * `engaged`
1779 # * `married`
1780 # * `itsComplicated`
1781 # * `openRelationship`
1782 # * `widowed`
1783 # * `inDomesticPartnership`
1784 # * `inCivilUnion`
1785 "metadata": { # Metadata about a field. # Metadata about the relationship status.
1786 "source": { # The source of a field. # The source of the field.
1787 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1788 #
1789 # Last update timestamp of this source.
1790 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1791 #
1792 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1793 # source. Used for web cache validation.
1794 "type": "A String", # The source type.
1795 "id": "A String", # The unique identifier within the source type generated by the server.
1796 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1797 #
1798 # Metadata about a source of type PROFILE.
1799 "userTypes": [ # The user types.
1800 "A String",
1801 ],
1802 "objectType": "A String", # The profile object type.
1803 },
1804 },
1805 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1806 # verified field is typically a name, email address, phone number, or
1807 # website that has been confirmed to be owned by the person.
1808 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1809 # field.
1810 },
1811 },
1812 ],
1813 "imClients": [ # The person's instant messaging clients.
1814 { # A person's instant messaging client.
1815 "username": "A String", # The user name used in the IM client.
1816 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
1817 # viewer's account locale or the `Accept-Language` HTTP header locale.
1818 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
1819 # predefined values:
1820 #
1821 # * `aim`
1822 # * `msn`
1823 # * `yahoo`
1824 # * `skype`
1825 # * `qq`
1826 # * `googleTalk`
1827 # * `icq`
1828 # * `jabber`
1829 # * `netMeeting`
1830 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
1831 # locale or the `Accept-Language` HTTP header locale.
1832 "type": "A String", # The type of the IM client. The type can be custom or one of these
1833 # predefined values:
1834 #
1835 # * `home`
1836 # * `work`
1837 # * `other`
1838 "metadata": { # Metadata about a field. # Metadata about the IM client.
1839 "source": { # The source of a field. # The source of the field.
1840 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1841 #
1842 # Last update timestamp of this source.
1843 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1844 #
1845 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1846 # source. Used for web cache validation.
1847 "type": "A String", # The source type.
1848 "id": "A String", # The unique identifier within the source type generated by the server.
1849 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1850 #
1851 # Metadata about a source of type PROFILE.
1852 "userTypes": [ # The user types.
1853 "A String",
1854 ],
1855 "objectType": "A String", # The profile object type.
1856 },
1857 },
1858 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1859 # verified field is typically a name, email address, phone number, or
1860 # website that has been confirmed to be owned by the person.
1861 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1862 # field.
1863 },
1864 },
1865 ],
1866 "events": [ # The person's events.
1867 { # An event related to the person.
1868 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
1869 # of day and time zone are either specified elsewhere or are not
1870 # significant. The date is relative to the
1871 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
1872 # The day may be 0 to represent a year and month where the day is not
1873 # significant. The year may be 0 to represent a month and day independent
1874 # of year; for example, anniversary date.
1875 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
1876 # month and day.
1877 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1878 # if specifying a year by itself or a year and month where the day is not
1879 # significant.
1880 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1881 # a year.
1882 },
1883 "formattedType": "A String", # The read-only type of the event translated and formatted in the
1884 # viewer's account locale or the `Accept-Language` HTTP header locale.
1885 "type": "A String", # The type of the event. The type can be custom or one of these predefined
1886 # values:
1887 #
1888 # * `anniversary`
1889 # * `other`
1890 "metadata": { # Metadata about a field. # Metadata about the event.
1891 "source": { # The source of a field. # The source of the field.
1892 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1893 #
1894 # Last update timestamp of this source.
1895 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1896 #
1897 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1898 # source. Used for web cache validation.
1899 "type": "A String", # The source type.
1900 "id": "A String", # The unique identifier within the source type generated by the server.
1901 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1902 #
1903 # Metadata about a source of type PROFILE.
1904 "userTypes": [ # The user types.
1905 "A String",
1906 ],
1907 "objectType": "A String", # The profile object type.
1908 },
1909 },
1910 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1911 # verified field is typically a name, email address, phone number, or
1912 # website that has been confirmed to be owned by the person.
1913 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1914 # field.
1915 },
1916 },
1917 ],
1918 "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
1919 "previousResourceNames": [ # Any former resource names this person has had. Populated only for
1920 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
1921 # that include a sync token.
1922 #
1923 # The resource name may change when adding or removing fields that link a
1924 # contact and profile such as a verified email, verified phone number, or
1925 # profile URL.
1926 "A String",
1927 ],
1928 "sources": [ # The sources of data for the person.
1929 { # The source of a field.
1930 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1931 #
1932 # Last update timestamp of this source.
1933 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1934 #
1935 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1936 # source. Used for web cache validation.
1937 "type": "A String", # The source type.
1938 "id": "A String", # The unique identifier within the source type generated by the server.
1939 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1940 #
1941 # Metadata about a source of type PROFILE.
1942 "userTypes": [ # The user types.
1943 "A String",
1944 ],
1945 "objectType": "A String", # The profile object type.
1946 },
1947 },
1948 ],
1949 "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
1950 "A String",
1951 ],
1952 "deleted": True or False, # True if the person resource has been deleted. Populated only for
1953 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
1954 # that include a sync token.
1955 "objectType": "A String", # **DEPRECATED** (Please use
1956 # `person.metadata.sources.profileMetadata.objectType` instead)
1957 #
1958 # The type of the person object.
1959 },
1960 "interests": [ # The person's interests.
1961 { # One of the person's interests.
1962 "value": "A String", # The interest; for example, `stargazing`.
1963 "metadata": { # Metadata about a field. # Metadata about the interest.
1964 "source": { # The source of a field. # The source of the field.
1965 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
1966 #
1967 # Last update timestamp of this source.
1968 "etag": "A String", # **Only populated in `person.metadata.sources`.**
1969 #
1970 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1971 # source. Used for web cache validation.
1972 "type": "A String", # The source type.
1973 "id": "A String", # The unique identifier within the source type generated by the server.
1974 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
1975 #
1976 # Metadata about a source of type PROFILE.
1977 "userTypes": [ # The user types.
1978 "A String",
1979 ],
1980 "objectType": "A String", # The profile object type.
1981 },
1982 },
1983 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1984 # verified field is typically a name, email address, phone number, or
1985 # website that has been confirmed to be owned by the person.
1986 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1987 # field.
1988 },
1989 },
1990 ],
1991 "photos": [ # The person's read-only photos.
1992 { # A person's read-only photo. A picture shown next to the person's name to
1993 # help others recognize the person.
1994 "default": True or False, # True if the photo is a default photo;
1995 # false if the photo is a user-provided photo.
1996 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
1997 # parameter `sz=`<var>size</var> at the end of the url. Example:
1998 # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
1999 "metadata": { # Metadata about a field. # Metadata about the photo.
2000 "source": { # The source of a field. # The source of the field.
2001 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2002 #
2003 # Last update timestamp of this source.
2004 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2005 #
2006 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2007 # source. Used for web cache validation.
2008 "type": "A String", # The source type.
2009 "id": "A String", # The unique identifier within the source type generated by the server.
2010 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2011 #
2012 # Metadata about a source of type PROFILE.
2013 "userTypes": [ # The user types.
2014 "A String",
2015 ],
2016 "objectType": "A String", # The profile object type.
2017 },
2018 },
2019 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2020 # verified field is typically a name, email address, phone number, or
2021 # website that has been confirmed to be owned by the person.
2022 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2023 # field.
2024 },
2025 },
2026 ],
2027 "residences": [ # The person's residences.
2028 { # A person's past or current residence.
2029 "current": True or False, # True if the residence is the person's current residence;
2030 # false if the residence is a past residence.
2031 "value": "A String", # The address of the residence.
2032 "metadata": { # Metadata about a field. # Metadata about the residence.
2033 "source": { # The source of a field. # The source of the field.
2034 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2035 #
2036 # Last update timestamp of this source.
2037 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2038 #
2039 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2040 # source. Used for web cache validation.
2041 "type": "A String", # The source type.
2042 "id": "A String", # The unique identifier within the source type generated by the server.
2043 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2044 #
2045 # Metadata about a source of type PROFILE.
2046 "userTypes": [ # The user types.
2047 "A String",
2048 ],
2049 "objectType": "A String", # The profile object type.
2050 },
2051 },
2052 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2053 # verified field is typically a name, email address, phone number, or
2054 # website that has been confirmed to be owned by the person.
2055 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2056 # field.
2057 },
2058 },
2059 ],
2060 "relationshipInterests": [ # The person's read-only relationship interests.
2061 { # A person's read-only relationship interest .
2062 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
2063 # viewer's account locale or the locale specified in the Accept-Language
2064 # HTTP header.
2065 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
2066 # or one of these predefined values:
2067 #
2068 # * `friend`
2069 # * `date`
2070 # * `relationship`
2071 # * `networking`
2072 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
2073 "source": { # The source of a field. # The source of the field.
2074 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2075 #
2076 # Last update timestamp of this source.
2077 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2078 #
2079 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2080 # source. Used for web cache validation.
2081 "type": "A String", # The source type.
2082 "id": "A String", # The unique identifier within the source type generated by the server.
2083 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2084 #
2085 # Metadata about a source of type PROFILE.
2086 "userTypes": [ # The user types.
2087 "A String",
2088 ],
2089 "objectType": "A String", # The profile object type.
2090 },
2091 },
2092 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2093 # verified field is typically a name, email address, phone number, or
2094 # website that has been confirmed to be owned by the person.
2095 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2096 # field.
2097 },
2098 },
2099 ],
2100 "coverPhotos": [ # The person's read-only cover photos.
2101 { # A person's read-only cover photo. A large image shown on the person's
2102 # profile page that represents who they are or what they care about.
2103 "default": True or False, # True if the cover photo is the default cover photo;
2104 # false if the cover photo is a user-provided cover photo.
2105 "url": "A String", # The URL of the cover photo.
2106 "metadata": { # Metadata about a field. # Metadata about the cover photo.
2107 "source": { # The source of a field. # The source of the field.
2108 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2109 #
2110 # Last update timestamp of this source.
2111 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2112 #
2113 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2114 # source. Used for web cache validation.
2115 "type": "A String", # The source type.
2116 "id": "A String", # The unique identifier within the source type generated by the server.
2117 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2118 #
2119 # Metadata about a source of type PROFILE.
2120 "userTypes": [ # The user types.
2121 "A String",
2122 ],
2123 "objectType": "A String", # The profile object type.
2124 },
2125 },
2126 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2127 # verified field is typically a name, email address, phone number, or
2128 # website that has been confirmed to be owned by the person.
2129 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2130 # field.
2131 },
2132 },
2133 ],
2134 "locales": [ # The person's locale preferences.
2135 { # A person's locale preference.
2136 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
2137 # language tag representing the locale.
2138 "metadata": { # Metadata about a field. # Metadata about the locale.
2139 "source": { # The source of a field. # The source of the field.
2140 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2141 #
2142 # Last update timestamp of this source.
2143 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2144 #
2145 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2146 # source. Used for web cache validation.
2147 "type": "A String", # The source type.
2148 "id": "A String", # The unique identifier within the source type generated by the server.
2149 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2150 #
2151 # Metadata about a source of type PROFILE.
2152 "userTypes": [ # The user types.
2153 "A String",
2154 ],
2155 "objectType": "A String", # The profile object type.
2156 },
2157 },
2158 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2159 # verified field is typically a name, email address, phone number, or
2160 # website that has been confirmed to be owned by the person.
2161 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2162 # field.
2163 },
2164 },
2165 ],
2166 "organizations": [ # The person's past or current organizations.
2167 { # A person's past or current organization. Overlapping date ranges are
2168 # permitted.
2169 "formattedType": "A String", # The read-only type of the organization translated and formatted in the
2170 # viewer's account locale or the `Accept-Language` HTTP header locale.
2171 "domain": "A String", # The domain name associated with the organization; for example,
2172 # `google.com`.
2173 "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
2174 # of day and time zone are either specified elsewhere or are not
2175 # significant. The date is relative to the
2176 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
2177 # The day may be 0 to represent a year and month where the day is not
2178 # significant. The year may be 0 to represent a month and day independent
2179 # of year; for example, anniversary date.
2180 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
2181 # month and day.
2182 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
2183 # if specifying a year by itself or a year and month where the day is not
2184 # significant.
2185 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
2186 # a year.
2187 },
2188 "name": "A String", # The name of the organization.
2189 "title": "A String", # The person's job title at the organization.
2190 "type": "A String", # The type of the organization. The type can be custom or one of these
2191 # predefined values:
2192 #
2193 # * `work`
2194 # * `school`
2195 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
2196 # symbol, abbreviation, or acronym.
2197 "current": True or False, # True if the organization is the person's current organization;
2198 # false if the organization is a past organization.
2199 "jobDescription": "A String", # The person's job description at the organization.
2200 "location": "A String", # The location of the organization office the person works at.
2201 "department": "A String", # The person's department at the organization.
2202 "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
2203 # of day and time zone are either specified elsewhere or are not
2204 # significant. The date is relative to the
2205 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
2206 # The day may be 0 to represent a year and month where the day is not
2207 # significant. The year may be 0 to represent a month and day independent
2208 # of year; for example, anniversary date.
2209 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
2210 # month and day.
2211 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
2212 # if specifying a year by itself or a year and month where the day is not
2213 # significant.
2214 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
2215 # a year.
2216 },
2217 "phoneticName": "A String", # The phonetic name of the organization.
2218 "metadata": { # Metadata about a field. # Metadata about the organization.
2219 "source": { # The source of a field. # The source of the field.
2220 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2221 #
2222 # Last update timestamp of this source.
2223 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2224 #
2225 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2226 # source. Used for web cache validation.
2227 "type": "A String", # The source type.
2228 "id": "A String", # The unique identifier within the source type generated by the server.
2229 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2230 #
2231 # Metadata about a source of type PROFILE.
2232 "userTypes": [ # The user types.
2233 "A String",
2234 ],
2235 "objectType": "A String", # The profile object type.
2236 },
2237 },
2238 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2239 # verified field is typically a name, email address, phone number, or
2240 # website that has been confirmed to be owned by the person.
2241 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2242 # field.
2243 },
2244 },
2245 ],
2246 "userDefined": [ # The person's user defined data.
2247 { # Arbitrary user data that is populated by the end users.
2248 "key": "A String", # The end user specified key of the user defined data.
2249 "value": "A String", # The end user specified value of the user defined data.
2250 "metadata": { # Metadata about a field. # Metadata about the user defined data.
2251 "source": { # The source of a field. # The source of the field.
2252 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2253 #
2254 # Last update timestamp of this source.
2255 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2256 #
2257 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2258 # source. Used for web cache validation.
2259 "type": "A String", # The source type.
2260 "id": "A String", # The unique identifier within the source type generated by the server.
2261 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2262 #
2263 # Metadata about a source of type PROFILE.
2264 "userTypes": [ # The user types.
2265 "A String",
2266 ],
2267 "objectType": "A String", # The profile object type.
2268 },
2269 },
2270 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2271 # verified field is typically a name, email address, phone number, or
2272 # website that has been confirmed to be owned by the person.
2273 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2274 # field.
2275 },
2276 },
2277 ],
2278 "biographies": [ # The person's biographies.
2279 { # A person's short biography.
2280 "contentType": "A String", # The content type of the biography.
2281 "value": "A String", # The short biography.
2282 "metadata": { # Metadata about a field. # Metadata about the biography.
2283 "source": { # The source of a field. # The source of the field.
2284 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2285 #
2286 # Last update timestamp of this source.
2287 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2288 #
2289 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2290 # source. Used for web cache validation.
2291 "type": "A String", # The source type.
2292 "id": "A String", # The unique identifier within the source type generated by the server.
2293 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2294 #
2295 # Metadata about a source of type PROFILE.
2296 "userTypes": [ # The user types.
2297 "A String",
2298 ],
2299 "objectType": "A String", # The profile object type.
2300 },
2301 },
2302 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2303 # verified field is typically a name, email address, phone number, or
2304 # website that has been confirmed to be owned by the person.
2305 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2306 # field.
2307 },
2308 },
2309 ],
2310 "memberships": [ # The person's group memberships.
2311 { # A person's membership in a group. Only contact group memberships can be
2312 # modified.
2313 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
2314 "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
2315 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
2316 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
2317 # Only contact_group_resource_name can be used for modifying memberships.
2318 # Any contact group membership can be removed, but only user group or
2319 # "myContacts" or "starred" system groups memberships can be added. A
2320 # contact must always have at least one contact group membership.
2321 },
2322 "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain membership.
2323 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
2324 },
2325 "metadata": { # Metadata about a field. # Metadata about the membership.
2326 "source": { # The source of a field. # The source of the field.
2327 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2328 #
2329 # Last update timestamp of this source.
2330 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2331 #
2332 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2333 # source. Used for web cache validation.
2334 "type": "A String", # The source type.
2335 "id": "A String", # The unique identifier within the source type generated by the server.
2336 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2337 #
2338 # Metadata about a source of type PROFILE.
2339 "userTypes": [ # The user types.
2340 "A String",
2341 ],
2342 "objectType": "A String", # The profile object type.
2343 },
2344 },
2345 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2346 # verified field is typically a name, email address, phone number, or
2347 # website that has been confirmed to be owned by the person.
2348 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2349 # field.
2350 },
2351 },
2352 ],
2353 "skills": [ # The person's skills.
2354 { # A skill that the person has.
2355 "value": "A String", # The skill; for example, `underwater basket weaving`.
2356 "metadata": { # Metadata about a field. # Metadata about the skill.
2357 "source": { # The source of a field. # The source of the field.
2358 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2359 #
2360 # Last update timestamp of this source.
2361 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2362 #
2363 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2364 # source. Used for web cache validation.
2365 "type": "A String", # The source type.
2366 "id": "A String", # The unique identifier within the source type generated by the server.
2367 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2368 #
2369 # Metadata about a source of type PROFILE.
2370 "userTypes": [ # The user types.
2371 "A String",
2372 ],
2373 "objectType": "A String", # The profile object type.
2374 },
2375 },
2376 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2377 # verified field is typically a name, email address, phone number, or
2378 # website that has been confirmed to be owned by the person.
2379 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2380 # field.
2381 },
2382 },
2383 ],
2384 "urls": [ # The person's associated URLs.
2385 { # A person's associated URLs.
2386 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
2387 # account locale or the `Accept-Language` HTTP header locale.
2388 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
2389 # values:
2390 #
2391 # * `home`
2392 # * `work`
2393 # * `blog`
2394 # * `profile`
2395 # * `homePage`
2396 # * `ftp`
2397 # * `reservations`
2398 # * `appInstallPage`: website for a Google+ application.
2399 # * `other`
2400 "value": "A String", # The URL.
2401 "metadata": { # Metadata about a field. # Metadata about the URL.
2402 "source": { # The source of a field. # The source of the field.
2403 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2404 #
2405 # Last update timestamp of this source.
2406 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2407 #
2408 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2409 # source. Used for web cache validation.
2410 "type": "A String", # The source type.
2411 "id": "A String", # The unique identifier within the source type generated by the server.
2412 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2413 #
2414 # Metadata about a source of type PROFILE.
2415 "userTypes": [ # The user types.
2416 "A String",
2417 ],
2418 "objectType": "A String", # The profile object type.
2419 },
2420 },
2421 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2422 # verified field is typically a name, email address, phone number, or
2423 # website that has been confirmed to be owned by the person.
2424 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2425 # field.
2426 },
2427 },
2428 ],
2429 "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
2430 #
2431 # The person's read-only age range.
2432 "genders": [ # The person's genders.
2433 { # A person's gender.
2434 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
2435 # account locale or the `Accept-Language` HTTP header locale.
2436 "value": "A String", # The gender for the person. The gender can be custom or one of these
2437 # predefined values:
2438 #
2439 # * `male`
2440 # * `female`
2441 # * `other`
2442 # * `unknown`
2443 "metadata": { # Metadata about a field. # Metadata about the gender.
2444 "source": { # The source of a field. # The source of the field.
2445 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2446 #
2447 # Last update timestamp of this source.
2448 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2449 #
2450 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2451 # source. Used for web cache validation.
2452 "type": "A String", # The source type.
2453 "id": "A String", # The unique identifier within the source type generated by the server.
2454 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2455 #
2456 # Metadata about a source of type PROFILE.
2457 "userTypes": [ # The user types.
2458 "A String",
2459 ],
2460 "objectType": "A String", # The profile object type.
2461 },
2462 },
2463 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2464 # verified field is typically a name, email address, phone number, or
2465 # website that has been confirmed to be owned by the person.
2466 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2467 # field.
2468 },
2469 },
2470 ],
2471 "emailAddresses": [ # The person's email addresses.
2472 { # A person's email address.
2473 "type": "A String", # The type of the email address. The type can be custom or one of these
2474 # predefined values:
2475 #
2476 # * `home`
2477 # * `work`
2478 # * `other`
2479 "formattedType": "A String", # The read-only type of the email address translated and formatted in the
2480 # viewer's account locale or the `Accept-Language` HTTP header locale.
2481 "displayName": "A String", # The display name of the email.
2482 "value": "A String", # The email address.
2483 "metadata": { # Metadata about a field. # Metadata about the email address.
2484 "source": { # The source of a field. # The source of the field.
2485 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2486 #
2487 # Last update timestamp of this source.
2488 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2489 #
2490 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2491 # source. Used for web cache validation.
2492 "type": "A String", # The source type.
2493 "id": "A String", # The unique identifier within the source type generated by the server.
2494 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2495 #
2496 # Metadata about a source of type PROFILE.
2497 "userTypes": [ # The user types.
2498 "A String",
2499 ],
2500 "objectType": "A String", # The profile object type.
2501 },
2502 },
2503 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2504 # verified field is typically a name, email address, phone number, or
2505 # website that has been confirmed to be owned by the person.
2506 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2507 # field.
2508 },
2509 },
2510 ],
2511 }</pre>
2512</div>
2513
2514<div class="method">
2515 <code class="details" id="deleteContact">deleteContact(resourceName, x__xgafv=None)</code>
2516 <pre>Delete a contact person. Any non-contact data will not be deleted.
2517
2518Args:
2519 resourceName: string, The resource name of the contact to delete. (required)
2520 x__xgafv: string, V1 error format.
2521 Allowed values
2522 1 - v1 error format
2523 2 - v2 error format
2524
2525Returns:
2526 An object of the form:
2527
2528 { # A generic empty message that you can re-use to avoid defining duplicated
2529 # empty messages in your APIs. A typical example is to use it as the request
2530 # or the response type of an API method. For instance:
2531 #
2532 # service Foo {
2533 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
2534 # }
2535 #
2536 # The JSON representation for `Empty` is empty JSON object `{}`.
2537 }</pre>
2538</div>
2539
2540<div class="method">
2541 <code class="details" id="get">get(resourceName, x__xgafv=None, requestMask_includeField=None, personFields=None)</code>
2542 <pre>Provides information about a person by specifying a resource name. Use
2543`people/me` to indicate the authenticated user.
2544<br>
2545The request throws a 400 error if 'personFields' is not specified.
2546
2547Args:
2548 resourceName: string, The resource name of the person to provide information about.
2549
2550- To get information about the authenticated user, specify `people/me`.
2551- To get information about a google account, specify
2552 `people/`<var>account_id</var>.
2553- To get information about a contact, specify the resource name that
2554 identifies the contact as returned by
2555[`people.connections.list`](/people/api/rest/v1/people.connections/list). (required)
2556 x__xgafv: string, V1 error format.
2557 Allowed values
2558 1 - v1 error format
2559 2 - v2 error format
2560 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]2561response. Each path should start with `person.`: for example,
2562`person.names` or `person.photos`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2563 personFields: string, **Required.** A field mask to restrict which fields on the person are
2564returned. Multiple fields can be specified by separating them with commas.
2565Valid values are:
2566
2567* addresses
2568* ageRanges
2569* biographies
2570* birthdays
2571* braggingRights
2572* coverPhotos
2573* emailAddresses
2574* events
2575* genders
2576* imClients
2577* interests
2578* locales
2579* memberships
2580* metadata
2581* names
2582* nicknames
2583* occupations
2584* organizations
2585* phoneNumbers
2586* photos
2587* relations
2588* relationshipInterests
2589* relationshipStatuses
2590* residences
2591* sipAddresses
2592* skills
2593* taglines
2594* urls
2595* userDefined
2596
2597Returns:
2598 An object of the form:
2599
2600 { # Information about a person merged from various data sources such as the
2601 # authenticated user's contacts and profile data.
2602 #
2603 # Most fields can have multiple items. The items in a field have no guaranteed
2604 # order, but each non-empty field is guaranteed to have exactly one field with
2605 # `metadata.primary` set to true.
2606 "sipAddresses": [ # The person's SIP addresses.
2607 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
2608 # communications to make voice or video calls over the internet.
2609 "formattedType": "A String", # The read-only type of the SIP address translated and formatted in the
2610 # viewer's account locale or the `Accept-Language` HTTP header locale.
2611 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
2612 # predefined values:
2613 #
2614 # * `home`
2615 # * `work`
2616 # * `mobile`
2617 # * `other`
2618 "value": "A String", # The SIP address in the
2619 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
2620 # format.
2621 "metadata": { # Metadata about a field. # Metadata about the SIP address.
2622 "source": { # The source of a field. # The source of the field.
2623 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2624 #
2625 # Last update timestamp of this source.
2626 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2627 #
2628 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2629 # source. Used for web cache validation.
2630 "type": "A String", # The source type.
2631 "id": "A String", # The unique identifier within the source type generated by the server.
2632 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2633 #
2634 # Metadata about a source of type PROFILE.
2635 "userTypes": [ # The user types.
2636 "A String",
2637 ],
2638 "objectType": "A String", # The profile object type.
2639 },
2640 },
2641 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2642 # verified field is typically a name, email address, phone number, or
2643 # website that has been confirmed to be owned by the person.
2644 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2645 # field.
2646 },
2647 },
2648 ],
2649 "phoneNumbers": [ # The person's phone numbers.
2650 { # A person's phone number.
2651 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
2652 # viewer's account locale or the `Accept-Language` HTTP header locale.
2653 "canonicalForm": "A String", # The read-only canonicalized [ITU-T
2654 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
2655 # form of the phone number.
2656 "type": "A String", # The type of the phone number. The type can be custom or one of these
2657 # predefined values:
2658 #
2659 # * `home`
2660 # * `work`
2661 # * `mobile`
2662 # * `homeFax`
2663 # * `workFax`
2664 # * `otherFax`
2665 # * `pager`
2666 # * `workMobile`
2667 # * `workPager`
2668 # * `main`
2669 # * `googleVoice`
2670 # * `other`
2671 "value": "A String", # The phone number.
2672 "metadata": { # Metadata about a field. # Metadata about the phone number.
2673 "source": { # The source of a field. # The source of the field.
2674 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2675 #
2676 # Last update timestamp of this source.
2677 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2678 #
2679 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2680 # source. Used for web cache validation.
2681 "type": "A String", # The source type.
2682 "id": "A String", # The unique identifier within the source type generated by the server.
2683 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2684 #
2685 # Metadata about a source of type PROFILE.
2686 "userTypes": [ # The user types.
2687 "A String",
2688 ],
2689 "objectType": "A String", # The profile object type.
2690 },
2691 },
2692 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2693 # verified field is typically a name, email address, phone number, or
2694 # website that has been confirmed to be owned by the person.
2695 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2696 # field.
2697 },
2698 },
2699 ],
2700 "addresses": [ # The person's street addresses.
2701 { # A person's physical address. May be a P.O. box or street address. All fields
2702 # are optional.
2703 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
2704 # account locale or the `Accept-Language` HTTP header locale.
2705 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
2706 # code of the address.
2707 "city": "A String", # The city of the address.
2708 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
2709 # will be automatically constructed from structured values.
2710 "region": "A String", # The region of the address; for example, the state or province.
2711 "poBox": "A String", # The P.O. box of the address.
2712 "streetAddress": "A String", # The street address.
2713 "country": "A String", # The country of the address.
2714 "postalCode": "A String", # The postal code of the address.
2715 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
2716 "type": "A String", # The type of the address. The type can be custom or one of these predefined
2717 # values:
2718 #
2719 # * `home`
2720 # * `work`
2721 # * `other`
2722 "metadata": { # Metadata about a field. # Metadata about the address.
2723 "source": { # The source of a field. # The source of the field.
2724 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2725 #
2726 # Last update timestamp of this source.
2727 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2728 #
2729 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2730 # source. Used for web cache validation.
2731 "type": "A String", # The source type.
2732 "id": "A String", # The unique identifier within the source type generated by the server.
2733 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2734 #
2735 # Metadata about a source of type PROFILE.
2736 "userTypes": [ # The user types.
2737 "A String",
2738 ],
2739 "objectType": "A String", # The profile object type.
2740 },
2741 },
2742 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2743 # verified field is typically a name, email address, phone number, or
2744 # website that has been confirmed to be owned by the person.
2745 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2746 # field.
2747 },
2748 },
2749 ],
2750 "nicknames": [ # The person's nicknames.
2751 { # A person's nickname.
2752 "type": "A String", # The type of the nickname.
2753 "value": "A String", # The nickname.
2754 "metadata": { # Metadata about a field. # Metadata about the nickname.
2755 "source": { # The source of a field. # The source of the field.
2756 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2757 #
2758 # Last update timestamp of this source.
2759 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2760 #
2761 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2762 # source. Used for web cache validation.
2763 "type": "A String", # The source type.
2764 "id": "A String", # The unique identifier within the source type generated by the server.
2765 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2766 #
2767 # Metadata about a source of type PROFILE.
2768 "userTypes": [ # The user types.
2769 "A String",
2770 ],
2771 "objectType": "A String", # The profile object type.
2772 },
2773 },
2774 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2775 # verified field is typically a name, email address, phone number, or
2776 # website that has been confirmed to be owned by the person.
2777 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2778 # field.
2779 },
2780 },
2781 ],
2782 "occupations": [ # The person's occupations.
2783 { # A person's occupation.
2784 "value": "A String", # The occupation; for example, `carpenter`.
2785 "metadata": { # Metadata about a field. # Metadata about the occupation.
2786 "source": { # The source of a field. # The source of the field.
2787 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2788 #
2789 # Last update timestamp of this source.
2790 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2791 #
2792 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2793 # source. Used for web cache validation.
2794 "type": "A String", # The source type.
2795 "id": "A String", # The unique identifier within the source type generated by the server.
2796 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2797 #
2798 # Metadata about a source of type PROFILE.
2799 "userTypes": [ # The user types.
2800 "A String",
2801 ],
2802 "objectType": "A String", # The profile object type.
2803 },
2804 },
2805 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2806 # verified field is typically a name, email address, phone number, or
2807 # website that has been confirmed to be owned by the person.
2808 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2809 # field.
2810 },
2811 },
2812 ],
2813 "braggingRights": [ # The person's bragging rights.
2814 { # A person's bragging rights.
2815 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
2816 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
2817 "source": { # The source of a field. # The source of the field.
2818 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2819 #
2820 # Last update timestamp of this source.
2821 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2822 #
2823 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2824 # source. Used for web cache validation.
2825 "type": "A String", # The source type.
2826 "id": "A String", # The unique identifier within the source type generated by the server.
2827 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2828 #
2829 # Metadata about a source of type PROFILE.
2830 "userTypes": [ # The user types.
2831 "A String",
2832 ],
2833 "objectType": "A String", # The profile object type.
2834 },
2835 },
2836 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2837 # verified field is typically a name, email address, phone number, or
2838 # website that has been confirmed to be owned by the person.
2839 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2840 # field.
2841 },
2842 },
2843 ],
2844 "names": [ # The person's names.
2845 { # A person's name. If the name is a mononym, the family name is empty.
2846 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
2847 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
2848 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
2849 "displayName": "A String", # The read-only display name formatted according to the locale specified by
2850 # the viewer's account or the `Accept-Language` HTTP header.
2851 "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
2852 # the locale specified by the viewer's account or the
2853 # `Accept-Language` HTTP header.
2854 "middleName": "A String", # The middle name(s).
2855 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
2856 "familyName": "A String", # The family name.
2857 "phoneticFullName": "A String", # The full name spelled as it sounds.
2858 "phoneticGivenName": "A String", # The given name spelled as it sounds.
2859 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
2860 "givenName": "A String", # The given name.
2861 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
2862 "metadata": { # Metadata about a field. # Metadata about the name.
2863 "source": { # The source of a field. # The source of the field.
2864 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2865 #
2866 # Last update timestamp of this source.
2867 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2868 #
2869 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2870 # source. Used for web cache validation.
2871 "type": "A String", # The source type.
2872 "id": "A String", # The unique identifier within the source type generated by the server.
2873 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2874 #
2875 # Metadata about a source of type PROFILE.
2876 "userTypes": [ # The user types.
2877 "A String",
2878 ],
2879 "objectType": "A String", # The profile object type.
2880 },
2881 },
2882 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2883 # verified field is typically a name, email address, phone number, or
2884 # website that has been confirmed to be owned by the person.
2885 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2886 # field.
2887 },
2888 },
2889 ],
2890 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
2891 # with a max length of 27 characters, in the form of
2892 # `people/`<var>person_id</var>.
2893 "taglines": [ # The person's read-only taglines.
2894 { # A read-only brief one-line description of the person.
2895 "value": "A String", # The tagline.
2896 "metadata": { # Metadata about a field. # Metadata about the tagline.
2897 "source": { # The source of a field. # The source of the field.
2898 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2899 #
2900 # Last update timestamp of this source.
2901 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2902 #
2903 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2904 # source. Used for web cache validation.
2905 "type": "A String", # The source type.
2906 "id": "A String", # The unique identifier within the source type generated by the server.
2907 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2908 #
2909 # Metadata about a source of type PROFILE.
2910 "userTypes": [ # The user types.
2911 "A String",
2912 ],
2913 "objectType": "A String", # The profile object type.
2914 },
2915 },
2916 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2917 # verified field is typically a name, email address, phone number, or
2918 # website that has been confirmed to be owned by the person.
2919 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2920 # field.
2921 },
2922 },
2923 ],
2924 "ageRanges": [ # The person's read-only age ranges.
2925 { # A person's age range.
2926 "ageRange": "A String", # The age range.
2927 "metadata": { # Metadata about a field. # Metadata about the age range.
2928 "source": { # The source of a field. # The source of the field.
2929 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2930 #
2931 # Last update timestamp of this source.
2932 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2933 #
2934 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2935 # source. Used for web cache validation.
2936 "type": "A String", # The source type.
2937 "id": "A String", # The unique identifier within the source type generated by the server.
2938 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2939 #
2940 # Metadata about a source of type PROFILE.
2941 "userTypes": [ # The user types.
2942 "A String",
2943 ],
2944 "objectType": "A String", # The profile object type.
2945 },
2946 },
2947 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2948 # verified field is typically a name, email address, phone number, or
2949 # website that has been confirmed to be owned by the person.
2950 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2951 # field.
2952 },
2953 },
2954 ],
2955 "birthdays": [ # The person's birthdays.
2956 { # A person's birthday. At least one of the `date` and `text` fields are
2957 # specified. The `date` and `text` fields typically represent the same
2958 # date, but are not guaranteed to.
2959 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
2960 # of day and time zone are either specified elsewhere or are not
2961 # significant. The date is relative to the
2962 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
2963 # The day may be 0 to represent a year and month where the day is not
2964 # significant. The year may be 0 to represent a month and day independent
2965 # of year; for example, anniversary date.
2966 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
2967 # month and day.
2968 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
2969 # if specifying a year by itself or a year and month where the day is not
2970 # significant.
2971 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
2972 # a year.
2973 },
2974 "text": "A String", # A free-form string representing the user's birthday.
2975 "metadata": { # Metadata about a field. # Metadata about the birthday.
2976 "source": { # The source of a field. # The source of the field.
2977 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
2978 #
2979 # Last update timestamp of this source.
2980 "etag": "A String", # **Only populated in `person.metadata.sources`.**
2981 #
2982 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
2983 # source. Used for web cache validation.
2984 "type": "A String", # The source type.
2985 "id": "A String", # The unique identifier within the source type generated by the server.
2986 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
2987 #
2988 # Metadata about a source of type PROFILE.
2989 "userTypes": [ # The user types.
2990 "A String",
2991 ],
2992 "objectType": "A String", # The profile object type.
2993 },
2994 },
2995 "verified": True or False, # True if the field is verified; false if the field is unverified. A
2996 # verified field is typically a name, email address, phone number, or
2997 # website that has been confirmed to be owned by the person.
2998 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
2999 # field.
3000 },
3001 },
3002 ],
3003 "relations": [ # The person's relations.
3004 { # A person's relation to another person.
3005 "person": "A String", # The name of the other person this relation refers to.
3006 "metadata": { # Metadata about a field. # Metadata about the relation.
3007 "source": { # The source of a field. # The source of the field.
3008 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3009 #
3010 # Last update timestamp of this source.
3011 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3012 #
3013 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3014 # source. Used for web cache validation.
3015 "type": "A String", # The source type.
3016 "id": "A String", # The unique identifier within the source type generated by the server.
3017 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3018 #
3019 # Metadata about a source of type PROFILE.
3020 "userTypes": [ # The user types.
3021 "A String",
3022 ],
3023 "objectType": "A String", # The profile object type.
3024 },
3025 },
3026 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3027 # verified field is typically a name, email address, phone number, or
3028 # website that has been confirmed to be owned by the person.
3029 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3030 # field.
3031 },
3032 "type": "A String", # The person's relation to the other person. The type can be custom or one of
3033 # these predefined values:
3034 #
3035 # * `spouse`
3036 # * `child`
3037 # * `mother`
3038 # * `father`
3039 # * `parent`
3040 # * `brother`
3041 # * `sister`
3042 # * `friend`
3043 # * `relative`
3044 # * `domesticPartner`
3045 # * `manager`
3046 # * `assistant`
3047 # * `referredBy`
3048 # * `partner`
3049 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
3050 # locale or the locale specified in the Accept-Language HTTP header.
3051 },
3052 ],
3053 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3054 # resource. Used for web cache validation.
3055 "relationshipStatuses": [ # The person's read-only relationship statuses.
3056 { # A person's read-only relationship status.
3057 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
3058 # the viewer's account locale or the `Accept-Language` HTTP header locale.
3059 "value": "A String", # The relationship status. The value can be custom or one of these
3060 # predefined values:
3061 #
3062 # * `single`
3063 # * `inARelationship`
3064 # * `engaged`
3065 # * `married`
3066 # * `itsComplicated`
3067 # * `openRelationship`
3068 # * `widowed`
3069 # * `inDomesticPartnership`
3070 # * `inCivilUnion`
3071 "metadata": { # Metadata about a field. # Metadata about the relationship status.
3072 "source": { # The source of a field. # The source of the field.
3073 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3074 #
3075 # Last update timestamp of this source.
3076 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3077 #
3078 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3079 # source. Used for web cache validation.
3080 "type": "A String", # The source type.
3081 "id": "A String", # The unique identifier within the source type generated by the server.
3082 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3083 #
3084 # Metadata about a source of type PROFILE.
3085 "userTypes": [ # The user types.
3086 "A String",
3087 ],
3088 "objectType": "A String", # The profile object type.
3089 },
3090 },
3091 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3092 # verified field is typically a name, email address, phone number, or
3093 # website that has been confirmed to be owned by the person.
3094 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3095 # field.
3096 },
3097 },
3098 ],
3099 "imClients": [ # The person's instant messaging clients.
3100 { # A person's instant messaging client.
3101 "username": "A String", # The user name used in the IM client.
3102 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
3103 # viewer's account locale or the `Accept-Language` HTTP header locale.
3104 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
3105 # predefined values:
3106 #
3107 # * `aim`
3108 # * `msn`
3109 # * `yahoo`
3110 # * `skype`
3111 # * `qq`
3112 # * `googleTalk`
3113 # * `icq`
3114 # * `jabber`
3115 # * `netMeeting`
3116 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
3117 # locale or the `Accept-Language` HTTP header locale.
3118 "type": "A String", # The type of the IM client. The type can be custom or one of these
3119 # predefined values:
3120 #
3121 # * `home`
3122 # * `work`
3123 # * `other`
3124 "metadata": { # Metadata about a field. # Metadata about the IM client.
3125 "source": { # The source of a field. # The source of the field.
3126 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3127 #
3128 # Last update timestamp of this source.
3129 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3130 #
3131 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3132 # source. Used for web cache validation.
3133 "type": "A String", # The source type.
3134 "id": "A String", # The unique identifier within the source type generated by the server.
3135 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3136 #
3137 # Metadata about a source of type PROFILE.
3138 "userTypes": [ # The user types.
3139 "A String",
3140 ],
3141 "objectType": "A String", # The profile object type.
3142 },
3143 },
3144 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3145 # verified field is typically a name, email address, phone number, or
3146 # website that has been confirmed to be owned by the person.
3147 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3148 # field.
3149 },
3150 },
3151 ],
3152 "events": [ # The person's events.
3153 { # An event related to the person.
3154 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
3155 # of day and time zone are either specified elsewhere or are not
3156 # significant. The date is relative to the
3157 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
3158 # The day may be 0 to represent a year and month where the day is not
3159 # significant. The year may be 0 to represent a month and day independent
3160 # of year; for example, anniversary date.
3161 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
3162 # month and day.
3163 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
3164 # if specifying a year by itself or a year and month where the day is not
3165 # significant.
3166 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
3167 # a year.
3168 },
3169 "formattedType": "A String", # The read-only type of the event translated and formatted in the
3170 # viewer's account locale or the `Accept-Language` HTTP header locale.
3171 "type": "A String", # The type of the event. The type can be custom or one of these predefined
3172 # values:
3173 #
3174 # * `anniversary`
3175 # * `other`
3176 "metadata": { # Metadata about a field. # Metadata about the event.
3177 "source": { # The source of a field. # The source of the field.
3178 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3179 #
3180 # Last update timestamp of this source.
3181 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3182 #
3183 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3184 # source. Used for web cache validation.
3185 "type": "A String", # The source type.
3186 "id": "A String", # The unique identifier within the source type generated by the server.
3187 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3188 #
3189 # Metadata about a source of type PROFILE.
3190 "userTypes": [ # The user types.
3191 "A String",
3192 ],
3193 "objectType": "A String", # The profile object type.
3194 },
3195 },
3196 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3197 # verified field is typically a name, email address, phone number, or
3198 # website that has been confirmed to be owned by the person.
3199 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3200 # field.
3201 },
3202 },
3203 ],
3204 "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
3205 "previousResourceNames": [ # Any former resource names this person has had. Populated only for
3206 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
3207 # that include a sync token.
3208 #
3209 # The resource name may change when adding or removing fields that link a
3210 # contact and profile such as a verified email, verified phone number, or
3211 # profile URL.
3212 "A String",
3213 ],
3214 "sources": [ # The sources of data for the person.
3215 { # The source of a field.
3216 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3217 #
3218 # Last update timestamp of this source.
3219 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3220 #
3221 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3222 # source. Used for web cache validation.
3223 "type": "A String", # The source type.
3224 "id": "A String", # The unique identifier within the source type generated by the server.
3225 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3226 #
3227 # Metadata about a source of type PROFILE.
3228 "userTypes": [ # The user types.
3229 "A String",
3230 ],
3231 "objectType": "A String", # The profile object type.
3232 },
3233 },
3234 ],
3235 "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
3236 "A String",
3237 ],
3238 "deleted": True or False, # True if the person resource has been deleted. Populated only for
3239 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
3240 # that include a sync token.
3241 "objectType": "A String", # **DEPRECATED** (Please use
3242 # `person.metadata.sources.profileMetadata.objectType` instead)
3243 #
3244 # The type of the person object.
3245 },
3246 "interests": [ # The person's interests.
3247 { # One of the person's interests.
3248 "value": "A String", # The interest; for example, `stargazing`.
3249 "metadata": { # Metadata about a field. # Metadata about the interest.
3250 "source": { # The source of a field. # The source of the field.
3251 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3252 #
3253 # Last update timestamp of this source.
3254 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3255 #
3256 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3257 # source. Used for web cache validation.
3258 "type": "A String", # The source type.
3259 "id": "A String", # The unique identifier within the source type generated by the server.
3260 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3261 #
3262 # Metadata about a source of type PROFILE.
3263 "userTypes": [ # The user types.
3264 "A String",
3265 ],
3266 "objectType": "A String", # The profile object type.
3267 },
3268 },
3269 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3270 # verified field is typically a name, email address, phone number, or
3271 # website that has been confirmed to be owned by the person.
3272 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3273 # field.
3274 },
3275 },
3276 ],
3277 "photos": [ # The person's read-only photos.
3278 { # A person's read-only photo. A picture shown next to the person's name to
3279 # help others recognize the person.
3280 "default": True or False, # True if the photo is a default photo;
3281 # false if the photo is a user-provided photo.
3282 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
3283 # parameter `sz=`<var>size</var> at the end of the url. Example:
3284 # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
3285 "metadata": { # Metadata about a field. # Metadata about the photo.
3286 "source": { # The source of a field. # The source of the field.
3287 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3288 #
3289 # Last update timestamp of this source.
3290 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3291 #
3292 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3293 # source. Used for web cache validation.
3294 "type": "A String", # The source type.
3295 "id": "A String", # The unique identifier within the source type generated by the server.
3296 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3297 #
3298 # Metadata about a source of type PROFILE.
3299 "userTypes": [ # The user types.
3300 "A String",
3301 ],
3302 "objectType": "A String", # The profile object type.
3303 },
3304 },
3305 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3306 # verified field is typically a name, email address, phone number, or
3307 # website that has been confirmed to be owned by the person.
3308 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3309 # field.
3310 },
3311 },
3312 ],
3313 "residences": [ # The person's residences.
3314 { # A person's past or current residence.
3315 "current": True or False, # True if the residence is the person's current residence;
3316 # false if the residence is a past residence.
3317 "value": "A String", # The address of the residence.
3318 "metadata": { # Metadata about a field. # Metadata about the residence.
3319 "source": { # The source of a field. # The source of the field.
3320 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3321 #
3322 # Last update timestamp of this source.
3323 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3324 #
3325 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3326 # source. Used for web cache validation.
3327 "type": "A String", # The source type.
3328 "id": "A String", # The unique identifier within the source type generated by the server.
3329 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3330 #
3331 # Metadata about a source of type PROFILE.
3332 "userTypes": [ # The user types.
3333 "A String",
3334 ],
3335 "objectType": "A String", # The profile object type.
3336 },
3337 },
3338 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3339 # verified field is typically a name, email address, phone number, or
3340 # website that has been confirmed to be owned by the person.
3341 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3342 # field.
3343 },
3344 },
3345 ],
3346 "relationshipInterests": [ # The person's read-only relationship interests.
3347 { # A person's read-only relationship interest .
3348 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
3349 # viewer's account locale or the locale specified in the Accept-Language
3350 # HTTP header.
3351 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
3352 # or one of these predefined values:
3353 #
3354 # * `friend`
3355 # * `date`
3356 # * `relationship`
3357 # * `networking`
3358 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
3359 "source": { # The source of a field. # The source of the field.
3360 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3361 #
3362 # Last update timestamp of this source.
3363 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3364 #
3365 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3366 # source. Used for web cache validation.
3367 "type": "A String", # The source type.
3368 "id": "A String", # The unique identifier within the source type generated by the server.
3369 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3370 #
3371 # Metadata about a source of type PROFILE.
3372 "userTypes": [ # The user types.
3373 "A String",
3374 ],
3375 "objectType": "A String", # The profile object type.
3376 },
3377 },
3378 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3379 # verified field is typically a name, email address, phone number, or
3380 # website that has been confirmed to be owned by the person.
3381 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3382 # field.
3383 },
3384 },
3385 ],
3386 "coverPhotos": [ # The person's read-only cover photos.
3387 { # A person's read-only cover photo. A large image shown on the person's
3388 # profile page that represents who they are or what they care about.
3389 "default": True or False, # True if the cover photo is the default cover photo;
3390 # false if the cover photo is a user-provided cover photo.
3391 "url": "A String", # The URL of the cover photo.
3392 "metadata": { # Metadata about a field. # Metadata about the cover photo.
3393 "source": { # The source of a field. # The source of the field.
3394 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3395 #
3396 # Last update timestamp of this source.
3397 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3398 #
3399 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3400 # source. Used for web cache validation.
3401 "type": "A String", # The source type.
3402 "id": "A String", # The unique identifier within the source type generated by the server.
3403 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3404 #
3405 # Metadata about a source of type PROFILE.
3406 "userTypes": [ # The user types.
3407 "A String",
3408 ],
3409 "objectType": "A String", # The profile object type.
3410 },
3411 },
3412 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3413 # verified field is typically a name, email address, phone number, or
3414 # website that has been confirmed to be owned by the person.
3415 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3416 # field.
3417 },
3418 },
3419 ],
3420 "locales": [ # The person's locale preferences.
3421 { # A person's locale preference.
3422 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
3423 # language tag representing the locale.
3424 "metadata": { # Metadata about a field. # Metadata about the locale.
3425 "source": { # The source of a field. # The source of the field.
3426 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3427 #
3428 # Last update timestamp of this source.
3429 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3430 #
3431 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3432 # source. Used for web cache validation.
3433 "type": "A String", # The source type.
3434 "id": "A String", # The unique identifier within the source type generated by the server.
3435 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3436 #
3437 # Metadata about a source of type PROFILE.
3438 "userTypes": [ # The user types.
3439 "A String",
3440 ],
3441 "objectType": "A String", # The profile object type.
3442 },
3443 },
3444 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3445 # verified field is typically a name, email address, phone number, or
3446 # website that has been confirmed to be owned by the person.
3447 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3448 # field.
3449 },
3450 },
3451 ],
3452 "organizations": [ # The person's past or current organizations.
3453 { # A person's past or current organization. Overlapping date ranges are
3454 # permitted.
3455 "formattedType": "A String", # The read-only type of the organization translated and formatted in the
3456 # viewer's account locale or the `Accept-Language` HTTP header locale.
3457 "domain": "A String", # The domain name associated with the organization; for example,
3458 # `google.com`.
3459 "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
3460 # of day and time zone are either specified elsewhere or are not
3461 # significant. The date is relative to the
3462 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
3463 # The day may be 0 to represent a year and month where the day is not
3464 # significant. The year may be 0 to represent a month and day independent
3465 # of year; for example, anniversary date.
3466 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
3467 # month and day.
3468 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
3469 # if specifying a year by itself or a year and month where the day is not
3470 # significant.
3471 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
3472 # a year.
3473 },
3474 "name": "A String", # The name of the organization.
3475 "title": "A String", # The person's job title at the organization.
3476 "type": "A String", # The type of the organization. The type can be custom or one of these
3477 # predefined values:
3478 #
3479 # * `work`
3480 # * `school`
3481 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
3482 # symbol, abbreviation, or acronym.
3483 "current": True or False, # True if the organization is the person's current organization;
3484 # false if the organization is a past organization.
3485 "jobDescription": "A String", # The person's job description at the organization.
3486 "location": "A String", # The location of the organization office the person works at.
3487 "department": "A String", # The person's department at the organization.
3488 "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
3489 # of day and time zone are either specified elsewhere or are not
3490 # significant. The date is relative to the
3491 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
3492 # The day may be 0 to represent a year and month where the day is not
3493 # significant. The year may be 0 to represent a month and day independent
3494 # of year; for example, anniversary date.
3495 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
3496 # month and day.
3497 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
3498 # if specifying a year by itself or a year and month where the day is not
3499 # significant.
3500 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
3501 # a year.
3502 },
3503 "phoneticName": "A String", # The phonetic name of the organization.
3504 "metadata": { # Metadata about a field. # Metadata about the organization.
3505 "source": { # The source of a field. # The source of the field.
3506 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3507 #
3508 # Last update timestamp of this source.
3509 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3510 #
3511 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3512 # source. Used for web cache validation.
3513 "type": "A String", # The source type.
3514 "id": "A String", # The unique identifier within the source type generated by the server.
3515 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3516 #
3517 # Metadata about a source of type PROFILE.
3518 "userTypes": [ # The user types.
3519 "A String",
3520 ],
3521 "objectType": "A String", # The profile object type.
3522 },
3523 },
3524 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3525 # verified field is typically a name, email address, phone number, or
3526 # website that has been confirmed to be owned by the person.
3527 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3528 # field.
3529 },
3530 },
3531 ],
3532 "userDefined": [ # The person's user defined data.
3533 { # Arbitrary user data that is populated by the end users.
3534 "key": "A String", # The end user specified key of the user defined data.
3535 "value": "A String", # The end user specified value of the user defined data.
3536 "metadata": { # Metadata about a field. # Metadata about the user defined data.
3537 "source": { # The source of a field. # The source of the field.
3538 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3539 #
3540 # Last update timestamp of this source.
3541 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3542 #
3543 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3544 # source. Used for web cache validation.
3545 "type": "A String", # The source type.
3546 "id": "A String", # The unique identifier within the source type generated by the server.
3547 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3548 #
3549 # Metadata about a source of type PROFILE.
3550 "userTypes": [ # The user types.
3551 "A String",
3552 ],
3553 "objectType": "A String", # The profile object type.
3554 },
3555 },
3556 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3557 # verified field is typically a name, email address, phone number, or
3558 # website that has been confirmed to be owned by the person.
3559 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3560 # field.
3561 },
3562 },
3563 ],
3564 "biographies": [ # The person's biographies.
3565 { # A person's short biography.
3566 "contentType": "A String", # The content type of the biography.
3567 "value": "A String", # The short biography.
3568 "metadata": { # Metadata about a field. # Metadata about the biography.
3569 "source": { # The source of a field. # The source of the field.
3570 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3571 #
3572 # Last update timestamp of this source.
3573 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3574 #
3575 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3576 # source. Used for web cache validation.
3577 "type": "A String", # The source type.
3578 "id": "A String", # The unique identifier within the source type generated by the server.
3579 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3580 #
3581 # Metadata about a source of type PROFILE.
3582 "userTypes": [ # The user types.
3583 "A String",
3584 ],
3585 "objectType": "A String", # The profile object type.
3586 },
3587 },
3588 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3589 # verified field is typically a name, email address, phone number, or
3590 # website that has been confirmed to be owned by the person.
3591 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3592 # field.
3593 },
3594 },
3595 ],
3596 "memberships": [ # The person's group memberships.
3597 { # A person's membership in a group. Only contact group memberships can be
3598 # modified.
3599 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
3600 "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
3601 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
3602 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
3603 # Only contact_group_resource_name can be used for modifying memberships.
3604 # Any contact group membership can be removed, but only user group or
3605 # "myContacts" or "starred" system groups memberships can be added. A
3606 # contact must always have at least one contact group membership.
3607 },
3608 "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain membership.
3609 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
3610 },
3611 "metadata": { # Metadata about a field. # Metadata about the membership.
3612 "source": { # The source of a field. # The source of the field.
3613 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3614 #
3615 # Last update timestamp of this source.
3616 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3617 #
3618 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3619 # source. Used for web cache validation.
3620 "type": "A String", # The source type.
3621 "id": "A String", # The unique identifier within the source type generated by the server.
3622 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3623 #
3624 # Metadata about a source of type PROFILE.
3625 "userTypes": [ # The user types.
3626 "A String",
3627 ],
3628 "objectType": "A String", # The profile object type.
3629 },
3630 },
3631 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3632 # verified field is typically a name, email address, phone number, or
3633 # website that has been confirmed to be owned by the person.
3634 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3635 # field.
3636 },
3637 },
3638 ],
3639 "skills": [ # The person's skills.
3640 { # A skill that the person has.
3641 "value": "A String", # The skill; for example, `underwater basket weaving`.
3642 "metadata": { # Metadata about a field. # Metadata about the skill.
3643 "source": { # The source of a field. # The source of the field.
3644 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3645 #
3646 # Last update timestamp of this source.
3647 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3648 #
3649 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3650 # source. Used for web cache validation.
3651 "type": "A String", # The source type.
3652 "id": "A String", # The unique identifier within the source type generated by the server.
3653 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3654 #
3655 # Metadata about a source of type PROFILE.
3656 "userTypes": [ # The user types.
3657 "A String",
3658 ],
3659 "objectType": "A String", # The profile object type.
3660 },
3661 },
3662 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3663 # verified field is typically a name, email address, phone number, or
3664 # website that has been confirmed to be owned by the person.
3665 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3666 # field.
3667 },
3668 },
3669 ],
3670 "urls": [ # The person's associated URLs.
3671 { # A person's associated URLs.
3672 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
3673 # account locale or the `Accept-Language` HTTP header locale.
3674 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
3675 # values:
3676 #
3677 # * `home`
3678 # * `work`
3679 # * `blog`
3680 # * `profile`
3681 # * `homePage`
3682 # * `ftp`
3683 # * `reservations`
3684 # * `appInstallPage`: website for a Google+ application.
3685 # * `other`
3686 "value": "A String", # The URL.
3687 "metadata": { # Metadata about a field. # Metadata about the URL.
3688 "source": { # The source of a field. # The source of the field.
3689 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3690 #
3691 # Last update timestamp of this source.
3692 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3693 #
3694 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3695 # source. Used for web cache validation.
3696 "type": "A String", # The source type.
3697 "id": "A String", # The unique identifier within the source type generated by the server.
3698 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3699 #
3700 # Metadata about a source of type PROFILE.
3701 "userTypes": [ # The user types.
3702 "A String",
3703 ],
3704 "objectType": "A String", # The profile object type.
3705 },
3706 },
3707 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3708 # verified field is typically a name, email address, phone number, or
3709 # website that has been confirmed to be owned by the person.
3710 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3711 # field.
3712 },
3713 },
3714 ],
3715 "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
3716 #
3717 # The person's read-only age range.
3718 "genders": [ # The person's genders.
3719 { # A person's gender.
3720 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
3721 # account locale or the `Accept-Language` HTTP header locale.
3722 "value": "A String", # The gender for the person. The gender can be custom or one of these
3723 # predefined values:
3724 #
3725 # * `male`
3726 # * `female`
3727 # * `other`
3728 # * `unknown`
3729 "metadata": { # Metadata about a field. # Metadata about the gender.
3730 "source": { # The source of a field. # The source of the field.
3731 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3732 #
3733 # Last update timestamp of this source.
3734 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3735 #
3736 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3737 # source. Used for web cache validation.
3738 "type": "A String", # The source type.
3739 "id": "A String", # The unique identifier within the source type generated by the server.
3740 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3741 #
3742 # Metadata about a source of type PROFILE.
3743 "userTypes": [ # The user types.
3744 "A String",
3745 ],
3746 "objectType": "A String", # The profile object type.
3747 },
3748 },
3749 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3750 # verified field is typically a name, email address, phone number, or
3751 # website that has been confirmed to be owned by the person.
3752 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3753 # field.
3754 },
3755 },
3756 ],
3757 "emailAddresses": [ # The person's email addresses.
3758 { # A person's email address.
3759 "type": "A String", # The type of the email address. The type can be custom or one of these
3760 # predefined values:
3761 #
3762 # * `home`
3763 # * `work`
3764 # * `other`
3765 "formattedType": "A String", # The read-only type of the email address translated and formatted in the
3766 # viewer's account locale or the `Accept-Language` HTTP header locale.
3767 "displayName": "A String", # The display name of the email.
3768 "value": "A String", # The email address.
3769 "metadata": { # Metadata about a field. # Metadata about the email address.
3770 "source": { # The source of a field. # The source of the field.
3771 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3772 #
3773 # Last update timestamp of this source.
3774 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3775 #
3776 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3777 # source. Used for web cache validation.
3778 "type": "A String", # The source type.
3779 "id": "A String", # The unique identifier within the source type generated by the server.
3780 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3781 #
3782 # Metadata about a source of type PROFILE.
3783 "userTypes": [ # The user types.
3784 "A String",
3785 ],
3786 "objectType": "A String", # The profile object type.
3787 },
3788 },
3789 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3790 # verified field is typically a name, email address, phone number, or
3791 # website that has been confirmed to be owned by the person.
3792 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3793 # field.
3794 },
3795 },
3796 ],
3797 }</pre>
3798</div>
3799
3800<div class="method">
3801 <code class="details" id="getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None, personFields=None)</code>
3802 <pre>Provides information about a list of specific people by specifying a list
3803of requested resource names. Use `people/me` to indicate the authenticated
3804user.
3805<br>
3806The request throws a 400 error if 'personFields' is not specified.
3807
3808Args:
3809 resourceNames: string, The resource names of the people to provide information about.
3810
3811- To get information about the authenticated user, specify `people/me`.
3812- To get information about a google account, specify
3813 `people/`<var>account_id</var>.
3814- To get information about a contact, specify the resource name that
3815 identifies the contact as returned by
3816[`people.connections.list`](/people/api/rest/v1/people.connections/list).
3817
3818You can include up to 50 resource names in one request. (repeated)
3819 x__xgafv: string, V1 error format.
3820 Allowed values
3821 1 - v1 error format
3822 2 - v2 error format
3823 requestMask_includeField: string, **Required.** Comma-separated list of person fields to be included in the
3824response. Each path should start with `person.`: for example,
3825`person.names` or `person.photos`.
3826 personFields: string, **Required.** A field mask to restrict which fields on each person are
3827returned. Multiple fields can be specified by separating them with commas.
3828Valid values are:
3829
3830* addresses
3831* ageRanges
3832* biographies
3833* birthdays
3834* braggingRights
3835* coverPhotos
3836* emailAddresses
3837* events
3838* genders
3839* imClients
3840* interests
3841* locales
3842* memberships
3843* metadata
3844* names
3845* nicknames
3846* occupations
3847* organizations
3848* phoneNumbers
3849* photos
3850* relations
3851* relationshipInterests
3852* relationshipStatuses
3853* residences
3854* sipAddresses
3855* skills
3856* taglines
3857* urls
3858* userDefined
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]3859
3860Returns:
3861 An object of the form:
3862
3863 {
3864 "responses": [ # The response for each requested resource name.
3865 { # The response for a single person
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3866 "status": { # The `Status` type defines a logical error model that is suitable for # The status of the response.
3867 # different programming environments, including REST APIs and RPC APIs. It is
3868 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
3869 # three pieces of data: error code, error message, and error details.
3870 #
3871 # You can find out more about this error model and how to work with it in the
3872 # [API Design Guide](https://cloud.google.com/apis/design/errors).
3873 "message": "A String", # A developer-facing error message, which should be in English. Any
3874 # user-facing error message should be localized and sent in the
3875 # google.rpc.Status.details field, or localized by the client.
3876 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
3877 "details": [ # A list of messages that carry the error details. There is a common set of
3878 # message types for APIs to use.
3879 {
3880 "a_key": "", # Properties of the object. Contains field @type with type URL.
3881 },
3882 ],
3883 },
3884 "person": { # Information about a person merged from various data sources such as the # The person.
3885 # authenticated user's contacts and profile data.
3886 #
3887 # Most fields can have multiple items. The items in a field have no guaranteed
3888 # order, but each non-empty field is guaranteed to have exactly one field with
3889 # `metadata.primary` set to true.
3890 "sipAddresses": [ # The person's SIP addresses.
3891 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
3892 # communications to make voice or video calls over the internet.
3893 "formattedType": "A String", # The read-only type of the SIP address translated and formatted in the
3894 # viewer's account locale or the `Accept-Language` HTTP header locale.
3895 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
3896 # predefined values:
3897 #
3898 # * `home`
3899 # * `work`
3900 # * `mobile`
3901 # * `other`
3902 "value": "A String", # The SIP address in the
3903 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
3904 # format.
3905 "metadata": { # Metadata about a field. # Metadata about the SIP address.
3906 "source": { # The source of a field. # The source of the field.
3907 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3908 #
3909 # Last update timestamp of this source.
3910 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3911 #
3912 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3913 # source. Used for web cache validation.
3914 "type": "A String", # The source type.
3915 "id": "A String", # The unique identifier within the source type generated by the server.
3916 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3917 #
3918 # Metadata about a source of type PROFILE.
3919 "userTypes": [ # The user types.
3920 "A String",
3921 ],
3922 "objectType": "A String", # The profile object type.
3923 },
3924 },
3925 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3926 # verified field is typically a name, email address, phone number, or
3927 # website that has been confirmed to be owned by the person.
3928 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3929 # field.
3930 },
3931 },
3932 ],
3933 "phoneNumbers": [ # The person's phone numbers.
3934 { # A person's phone number.
3935 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
3936 # viewer's account locale or the `Accept-Language` HTTP header locale.
3937 "canonicalForm": "A String", # The read-only canonicalized [ITU-T
3938 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
3939 # form of the phone number.
3940 "type": "A String", # The type of the phone number. The type can be custom or one of these
3941 # predefined values:
3942 #
3943 # * `home`
3944 # * `work`
3945 # * `mobile`
3946 # * `homeFax`
3947 # * `workFax`
3948 # * `otherFax`
3949 # * `pager`
3950 # * `workMobile`
3951 # * `workPager`
3952 # * `main`
3953 # * `googleVoice`
3954 # * `other`
3955 "value": "A String", # The phone number.
3956 "metadata": { # Metadata about a field. # Metadata about the phone number.
3957 "source": { # The source of a field. # The source of the field.
3958 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
3959 #
3960 # Last update timestamp of this source.
3961 "etag": "A String", # **Only populated in `person.metadata.sources`.**
3962 #
3963 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
3964 # source. Used for web cache validation.
3965 "type": "A String", # The source type.
3966 "id": "A String", # The unique identifier within the source type generated by the server.
3967 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
3968 #
3969 # Metadata about a source of type PROFILE.
3970 "userTypes": [ # The user types.
3971 "A String",
3972 ],
3973 "objectType": "A String", # The profile object type.
3974 },
3975 },
3976 "verified": True or False, # True if the field is verified; false if the field is unverified. A
3977 # verified field is typically a name, email address, phone number, or
3978 # website that has been confirmed to be owned by the person.
3979 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
3980 # field.
3981 },
3982 },
3983 ],
3984 "addresses": [ # The person's street addresses.
3985 { # A person's physical address. May be a P.O. box or street address. All fields
3986 # are optional.
3987 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
3988 # account locale or the `Accept-Language` HTTP header locale.
3989 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
3990 # code of the address.
3991 "city": "A String", # The city of the address.
3992 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
3993 # will be automatically constructed from structured values.
3994 "region": "A String", # The region of the address; for example, the state or province.
3995 "poBox": "A String", # The P.O. box of the address.
3996 "streetAddress": "A String", # The street address.
3997 "country": "A String", # The country of the address.
3998 "postalCode": "A String", # The postal code of the address.
3999 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
4000 "type": "A String", # The type of the address. The type can be custom or one of these predefined
4001 # values:
4002 #
4003 # * `home`
4004 # * `work`
4005 # * `other`
4006 "metadata": { # Metadata about a field. # Metadata about the address.
4007 "source": { # The source of a field. # The source of the field.
4008 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4009 #
4010 # Last update timestamp of this source.
4011 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4012 #
4013 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4014 # source. Used for web cache validation.
4015 "type": "A String", # The source type.
4016 "id": "A String", # The unique identifier within the source type generated by the server.
4017 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4018 #
4019 # Metadata about a source of type PROFILE.
4020 "userTypes": [ # The user types.
4021 "A String",
4022 ],
4023 "objectType": "A String", # The profile object type.
4024 },
4025 },
4026 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4027 # verified field is typically a name, email address, phone number, or
4028 # website that has been confirmed to be owned by the person.
4029 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4030 # field.
4031 },
4032 },
4033 ],
4034 "nicknames": [ # The person's nicknames.
4035 { # A person's nickname.
4036 "type": "A String", # The type of the nickname.
4037 "value": "A String", # The nickname.
4038 "metadata": { # Metadata about a field. # Metadata about the nickname.
4039 "source": { # The source of a field. # The source of the field.
4040 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4041 #
4042 # Last update timestamp of this source.
4043 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4044 #
4045 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4046 # source. Used for web cache validation.
4047 "type": "A String", # The source type.
4048 "id": "A String", # The unique identifier within the source type generated by the server.
4049 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4050 #
4051 # Metadata about a source of type PROFILE.
4052 "userTypes": [ # The user types.
4053 "A String",
4054 ],
4055 "objectType": "A String", # The profile object type.
4056 },
4057 },
4058 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4059 # verified field is typically a name, email address, phone number, or
4060 # website that has been confirmed to be owned by the person.
4061 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4062 # field.
4063 },
4064 },
4065 ],
4066 "occupations": [ # The person's occupations.
4067 { # A person's occupation.
4068 "value": "A String", # The occupation; for example, `carpenter`.
4069 "metadata": { # Metadata about a field. # Metadata about the occupation.
4070 "source": { # The source of a field. # The source of the field.
4071 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4072 #
4073 # Last update timestamp of this source.
4074 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4075 #
4076 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4077 # source. Used for web cache validation.
4078 "type": "A String", # The source type.
4079 "id": "A String", # The unique identifier within the source type generated by the server.
4080 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4081 #
4082 # Metadata about a source of type PROFILE.
4083 "userTypes": [ # The user types.
4084 "A String",
4085 ],
4086 "objectType": "A String", # The profile object type.
4087 },
4088 },
4089 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4090 # verified field is typically a name, email address, phone number, or
4091 # website that has been confirmed to be owned by the person.
4092 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4093 # field.
4094 },
4095 },
4096 ],
4097 "braggingRights": [ # The person's bragging rights.
4098 { # A person's bragging rights.
4099 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
4100 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
4101 "source": { # The source of a field. # The source of the field.
4102 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4103 #
4104 # Last update timestamp of this source.
4105 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4106 #
4107 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4108 # source. Used for web cache validation.
4109 "type": "A String", # The source type.
4110 "id": "A String", # The unique identifier within the source type generated by the server.
4111 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4112 #
4113 # Metadata about a source of type PROFILE.
4114 "userTypes": [ # The user types.
4115 "A String",
4116 ],
4117 "objectType": "A String", # The profile object type.
4118 },
4119 },
4120 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4121 # verified field is typically a name, email address, phone number, or
4122 # website that has been confirmed to be owned by the person.
4123 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4124 # field.
4125 },
4126 },
4127 ],
4128 "names": [ # The person's names.
4129 { # A person's name. If the name is a mononym, the family name is empty.
4130 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
4131 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
4132 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
4133 "displayName": "A String", # The read-only display name formatted according to the locale specified by
4134 # the viewer's account or the `Accept-Language` HTTP header.
4135 "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
4136 # the locale specified by the viewer's account or the
4137 # `Accept-Language` HTTP header.
4138 "middleName": "A String", # The middle name(s).
4139 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
4140 "familyName": "A String", # The family name.
4141 "phoneticFullName": "A String", # The full name spelled as it sounds.
4142 "phoneticGivenName": "A String", # The given name spelled as it sounds.
4143 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
4144 "givenName": "A String", # The given name.
4145 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
4146 "metadata": { # Metadata about a field. # Metadata about the name.
4147 "source": { # The source of a field. # The source of the field.
4148 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4149 #
4150 # Last update timestamp of this source.
4151 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4152 #
4153 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4154 # source. Used for web cache validation.
4155 "type": "A String", # The source type.
4156 "id": "A String", # The unique identifier within the source type generated by the server.
4157 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4158 #
4159 # Metadata about a source of type PROFILE.
4160 "userTypes": [ # The user types.
4161 "A String",
4162 ],
4163 "objectType": "A String", # The profile object type.
4164 },
4165 },
4166 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4167 # verified field is typically a name, email address, phone number, or
4168 # website that has been confirmed to be owned by the person.
4169 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4170 # field.
4171 },
4172 },
4173 ],
4174 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
4175 # with a max length of 27 characters, in the form of
4176 # `people/`<var>person_id</var>.
4177 "taglines": [ # The person's read-only taglines.
4178 { # A read-only brief one-line description of the person.
4179 "value": "A String", # The tagline.
4180 "metadata": { # Metadata about a field. # Metadata about the tagline.
4181 "source": { # The source of a field. # The source of the field.
4182 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4183 #
4184 # Last update timestamp of this source.
4185 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4186 #
4187 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4188 # source. Used for web cache validation.
4189 "type": "A String", # The source type.
4190 "id": "A String", # The unique identifier within the source type generated by the server.
4191 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4192 #
4193 # Metadata about a source of type PROFILE.
4194 "userTypes": [ # The user types.
4195 "A String",
4196 ],
4197 "objectType": "A String", # The profile object type.
4198 },
4199 },
4200 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4201 # verified field is typically a name, email address, phone number, or
4202 # website that has been confirmed to be owned by the person.
4203 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4204 # field.
4205 },
4206 },
4207 ],
4208 "ageRanges": [ # The person's read-only age ranges.
4209 { # A person's age range.
4210 "ageRange": "A String", # The age range.
4211 "metadata": { # Metadata about a field. # Metadata about the age range.
4212 "source": { # The source of a field. # The source of the field.
4213 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4214 #
4215 # Last update timestamp of this source.
4216 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4217 #
4218 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4219 # source. Used for web cache validation.
4220 "type": "A String", # The source type.
4221 "id": "A String", # The unique identifier within the source type generated by the server.
4222 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4223 #
4224 # Metadata about a source of type PROFILE.
4225 "userTypes": [ # The user types.
4226 "A String",
4227 ],
4228 "objectType": "A String", # The profile object type.
4229 },
4230 },
4231 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4232 # verified field is typically a name, email address, phone number, or
4233 # website that has been confirmed to be owned by the person.
4234 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4235 # field.
4236 },
4237 },
4238 ],
4239 "birthdays": [ # The person's birthdays.
4240 { # A person's birthday. At least one of the `date` and `text` fields are
4241 # specified. The `date` and `text` fields typically represent the same
4242 # date, but are not guaranteed to.
4243 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
4244 # of day and time zone are either specified elsewhere or are not
4245 # significant. The date is relative to the
4246 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
4247 # The day may be 0 to represent a year and month where the day is not
4248 # significant. The year may be 0 to represent a month and day independent
4249 # of year; for example, anniversary date.
4250 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4251 # month and day.
4252 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4253 # if specifying a year by itself or a year and month where the day is not
4254 # significant.
4255 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4256 # a year.
4257 },
4258 "text": "A String", # A free-form string representing the user's birthday.
4259 "metadata": { # Metadata about a field. # Metadata about the birthday.
4260 "source": { # The source of a field. # The source of the field.
4261 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4262 #
4263 # Last update timestamp of this source.
4264 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4265 #
4266 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4267 # source. Used for web cache validation.
4268 "type": "A String", # The source type.
4269 "id": "A String", # The unique identifier within the source type generated by the server.
4270 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4271 #
4272 # Metadata about a source of type PROFILE.
4273 "userTypes": [ # The user types.
4274 "A String",
4275 ],
4276 "objectType": "A String", # The profile object type.
4277 },
4278 },
4279 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4280 # verified field is typically a name, email address, phone number, or
4281 # website that has been confirmed to be owned by the person.
4282 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4283 # field.
4284 },
4285 },
4286 ],
4287 "relations": [ # The person's relations.
4288 { # A person's relation to another person.
4289 "person": "A String", # The name of the other person this relation refers to.
4290 "metadata": { # Metadata about a field. # Metadata about the relation.
4291 "source": { # The source of a field. # The source of the field.
4292 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4293 #
4294 # Last update timestamp of this source.
4295 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4296 #
4297 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4298 # source. Used for web cache validation.
4299 "type": "A String", # The source type.
4300 "id": "A String", # The unique identifier within the source type generated by the server.
4301 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4302 #
4303 # Metadata about a source of type PROFILE.
4304 "userTypes": [ # The user types.
4305 "A String",
4306 ],
4307 "objectType": "A String", # The profile object type.
4308 },
4309 },
4310 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4311 # verified field is typically a name, email address, phone number, or
4312 # website that has been confirmed to be owned by the person.
4313 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4314 # field.
4315 },
4316 "type": "A String", # The person's relation to the other person. The type can be custom or one of
4317 # these predefined values:
4318 #
4319 # * `spouse`
4320 # * `child`
4321 # * `mother`
4322 # * `father`
4323 # * `parent`
4324 # * `brother`
4325 # * `sister`
4326 # * `friend`
4327 # * `relative`
4328 # * `domesticPartner`
4329 # * `manager`
4330 # * `assistant`
4331 # * `referredBy`
4332 # * `partner`
4333 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
4334 # locale or the locale specified in the Accept-Language HTTP header.
4335 },
4336 ],
4337 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4338 # resource. Used for web cache validation.
4339 "relationshipStatuses": [ # The person's read-only relationship statuses.
4340 { # A person's read-only relationship status.
4341 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
4342 # the viewer's account locale or the `Accept-Language` HTTP header locale.
4343 "value": "A String", # The relationship status. The value can be custom or one of these
4344 # predefined values:
4345 #
4346 # * `single`
4347 # * `inARelationship`
4348 # * `engaged`
4349 # * `married`
4350 # * `itsComplicated`
4351 # * `openRelationship`
4352 # * `widowed`
4353 # * `inDomesticPartnership`
4354 # * `inCivilUnion`
4355 "metadata": { # Metadata about a field. # Metadata about the relationship status.
4356 "source": { # The source of a field. # The source of the field.
4357 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4358 #
4359 # Last update timestamp of this source.
4360 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4361 #
4362 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4363 # source. Used for web cache validation.
4364 "type": "A String", # The source type.
4365 "id": "A String", # The unique identifier within the source type generated by the server.
4366 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4367 #
4368 # Metadata about a source of type PROFILE.
4369 "userTypes": [ # The user types.
4370 "A String",
4371 ],
4372 "objectType": "A String", # The profile object type.
4373 },
4374 },
4375 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4376 # verified field is typically a name, email address, phone number, or
4377 # website that has been confirmed to be owned by the person.
4378 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4379 # field.
4380 },
4381 },
4382 ],
4383 "imClients": [ # The person's instant messaging clients.
4384 { # A person's instant messaging client.
4385 "username": "A String", # The user name used in the IM client.
4386 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
4387 # viewer's account locale or the `Accept-Language` HTTP header locale.
4388 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
4389 # predefined values:
4390 #
4391 # * `aim`
4392 # * `msn`
4393 # * `yahoo`
4394 # * `skype`
4395 # * `qq`
4396 # * `googleTalk`
4397 # * `icq`
4398 # * `jabber`
4399 # * `netMeeting`
4400 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
4401 # locale or the `Accept-Language` HTTP header locale.
4402 "type": "A String", # The type of the IM client. The type can be custom or one of these
4403 # predefined values:
4404 #
4405 # * `home`
4406 # * `work`
4407 # * `other`
4408 "metadata": { # Metadata about a field. # Metadata about the IM client.
4409 "source": { # The source of a field. # The source of the field.
4410 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4411 #
4412 # Last update timestamp of this source.
4413 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4414 #
4415 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4416 # source. Used for web cache validation.
4417 "type": "A String", # The source type.
4418 "id": "A String", # The unique identifier within the source type generated by the server.
4419 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4420 #
4421 # Metadata about a source of type PROFILE.
4422 "userTypes": [ # The user types.
4423 "A String",
4424 ],
4425 "objectType": "A String", # The profile object type.
4426 },
4427 },
4428 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4429 # verified field is typically a name, email address, phone number, or
4430 # website that has been confirmed to be owned by the person.
4431 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4432 # field.
4433 },
4434 },
4435 ],
4436 "events": [ # The person's events.
4437 { # An event related to the person.
4438 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
4439 # of day and time zone are either specified elsewhere or are not
4440 # significant. The date is relative to the
4441 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
4442 # The day may be 0 to represent a year and month where the day is not
4443 # significant. The year may be 0 to represent a month and day independent
4444 # of year; for example, anniversary date.
4445 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4446 # month and day.
4447 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4448 # if specifying a year by itself or a year and month where the day is not
4449 # significant.
4450 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4451 # a year.
4452 },
4453 "formattedType": "A String", # The read-only type of the event translated and formatted in the
4454 # viewer's account locale or the `Accept-Language` HTTP header locale.
4455 "type": "A String", # The type of the event. The type can be custom or one of these predefined
4456 # values:
4457 #
4458 # * `anniversary`
4459 # * `other`
4460 "metadata": { # Metadata about a field. # Metadata about the event.
4461 "source": { # The source of a field. # The source of the field.
4462 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4463 #
4464 # Last update timestamp of this source.
4465 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4466 #
4467 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4468 # source. Used for web cache validation.
4469 "type": "A String", # The source type.
4470 "id": "A String", # The unique identifier within the source type generated by the server.
4471 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4472 #
4473 # Metadata about a source of type PROFILE.
4474 "userTypes": [ # The user types.
4475 "A String",
4476 ],
4477 "objectType": "A String", # The profile object type.
4478 },
4479 },
4480 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4481 # verified field is typically a name, email address, phone number, or
4482 # website that has been confirmed to be owned by the person.
4483 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4484 # field.
4485 },
4486 },
4487 ],
4488 "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
4489 "previousResourceNames": [ # Any former resource names this person has had. Populated only for
4490 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
4491 # that include a sync token.
4492 #
4493 # The resource name may change when adding or removing fields that link a
4494 # contact and profile such as a verified email, verified phone number, or
4495 # profile URL.
4496 "A String",
4497 ],
4498 "sources": [ # The sources of data for the person.
4499 { # The source of a field.
4500 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4501 #
4502 # Last update timestamp of this source.
4503 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4504 #
4505 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4506 # source. Used for web cache validation.
4507 "type": "A String", # The source type.
4508 "id": "A String", # The unique identifier within the source type generated by the server.
4509 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4510 #
4511 # Metadata about a source of type PROFILE.
4512 "userTypes": [ # The user types.
4513 "A String",
4514 ],
4515 "objectType": "A String", # The profile object type.
4516 },
4517 },
4518 ],
4519 "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
4520 "A String",
4521 ],
4522 "deleted": True or False, # True if the person resource has been deleted. Populated only for
4523 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
4524 # that include a sync token.
4525 "objectType": "A String", # **DEPRECATED** (Please use
4526 # `person.metadata.sources.profileMetadata.objectType` instead)
4527 #
4528 # The type of the person object.
4529 },
4530 "interests": [ # The person's interests.
4531 { # One of the person's interests.
4532 "value": "A String", # The interest; for example, `stargazing`.
4533 "metadata": { # Metadata about a field. # Metadata about the interest.
4534 "source": { # The source of a field. # The source of the field.
4535 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4536 #
4537 # Last update timestamp of this source.
4538 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4539 #
4540 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4541 # source. Used for web cache validation.
4542 "type": "A String", # The source type.
4543 "id": "A String", # The unique identifier within the source type generated by the server.
4544 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4545 #
4546 # Metadata about a source of type PROFILE.
4547 "userTypes": [ # The user types.
4548 "A String",
4549 ],
4550 "objectType": "A String", # The profile object type.
4551 },
4552 },
4553 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4554 # verified field is typically a name, email address, phone number, or
4555 # website that has been confirmed to be owned by the person.
4556 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4557 # field.
4558 },
4559 },
4560 ],
4561 "photos": [ # The person's read-only photos.
4562 { # A person's read-only photo. A picture shown next to the person's name to
4563 # help others recognize the person.
4564 "default": True or False, # True if the photo is a default photo;
4565 # false if the photo is a user-provided photo.
4566 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
4567 # parameter `sz=`<var>size</var> at the end of the url. Example:
4568 # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
4569 "metadata": { # Metadata about a field. # Metadata about the photo.
4570 "source": { # The source of a field. # The source of the field.
4571 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4572 #
4573 # Last update timestamp of this source.
4574 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4575 #
4576 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4577 # source. Used for web cache validation.
4578 "type": "A String", # The source type.
4579 "id": "A String", # The unique identifier within the source type generated by the server.
4580 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4581 #
4582 # Metadata about a source of type PROFILE.
4583 "userTypes": [ # The user types.
4584 "A String",
4585 ],
4586 "objectType": "A String", # The profile object type.
4587 },
4588 },
4589 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4590 # verified field is typically a name, email address, phone number, or
4591 # website that has been confirmed to be owned by the person.
4592 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4593 # field.
4594 },
4595 },
4596 ],
4597 "residences": [ # The person's residences.
4598 { # A person's past or current residence.
4599 "current": True or False, # True if the residence is the person's current residence;
4600 # false if the residence is a past residence.
4601 "value": "A String", # The address of the residence.
4602 "metadata": { # Metadata about a field. # Metadata about the residence.
4603 "source": { # The source of a field. # The source of the field.
4604 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4605 #
4606 # Last update timestamp of this source.
4607 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4608 #
4609 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4610 # source. Used for web cache validation.
4611 "type": "A String", # The source type.
4612 "id": "A String", # The unique identifier within the source type generated by the server.
4613 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4614 #
4615 # Metadata about a source of type PROFILE.
4616 "userTypes": [ # The user types.
4617 "A String",
4618 ],
4619 "objectType": "A String", # The profile object type.
4620 },
4621 },
4622 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4623 # verified field is typically a name, email address, phone number, or
4624 # website that has been confirmed to be owned by the person.
4625 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4626 # field.
4627 },
4628 },
4629 ],
4630 "relationshipInterests": [ # The person's read-only relationship interests.
4631 { # A person's read-only relationship interest .
4632 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
4633 # viewer's account locale or the locale specified in the Accept-Language
4634 # HTTP header.
4635 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
4636 # or one of these predefined values:
4637 #
4638 # * `friend`
4639 # * `date`
4640 # * `relationship`
4641 # * `networking`
4642 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
4643 "source": { # The source of a field. # The source of the field.
4644 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4645 #
4646 # Last update timestamp of this source.
4647 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4648 #
4649 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4650 # source. Used for web cache validation.
4651 "type": "A String", # The source type.
4652 "id": "A String", # The unique identifier within the source type generated by the server.
4653 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4654 #
4655 # Metadata about a source of type PROFILE.
4656 "userTypes": [ # The user types.
4657 "A String",
4658 ],
4659 "objectType": "A String", # The profile object type.
4660 },
4661 },
4662 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4663 # verified field is typically a name, email address, phone number, or
4664 # website that has been confirmed to be owned by the person.
4665 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4666 # field.
4667 },
4668 },
4669 ],
4670 "coverPhotos": [ # The person's read-only cover photos.
4671 { # A person's read-only cover photo. A large image shown on the person's
4672 # profile page that represents who they are or what they care about.
4673 "default": True or False, # True if the cover photo is the default cover photo;
4674 # false if the cover photo is a user-provided cover photo.
4675 "url": "A String", # The URL of the cover photo.
4676 "metadata": { # Metadata about a field. # Metadata about the cover photo.
4677 "source": { # The source of a field. # The source of the field.
4678 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4679 #
4680 # Last update timestamp of this source.
4681 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4682 #
4683 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4684 # source. Used for web cache validation.
4685 "type": "A String", # The source type.
4686 "id": "A String", # The unique identifier within the source type generated by the server.
4687 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4688 #
4689 # Metadata about a source of type PROFILE.
4690 "userTypes": [ # The user types.
4691 "A String",
4692 ],
4693 "objectType": "A String", # The profile object type.
4694 },
4695 },
4696 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4697 # verified field is typically a name, email address, phone number, or
4698 # website that has been confirmed to be owned by the person.
4699 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4700 # field.
4701 },
4702 },
4703 ],
4704 "locales": [ # The person's locale preferences.
4705 { # A person's locale preference.
4706 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
4707 # language tag representing the locale.
4708 "metadata": { # Metadata about a field. # Metadata about the locale.
4709 "source": { # The source of a field. # The source of the field.
4710 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4711 #
4712 # Last update timestamp of this source.
4713 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4714 #
4715 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4716 # source. Used for web cache validation.
4717 "type": "A String", # The source type.
4718 "id": "A String", # The unique identifier within the source type generated by the server.
4719 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4720 #
4721 # Metadata about a source of type PROFILE.
4722 "userTypes": [ # The user types.
4723 "A String",
4724 ],
4725 "objectType": "A String", # The profile object type.
4726 },
4727 },
4728 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4729 # verified field is typically a name, email address, phone number, or
4730 # website that has been confirmed to be owned by the person.
4731 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4732 # field.
4733 },
4734 },
4735 ],
4736 "organizations": [ # The person's past or current organizations.
4737 { # A person's past or current organization. Overlapping date ranges are
4738 # permitted.
4739 "formattedType": "A String", # The read-only type of the organization translated and formatted in the
4740 # viewer's account locale or the `Accept-Language` HTTP header locale.
4741 "domain": "A String", # The domain name associated with the organization; for example,
4742 # `google.com`.
4743 "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
4744 # of day and time zone are either specified elsewhere or are not
4745 # significant. The date is relative to the
4746 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
4747 # The day may be 0 to represent a year and month where the day is not
4748 # significant. The year may be 0 to represent a month and day independent
4749 # of year; for example, anniversary date.
4750 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4751 # month and day.
4752 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4753 # if specifying a year by itself or a year and month where the day is not
4754 # significant.
4755 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4756 # a year.
4757 },
4758 "name": "A String", # The name of the organization.
4759 "title": "A String", # The person's job title at the organization.
4760 "type": "A String", # The type of the organization. The type can be custom or one of these
4761 # predefined values:
4762 #
4763 # * `work`
4764 # * `school`
4765 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
4766 # symbol, abbreviation, or acronym.
4767 "current": True or False, # True if the organization is the person's current organization;
4768 # false if the organization is a past organization.
4769 "jobDescription": "A String", # The person's job description at the organization.
4770 "location": "A String", # The location of the organization office the person works at.
4771 "department": "A String", # The person's department at the organization.
4772 "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
4773 # of day and time zone are either specified elsewhere or are not
4774 # significant. The date is relative to the
4775 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
4776 # The day may be 0 to represent a year and month where the day is not
4777 # significant. The year may be 0 to represent a month and day independent
4778 # of year; for example, anniversary date.
4779 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
4780 # month and day.
4781 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
4782 # if specifying a year by itself or a year and month where the day is not
4783 # significant.
4784 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
4785 # a year.
4786 },
4787 "phoneticName": "A String", # The phonetic name of the organization.
4788 "metadata": { # Metadata about a field. # Metadata about the organization.
4789 "source": { # The source of a field. # The source of the field.
4790 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4791 #
4792 # Last update timestamp of this source.
4793 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4794 #
4795 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4796 # source. Used for web cache validation.
4797 "type": "A String", # The source type.
4798 "id": "A String", # The unique identifier within the source type generated by the server.
4799 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4800 #
4801 # Metadata about a source of type PROFILE.
4802 "userTypes": [ # The user types.
4803 "A String",
4804 ],
4805 "objectType": "A String", # The profile object type.
4806 },
4807 },
4808 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4809 # verified field is typically a name, email address, phone number, or
4810 # website that has been confirmed to be owned by the person.
4811 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4812 # field.
4813 },
4814 },
4815 ],
4816 "userDefined": [ # The person's user defined data.
4817 { # Arbitrary user data that is populated by the end users.
4818 "key": "A String", # The end user specified key of the user defined data.
4819 "value": "A String", # The end user specified value of the user defined data.
4820 "metadata": { # Metadata about a field. # Metadata about the user defined data.
4821 "source": { # The source of a field. # The source of the field.
4822 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4823 #
4824 # Last update timestamp of this source.
4825 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4826 #
4827 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4828 # source. Used for web cache validation.
4829 "type": "A String", # The source type.
4830 "id": "A String", # The unique identifier within the source type generated by the server.
4831 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4832 #
4833 # Metadata about a source of type PROFILE.
4834 "userTypes": [ # The user types.
4835 "A String",
4836 ],
4837 "objectType": "A String", # The profile object type.
4838 },
4839 },
4840 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4841 # verified field is typically a name, email address, phone number, or
4842 # website that has been confirmed to be owned by the person.
4843 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4844 # field.
4845 },
4846 },
4847 ],
4848 "biographies": [ # The person's biographies.
4849 { # A person's short biography.
4850 "contentType": "A String", # The content type of the biography.
4851 "value": "A String", # The short biography.
4852 "metadata": { # Metadata about a field. # Metadata about the biography.
4853 "source": { # The source of a field. # The source of the field.
4854 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4855 #
4856 # Last update timestamp of this source.
4857 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4858 #
4859 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4860 # source. Used for web cache validation.
4861 "type": "A String", # The source type.
4862 "id": "A String", # The unique identifier within the source type generated by the server.
4863 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4864 #
4865 # Metadata about a source of type PROFILE.
4866 "userTypes": [ # The user types.
4867 "A String",
4868 ],
4869 "objectType": "A String", # The profile object type.
4870 },
4871 },
4872 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4873 # verified field is typically a name, email address, phone number, or
4874 # website that has been confirmed to be owned by the person.
4875 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4876 # field.
4877 },
4878 },
4879 ],
4880 "memberships": [ # The person's group memberships.
4881 { # A person's membership in a group. Only contact group memberships can be
4882 # modified.
4883 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
4884 "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
4885 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
4886 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
4887 # Only contact_group_resource_name can be used for modifying memberships.
4888 # Any contact group membership can be removed, but only user group or
4889 # "myContacts" or "starred" system groups memberships can be added. A
4890 # contact must always have at least one contact group membership.
4891 },
4892 "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain membership.
4893 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
4894 },
4895 "metadata": { # Metadata about a field. # Metadata about the membership.
4896 "source": { # The source of a field. # The source of the field.
4897 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4898 #
4899 # Last update timestamp of this source.
4900 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4901 #
4902 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4903 # source. Used for web cache validation.
4904 "type": "A String", # The source type.
4905 "id": "A String", # The unique identifier within the source type generated by the server.
4906 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4907 #
4908 # Metadata about a source of type PROFILE.
4909 "userTypes": [ # The user types.
4910 "A String",
4911 ],
4912 "objectType": "A String", # The profile object type.
4913 },
4914 },
4915 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4916 # verified field is typically a name, email address, phone number, or
4917 # website that has been confirmed to be owned by the person.
4918 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4919 # field.
4920 },
4921 },
4922 ],
4923 "skills": [ # The person's skills.
4924 { # A skill that the person has.
4925 "value": "A String", # The skill; for example, `underwater basket weaving`.
4926 "metadata": { # Metadata about a field. # Metadata about the skill.
4927 "source": { # The source of a field. # The source of the field.
4928 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4929 #
4930 # Last update timestamp of this source.
4931 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4932 #
4933 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4934 # source. Used for web cache validation.
4935 "type": "A String", # The source type.
4936 "id": "A String", # The unique identifier within the source type generated by the server.
4937 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4938 #
4939 # Metadata about a source of type PROFILE.
4940 "userTypes": [ # The user types.
4941 "A String",
4942 ],
4943 "objectType": "A String", # The profile object type.
4944 },
4945 },
4946 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4947 # verified field is typically a name, email address, phone number, or
4948 # website that has been confirmed to be owned by the person.
4949 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4950 # field.
4951 },
4952 },
4953 ],
4954 "urls": [ # The person's associated URLs.
4955 { # A person's associated URLs.
4956 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
4957 # account locale or the `Accept-Language` HTTP header locale.
4958 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
4959 # values:
4960 #
4961 # * `home`
4962 # * `work`
4963 # * `blog`
4964 # * `profile`
4965 # * `homePage`
4966 # * `ftp`
4967 # * `reservations`
4968 # * `appInstallPage`: website for a Google+ application.
4969 # * `other`
4970 "value": "A String", # The URL.
4971 "metadata": { # Metadata about a field. # Metadata about the URL.
4972 "source": { # The source of a field. # The source of the field.
4973 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
4974 #
4975 # Last update timestamp of this source.
4976 "etag": "A String", # **Only populated in `person.metadata.sources`.**
4977 #
4978 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
4979 # source. Used for web cache validation.
4980 "type": "A String", # The source type.
4981 "id": "A String", # The unique identifier within the source type generated by the server.
4982 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
4983 #
4984 # Metadata about a source of type PROFILE.
4985 "userTypes": [ # The user types.
4986 "A String",
4987 ],
4988 "objectType": "A String", # The profile object type.
4989 },
4990 },
4991 "verified": True or False, # True if the field is verified; false if the field is unverified. A
4992 # verified field is typically a name, email address, phone number, or
4993 # website that has been confirmed to be owned by the person.
4994 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
4995 # field.
4996 },
4997 },
4998 ],
4999 "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
5000 #
5001 # The person's read-only age range.
5002 "genders": [ # The person's genders.
5003 { # A person's gender.
5004 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
5005 # account locale or the `Accept-Language` HTTP header locale.
5006 "value": "A String", # The gender for the person. The gender can be custom or one of these
5007 # predefined values:
5008 #
5009 # * `male`
5010 # * `female`
5011 # * `other`
5012 # * `unknown`
5013 "metadata": { # Metadata about a field. # Metadata about the gender.
5014 "source": { # The source of a field. # The source of the field.
5015 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5016 #
5017 # Last update timestamp of this source.
5018 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5019 #
5020 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5021 # source. Used for web cache validation.
5022 "type": "A String", # The source type.
5023 "id": "A String", # The unique identifier within the source type generated by the server.
5024 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5025 #
5026 # Metadata about a source of type PROFILE.
5027 "userTypes": [ # The user types.
5028 "A String",
5029 ],
5030 "objectType": "A String", # The profile object type.
5031 },
5032 },
5033 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5034 # verified field is typically a name, email address, phone number, or
5035 # website that has been confirmed to be owned by the person.
5036 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5037 # field.
5038 },
5039 },
5040 ],
5041 "emailAddresses": [ # The person's email addresses.
5042 { # A person's email address.
5043 "type": "A String", # The type of the email address. The type can be custom or one of these
5044 # predefined values:
5045 #
5046 # * `home`
5047 # * `work`
5048 # * `other`
5049 "formattedType": "A String", # The read-only type of the email address translated and formatted in the
5050 # viewer's account locale or the `Accept-Language` HTTP header locale.
5051 "displayName": "A String", # The display name of the email.
5052 "value": "A String", # The email address.
5053 "metadata": { # Metadata about a field. # Metadata about the email address.
5054 "source": { # The source of a field. # The source of the field.
5055 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5056 #
5057 # Last update timestamp of this source.
5058 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5059 #
5060 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5061 # source. Used for web cache validation.
5062 "type": "A String", # The source type.
5063 "id": "A String", # The unique identifier within the source type generated by the server.
5064 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5065 #
5066 # Metadata about a source of type PROFILE.
5067 "userTypes": [ # The user types.
5068 "A String",
5069 ],
5070 "objectType": "A String", # The profile object type.
5071 },
5072 },
5073 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5074 # verified field is typically a name, email address, phone number, or
5075 # website that has been confirmed to be owned by the person.
5076 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5077 # field.
5078 },
5079 },
5080 ],
5081 },
5082 "httpStatusCode": 42, # **DEPRECATED** (Please use status instead)
5083 #
5084 # [HTTP 1.1 status code]
5085 # (http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]5086 "requestedResourceName": "A String", # The original requested resource name. May be different than the resource
5087 # name on the returned person.
5088 #
5089 # The resource name can change when adding or removing fields that link a
5090 # contact and profile such as a verified email, verified phone number, or a
5091 # profile URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]5092 },
5093 ],
5094 }</pre>
5095</div>
5096
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]5097<div class="method">
5098 <code class="details" id="updateContact">updateContact(resourceName, body, updatePersonFields=None, x__xgafv=None)</code>
5099 <pre>Update contact data for an existing contact person. Any non-contact data
5100will not be modified.
5101
5102The request throws a 400 error if `updatePersonFields` is not specified.
5103<br>
5104The request throws a 400 error if `person.metadata.sources` is not
5105specified for the contact to be updated.
5106<br>
5107The request throws a 412 error if `person.metadata.sources.etag` is
5108different than the contact's etag, which indicates the contact has changed
5109since its data was read. Clients should get the latest person and re-apply
5110their updates to the latest person.
5111
5112Args:
5113 resourceName: string, The resource name for the person, assigned by the server. An ASCII string
5114with a max length of 27 characters, in the form of
5115`people/`<var>person_id</var>. (required)
5116 body: object, The request body. (required)
5117 The object takes the form of:
5118
5119{ # Information about a person merged from various data sources such as the
5120 # authenticated user's contacts and profile data.
5121 #
5122 # Most fields can have multiple items. The items in a field have no guaranteed
5123 # order, but each non-empty field is guaranteed to have exactly one field with
5124 # `metadata.primary` set to true.
5125 "sipAddresses": [ # The person's SIP addresses.
5126 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
5127 # communications to make voice or video calls over the internet.
5128 "formattedType": "A String", # The read-only type of the SIP address translated and formatted in the
5129 # viewer's account locale or the `Accept-Language` HTTP header locale.
5130 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
5131 # predefined values:
5132 #
5133 # * `home`
5134 # * `work`
5135 # * `mobile`
5136 # * `other`
5137 "value": "A String", # The SIP address in the
5138 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
5139 # format.
5140 "metadata": { # Metadata about a field. # Metadata about the SIP address.
5141 "source": { # The source of a field. # The source of the field.
5142 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5143 #
5144 # Last update timestamp of this source.
5145 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5146 #
5147 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5148 # source. Used for web cache validation.
5149 "type": "A String", # The source type.
5150 "id": "A String", # The unique identifier within the source type generated by the server.
5151 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5152 #
5153 # Metadata about a source of type PROFILE.
5154 "userTypes": [ # The user types.
5155 "A String",
5156 ],
5157 "objectType": "A String", # The profile object type.
5158 },
5159 },
5160 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5161 # verified field is typically a name, email address, phone number, or
5162 # website that has been confirmed to be owned by the person.
5163 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5164 # field.
5165 },
5166 },
5167 ],
5168 "phoneNumbers": [ # The person's phone numbers.
5169 { # A person's phone number.
5170 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
5171 # viewer's account locale or the `Accept-Language` HTTP header locale.
5172 "canonicalForm": "A String", # The read-only canonicalized [ITU-T
5173 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
5174 # form of the phone number.
5175 "type": "A String", # The type of the phone number. The type can be custom or one of these
5176 # predefined values:
5177 #
5178 # * `home`
5179 # * `work`
5180 # * `mobile`
5181 # * `homeFax`
5182 # * `workFax`
5183 # * `otherFax`
5184 # * `pager`
5185 # * `workMobile`
5186 # * `workPager`
5187 # * `main`
5188 # * `googleVoice`
5189 # * `other`
5190 "value": "A String", # The phone number.
5191 "metadata": { # Metadata about a field. # Metadata about the phone number.
5192 "source": { # The source of a field. # The source of the field.
5193 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5194 #
5195 # Last update timestamp of this source.
5196 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5197 #
5198 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5199 # source. Used for web cache validation.
5200 "type": "A String", # The source type.
5201 "id": "A String", # The unique identifier within the source type generated by the server.
5202 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5203 #
5204 # Metadata about a source of type PROFILE.
5205 "userTypes": [ # The user types.
5206 "A String",
5207 ],
5208 "objectType": "A String", # The profile object type.
5209 },
5210 },
5211 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5212 # verified field is typically a name, email address, phone number, or
5213 # website that has been confirmed to be owned by the person.
5214 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5215 # field.
5216 },
5217 },
5218 ],
5219 "addresses": [ # The person's street addresses.
5220 { # A person's physical address. May be a P.O. box or street address. All fields
5221 # are optional.
5222 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
5223 # account locale or the `Accept-Language` HTTP header locale.
5224 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
5225 # code of the address.
5226 "city": "A String", # The city of the address.
5227 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
5228 # will be automatically constructed from structured values.
5229 "region": "A String", # The region of the address; for example, the state or province.
5230 "poBox": "A String", # The P.O. box of the address.
5231 "streetAddress": "A String", # The street address.
5232 "country": "A String", # The country of the address.
5233 "postalCode": "A String", # The postal code of the address.
5234 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
5235 "type": "A String", # The type of the address. The type can be custom or one of these predefined
5236 # values:
5237 #
5238 # * `home`
5239 # * `work`
5240 # * `other`
5241 "metadata": { # Metadata about a field. # Metadata about the address.
5242 "source": { # The source of a field. # The source of the field.
5243 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5244 #
5245 # Last update timestamp of this source.
5246 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5247 #
5248 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5249 # source. Used for web cache validation.
5250 "type": "A String", # The source type.
5251 "id": "A String", # The unique identifier within the source type generated by the server.
5252 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5253 #
5254 # Metadata about a source of type PROFILE.
5255 "userTypes": [ # The user types.
5256 "A String",
5257 ],
5258 "objectType": "A String", # The profile object type.
5259 },
5260 },
5261 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5262 # verified field is typically a name, email address, phone number, or
5263 # website that has been confirmed to be owned by the person.
5264 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5265 # field.
5266 },
5267 },
5268 ],
5269 "nicknames": [ # The person's nicknames.
5270 { # A person's nickname.
5271 "type": "A String", # The type of the nickname.
5272 "value": "A String", # The nickname.
5273 "metadata": { # Metadata about a field. # Metadata about the nickname.
5274 "source": { # The source of a field. # The source of the field.
5275 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5276 #
5277 # Last update timestamp of this source.
5278 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5279 #
5280 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5281 # source. Used for web cache validation.
5282 "type": "A String", # The source type.
5283 "id": "A String", # The unique identifier within the source type generated by the server.
5284 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5285 #
5286 # Metadata about a source of type PROFILE.
5287 "userTypes": [ # The user types.
5288 "A String",
5289 ],
5290 "objectType": "A String", # The profile object type.
5291 },
5292 },
5293 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5294 # verified field is typically a name, email address, phone number, or
5295 # website that has been confirmed to be owned by the person.
5296 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5297 # field.
5298 },
5299 },
5300 ],
5301 "occupations": [ # The person's occupations.
5302 { # A person's occupation.
5303 "value": "A String", # The occupation; for example, `carpenter`.
5304 "metadata": { # Metadata about a field. # Metadata about the occupation.
5305 "source": { # The source of a field. # The source of the field.
5306 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5307 #
5308 # Last update timestamp of this source.
5309 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5310 #
5311 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5312 # source. Used for web cache validation.
5313 "type": "A String", # The source type.
5314 "id": "A String", # The unique identifier within the source type generated by the server.
5315 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5316 #
5317 # Metadata about a source of type PROFILE.
5318 "userTypes": [ # The user types.
5319 "A String",
5320 ],
5321 "objectType": "A String", # The profile object type.
5322 },
5323 },
5324 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5325 # verified field is typically a name, email address, phone number, or
5326 # website that has been confirmed to be owned by the person.
5327 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5328 # field.
5329 },
5330 },
5331 ],
5332 "braggingRights": [ # The person's bragging rights.
5333 { # A person's bragging rights.
5334 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
5335 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
5336 "source": { # The source of a field. # The source of the field.
5337 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5338 #
5339 # Last update timestamp of this source.
5340 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5341 #
5342 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5343 # source. Used for web cache validation.
5344 "type": "A String", # The source type.
5345 "id": "A String", # The unique identifier within the source type generated by the server.
5346 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5347 #
5348 # Metadata about a source of type PROFILE.
5349 "userTypes": [ # The user types.
5350 "A String",
5351 ],
5352 "objectType": "A String", # The profile object type.
5353 },
5354 },
5355 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5356 # verified field is typically a name, email address, phone number, or
5357 # website that has been confirmed to be owned by the person.
5358 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5359 # field.
5360 },
5361 },
5362 ],
5363 "names": [ # The person's names.
5364 { # A person's name. If the name is a mononym, the family name is empty.
5365 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
5366 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
5367 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
5368 "displayName": "A String", # The read-only display name formatted according to the locale specified by
5369 # the viewer's account or the `Accept-Language` HTTP header.
5370 "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
5371 # the locale specified by the viewer's account or the
5372 # `Accept-Language` HTTP header.
5373 "middleName": "A String", # The middle name(s).
5374 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
5375 "familyName": "A String", # The family name.
5376 "phoneticFullName": "A String", # The full name spelled as it sounds.
5377 "phoneticGivenName": "A String", # The given name spelled as it sounds.
5378 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
5379 "givenName": "A String", # The given name.
5380 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
5381 "metadata": { # Metadata about a field. # Metadata about the name.
5382 "source": { # The source of a field. # The source of the field.
5383 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5384 #
5385 # Last update timestamp of this source.
5386 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5387 #
5388 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5389 # source. Used for web cache validation.
5390 "type": "A String", # The source type.
5391 "id": "A String", # The unique identifier within the source type generated by the server.
5392 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5393 #
5394 # Metadata about a source of type PROFILE.
5395 "userTypes": [ # The user types.
5396 "A String",
5397 ],
5398 "objectType": "A String", # The profile object type.
5399 },
5400 },
5401 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5402 # verified field is typically a name, email address, phone number, or
5403 # website that has been confirmed to be owned by the person.
5404 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5405 # field.
5406 },
5407 },
5408 ],
5409 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
5410 # with a max length of 27 characters, in the form of
5411 # `people/`<var>person_id</var>.
5412 "taglines": [ # The person's read-only taglines.
5413 { # A read-only brief one-line description of the person.
5414 "value": "A String", # The tagline.
5415 "metadata": { # Metadata about a field. # Metadata about the tagline.
5416 "source": { # The source of a field. # The source of the field.
5417 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5418 #
5419 # Last update timestamp of this source.
5420 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5421 #
5422 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5423 # source. Used for web cache validation.
5424 "type": "A String", # The source type.
5425 "id": "A String", # The unique identifier within the source type generated by the server.
5426 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5427 #
5428 # Metadata about a source of type PROFILE.
5429 "userTypes": [ # The user types.
5430 "A String",
5431 ],
5432 "objectType": "A String", # The profile object type.
5433 },
5434 },
5435 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5436 # verified field is typically a name, email address, phone number, or
5437 # website that has been confirmed to be owned by the person.
5438 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5439 # field.
5440 },
5441 },
5442 ],
5443 "ageRanges": [ # The person's read-only age ranges.
5444 { # A person's age range.
5445 "ageRange": "A String", # The age range.
5446 "metadata": { # Metadata about a field. # Metadata about the age range.
5447 "source": { # The source of a field. # The source of the field.
5448 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5449 #
5450 # Last update timestamp of this source.
5451 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5452 #
5453 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5454 # source. Used for web cache validation.
5455 "type": "A String", # The source type.
5456 "id": "A String", # The unique identifier within the source type generated by the server.
5457 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5458 #
5459 # Metadata about a source of type PROFILE.
5460 "userTypes": [ # The user types.
5461 "A String",
5462 ],
5463 "objectType": "A String", # The profile object type.
5464 },
5465 },
5466 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5467 # verified field is typically a name, email address, phone number, or
5468 # website that has been confirmed to be owned by the person.
5469 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5470 # field.
5471 },
5472 },
5473 ],
5474 "birthdays": [ # The person's birthdays.
5475 { # A person's birthday. At least one of the `date` and `text` fields are
5476 # specified. The `date` and `text` fields typically represent the same
5477 # date, but are not guaranteed to.
5478 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
5479 # of day and time zone are either specified elsewhere or are not
5480 # significant. The date is relative to the
5481 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
5482 # The day may be 0 to represent a year and month where the day is not
5483 # significant. The year may be 0 to represent a month and day independent
5484 # of year; for example, anniversary date.
5485 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
5486 # month and day.
5487 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
5488 # if specifying a year by itself or a year and month where the day is not
5489 # significant.
5490 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
5491 # a year.
5492 },
5493 "text": "A String", # A free-form string representing the user's birthday.
5494 "metadata": { # Metadata about a field. # Metadata about the birthday.
5495 "source": { # The source of a field. # The source of the field.
5496 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5497 #
5498 # Last update timestamp of this source.
5499 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5500 #
5501 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5502 # source. Used for web cache validation.
5503 "type": "A String", # The source type.
5504 "id": "A String", # The unique identifier within the source type generated by the server.
5505 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5506 #
5507 # Metadata about a source of type PROFILE.
5508 "userTypes": [ # The user types.
5509 "A String",
5510 ],
5511 "objectType": "A String", # The profile object type.
5512 },
5513 },
5514 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5515 # verified field is typically a name, email address, phone number, or
5516 # website that has been confirmed to be owned by the person.
5517 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5518 # field.
5519 },
5520 },
5521 ],
5522 "relations": [ # The person's relations.
5523 { # A person's relation to another person.
5524 "person": "A String", # The name of the other person this relation refers to.
5525 "metadata": { # Metadata about a field. # Metadata about the relation.
5526 "source": { # The source of a field. # The source of the field.
5527 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5528 #
5529 # Last update timestamp of this source.
5530 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5531 #
5532 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5533 # source. Used for web cache validation.
5534 "type": "A String", # The source type.
5535 "id": "A String", # The unique identifier within the source type generated by the server.
5536 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5537 #
5538 # Metadata about a source of type PROFILE.
5539 "userTypes": [ # The user types.
5540 "A String",
5541 ],
5542 "objectType": "A String", # The profile object type.
5543 },
5544 },
5545 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5546 # verified field is typically a name, email address, phone number, or
5547 # website that has been confirmed to be owned by the person.
5548 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5549 # field.
5550 },
5551 "type": "A String", # The person's relation to the other person. The type can be custom or one of
5552 # these predefined values:
5553 #
5554 # * `spouse`
5555 # * `child`
5556 # * `mother`
5557 # * `father`
5558 # * `parent`
5559 # * `brother`
5560 # * `sister`
5561 # * `friend`
5562 # * `relative`
5563 # * `domesticPartner`
5564 # * `manager`
5565 # * `assistant`
5566 # * `referredBy`
5567 # * `partner`
5568 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
5569 # locale or the locale specified in the Accept-Language HTTP header.
5570 },
5571 ],
5572 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5573 # resource. Used for web cache validation.
5574 "relationshipStatuses": [ # The person's read-only relationship statuses.
5575 { # A person's read-only relationship status.
5576 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
5577 # the viewer's account locale or the `Accept-Language` HTTP header locale.
5578 "value": "A String", # The relationship status. The value can be custom or one of these
5579 # predefined values:
5580 #
5581 # * `single`
5582 # * `inARelationship`
5583 # * `engaged`
5584 # * `married`
5585 # * `itsComplicated`
5586 # * `openRelationship`
5587 # * `widowed`
5588 # * `inDomesticPartnership`
5589 # * `inCivilUnion`
5590 "metadata": { # Metadata about a field. # Metadata about the relationship status.
5591 "source": { # The source of a field. # The source of the field.
5592 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5593 #
5594 # Last update timestamp of this source.
5595 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5596 #
5597 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5598 # source. Used for web cache validation.
5599 "type": "A String", # The source type.
5600 "id": "A String", # The unique identifier within the source type generated by the server.
5601 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5602 #
5603 # Metadata about a source of type PROFILE.
5604 "userTypes": [ # The user types.
5605 "A String",
5606 ],
5607 "objectType": "A String", # The profile object type.
5608 },
5609 },
5610 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5611 # verified field is typically a name, email address, phone number, or
5612 # website that has been confirmed to be owned by the person.
5613 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5614 # field.
5615 },
5616 },
5617 ],
5618 "imClients": [ # The person's instant messaging clients.
5619 { # A person's instant messaging client.
5620 "username": "A String", # The user name used in the IM client.
5621 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
5622 # viewer's account locale or the `Accept-Language` HTTP header locale.
5623 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
5624 # predefined values:
5625 #
5626 # * `aim`
5627 # * `msn`
5628 # * `yahoo`
5629 # * `skype`
5630 # * `qq`
5631 # * `googleTalk`
5632 # * `icq`
5633 # * `jabber`
5634 # * `netMeeting`
5635 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
5636 # locale or the `Accept-Language` HTTP header locale.
5637 "type": "A String", # The type of the IM client. The type can be custom or one of these
5638 # predefined values:
5639 #
5640 # * `home`
5641 # * `work`
5642 # * `other`
5643 "metadata": { # Metadata about a field. # Metadata about the IM client.
5644 "source": { # The source of a field. # The source of the field.
5645 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5646 #
5647 # Last update timestamp of this source.
5648 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5649 #
5650 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5651 # source. Used for web cache validation.
5652 "type": "A String", # The source type.
5653 "id": "A String", # The unique identifier within the source type generated by the server.
5654 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5655 #
5656 # Metadata about a source of type PROFILE.
5657 "userTypes": [ # The user types.
5658 "A String",
5659 ],
5660 "objectType": "A String", # The profile object type.
5661 },
5662 },
5663 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5664 # verified field is typically a name, email address, phone number, or
5665 # website that has been confirmed to be owned by the person.
5666 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5667 # field.
5668 },
5669 },
5670 ],
5671 "events": [ # The person's events.
5672 { # An event related to the person.
5673 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
5674 # of day and time zone are either specified elsewhere or are not
5675 # significant. The date is relative to the
5676 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
5677 # The day may be 0 to represent a year and month where the day is not
5678 # significant. The year may be 0 to represent a month and day independent
5679 # of year; for example, anniversary date.
5680 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
5681 # month and day.
5682 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
5683 # if specifying a year by itself or a year and month where the day is not
5684 # significant.
5685 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
5686 # a year.
5687 },
5688 "formattedType": "A String", # The read-only type of the event translated and formatted in the
5689 # viewer's account locale or the `Accept-Language` HTTP header locale.
5690 "type": "A String", # The type of the event. The type can be custom or one of these predefined
5691 # values:
5692 #
5693 # * `anniversary`
5694 # * `other`
5695 "metadata": { # Metadata about a field. # Metadata about the event.
5696 "source": { # The source of a field. # The source of the field.
5697 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5698 #
5699 # Last update timestamp of this source.
5700 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5701 #
5702 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5703 # source. Used for web cache validation.
5704 "type": "A String", # The source type.
5705 "id": "A String", # The unique identifier within the source type generated by the server.
5706 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5707 #
5708 # Metadata about a source of type PROFILE.
5709 "userTypes": [ # The user types.
5710 "A String",
5711 ],
5712 "objectType": "A String", # The profile object type.
5713 },
5714 },
5715 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5716 # verified field is typically a name, email address, phone number, or
5717 # website that has been confirmed to be owned by the person.
5718 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5719 # field.
5720 },
5721 },
5722 ],
5723 "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
5724 "previousResourceNames": [ # Any former resource names this person has had. Populated only for
5725 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
5726 # that include a sync token.
5727 #
5728 # The resource name may change when adding or removing fields that link a
5729 # contact and profile such as a verified email, verified phone number, or
5730 # profile URL.
5731 "A String",
5732 ],
5733 "sources": [ # The sources of data for the person.
5734 { # The source of a field.
5735 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5736 #
5737 # Last update timestamp of this source.
5738 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5739 #
5740 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5741 # source. Used for web cache validation.
5742 "type": "A String", # The source type.
5743 "id": "A String", # The unique identifier within the source type generated by the server.
5744 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5745 #
5746 # Metadata about a source of type PROFILE.
5747 "userTypes": [ # The user types.
5748 "A String",
5749 ],
5750 "objectType": "A String", # The profile object type.
5751 },
5752 },
5753 ],
5754 "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
5755 "A String",
5756 ],
5757 "deleted": True or False, # True if the person resource has been deleted. Populated only for
5758 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
5759 # that include a sync token.
5760 "objectType": "A String", # **DEPRECATED** (Please use
5761 # `person.metadata.sources.profileMetadata.objectType` instead)
5762 #
5763 # The type of the person object.
5764 },
5765 "interests": [ # The person's interests.
5766 { # One of the person's interests.
5767 "value": "A String", # The interest; for example, `stargazing`.
5768 "metadata": { # Metadata about a field. # Metadata about the interest.
5769 "source": { # The source of a field. # The source of the field.
5770 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5771 #
5772 # Last update timestamp of this source.
5773 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5774 #
5775 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5776 # source. Used for web cache validation.
5777 "type": "A String", # The source type.
5778 "id": "A String", # The unique identifier within the source type generated by the server.
5779 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5780 #
5781 # Metadata about a source of type PROFILE.
5782 "userTypes": [ # The user types.
5783 "A String",
5784 ],
5785 "objectType": "A String", # The profile object type.
5786 },
5787 },
5788 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5789 # verified field is typically a name, email address, phone number, or
5790 # website that has been confirmed to be owned by the person.
5791 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5792 # field.
5793 },
5794 },
5795 ],
5796 "photos": [ # The person's read-only photos.
5797 { # A person's read-only photo. A picture shown next to the person's name to
5798 # help others recognize the person.
5799 "default": True or False, # True if the photo is a default photo;
5800 # false if the photo is a user-provided photo.
5801 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
5802 # parameter `sz=`<var>size</var> at the end of the url. Example:
5803 # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
5804 "metadata": { # Metadata about a field. # Metadata about the photo.
5805 "source": { # The source of a field. # The source of the field.
5806 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5807 #
5808 # Last update timestamp of this source.
5809 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5810 #
5811 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5812 # source. Used for web cache validation.
5813 "type": "A String", # The source type.
5814 "id": "A String", # The unique identifier within the source type generated by the server.
5815 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5816 #
5817 # Metadata about a source of type PROFILE.
5818 "userTypes": [ # The user types.
5819 "A String",
5820 ],
5821 "objectType": "A String", # The profile object type.
5822 },
5823 },
5824 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5825 # verified field is typically a name, email address, phone number, or
5826 # website that has been confirmed to be owned by the person.
5827 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5828 # field.
5829 },
5830 },
5831 ],
5832 "residences": [ # The person's residences.
5833 { # A person's past or current residence.
5834 "current": True or False, # True if the residence is the person's current residence;
5835 # false if the residence is a past residence.
5836 "value": "A String", # The address of the residence.
5837 "metadata": { # Metadata about a field. # Metadata about the residence.
5838 "source": { # The source of a field. # The source of the field.
5839 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5840 #
5841 # Last update timestamp of this source.
5842 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5843 #
5844 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5845 # source. Used for web cache validation.
5846 "type": "A String", # The source type.
5847 "id": "A String", # The unique identifier within the source type generated by the server.
5848 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5849 #
5850 # Metadata about a source of type PROFILE.
5851 "userTypes": [ # The user types.
5852 "A String",
5853 ],
5854 "objectType": "A String", # The profile object type.
5855 },
5856 },
5857 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5858 # verified field is typically a name, email address, phone number, or
5859 # website that has been confirmed to be owned by the person.
5860 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5861 # field.
5862 },
5863 },
5864 ],
5865 "relationshipInterests": [ # The person's read-only relationship interests.
5866 { # A person's read-only relationship interest .
5867 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
5868 # viewer's account locale or the locale specified in the Accept-Language
5869 # HTTP header.
5870 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
5871 # or one of these predefined values:
5872 #
5873 # * `friend`
5874 # * `date`
5875 # * `relationship`
5876 # * `networking`
5877 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
5878 "source": { # The source of a field. # The source of the field.
5879 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5880 #
5881 # Last update timestamp of this source.
5882 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5883 #
5884 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5885 # source. Used for web cache validation.
5886 "type": "A String", # The source type.
5887 "id": "A String", # The unique identifier within the source type generated by the server.
5888 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5889 #
5890 # Metadata about a source of type PROFILE.
5891 "userTypes": [ # The user types.
5892 "A String",
5893 ],
5894 "objectType": "A String", # The profile object type.
5895 },
5896 },
5897 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5898 # verified field is typically a name, email address, phone number, or
5899 # website that has been confirmed to be owned by the person.
5900 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5901 # field.
5902 },
5903 },
5904 ],
5905 "coverPhotos": [ # The person's read-only cover photos.
5906 { # A person's read-only cover photo. A large image shown on the person's
5907 # profile page that represents who they are or what they care about.
5908 "default": True or False, # True if the cover photo is the default cover photo;
5909 # false if the cover photo is a user-provided cover photo.
5910 "url": "A String", # The URL of the cover photo.
5911 "metadata": { # Metadata about a field. # Metadata about the cover photo.
5912 "source": { # The source of a field. # The source of the field.
5913 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5914 #
5915 # Last update timestamp of this source.
5916 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5917 #
5918 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5919 # source. Used for web cache validation.
5920 "type": "A String", # The source type.
5921 "id": "A String", # The unique identifier within the source type generated by the server.
5922 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5923 #
5924 # Metadata about a source of type PROFILE.
5925 "userTypes": [ # The user types.
5926 "A String",
5927 ],
5928 "objectType": "A String", # The profile object type.
5929 },
5930 },
5931 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5932 # verified field is typically a name, email address, phone number, or
5933 # website that has been confirmed to be owned by the person.
5934 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5935 # field.
5936 },
5937 },
5938 ],
5939 "locales": [ # The person's locale preferences.
5940 { # A person's locale preference.
5941 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
5942 # language tag representing the locale.
5943 "metadata": { # Metadata about a field. # Metadata about the locale.
5944 "source": { # The source of a field. # The source of the field.
5945 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
5946 #
5947 # Last update timestamp of this source.
5948 "etag": "A String", # **Only populated in `person.metadata.sources`.**
5949 #
5950 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
5951 # source. Used for web cache validation.
5952 "type": "A String", # The source type.
5953 "id": "A String", # The unique identifier within the source type generated by the server.
5954 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
5955 #
5956 # Metadata about a source of type PROFILE.
5957 "userTypes": [ # The user types.
5958 "A String",
5959 ],
5960 "objectType": "A String", # The profile object type.
5961 },
5962 },
5963 "verified": True or False, # True if the field is verified; false if the field is unverified. A
5964 # verified field is typically a name, email address, phone number, or
5965 # website that has been confirmed to be owned by the person.
5966 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
5967 # field.
5968 },
5969 },
5970 ],
5971 "organizations": [ # The person's past or current organizations.
5972 { # A person's past or current organization. Overlapping date ranges are
5973 # permitted.
5974 "formattedType": "A String", # The read-only type of the organization translated and formatted in the
5975 # viewer's account locale or the `Accept-Language` HTTP header locale.
5976 "domain": "A String", # The domain name associated with the organization; for example,
5977 # `google.com`.
5978 "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
5979 # of day and time zone are either specified elsewhere or are not
5980 # significant. The date is relative to the
5981 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
5982 # The day may be 0 to represent a year and month where the day is not
5983 # significant. The year may be 0 to represent a month and day independent
5984 # of year; for example, anniversary date.
5985 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
5986 # month and day.
5987 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
5988 # if specifying a year by itself or a year and month where the day is not
5989 # significant.
5990 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
5991 # a year.
5992 },
5993 "name": "A String", # The name of the organization.
5994 "title": "A String", # The person's job title at the organization.
5995 "type": "A String", # The type of the organization. The type can be custom or one of these
5996 # predefined values:
5997 #
5998 # * `work`
5999 # * `school`
6000 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
6001 # symbol, abbreviation, or acronym.
6002 "current": True or False, # True if the organization is the person's current organization;
6003 # false if the organization is a past organization.
6004 "jobDescription": "A String", # The person's job description at the organization.
6005 "location": "A String", # The location of the organization office the person works at.
6006 "department": "A String", # The person's department at the organization.
6007 "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
6008 # of day and time zone are either specified elsewhere or are not
6009 # significant. The date is relative to the
6010 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
6011 # The day may be 0 to represent a year and month where the day is not
6012 # significant. The year may be 0 to represent a month and day independent
6013 # of year; for example, anniversary date.
6014 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
6015 # month and day.
6016 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
6017 # if specifying a year by itself or a year and month where the day is not
6018 # significant.
6019 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
6020 # a year.
6021 },
6022 "phoneticName": "A String", # The phonetic name of the organization.
6023 "metadata": { # Metadata about a field. # Metadata about the organization.
6024 "source": { # The source of a field. # The source of the field.
6025 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6026 #
6027 # Last update timestamp of this source.
6028 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6029 #
6030 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6031 # source. Used for web cache validation.
6032 "type": "A String", # The source type.
6033 "id": "A String", # The unique identifier within the source type generated by the server.
6034 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6035 #
6036 # Metadata about a source of type PROFILE.
6037 "userTypes": [ # The user types.
6038 "A String",
6039 ],
6040 "objectType": "A String", # The profile object type.
6041 },
6042 },
6043 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6044 # verified field is typically a name, email address, phone number, or
6045 # website that has been confirmed to be owned by the person.
6046 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6047 # field.
6048 },
6049 },
6050 ],
6051 "userDefined": [ # The person's user defined data.
6052 { # Arbitrary user data that is populated by the end users.
6053 "key": "A String", # The end user specified key of the user defined data.
6054 "value": "A String", # The end user specified value of the user defined data.
6055 "metadata": { # Metadata about a field. # Metadata about the user defined data.
6056 "source": { # The source of a field. # The source of the field.
6057 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6058 #
6059 # Last update timestamp of this source.
6060 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6061 #
6062 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6063 # source. Used for web cache validation.
6064 "type": "A String", # The source type.
6065 "id": "A String", # The unique identifier within the source type generated by the server.
6066 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6067 #
6068 # Metadata about a source of type PROFILE.
6069 "userTypes": [ # The user types.
6070 "A String",
6071 ],
6072 "objectType": "A String", # The profile object type.
6073 },
6074 },
6075 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6076 # verified field is typically a name, email address, phone number, or
6077 # website that has been confirmed to be owned by the person.
6078 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6079 # field.
6080 },
6081 },
6082 ],
6083 "biographies": [ # The person's biographies.
6084 { # A person's short biography.
6085 "contentType": "A String", # The content type of the biography.
6086 "value": "A String", # The short biography.
6087 "metadata": { # Metadata about a field. # Metadata about the biography.
6088 "source": { # The source of a field. # The source of the field.
6089 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6090 #
6091 # Last update timestamp of this source.
6092 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6093 #
6094 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6095 # source. Used for web cache validation.
6096 "type": "A String", # The source type.
6097 "id": "A String", # The unique identifier within the source type generated by the server.
6098 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6099 #
6100 # Metadata about a source of type PROFILE.
6101 "userTypes": [ # The user types.
6102 "A String",
6103 ],
6104 "objectType": "A String", # The profile object type.
6105 },
6106 },
6107 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6108 # verified field is typically a name, email address, phone number, or
6109 # website that has been confirmed to be owned by the person.
6110 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6111 # field.
6112 },
6113 },
6114 ],
6115 "memberships": [ # The person's group memberships.
6116 { # A person's membership in a group. Only contact group memberships can be
6117 # modified.
6118 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
6119 "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
6120 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
6121 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
6122 # Only contact_group_resource_name can be used for modifying memberships.
6123 # Any contact group membership can be removed, but only user group or
6124 # "myContacts" or "starred" system groups memberships can be added. A
6125 # contact must always have at least one contact group membership.
6126 },
6127 "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain membership.
6128 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
6129 },
6130 "metadata": { # Metadata about a field. # Metadata about the membership.
6131 "source": { # The source of a field. # The source of the field.
6132 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6133 #
6134 # Last update timestamp of this source.
6135 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6136 #
6137 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6138 # source. Used for web cache validation.
6139 "type": "A String", # The source type.
6140 "id": "A String", # The unique identifier within the source type generated by the server.
6141 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6142 #
6143 # Metadata about a source of type PROFILE.
6144 "userTypes": [ # The user types.
6145 "A String",
6146 ],
6147 "objectType": "A String", # The profile object type.
6148 },
6149 },
6150 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6151 # verified field is typically a name, email address, phone number, or
6152 # website that has been confirmed to be owned by the person.
6153 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6154 # field.
6155 },
6156 },
6157 ],
6158 "skills": [ # The person's skills.
6159 { # A skill that the person has.
6160 "value": "A String", # The skill; for example, `underwater basket weaving`.
6161 "metadata": { # Metadata about a field. # Metadata about the skill.
6162 "source": { # The source of a field. # The source of the field.
6163 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6164 #
6165 # Last update timestamp of this source.
6166 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6167 #
6168 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6169 # source. Used for web cache validation.
6170 "type": "A String", # The source type.
6171 "id": "A String", # The unique identifier within the source type generated by the server.
6172 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6173 #
6174 # Metadata about a source of type PROFILE.
6175 "userTypes": [ # The user types.
6176 "A String",
6177 ],
6178 "objectType": "A String", # The profile object type.
6179 },
6180 },
6181 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6182 # verified field is typically a name, email address, phone number, or
6183 # website that has been confirmed to be owned by the person.
6184 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6185 # field.
6186 },
6187 },
6188 ],
6189 "urls": [ # The person's associated URLs.
6190 { # A person's associated URLs.
6191 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
6192 # account locale or the `Accept-Language` HTTP header locale.
6193 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
6194 # values:
6195 #
6196 # * `home`
6197 # * `work`
6198 # * `blog`
6199 # * `profile`
6200 # * `homePage`
6201 # * `ftp`
6202 # * `reservations`
6203 # * `appInstallPage`: website for a Google+ application.
6204 # * `other`
6205 "value": "A String", # The URL.
6206 "metadata": { # Metadata about a field. # Metadata about the URL.
6207 "source": { # The source of a field. # The source of the field.
6208 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6209 #
6210 # Last update timestamp of this source.
6211 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6212 #
6213 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6214 # source. Used for web cache validation.
6215 "type": "A String", # The source type.
6216 "id": "A String", # The unique identifier within the source type generated by the server.
6217 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6218 #
6219 # Metadata about a source of type PROFILE.
6220 "userTypes": [ # The user types.
6221 "A String",
6222 ],
6223 "objectType": "A String", # The profile object type.
6224 },
6225 },
6226 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6227 # verified field is typically a name, email address, phone number, or
6228 # website that has been confirmed to be owned by the person.
6229 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6230 # field.
6231 },
6232 },
6233 ],
6234 "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
6235 #
6236 # The person's read-only age range.
6237 "genders": [ # The person's genders.
6238 { # A person's gender.
6239 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
6240 # account locale or the `Accept-Language` HTTP header locale.
6241 "value": "A String", # The gender for the person. The gender can be custom or one of these
6242 # predefined values:
6243 #
6244 # * `male`
6245 # * `female`
6246 # * `other`
6247 # * `unknown`
6248 "metadata": { # Metadata about a field. # Metadata about the gender.
6249 "source": { # The source of a field. # The source of the field.
6250 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6251 #
6252 # Last update timestamp of this source.
6253 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6254 #
6255 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6256 # source. Used for web cache validation.
6257 "type": "A String", # The source type.
6258 "id": "A String", # The unique identifier within the source type generated by the server.
6259 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6260 #
6261 # Metadata about a source of type PROFILE.
6262 "userTypes": [ # The user types.
6263 "A String",
6264 ],
6265 "objectType": "A String", # The profile object type.
6266 },
6267 },
6268 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6269 # verified field is typically a name, email address, phone number, or
6270 # website that has been confirmed to be owned by the person.
6271 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6272 # field.
6273 },
6274 },
6275 ],
6276 "emailAddresses": [ # The person's email addresses.
6277 { # A person's email address.
6278 "type": "A String", # The type of the email address. The type can be custom or one of these
6279 # predefined values:
6280 #
6281 # * `home`
6282 # * `work`
6283 # * `other`
6284 "formattedType": "A String", # The read-only type of the email address translated and formatted in the
6285 # viewer's account locale or the `Accept-Language` HTTP header locale.
6286 "displayName": "A String", # The display name of the email.
6287 "value": "A String", # The email address.
6288 "metadata": { # Metadata about a field. # Metadata about the email address.
6289 "source": { # The source of a field. # The source of the field.
6290 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6291 #
6292 # Last update timestamp of this source.
6293 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6294 #
6295 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6296 # source. Used for web cache validation.
6297 "type": "A String", # The source type.
6298 "id": "A String", # The unique identifier within the source type generated by the server.
6299 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6300 #
6301 # Metadata about a source of type PROFILE.
6302 "userTypes": [ # The user types.
6303 "A String",
6304 ],
6305 "objectType": "A String", # The profile object type.
6306 },
6307 },
6308 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6309 # verified field is typically a name, email address, phone number, or
6310 # website that has been confirmed to be owned by the person.
6311 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6312 # field.
6313 },
6314 },
6315 ],
6316 }
6317
6318 updatePersonFields: string, **Required.** A field mask to restrict which fields on the person are
6319updated. Multiple fields can be specified by separating them with commas.
6320All updated fields will be replaced. Valid values are:
6321
6322* addresses
6323* biographies
6324* birthdays
6325* emailAddresses
6326* events
6327* genders
6328* imClients
6329* interests
6330* locales
6331* memberships
6332* names
6333* nicknames
6334* occupations
6335* organizations
6336* phoneNumbers
6337* relations
6338* residences
6339* sipAddresses
6340* urls
6341* userDefined
6342 x__xgafv: string, V1 error format.
6343 Allowed values
6344 1 - v1 error format
6345 2 - v2 error format
6346
6347Returns:
6348 An object of the form:
6349
6350 { # Information about a person merged from various data sources such as the
6351 # authenticated user's contacts and profile data.
6352 #
6353 # Most fields can have multiple items. The items in a field have no guaranteed
6354 # order, but each non-empty field is guaranteed to have exactly one field with
6355 # `metadata.primary` set to true.
6356 "sipAddresses": [ # The person's SIP addresses.
6357 { # A person's SIP address. Session Initial Protocol addresses are used for VoIP
6358 # communications to make voice or video calls over the internet.
6359 "formattedType": "A String", # The read-only type of the SIP address translated and formatted in the
6360 # viewer's account locale or the `Accept-Language` HTTP header locale.
6361 "type": "A String", # The type of the SIP address. The type can be custom or or one of these
6362 # predefined values:
6363 #
6364 # * `home`
6365 # * `work`
6366 # * `mobile`
6367 # * `other`
6368 "value": "A String", # The SIP address in the
6369 # [RFC 3261 19.1](https://tools.ietf.org/html/rfc3261#section-19.1) SIP URI
6370 # format.
6371 "metadata": { # Metadata about a field. # Metadata about the SIP address.
6372 "source": { # The source of a field. # The source of the field.
6373 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6374 #
6375 # Last update timestamp of this source.
6376 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6377 #
6378 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6379 # source. Used for web cache validation.
6380 "type": "A String", # The source type.
6381 "id": "A String", # The unique identifier within the source type generated by the server.
6382 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6383 #
6384 # Metadata about a source of type PROFILE.
6385 "userTypes": [ # The user types.
6386 "A String",
6387 ],
6388 "objectType": "A String", # The profile object type.
6389 },
6390 },
6391 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6392 # verified field is typically a name, email address, phone number, or
6393 # website that has been confirmed to be owned by the person.
6394 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6395 # field.
6396 },
6397 },
6398 ],
6399 "phoneNumbers": [ # The person's phone numbers.
6400 { # A person's phone number.
6401 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
6402 # viewer's account locale or the `Accept-Language` HTTP header locale.
6403 "canonicalForm": "A String", # The read-only canonicalized [ITU-T
6404 # E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
6405 # form of the phone number.
6406 "type": "A String", # The type of the phone number. The type can be custom or one of these
6407 # predefined values:
6408 #
6409 # * `home`
6410 # * `work`
6411 # * `mobile`
6412 # * `homeFax`
6413 # * `workFax`
6414 # * `otherFax`
6415 # * `pager`
6416 # * `workMobile`
6417 # * `workPager`
6418 # * `main`
6419 # * `googleVoice`
6420 # * `other`
6421 "value": "A String", # The phone number.
6422 "metadata": { # Metadata about a field. # Metadata about the phone number.
6423 "source": { # The source of a field. # The source of the field.
6424 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6425 #
6426 # Last update timestamp of this source.
6427 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6428 #
6429 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6430 # source. Used for web cache validation.
6431 "type": "A String", # The source type.
6432 "id": "A String", # The unique identifier within the source type generated by the server.
6433 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6434 #
6435 # Metadata about a source of type PROFILE.
6436 "userTypes": [ # The user types.
6437 "A String",
6438 ],
6439 "objectType": "A String", # The profile object type.
6440 },
6441 },
6442 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6443 # verified field is typically a name, email address, phone number, or
6444 # website that has been confirmed to be owned by the person.
6445 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6446 # field.
6447 },
6448 },
6449 ],
6450 "addresses": [ # The person's street addresses.
6451 { # A person's physical address. May be a P.O. box or street address. All fields
6452 # are optional.
6453 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
6454 # account locale or the `Accept-Language` HTTP header locale.
6455 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
6456 # code of the address.
6457 "city": "A String", # The city of the address.
6458 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
6459 # will be automatically constructed from structured values.
6460 "region": "A String", # The region of the address; for example, the state or province.
6461 "poBox": "A String", # The P.O. box of the address.
6462 "streetAddress": "A String", # The street address.
6463 "country": "A String", # The country of the address.
6464 "postalCode": "A String", # The postal code of the address.
6465 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
6466 "type": "A String", # The type of the address. The type can be custom or one of these predefined
6467 # values:
6468 #
6469 # * `home`
6470 # * `work`
6471 # * `other`
6472 "metadata": { # Metadata about a field. # Metadata about the address.
6473 "source": { # The source of a field. # The source of the field.
6474 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6475 #
6476 # Last update timestamp of this source.
6477 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6478 #
6479 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6480 # source. Used for web cache validation.
6481 "type": "A String", # The source type.
6482 "id": "A String", # The unique identifier within the source type generated by the server.
6483 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6484 #
6485 # Metadata about a source of type PROFILE.
6486 "userTypes": [ # The user types.
6487 "A String",
6488 ],
6489 "objectType": "A String", # The profile object type.
6490 },
6491 },
6492 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6493 # verified field is typically a name, email address, phone number, or
6494 # website that has been confirmed to be owned by the person.
6495 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6496 # field.
6497 },
6498 },
6499 ],
6500 "nicknames": [ # The person's nicknames.
6501 { # A person's nickname.
6502 "type": "A String", # The type of the nickname.
6503 "value": "A String", # The nickname.
6504 "metadata": { # Metadata about a field. # Metadata about the nickname.
6505 "source": { # The source of a field. # The source of the field.
6506 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6507 #
6508 # Last update timestamp of this source.
6509 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6510 #
6511 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6512 # source. Used for web cache validation.
6513 "type": "A String", # The source type.
6514 "id": "A String", # The unique identifier within the source type generated by the server.
6515 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6516 #
6517 # Metadata about a source of type PROFILE.
6518 "userTypes": [ # The user types.
6519 "A String",
6520 ],
6521 "objectType": "A String", # The profile object type.
6522 },
6523 },
6524 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6525 # verified field is typically a name, email address, phone number, or
6526 # website that has been confirmed to be owned by the person.
6527 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6528 # field.
6529 },
6530 },
6531 ],
6532 "occupations": [ # The person's occupations.
6533 { # A person's occupation.
6534 "value": "A String", # The occupation; for example, `carpenter`.
6535 "metadata": { # Metadata about a field. # Metadata about the occupation.
6536 "source": { # The source of a field. # The source of the field.
6537 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6538 #
6539 # Last update timestamp of this source.
6540 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6541 #
6542 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6543 # source. Used for web cache validation.
6544 "type": "A String", # The source type.
6545 "id": "A String", # The unique identifier within the source type generated by the server.
6546 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6547 #
6548 # Metadata about a source of type PROFILE.
6549 "userTypes": [ # The user types.
6550 "A String",
6551 ],
6552 "objectType": "A String", # The profile object type.
6553 },
6554 },
6555 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6556 # verified field is typically a name, email address, phone number, or
6557 # website that has been confirmed to be owned by the person.
6558 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6559 # field.
6560 },
6561 },
6562 ],
6563 "braggingRights": [ # The person's bragging rights.
6564 { # A person's bragging rights.
6565 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
6566 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
6567 "source": { # The source of a field. # The source of the field.
6568 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6569 #
6570 # Last update timestamp of this source.
6571 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6572 #
6573 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6574 # source. Used for web cache validation.
6575 "type": "A String", # The source type.
6576 "id": "A String", # The unique identifier within the source type generated by the server.
6577 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6578 #
6579 # Metadata about a source of type PROFILE.
6580 "userTypes": [ # The user types.
6581 "A String",
6582 ],
6583 "objectType": "A String", # The profile object type.
6584 },
6585 },
6586 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6587 # verified field is typically a name, email address, phone number, or
6588 # website that has been confirmed to be owned by the person.
6589 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6590 # field.
6591 },
6592 },
6593 ],
6594 "names": [ # The person's names.
6595 { # A person's name. If the name is a mononym, the family name is empty.
6596 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
6597 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
6598 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
6599 "displayName": "A String", # The read-only display name formatted according to the locale specified by
6600 # the viewer's account or the `Accept-Language` HTTP header.
6601 "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
6602 # the locale specified by the viewer's account or the
6603 # `Accept-Language` HTTP header.
6604 "middleName": "A String", # The middle name(s).
6605 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
6606 "familyName": "A String", # The family name.
6607 "phoneticFullName": "A String", # The full name spelled as it sounds.
6608 "phoneticGivenName": "A String", # The given name spelled as it sounds.
6609 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
6610 "givenName": "A String", # The given name.
6611 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
6612 "metadata": { # Metadata about a field. # Metadata about the name.
6613 "source": { # The source of a field. # The source of the field.
6614 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6615 #
6616 # Last update timestamp of this source.
6617 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6618 #
6619 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6620 # source. Used for web cache validation.
6621 "type": "A String", # The source type.
6622 "id": "A String", # The unique identifier within the source type generated by the server.
6623 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6624 #
6625 # Metadata about a source of type PROFILE.
6626 "userTypes": [ # The user types.
6627 "A String",
6628 ],
6629 "objectType": "A String", # The profile object type.
6630 },
6631 },
6632 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6633 # verified field is typically a name, email address, phone number, or
6634 # website that has been confirmed to be owned by the person.
6635 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6636 # field.
6637 },
6638 },
6639 ],
6640 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
6641 # with a max length of 27 characters, in the form of
6642 # `people/`<var>person_id</var>.
6643 "taglines": [ # The person's read-only taglines.
6644 { # A read-only brief one-line description of the person.
6645 "value": "A String", # The tagline.
6646 "metadata": { # Metadata about a field. # Metadata about the tagline.
6647 "source": { # The source of a field. # The source of the field.
6648 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6649 #
6650 # Last update timestamp of this source.
6651 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6652 #
6653 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6654 # source. Used for web cache validation.
6655 "type": "A String", # The source type.
6656 "id": "A String", # The unique identifier within the source type generated by the server.
6657 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6658 #
6659 # Metadata about a source of type PROFILE.
6660 "userTypes": [ # The user types.
6661 "A String",
6662 ],
6663 "objectType": "A String", # The profile object type.
6664 },
6665 },
6666 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6667 # verified field is typically a name, email address, phone number, or
6668 # website that has been confirmed to be owned by the person.
6669 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6670 # field.
6671 },
6672 },
6673 ],
6674 "ageRanges": [ # The person's read-only age ranges.
6675 { # A person's age range.
6676 "ageRange": "A String", # The age range.
6677 "metadata": { # Metadata about a field. # Metadata about the age range.
6678 "source": { # The source of a field. # The source of the field.
6679 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6680 #
6681 # Last update timestamp of this source.
6682 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6683 #
6684 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6685 # source. Used for web cache validation.
6686 "type": "A String", # The source type.
6687 "id": "A String", # The unique identifier within the source type generated by the server.
6688 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6689 #
6690 # Metadata about a source of type PROFILE.
6691 "userTypes": [ # The user types.
6692 "A String",
6693 ],
6694 "objectType": "A String", # The profile object type.
6695 },
6696 },
6697 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6698 # verified field is typically a name, email address, phone number, or
6699 # website that has been confirmed to be owned by the person.
6700 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6701 # field.
6702 },
6703 },
6704 ],
6705 "birthdays": [ # The person's birthdays.
6706 { # A person's birthday. At least one of the `date` and `text` fields are
6707 # specified. The `date` and `text` fields typically represent the same
6708 # date, but are not guaranteed to.
6709 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
6710 # of day and time zone are either specified elsewhere or are not
6711 # significant. The date is relative to the
6712 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
6713 # The day may be 0 to represent a year and month where the day is not
6714 # significant. The year may be 0 to represent a month and day independent
6715 # of year; for example, anniversary date.
6716 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
6717 # month and day.
6718 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
6719 # if specifying a year by itself or a year and month where the day is not
6720 # significant.
6721 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
6722 # a year.
6723 },
6724 "text": "A String", # A free-form string representing the user's birthday.
6725 "metadata": { # Metadata about a field. # Metadata about the birthday.
6726 "source": { # The source of a field. # The source of the field.
6727 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6728 #
6729 # Last update timestamp of this source.
6730 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6731 #
6732 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6733 # source. Used for web cache validation.
6734 "type": "A String", # The source type.
6735 "id": "A String", # The unique identifier within the source type generated by the server.
6736 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6737 #
6738 # Metadata about a source of type PROFILE.
6739 "userTypes": [ # The user types.
6740 "A String",
6741 ],
6742 "objectType": "A String", # The profile object type.
6743 },
6744 },
6745 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6746 # verified field is typically a name, email address, phone number, or
6747 # website that has been confirmed to be owned by the person.
6748 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6749 # field.
6750 },
6751 },
6752 ],
6753 "relations": [ # The person's relations.
6754 { # A person's relation to another person.
6755 "person": "A String", # The name of the other person this relation refers to.
6756 "metadata": { # Metadata about a field. # Metadata about the relation.
6757 "source": { # The source of a field. # The source of the field.
6758 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6759 #
6760 # Last update timestamp of this source.
6761 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6762 #
6763 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6764 # source. Used for web cache validation.
6765 "type": "A String", # The source type.
6766 "id": "A String", # The unique identifier within the source type generated by the server.
6767 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6768 #
6769 # Metadata about a source of type PROFILE.
6770 "userTypes": [ # The user types.
6771 "A String",
6772 ],
6773 "objectType": "A String", # The profile object type.
6774 },
6775 },
6776 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6777 # verified field is typically a name, email address, phone number, or
6778 # website that has been confirmed to be owned by the person.
6779 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6780 # field.
6781 },
6782 "type": "A String", # The person's relation to the other person. The type can be custom or one of
6783 # these predefined values:
6784 #
6785 # * `spouse`
6786 # * `child`
6787 # * `mother`
6788 # * `father`
6789 # * `parent`
6790 # * `brother`
6791 # * `sister`
6792 # * `friend`
6793 # * `relative`
6794 # * `domesticPartner`
6795 # * `manager`
6796 # * `assistant`
6797 # * `referredBy`
6798 # * `partner`
6799 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
6800 # locale or the locale specified in the Accept-Language HTTP header.
6801 },
6802 ],
6803 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6804 # resource. Used for web cache validation.
6805 "relationshipStatuses": [ # The person's read-only relationship statuses.
6806 { # A person's read-only relationship status.
6807 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
6808 # the viewer's account locale or the `Accept-Language` HTTP header locale.
6809 "value": "A String", # The relationship status. The value can be custom or one of these
6810 # predefined values:
6811 #
6812 # * `single`
6813 # * `inARelationship`
6814 # * `engaged`
6815 # * `married`
6816 # * `itsComplicated`
6817 # * `openRelationship`
6818 # * `widowed`
6819 # * `inDomesticPartnership`
6820 # * `inCivilUnion`
6821 "metadata": { # Metadata about a field. # Metadata about the relationship status.
6822 "source": { # The source of a field. # The source of the field.
6823 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6824 #
6825 # Last update timestamp of this source.
6826 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6827 #
6828 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6829 # source. Used for web cache validation.
6830 "type": "A String", # The source type.
6831 "id": "A String", # The unique identifier within the source type generated by the server.
6832 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6833 #
6834 # Metadata about a source of type PROFILE.
6835 "userTypes": [ # The user types.
6836 "A String",
6837 ],
6838 "objectType": "A String", # The profile object type.
6839 },
6840 },
6841 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6842 # verified field is typically a name, email address, phone number, or
6843 # website that has been confirmed to be owned by the person.
6844 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6845 # field.
6846 },
6847 },
6848 ],
6849 "imClients": [ # The person's instant messaging clients.
6850 { # A person's instant messaging client.
6851 "username": "A String", # The user name used in the IM client.
6852 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
6853 # viewer's account locale or the `Accept-Language` HTTP header locale.
6854 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or one of these
6855 # predefined values:
6856 #
6857 # * `aim`
6858 # * `msn`
6859 # * `yahoo`
6860 # * `skype`
6861 # * `qq`
6862 # * `googleTalk`
6863 # * `icq`
6864 # * `jabber`
6865 # * `netMeeting`
6866 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
6867 # locale or the `Accept-Language` HTTP header locale.
6868 "type": "A String", # The type of the IM client. The type can be custom or one of these
6869 # predefined values:
6870 #
6871 # * `home`
6872 # * `work`
6873 # * `other`
6874 "metadata": { # Metadata about a field. # Metadata about the IM client.
6875 "source": { # The source of a field. # The source of the field.
6876 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6877 #
6878 # Last update timestamp of this source.
6879 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6880 #
6881 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6882 # source. Used for web cache validation.
6883 "type": "A String", # The source type.
6884 "id": "A String", # The unique identifier within the source type generated by the server.
6885 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6886 #
6887 # Metadata about a source of type PROFILE.
6888 "userTypes": [ # The user types.
6889 "A String",
6890 ],
6891 "objectType": "A String", # The profile object type.
6892 },
6893 },
6894 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6895 # verified field is typically a name, email address, phone number, or
6896 # website that has been confirmed to be owned by the person.
6897 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6898 # field.
6899 },
6900 },
6901 ],
6902 "events": [ # The person's events.
6903 { # An event related to the person.
6904 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
6905 # of day and time zone are either specified elsewhere or are not
6906 # significant. The date is relative to the
6907 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
6908 # The day may be 0 to represent a year and month where the day is not
6909 # significant. The year may be 0 to represent a month and day independent
6910 # of year; for example, anniversary date.
6911 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
6912 # month and day.
6913 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
6914 # if specifying a year by itself or a year and month where the day is not
6915 # significant.
6916 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
6917 # a year.
6918 },
6919 "formattedType": "A String", # The read-only type of the event translated and formatted in the
6920 # viewer's account locale or the `Accept-Language` HTTP header locale.
6921 "type": "A String", # The type of the event. The type can be custom or one of these predefined
6922 # values:
6923 #
6924 # * `anniversary`
6925 # * `other`
6926 "metadata": { # Metadata about a field. # Metadata about the event.
6927 "source": { # The source of a field. # The source of the field.
6928 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6929 #
6930 # Last update timestamp of this source.
6931 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6932 #
6933 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6934 # source. Used for web cache validation.
6935 "type": "A String", # The source type.
6936 "id": "A String", # The unique identifier within the source type generated by the server.
6937 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6938 #
6939 # Metadata about a source of type PROFILE.
6940 "userTypes": [ # The user types.
6941 "A String",
6942 ],
6943 "objectType": "A String", # The profile object type.
6944 },
6945 },
6946 "verified": True or False, # True if the field is verified; false if the field is unverified. A
6947 # verified field is typically a name, email address, phone number, or
6948 # website that has been confirmed to be owned by the person.
6949 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
6950 # field.
6951 },
6952 },
6953 ],
6954 "metadata": { # The read-only metadata about a person. # Read-only metadata about the person.
6955 "previousResourceNames": [ # Any former resource names this person has had. Populated only for
6956 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
6957 # that include a sync token.
6958 #
6959 # The resource name may change when adding or removing fields that link a
6960 # contact and profile such as a verified email, verified phone number, or
6961 # profile URL.
6962 "A String",
6963 ],
6964 "sources": [ # The sources of data for the person.
6965 { # The source of a field.
6966 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
6967 #
6968 # Last update timestamp of this source.
6969 "etag": "A String", # **Only populated in `person.metadata.sources`.**
6970 #
6971 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
6972 # source. Used for web cache validation.
6973 "type": "A String", # The source type.
6974 "id": "A String", # The unique identifier within the source type generated by the server.
6975 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
6976 #
6977 # Metadata about a source of type PROFILE.
6978 "userTypes": [ # The user types.
6979 "A String",
6980 ],
6981 "objectType": "A String", # The profile object type.
6982 },
6983 },
6984 ],
6985 "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
6986 "A String",
6987 ],
6988 "deleted": True or False, # True if the person resource has been deleted. Populated only for
6989 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
6990 # that include a sync token.
6991 "objectType": "A String", # **DEPRECATED** (Please use
6992 # `person.metadata.sources.profileMetadata.objectType` instead)
6993 #
6994 # The type of the person object.
6995 },
6996 "interests": [ # The person's interests.
6997 { # One of the person's interests.
6998 "value": "A String", # The interest; for example, `stargazing`.
6999 "metadata": { # Metadata about a field. # Metadata about the interest.
7000 "source": { # The source of a field. # The source of the field.
7001 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7002 #
7003 # Last update timestamp of this source.
7004 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7005 #
7006 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7007 # source. Used for web cache validation.
7008 "type": "A String", # The source type.
7009 "id": "A String", # The unique identifier within the source type generated by the server.
7010 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7011 #
7012 # Metadata about a source of type PROFILE.
7013 "userTypes": [ # The user types.
7014 "A String",
7015 ],
7016 "objectType": "A String", # The profile object type.
7017 },
7018 },
7019 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7020 # verified field is typically a name, email address, phone number, or
7021 # website that has been confirmed to be owned by the person.
7022 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7023 # field.
7024 },
7025 },
7026 ],
7027 "photos": [ # The person's read-only photos.
7028 { # A person's read-only photo. A picture shown next to the person's name to
7029 # help others recognize the person.
7030 "default": True or False, # True if the photo is a default photo;
7031 # false if the photo is a user-provided photo.
7032 "url": "A String", # The URL of the photo. You can change the desired size by appending a query
7033 # parameter `sz=`<var>size</var> at the end of the url. Example:
7034 # `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`
7035 "metadata": { # Metadata about a field. # Metadata about the photo.
7036 "source": { # The source of a field. # The source of the field.
7037 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7038 #
7039 # Last update timestamp of this source.
7040 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7041 #
7042 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7043 # source. Used for web cache validation.
7044 "type": "A String", # The source type.
7045 "id": "A String", # The unique identifier within the source type generated by the server.
7046 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7047 #
7048 # Metadata about a source of type PROFILE.
7049 "userTypes": [ # The user types.
7050 "A String",
7051 ],
7052 "objectType": "A String", # The profile object type.
7053 },
7054 },
7055 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7056 # verified field is typically a name, email address, phone number, or
7057 # website that has been confirmed to be owned by the person.
7058 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7059 # field.
7060 },
7061 },
7062 ],
7063 "residences": [ # The person's residences.
7064 { # A person's past or current residence.
7065 "current": True or False, # True if the residence is the person's current residence;
7066 # false if the residence is a past residence.
7067 "value": "A String", # The address of the residence.
7068 "metadata": { # Metadata about a field. # Metadata about the residence.
7069 "source": { # The source of a field. # The source of the field.
7070 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7071 #
7072 # Last update timestamp of this source.
7073 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7074 #
7075 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7076 # source. Used for web cache validation.
7077 "type": "A String", # The source type.
7078 "id": "A String", # The unique identifier within the source type generated by the server.
7079 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7080 #
7081 # Metadata about a source of type PROFILE.
7082 "userTypes": [ # The user types.
7083 "A String",
7084 ],
7085 "objectType": "A String", # The profile object type.
7086 },
7087 },
7088 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7089 # verified field is typically a name, email address, phone number, or
7090 # website that has been confirmed to be owned by the person.
7091 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7092 # field.
7093 },
7094 },
7095 ],
7096 "relationshipInterests": [ # The person's read-only relationship interests.
7097 { # A person's read-only relationship interest .
7098 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
7099 # viewer's account locale or the locale specified in the Accept-Language
7100 # HTTP header.
7101 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
7102 # or one of these predefined values:
7103 #
7104 # * `friend`
7105 # * `date`
7106 # * `relationship`
7107 # * `networking`
7108 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
7109 "source": { # The source of a field. # The source of the field.
7110 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7111 #
7112 # Last update timestamp of this source.
7113 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7114 #
7115 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7116 # source. Used for web cache validation.
7117 "type": "A String", # The source type.
7118 "id": "A String", # The unique identifier within the source type generated by the server.
7119 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7120 #
7121 # Metadata about a source of type PROFILE.
7122 "userTypes": [ # The user types.
7123 "A String",
7124 ],
7125 "objectType": "A String", # The profile object type.
7126 },
7127 },
7128 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7129 # verified field is typically a name, email address, phone number, or
7130 # website that has been confirmed to be owned by the person.
7131 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7132 # field.
7133 },
7134 },
7135 ],
7136 "coverPhotos": [ # The person's read-only cover photos.
7137 { # A person's read-only cover photo. A large image shown on the person's
7138 # profile page that represents who they are or what they care about.
7139 "default": True or False, # True if the cover photo is the default cover photo;
7140 # false if the cover photo is a user-provided cover photo.
7141 "url": "A String", # The URL of the cover photo.
7142 "metadata": { # Metadata about a field. # Metadata about the cover photo.
7143 "source": { # The source of a field. # The source of the field.
7144 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7145 #
7146 # Last update timestamp of this source.
7147 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7148 #
7149 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7150 # source. Used for web cache validation.
7151 "type": "A String", # The source type.
7152 "id": "A String", # The unique identifier within the source type generated by the server.
7153 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7154 #
7155 # Metadata about a source of type PROFILE.
7156 "userTypes": [ # The user types.
7157 "A String",
7158 ],
7159 "objectType": "A String", # The profile object type.
7160 },
7161 },
7162 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7163 # verified field is typically a name, email address, phone number, or
7164 # website that has been confirmed to be owned by the person.
7165 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7166 # field.
7167 },
7168 },
7169 ],
7170 "locales": [ # The person's locale preferences.
7171 { # A person's locale preference.
7172 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
7173 # language tag representing the locale.
7174 "metadata": { # Metadata about a field. # Metadata about the locale.
7175 "source": { # The source of a field. # The source of the field.
7176 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7177 #
7178 # Last update timestamp of this source.
7179 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7180 #
7181 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7182 # source. Used for web cache validation.
7183 "type": "A String", # The source type.
7184 "id": "A String", # The unique identifier within the source type generated by the server.
7185 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7186 #
7187 # Metadata about a source of type PROFILE.
7188 "userTypes": [ # The user types.
7189 "A String",
7190 ],
7191 "objectType": "A String", # The profile object type.
7192 },
7193 },
7194 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7195 # verified field is typically a name, email address, phone number, or
7196 # website that has been confirmed to be owned by the person.
7197 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7198 # field.
7199 },
7200 },
7201 ],
7202 "organizations": [ # The person's past or current organizations.
7203 { # A person's past or current organization. Overlapping date ranges are
7204 # permitted.
7205 "formattedType": "A String", # The read-only type of the organization translated and formatted in the
7206 # viewer's account locale or the `Accept-Language` HTTP header locale.
7207 "domain": "A String", # The domain name associated with the organization; for example,
7208 # `google.com`.
7209 "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
7210 # of day and time zone are either specified elsewhere or are not
7211 # significant. The date is relative to the
7212 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
7213 # The day may be 0 to represent a year and month where the day is not
7214 # significant. The year may be 0 to represent a month and day independent
7215 # of year; for example, anniversary date.
7216 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
7217 # month and day.
7218 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
7219 # if specifying a year by itself or a year and month where the day is not
7220 # significant.
7221 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
7222 # a year.
7223 },
7224 "name": "A String", # The name of the organization.
7225 "title": "A String", # The person's job title at the organization.
7226 "type": "A String", # The type of the organization. The type can be custom or one of these
7227 # predefined values:
7228 #
7229 # * `work`
7230 # * `school`
7231 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
7232 # symbol, abbreviation, or acronym.
7233 "current": True or False, # True if the organization is the person's current organization;
7234 # false if the organization is a past organization.
7235 "jobDescription": "A String", # The person's job description at the organization.
7236 "location": "A String", # The location of the organization office the person works at.
7237 "department": "A String", # The person's department at the organization.
7238 "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
7239 # of day and time zone are either specified elsewhere or are not
7240 # significant. The date is relative to the
7241 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
7242 # The day may be 0 to represent a year and month where the day is not
7243 # significant. The year may be 0 to represent a month and day independent
7244 # of year; for example, anniversary date.
7245 "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a
7246 # month and day.
7247 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
7248 # if specifying a year by itself or a year and month where the day is not
7249 # significant.
7250 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
7251 # a year.
7252 },
7253 "phoneticName": "A String", # The phonetic name of the organization.
7254 "metadata": { # Metadata about a field. # Metadata about the organization.
7255 "source": { # The source of a field. # The source of the field.
7256 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7257 #
7258 # Last update timestamp of this source.
7259 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7260 #
7261 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7262 # source. Used for web cache validation.
7263 "type": "A String", # The source type.
7264 "id": "A String", # The unique identifier within the source type generated by the server.
7265 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7266 #
7267 # Metadata about a source of type PROFILE.
7268 "userTypes": [ # The user types.
7269 "A String",
7270 ],
7271 "objectType": "A String", # The profile object type.
7272 },
7273 },
7274 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7275 # verified field is typically a name, email address, phone number, or
7276 # website that has been confirmed to be owned by the person.
7277 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7278 # field.
7279 },
7280 },
7281 ],
7282 "userDefined": [ # The person's user defined data.
7283 { # Arbitrary user data that is populated by the end users.
7284 "key": "A String", # The end user specified key of the user defined data.
7285 "value": "A String", # The end user specified value of the user defined data.
7286 "metadata": { # Metadata about a field. # Metadata about the user defined data.
7287 "source": { # The source of a field. # The source of the field.
7288 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7289 #
7290 # Last update timestamp of this source.
7291 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7292 #
7293 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7294 # source. Used for web cache validation.
7295 "type": "A String", # The source type.
7296 "id": "A String", # The unique identifier within the source type generated by the server.
7297 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7298 #
7299 # Metadata about a source of type PROFILE.
7300 "userTypes": [ # The user types.
7301 "A String",
7302 ],
7303 "objectType": "A String", # The profile object type.
7304 },
7305 },
7306 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7307 # verified field is typically a name, email address, phone number, or
7308 # website that has been confirmed to be owned by the person.
7309 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7310 # field.
7311 },
7312 },
7313 ],
7314 "biographies": [ # The person's biographies.
7315 { # A person's short biography.
7316 "contentType": "A String", # The content type of the biography.
7317 "value": "A String", # The short biography.
7318 "metadata": { # Metadata about a field. # Metadata about the biography.
7319 "source": { # The source of a field. # The source of the field.
7320 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7321 #
7322 # Last update timestamp of this source.
7323 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7324 #
7325 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7326 # source. Used for web cache validation.
7327 "type": "A String", # The source type.
7328 "id": "A String", # The unique identifier within the source type generated by the server.
7329 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7330 #
7331 # Metadata about a source of type PROFILE.
7332 "userTypes": [ # The user types.
7333 "A String",
7334 ],
7335 "objectType": "A String", # The profile object type.
7336 },
7337 },
7338 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7339 # verified field is typically a name, email address, phone number, or
7340 # website that has been confirmed to be owned by the person.
7341 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7342 # field.
7343 },
7344 },
7345 ],
7346 "memberships": [ # The person's group memberships.
7347 { # A person's membership in a group. Only contact group memberships can be
7348 # modified.
7349 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
7350 "contactGroupId": "A String", # The read-only contact group ID for the contact group membership.
7351 "contactGroupResourceName": "A String", # The resource name for the contact group, assigned by the server. An ASCII
7352 # string, in the form of `contactGroups/`<var>contact_group_id</var>.
7353 # Only contact_group_resource_name can be used for modifying memberships.
7354 # Any contact group membership can be removed, but only user group or
7355 # "myContacts" or "starred" system groups memberships can be added. A
7356 # contact must always have at least one contact group membership.
7357 },
7358 "domainMembership": { # A read-only G Suite Domain membership. # The read-only domain membership.
7359 "inViewerDomain": True or False, # True if the person is in the viewer's G Suite domain.
7360 },
7361 "metadata": { # Metadata about a field. # Metadata about the membership.
7362 "source": { # The source of a field. # The source of the field.
7363 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7364 #
7365 # Last update timestamp of this source.
7366 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7367 #
7368 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7369 # source. Used for web cache validation.
7370 "type": "A String", # The source type.
7371 "id": "A String", # The unique identifier within the source type generated by the server.
7372 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7373 #
7374 # Metadata about a source of type PROFILE.
7375 "userTypes": [ # The user types.
7376 "A String",
7377 ],
7378 "objectType": "A String", # The profile object type.
7379 },
7380 },
7381 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7382 # verified field is typically a name, email address, phone number, or
7383 # website that has been confirmed to be owned by the person.
7384 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7385 # field.
7386 },
7387 },
7388 ],
7389 "skills": [ # The person's skills.
7390 { # A skill that the person has.
7391 "value": "A String", # The skill; for example, `underwater basket weaving`.
7392 "metadata": { # Metadata about a field. # Metadata about the skill.
7393 "source": { # The source of a field. # The source of the field.
7394 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7395 #
7396 # Last update timestamp of this source.
7397 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7398 #
7399 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7400 # source. Used for web cache validation.
7401 "type": "A String", # The source type.
7402 "id": "A String", # The unique identifier within the source type generated by the server.
7403 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7404 #
7405 # Metadata about a source of type PROFILE.
7406 "userTypes": [ # The user types.
7407 "A String",
7408 ],
7409 "objectType": "A String", # The profile object type.
7410 },
7411 },
7412 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7413 # verified field is typically a name, email address, phone number, or
7414 # website that has been confirmed to be owned by the person.
7415 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7416 # field.
7417 },
7418 },
7419 ],
7420 "urls": [ # The person's associated URLs.
7421 { # A person's associated URLs.
7422 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
7423 # account locale or the `Accept-Language` HTTP header locale.
7424 "type": "A String", # The type of the URL. The type can be custom or one of these predefined
7425 # values:
7426 #
7427 # * `home`
7428 # * `work`
7429 # * `blog`
7430 # * `profile`
7431 # * `homePage`
7432 # * `ftp`
7433 # * `reservations`
7434 # * `appInstallPage`: website for a Google+ application.
7435 # * `other`
7436 "value": "A String", # The URL.
7437 "metadata": { # Metadata about a field. # Metadata about the URL.
7438 "source": { # The source of a field. # The source of the field.
7439 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7440 #
7441 # Last update timestamp of this source.
7442 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7443 #
7444 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7445 # source. Used for web cache validation.
7446 "type": "A String", # The source type.
7447 "id": "A String", # The unique identifier within the source type generated by the server.
7448 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7449 #
7450 # Metadata about a source of type PROFILE.
7451 "userTypes": [ # The user types.
7452 "A String",
7453 ],
7454 "objectType": "A String", # The profile object type.
7455 },
7456 },
7457 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7458 # verified field is typically a name, email address, phone number, or
7459 # website that has been confirmed to be owned by the person.
7460 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7461 # field.
7462 },
7463 },
7464 ],
7465 "ageRange": "A String", # **DEPRECATED** (Please use `person.ageRanges` instead)**
7466 #
7467 # The person's read-only age range.
7468 "genders": [ # The person's genders.
7469 { # A person's gender.
7470 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
7471 # account locale or the `Accept-Language` HTTP header locale.
7472 "value": "A String", # The gender for the person. The gender can be custom or one of these
7473 # predefined values:
7474 #
7475 # * `male`
7476 # * `female`
7477 # * `other`
7478 # * `unknown`
7479 "metadata": { # Metadata about a field. # Metadata about the gender.
7480 "source": { # The source of a field. # The source of the field.
7481 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7482 #
7483 # Last update timestamp of this source.
7484 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7485 #
7486 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7487 # source. Used for web cache validation.
7488 "type": "A String", # The source type.
7489 "id": "A String", # The unique identifier within the source type generated by the server.
7490 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7491 #
7492 # Metadata about a source of type PROFILE.
7493 "userTypes": [ # The user types.
7494 "A String",
7495 ],
7496 "objectType": "A String", # The profile object type.
7497 },
7498 },
7499 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7500 # verified field is typically a name, email address, phone number, or
7501 # website that has been confirmed to be owned by the person.
7502 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7503 # field.
7504 },
7505 },
7506 ],
7507 "emailAddresses": [ # The person's email addresses.
7508 { # A person's email address.
7509 "type": "A String", # The type of the email address. The type can be custom or one of these
7510 # predefined values:
7511 #
7512 # * `home`
7513 # * `work`
7514 # * `other`
7515 "formattedType": "A String", # The read-only type of the email address translated and formatted in the
7516 # viewer's account locale or the `Accept-Language` HTTP header locale.
7517 "displayName": "A String", # The display name of the email.
7518 "value": "A String", # The email address.
7519 "metadata": { # Metadata about a field. # Metadata about the email address.
7520 "source": { # The source of a field. # The source of the field.
7521 "updateTime": "A String", # **Only populated in `person.metadata.sources`.**
7522 #
7523 # Last update timestamp of this source.
7524 "etag": "A String", # **Only populated in `person.metadata.sources`.**
7525 #
7526 # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
7527 # source. Used for web cache validation.
7528 "type": "A String", # The source type.
7529 "id": "A String", # The unique identifier within the source type generated by the server.
7530 "profileMetadata": { # The read-only metadata about a profile. # **Only populated in `person.metadata.sources`.**
7531 #
7532 # Metadata about a source of type PROFILE.
7533 "userTypes": [ # The user types.
7534 "A String",
7535 ],
7536 "objectType": "A String", # The profile object type.
7537 },
7538 },
7539 "verified": True or False, # True if the field is verified; false if the field is unverified. A
7540 # verified field is typically a name, email address, phone number, or
7541 # website that has been confirmed to be owned by the person.
7542 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
7543 # field.
7544 },
7545 },
7546 ],
7547 }</pre>
7548</div>
7549
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]7550</body></html>