Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2f245374da9c895dbd8bb0423e98707d51b53414 / . / docs / dyn / people_v1.people.html
blob: 168b82a0f01dd3dc2f616636aa15d59596e2b99d [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
75<h1><a href="people_v1.html">Google People API</a> . <a href="people_v1.people.html">people</a></h1>
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">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]83 <code><a href="#get">get(resourceName, x__xgafv=None, requestMask_includeField=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]84<p class="firstline">Provides information about a person resource for a resource name. Use</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<p class="toc_element">
86 <code><a href="#getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]87<p class="firstline">Provides information about a list of specific people by specifying a list</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]88<h3>Method Details</h3>
89<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]90 <code class="details" id="get">get(resourceName, x__xgafv=None, requestMask_includeField=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]91 <pre>Provides information about a person resource for a resource name. Use
92`people/me` to indicate the authenticated user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]93
94Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]95 resourceName: string, The resource name of the person to provide information about.
96
97- To get information about the authenticated user, specify `people/me`.
98- To get information about any user, specify the resource name that
99 identifies the user, such as the resource names returned by
100 [`people.connections.list`](/people/api/rest/v1/people.connections/list). (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]101 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105 requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting
106this field will include all fields except for connections.list requests,
107which have a default mask that includes common fields like metadata, name,
108photo, and profile url.
109Each path should start with `person.`: for example, `person.names` or
110`person.photos`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]111
112Returns:
113 An object of the form:
114
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]115 { # Information about a person merged from various data sources such as the
116 # authenticated user's contacts and profile data. Fields other than IDs,
117 # metadata, and group memberships are user-edited.
118 #
119 # Most fields can have multiple items. The items in a field have no guaranteed
120 # order, but each non-empty field is guaranteed to have exactly one field with
121 # `metadata.primary` set to true.
122 # NEXT_ID: 31
123 "braggingRights": [ # The person's bragging rights.
124 { # A person's bragging rights.
125 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
126 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]127 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]128 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
129 # source. Used for web cache validation. Only populated in
130 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]131 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]132 "id": "A String", # The unique identifier within the source type generated by the server.
133 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
134 "objectType": "A String", # The profile object type.
135 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]136 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]137 "verified": True or False, # True if the field is verified; false if the field is unverified. A
138 # verified field is typically a name, email address, phone number, or
139 # website that has been confirmed to be owned by the person.
140 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
141 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]142 },
143 },
144 ],
145 "addresses": [ # The person's street addresses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]146 { # A person's physical address. May be a P.O. box or street address. All fields
147 # are optional.
148 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
149 # account locale or the `Accept-Language` HTTP header locale.
150 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
151 # code of the address.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]152 "city": "A String", # The city of the address.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]153 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
154 # will be automatically constructed from structured values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]155 "region": "A String", # The region of the address; for example, the state or province.
156 "poBox": "A String", # The P.O. box of the address.
157 "streetAddress": "A String", # The street address.
158 "country": "A String", # The country of the address.
159 "postalCode": "A String", # The postal code of the address.
160 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]161 "type": "A String", # The type of the address. The type can be custom or predefined.
162 # Possible values include, but are not limited to, the following:
163 #
164 # * `home`
165 # * `work`
166 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]167 "metadata": { # Metadata about a field. # Metadata about the address.
168 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]169 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
170 # source. Used for web cache validation. Only populated in
171 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]172 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]173 "id": "A String", # The unique identifier within the source type generated by the server.
174 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
175 "objectType": "A String", # The profile object type.
176 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]177 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]178 "verified": True or False, # True if the field is verified; false if the field is unverified. A
179 # verified field is typically a name, email address, phone number, or
180 # website that has been confirmed to be owned by the person.
181 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
182 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]183 },
184 },
185 ],
186 "nicknames": [ # The person's nicknames.
187 { # A person's nickname.
188 "type": "A String", # The type of the nickname.
189 "value": "A String", # The nickname.
190 "metadata": { # Metadata about a field. # Metadata about the nickname.
191 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]192 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
193 # source. Used for web cache validation. Only populated in
194 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]195 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]196 "id": "A String", # The unique identifier within the source type generated by the server.
197 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
198 "objectType": "A String", # The profile object type.
199 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]200 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]201 "verified": True or False, # True if the field is verified; false if the field is unverified. A
202 # verified field is typically a name, email address, phone number, or
203 # website that has been confirmed to be owned by the person.
204 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
205 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]206 },
207 },
208 ],
209 "occupations": [ # The person's occupations.
210 { # A person's occupation.
211 "value": "A String", # The occupation; for example, `carpenter`.
212 "metadata": { # Metadata about a field. # Metadata about the occupation.
213 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]214 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
215 # source. Used for web cache validation. Only populated in
216 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]217 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]218 "id": "A String", # The unique identifier within the source type generated by the server.
219 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
220 "objectType": "A String", # The profile object type.
221 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]222 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]223 "verified": True or False, # True if the field is verified; false if the field is unverified. A
224 # verified field is typically a name, email address, phone number, or
225 # website that has been confirmed to be owned by the person.
226 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
227 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]228 },
229 },
230 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]231 "phoneNumbers": [ # The person's phone numbers.
232 { # A person's phone number.
233 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
234 # viewer's account locale or the the `Accept-Language` HTTP header locale.
235 "metadata": { # Metadata about a field. # Metadata about the phone number.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]236 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]237 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
238 # source. Used for web cache validation. Only populated in
239 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]240 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]241 "id": "A String", # The unique identifier within the source type generated by the server.
242 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
243 "objectType": "A String", # The profile object type.
244 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]245 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]246 "verified": True or False, # True if the field is verified; false if the field is unverified. A
247 # verified field is typically a name, email address, phone number, or
248 # website that has been confirmed to be owned by the person.
249 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
250 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]251 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]252 "type": "A String", # The type of the phone number. The type can be custom or predefined.
253 # Possible values include, but are not limited to, the following:
254 #
255 # * `home`
256 # * `work`
257 # * `mobile`
258 # * `homeFax`
259 # * `workFax`
260 # * `otherFax`
261 # * `pager`
262 # * `workMobile`
263 # * `workPager`
264 # * `main`
265 # * `googleVoice`
266 # * `other`
267 "value": "A String", # The phone number.
268 "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
269 # form of the phone number.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]270 },
271 ],
272 "names": [ # The person's names.
273 { # A person's name. If the name is a mononym, the family name is empty.
274 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
275 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
276 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]277 "displayName": "A String", # The read-only display name formatted according to the locale specified by
278 # the viewer's account or the <code>Accept-Language</code> HTTP header.
279 "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
280 # the locale specified by the viewer's account or the
281 # <code>Accept-Language</code> HTTP header.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]282 "middleName": "A String", # The middle name(s).
283 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
284 "familyName": "A String", # The family name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]285 "phoneticFullName": "A String", # The full name spelled as it sounds.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]286 "phoneticGivenName": "A String", # The given name spelled as it sounds.
287 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
288 "givenName": "A String", # The given name.
289 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
290 "metadata": { # Metadata about a field. # Metadata about the name.
291 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]292 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
293 # source. Used for web cache validation. Only populated in
294 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]295 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]296 "id": "A String", # The unique identifier within the source type generated by the server.
297 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
298 "objectType": "A String", # The profile object type.
299 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]300 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]301 "verified": True or False, # True if the field is verified; false if the field is unverified. A
302 # verified field is typically a name, email address, phone number, or
303 # website that has been confirmed to be owned by the person.
304 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
305 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]306 },
307 },
308 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]309 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
310 # with a max length of 27 characters. Always starts with `people/`.
311 "ageRanges": [ # The person's age ranges.
312 { # A person's age range.
313 "ageRange": "A String", # The age range.
314 "metadata": { # Metadata about a field. # Metadata about the age range.
315 "source": { # The source of a field. # The source of the field.
316 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
317 # source. Used for web cache validation. Only populated in
318 # person.metadata.sources.
319 "type": "A String", # The source type.
320 "id": "A String", # The unique identifier within the source type generated by the server.
321 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
322 "objectType": "A String", # The profile object type.
323 },
324 },
325 "verified": True or False, # True if the field is verified; false if the field is unverified. A
326 # verified field is typically a name, email address, phone number, or
327 # website that has been confirmed to be owned by the person.
328 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
329 # field.
330 },
331 },
332 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]333 "birthdays": [ # The person's birthdays.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]334 { # A person's birthday. At least one of the `date` and `text` fields are
335 # specified. The `date` and `text` fields typically represent the same
336 # date, but are not guaranteed to.
337 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
338 # of day and time zone are either specified elsewhere or are not
339 # significant. The date is relative to the
340 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
341 # The day may be 0 to represent a year and month where the day is not
342 # significant. The year may be 0 to represent a month and day independent
343 # of year; for example, anniversary date.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]344 "month": 42, # Month of year. Must be from 1 to 12.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]345 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
346 # if specifying a year/month where the day is not significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]347 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
348 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]349 },
350 "text": "A String", # A free-form string representing the user's birthday.
351 "metadata": { # Metadata about a field. # Metadata about the birthday.
352 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]353 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
354 # source. Used for web cache validation. Only populated in
355 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]356 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]357 "id": "A String", # The unique identifier within the source type generated by the server.
358 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
359 "objectType": "A String", # The profile object type.
360 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]361 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]362 "verified": True or False, # True if the field is verified; false if the field is unverified. A
363 # verified field is typically a name, email address, phone number, or
364 # website that has been confirmed to be owned by the person.
365 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
366 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]367 },
368 },
369 ],
370 "relations": [ # The person's relations.
371 { # A person's relation to another person.
372 "person": "A String", # The name of the other person this relation refers to.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]373 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
374 # locale or the locale specified in the Accept-Language HTTP header.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]375 "type": "A String", # The person's relation to the other person. The type can be custom or predefined.
376 # Possible values include, but are not limited to, the following values:
377 #
378 # * `spouse`
379 # * `child`
380 # * `mother`
381 # * `father`
382 # * `parent`
383 # * `brother`
384 # * `sister`
385 # * `friend`
386 # * `relative`
387 # * `domesticPartner`
388 # * `manager`
389 # * `assistant`
390 # * `referredBy`
391 # * `partner`
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]392 "metadata": { # Metadata about a field. # Metadata about the relation.
393 "source": { # The source of a field. # The source of the field.
394 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
395 # source. Used for web cache validation. Only populated in
396 # person.metadata.sources.
397 "type": "A String", # The source type.
398 "id": "A String", # The unique identifier within the source type generated by the server.
399 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
400 "objectType": "A String", # The profile object type.
401 },
402 },
403 "verified": True or False, # True if the field is verified; false if the field is unverified. A
404 # verified field is typically a name, email address, phone number, or
405 # website that has been confirmed to be owned by the person.
406 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
407 # field.
408 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]409 },
410 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]411 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
412 # resource. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]413 "relationshipStatuses": [ # The person's relationship statuses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]414 { # A person's read-only relationship status.
415 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
416 # the viewer's account locale or the `Accept-Language` HTTP header locale.
417 "value": "A String", # The relationship status. The value can be custom or predefined.
418 # Possible values include, but are not limited to, the following:
419 #
420 # * `single`
421 # * `inARelationship`
422 # * `engaged`
423 # * `married`
424 # * `itsComplicated`
425 # * `openRelationship`
426 # * `widowed`
427 # * `inDomesticPartnership`
428 # * `inCivilUnion`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]429 "metadata": { # Metadata about a field. # Metadata about the relationship status.
430 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]431 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
432 # source. Used for web cache validation. Only populated in
433 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]434 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]435 "id": "A String", # The unique identifier within the source type generated by the server.
436 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
437 "objectType": "A String", # The profile object type.
438 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]439 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]440 "verified": True or False, # True if the field is verified; false if the field is unverified. A
441 # verified field is typically a name, email address, phone number, or
442 # website that has been confirmed to be owned by the person.
443 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
444 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]445 },
446 },
447 ],
448 "skills": [ # The person's skills.
449 { # A skill that the person has.
450 "value": "A String", # The skill; for example, `underwater basket weaving`.
451 "metadata": { # Metadata about a field. # Metadata about the skill.
452 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]453 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
454 # source. Used for web cache validation. Only populated in
455 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]456 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]457 "id": "A String", # The unique identifier within the source type generated by the server.
458 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
459 "objectType": "A String", # The profile object type.
460 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]461 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]462 "verified": True or False, # True if the field is verified; false if the field is unverified. A
463 # verified field is typically a name, email address, phone number, or
464 # website that has been confirmed to be owned by the person.
465 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
466 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]467 },
468 },
469 ],
470 "imClients": [ # The person's instant messaging clients.
471 { # A person's instant messaging client.
472 "username": "A String", # The user name used in the IM client.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]473 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
474 # viewer's account locale or the `Accept-Language` HTTP header locale.
475 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined.
476 # Possible values include, but are not limited to, the following:
477 #
478 # * `aim`
479 # * `msn`
480 # * `yahoo`
481 # * `skype`
482 # * `qq`
483 # * `googleTalk`
484 # * `icq`
485 # * `jabber`
486 # * `netMeeting`
487 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
488 # locale or the `Accept-Language` HTTP header locale.
489 "type": "A String", # The type of the IM client. The type can be custom or predefined.
490 # Possible values include, but are not limited to, the following:
491 #
492 # * `home`
493 # * `work`
494 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]495 "metadata": { # Metadata about a field. # Metadata about the IM client.
496 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]497 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
498 # source. Used for web cache validation. Only populated in
499 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]500 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]501 "id": "A String", # The unique identifier within the source type generated by the server.
502 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
503 "objectType": "A String", # The profile object type.
504 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]505 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]506 "verified": True or False, # True if the field is verified; false if the field is unverified. A
507 # verified field is typically a name, email address, phone number, or
508 # website that has been confirmed to be owned by the person.
509 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
510 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]511 },
512 },
513 ],
514 "events": [ # The person's events.
515 { # An event related to the person.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]516 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
517 # of day and time zone are either specified elsewhere or are not
518 # significant. The date is relative to the
519 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
520 # The day may be 0 to represent a year and month where the day is not
521 # significant. The year may be 0 to represent a month and day independent
522 # of year; for example, anniversary date.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]523 "month": 42, # Month of year. Must be from 1 to 12.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]524 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
525 # if specifying a year/month where the day is not significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]526 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
527 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]528 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]529 "formattedType": "A String", # The read-only type of the event translated and formatted in the
530 # viewer's account locale or the `Accept-Language` HTTP header locale.
531 "type": "A String", # The type of the event. The type can be custom or predefined.
532 # Possible values include, but are not limited to, the following:
533 #
534 # * `anniversary`
535 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]536 "metadata": { # Metadata about a field. # Metadata about the event.
537 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]538 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
539 # source. Used for web cache validation. Only populated in
540 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]541 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]542 "id": "A String", # The unique identifier within the source type generated by the server.
543 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
544 "objectType": "A String", # The profile object type.
545 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]546 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]547 "verified": True or False, # True if the field is verified; false if the field is unverified. A
548 # verified field is typically a name, email address, phone number, or
549 # website that has been confirmed to be owned by the person.
550 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
551 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]552 },
553 },
554 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]555 "metadata": { # The read-only metadata about a person. # Metadata about the person.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]556 "previousResourceNames": [ # Any former resource names this person has had. Populated only for
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]557 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
558 # that include a sync token.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]559 #
560 # The resource name may change when adding or removing fields that link a
561 # contact and profile such as a verified email, verified phone number, or
562 # profile URL.
563 "A String",
564 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]565 "sources": [ # The sources of data for the person.
566 { # The source of a field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]567 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
568 # source. Used for web cache validation. Only populated in
569 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]570 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]571 "id": "A String", # The unique identifier within the source type generated by the server.
572 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
573 "objectType": "A String", # The profile object type.
574 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]575 },
576 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]577 "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
578 "A String",
579 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]580 "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]581 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
582 # that include a sync token.
583 "objectType": "A String", # DEPRECATED(Please read person.metadata.sources.profile_metadata instead).
584 # The type of the person object.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]585 },
586 "interests": [ # The person's interests.
587 { # One of the person's interests.
588 "value": "A String", # The interest; for example, `stargazing`.
589 "metadata": { # Metadata about a field. # Metadata about the interest.
590 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]591 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
592 # source. Used for web cache validation. Only populated in
593 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]594 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]595 "id": "A String", # The unique identifier within the source type generated by the server.
596 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
597 "objectType": "A String", # The profile object type.
598 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]599 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]600 "verified": True or False, # True if the field is verified; false if the field is unverified. A
601 # verified field is typically a name, email address, phone number, or
602 # website that has been confirmed to be owned by the person.
603 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
604 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]605 },
606 },
607 ],
608 "photos": [ # The person's photos.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]609 { # A person's read-only photo. A picture shown next to the person's name to
610 # help others recognize the person.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]611 "url": "A String", # The URL of the photo.
612 "metadata": { # Metadata about a field. # Metadata about the photo.
613 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]614 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
615 # source. Used for web cache validation. Only populated in
616 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]617 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]618 "id": "A String", # The unique identifier within the source type generated by the server.
619 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
620 "objectType": "A String", # The profile object type.
621 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]622 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]623 "verified": True or False, # True if the field is verified; false if the field is unverified. A
624 # verified field is typically a name, email address, phone number, or
625 # website that has been confirmed to be owned by the person.
626 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
627 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]628 },
629 },
630 ],
631 "residences": [ # The person's residences.
632 { # A person's past or current residence.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]633 "current": True or False, # True if the residence is the person's current residence;
634 # false if the residence is a past residence.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]635 "value": "A String", # The address of the residence.
636 "metadata": { # Metadata about a field. # Metadata about the residence.
637 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]638 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
639 # source. Used for web cache validation. Only populated in
640 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]641 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]642 "id": "A String", # The unique identifier within the source type generated by the server.
643 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
644 "objectType": "A String", # The profile object type.
645 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]646 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]647 "verified": True or False, # True if the field is verified; false if the field is unverified. A
648 # verified field is typically a name, email address, phone number, or
649 # website that has been confirmed to be owned by the person.
650 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
651 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]652 },
653 },
654 ],
655 "relationshipInterests": [ # The kind of relationship the person is looking for.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]656 { # A person's read-only relationship interest .
657 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
658 # viewer's account locale or the locale specified in the Accept-Language
659 # HTTP header.
660 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
661 # or predefined. Possible values include, but are not limited to, the
662 # following values:
663 #
664 # * `friend`
665 # * `date`
666 # * `relationship`
667 # * `networking`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]668 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
669 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]670 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
671 # source. Used for web cache validation. Only populated in
672 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]673 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]674 "id": "A String", # The unique identifier within the source type generated by the server.
675 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
676 "objectType": "A String", # The profile object type.
677 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]678 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]679 "verified": True or False, # True if the field is verified; false if the field is unverified. A
680 # verified field is typically a name, email address, phone number, or
681 # website that has been confirmed to be owned by the person.
682 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
683 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]684 },
685 },
686 ],
687 "coverPhotos": [ # The person's cover photos.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]688 { # A person's read-only cover photo. A large image shown on the person's
689 # profile page that represents who they are or what they care about.
690 "default": True or False, # True if the cover photo is the default cover photo;
691 # false if the cover photo is a user-provided cover photo.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]692 "url": "A String", # The URL of the cover photo.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]693 "metadata": { # Metadata about a field. # Metadata about the cover photo.
694 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]695 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
696 # source. Used for web cache validation. Only populated in
697 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]698 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]699 "id": "A String", # The unique identifier within the source type generated by the server.
700 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
701 "objectType": "A String", # The profile object type.
702 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]703 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]704 "verified": True or False, # True if the field is verified; false if the field is unverified. A
705 # verified field is typically a name, email address, phone number, or
706 # website that has been confirmed to be owned by the person.
707 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
708 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]709 },
710 },
711 ],
712 "locales": [ # The person's locale preferences.
713 { # A person's locale preference.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]714 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
715 # language tag representing the locale.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]716 "metadata": { # Metadata about a field. # Metadata about the locale.
717 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]718 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
719 # source. Used for web cache validation. Only populated in
720 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]721 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]722 "id": "A String", # The unique identifier within the source type generated by the server.
723 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
724 "objectType": "A String", # The profile object type.
725 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]726 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]727 "verified": True or False, # True if the field is verified; false if the field is unverified. A
728 # verified field is typically a name, email address, phone number, or
729 # website that has been confirmed to be owned by the person.
730 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
731 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]732 },
733 },
734 ],
735 "organizations": [ # The person's past or current organizations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]736 { # A person's past or current organization. Overlapping date ranges are
737 # permitted.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]738 "formattedType": "A String", # The read-only type of the organization translated and formatted in the
739 # viewer's account locale or the `Accept-Language` HTTP header locale.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]740 "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]741 "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
742 # of day and time zone are either specified elsewhere or are not
743 # significant. The date is relative to the
744 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
745 # The day may be 0 to represent a year and month where the day is not
746 # significant. The year may be 0 to represent a month and day independent
747 # of year; for example, anniversary date.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]748 "month": 42, # Month of year. Must be from 1 to 12.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]749 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
750 # if specifying a year/month where the day is not significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]751 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
752 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]753 },
754 "name": "A String", # The name of the organization.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]755 "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
756 # of day and time zone are either specified elsewhere or are not
757 # significant. The date is relative to the
758 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
759 # The day may be 0 to represent a year and month where the day is not
760 # significant. The year may be 0 to represent a month and day independent
761 # of year; for example, anniversary date.
762 "month": 42, # Month of year. Must be from 1 to 12.
763 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
764 # if specifying a year/month where the day is not significant.
765 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
766 # a year.
767 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]768 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
769 # symbol, abbreviation, or acronym.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]770 "title": "A String", # The person's job title at the organization.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]771 "current": True or False, # True if the organization is the person's current organization;
772 # false if the organization is a past organization.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]773 "jobDescription": "A String", # The person's job description at the organization.
774 "location": "A String", # The location of the organization office the person works at.
775 "department": "A String", # The person's department at the organization.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]776 "type": "A String", # The type of the organization. The type can be custom or predefined.
777 # Possible values include, but are not limited to, the following:
778 #
779 # * `work`
780 # * `school`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]781 "phoneticName": "A String", # The phonetic name of the organization.
782 "metadata": { # Metadata about a field. # Metadata about the organization.
783 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]784 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
785 # source. Used for web cache validation. Only populated in
786 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]787 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]788 "id": "A String", # The unique identifier within the source type generated by the server.
789 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
790 "objectType": "A String", # The profile object type.
791 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]792 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]793 "verified": True or False, # True if the field is verified; false if the field is unverified. A
794 # verified field is typically a name, email address, phone number, or
795 # website that has been confirmed to be owned by the person.
796 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
797 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]798 },
799 },
800 ],
801 "biographies": [ # The person's biographies.
802 { # A person's short biography.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]803 "contentType": "A String", # The content type of the biography.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]804 "value": "A String", # The short biography.
805 "metadata": { # Metadata about a field. # Metadata about the biography.
806 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]807 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
808 # source. Used for web cache validation. Only populated in
809 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]810 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]811 "id": "A String", # The unique identifier within the source type generated by the server.
812 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
813 "objectType": "A String", # The profile object type.
814 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]815 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]816 "verified": True or False, # True if the field is verified; false if the field is unverified. A
817 # verified field is typically a name, email address, phone number, or
818 # website that has been confirmed to be owned by the person.
819 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
820 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]821 },
822 },
823 ],
824 "memberships": [ # The person's group memberships.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]825 { # A person's read-only membership in a group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]826 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]827 "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group
828 # ID can be custom or predefined. Possible values include, but are not
829 # limited to, the following:
830 #
831 # * `myContacts`
832 # * `starred`
833 # * A numerical ID for user-created groups.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]834 },
835 "domainMembership": { # A Google Apps Domain membership. # The domain membership.
836 "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
837 },
838 "metadata": { # Metadata about a field. # Metadata about the membership.
839 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]840 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
841 # source. Used for web cache validation. Only populated in
842 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]843 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]844 "id": "A String", # The unique identifier within the source type generated by the server.
845 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
846 "objectType": "A String", # The profile object type.
847 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]848 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]849 "verified": True or False, # True if the field is verified; false if the field is unverified. A
850 # verified field is typically a name, email address, phone number, or
851 # website that has been confirmed to be owned by the person.
852 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
853 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]854 },
855 },
856 ],
857 "taglines": [ # The person's taglines.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]858 { # A read-only brief one-line description of the person.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]859 "value": "A String", # The tagline.
860 "metadata": { # Metadata about a field. # Metadata about the tagline.
861 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]862 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
863 # source. Used for web cache validation. Only populated in
864 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]865 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]866 "id": "A String", # The unique identifier within the source type generated by the server.
867 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
868 "objectType": "A String", # The profile object type.
869 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]870 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]871 "verified": True or False, # True if the field is verified; false if the field is unverified. A
872 # verified field is typically a name, email address, phone number, or
873 # website that has been confirmed to be owned by the person.
874 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
875 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]876 },
877 },
878 ],
879 "urls": [ # The person's associated URLs.
880 { # A person's associated URLs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]881 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
882 # account locale or the `Accept-Language` HTTP header locale.
883 "type": "A String", # The type of the URL. The type can be custom or predefined.
884 # Possible values include, but are not limited to, the following:
885 #
886 # * `home`
887 # * `work`
888 # * `blog`
889 # * `profile`
890 # * `homePage`
891 # * `ftp`
892 # * `reservations`
893 # * `appInstallPage`: website for a Google+ application.
894 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]895 "value": "A String", # The URL.
896 "metadata": { # Metadata about a field. # Metadata about the URL.
897 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]898 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
899 # source. Used for web cache validation. Only populated in
900 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]901 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]902 "id": "A String", # The unique identifier within the source type generated by the server.
903 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
904 "objectType": "A String", # The profile object type.
905 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]906 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]907 "verified": True or False, # True if the field is verified; false if the field is unverified. A
908 # verified field is typically a name, email address, phone number, or
909 # website that has been confirmed to be owned by the person.
910 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
911 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]912 },
913 },
914 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]915 "ageRange": "A String", # DEPRECATED(Please read person.age_ranges instead). The person's age range.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]916 "genders": [ # The person's genders.
917 { # A person's gender.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]918 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
919 # account locale or the `Accept-Language` HTTP header locale.
920 "value": "A String", # The gender for the person. The gender can be custom or predefined.
921 # Possible values include, but are not limited to, the
922 # following:
923 #
924 # * `male`
925 # * `female`
926 # * `other`
927 # * `unknown`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]928 "metadata": { # Metadata about a field. # Metadata about the gender.
929 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]930 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
931 # source. Used for web cache validation. Only populated in
932 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]933 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]934 "id": "A String", # The unique identifier within the source type generated by the server.
935 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
936 "objectType": "A String", # The profile object type.
937 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]938 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]939 "verified": True or False, # True if the field is verified; false if the field is unverified. A
940 # verified field is typically a name, email address, phone number, or
941 # website that has been confirmed to be owned by the person.
942 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
943 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]944 },
945 },
946 ],
947 "emailAddresses": [ # The person's email addresses.
948 { # A person's email address.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]949 "formattedType": "A String", # The read-only type of the email address translated and formatted in the
950 # viewer's account locale or the `Accept-Language` HTTP header locale.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]951 "type": "A String", # The type of the email address. The type can be custom or predefined.
952 # Possible values include, but are not limited to, the following:
953 #
954 # * `home`
955 # * `work`
956 # * `other`
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]957 "displayName": "A String", # The display name of the email.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]958 "value": "A String", # The email address.
959 "metadata": { # Metadata about a field. # Metadata about the email address.
960 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]961 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
962 # source. Used for web cache validation. Only populated in
963 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]964 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]965 "id": "A String", # The unique identifier within the source type generated by the server.
966 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
967 "objectType": "A String", # The profile object type.
968 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]969 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]970 "verified": True or False, # True if the field is verified; false if the field is unverified. A
971 # verified field is typically a name, email address, phone number, or
972 # website that has been confirmed to be owned by the person.
973 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
974 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]975 },
976 },
977 ],
978 }</pre>
979</div>
980
981<div class="method">
982 <code class="details" id="getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]983 <pre>Provides information about a list of specific people by specifying a list
984of requested resource names. Use `people/me` to indicate the authenticated
985user.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]986
987Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]988 resourceNames: string, The resource name, such as one returned by
989[`people.connections.list`](/people/api/rest/v1/people.connections/list),
990of one of the people to provide information about. You can include this
991parameter up to 50 times in one request. (repeated)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]992 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]993 Allowed values
994 1 - v1 error format
995 2 - v2 error format
996 requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting
997this field will include all fields except for connections.list requests,
998which have a default mask that includes common fields like metadata, name,
999photo, and profile url.
1000Each path should start with `person.`: for example, `person.names` or
1001`person.photos`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1002
1003Returns:
1004 An object of the form:
1005
1006 {
1007 "responses": [ # The response for each requested resource name.
1008 { # The response for a single person
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1009 "requestedResourceName": "A String", # The original requested resource name. May be different than the resource
1010 # name on the returned person.
1011 #
1012 # The resource name can change when adding or removing fields that link a
1013 # contact and profile such as a verified email, verified phone number, or a
1014 # profile URL.
1015 "person": { # Information about a person merged from various data sources such as the # The person.
1016 # authenticated user's contacts and profile data. Fields other than IDs,
1017 # metadata, and group memberships are user-edited.
1018 #
1019 # Most fields can have multiple items. The items in a field have no guaranteed
1020 # order, but each non-empty field is guaranteed to have exactly one field with
1021 # `metadata.primary` set to true.
1022 # NEXT_ID: 31
1023 "braggingRights": [ # The person's bragging rights.
1024 { # A person's bragging rights.
1025 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
1026 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1027 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1028 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1029 # source. Used for web cache validation. Only populated in
1030 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1031 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1032 "id": "A String", # The unique identifier within the source type generated by the server.
1033 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1034 "objectType": "A String", # The profile object type.
1035 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1036 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1037 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1038 # verified field is typically a name, email address, phone number, or
1039 # website that has been confirmed to be owned by the person.
1040 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1041 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1042 },
1043 },
1044 ],
1045 "addresses": [ # The person's street addresses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1046 { # A person's physical address. May be a P.O. box or street address. All fields
1047 # are optional.
1048 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's
1049 # account locale or the `Accept-Language` HTTP header locale.
1050 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country
1051 # code of the address.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1052 "city": "A String", # The city of the address.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1053 "formattedValue": "A String", # The unstructured value of the address. If this is not set by the user it
1054 # will be automatically constructed from structured values.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1055 "region": "A String", # The region of the address; for example, the state or province.
1056 "poBox": "A String", # The P.O. box of the address.
1057 "streetAddress": "A String", # The street address.
1058 "country": "A String", # The country of the address.
1059 "postalCode": "A String", # The postal code of the address.
1060 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1061 "type": "A String", # The type of the address. The type can be custom or predefined.
1062 # Possible values include, but are not limited to, the following:
1063 #
1064 # * `home`
1065 # * `work`
1066 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1067 "metadata": { # Metadata about a field. # Metadata about the address.
1068 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1069 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1070 # source. Used for web cache validation. Only populated in
1071 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1072 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1073 "id": "A String", # The unique identifier within the source type generated by the server.
1074 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1075 "objectType": "A String", # The profile object type.
1076 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1077 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1078 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1079 # verified field is typically a name, email address, phone number, or
1080 # website that has been confirmed to be owned by the person.
1081 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1082 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1083 },
1084 },
1085 ],
1086 "nicknames": [ # The person's nicknames.
1087 { # A person's nickname.
1088 "type": "A String", # The type of the nickname.
1089 "value": "A String", # The nickname.
1090 "metadata": { # Metadata about a field. # Metadata about the nickname.
1091 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1092 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1093 # source. Used for web cache validation. Only populated in
1094 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1095 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1096 "id": "A String", # The unique identifier within the source type generated by the server.
1097 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1098 "objectType": "A String", # The profile object type.
1099 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1100 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1101 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1102 # verified field is typically a name, email address, phone number, or
1103 # website that has been confirmed to be owned by the person.
1104 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1105 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1106 },
1107 },
1108 ],
1109 "occupations": [ # The person's occupations.
1110 { # A person's occupation.
1111 "value": "A String", # The occupation; for example, `carpenter`.
1112 "metadata": { # Metadata about a field. # Metadata about the occupation.
1113 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1114 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1115 # source. Used for web cache validation. Only populated in
1116 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1117 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1118 "id": "A String", # The unique identifier within the source type generated by the server.
1119 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1120 "objectType": "A String", # The profile object type.
1121 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1122 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1123 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1124 # verified field is typically a name, email address, phone number, or
1125 # website that has been confirmed to be owned by the person.
1126 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1127 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1128 },
1129 },
1130 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1131 "phoneNumbers": [ # The person's phone numbers.
1132 { # A person's phone number.
1133 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the
1134 # viewer's account locale or the the `Accept-Language` HTTP header locale.
1135 "metadata": { # Metadata about a field. # Metadata about the phone number.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1136 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1137 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1138 # source. Used for web cache validation. Only populated in
1139 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1140 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1141 "id": "A String", # The unique identifier within the source type generated by the server.
1142 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1143 "objectType": "A String", # The profile object type.
1144 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1145 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1146 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1147 # verified field is typically a name, email address, phone number, or
1148 # website that has been confirmed to be owned by the person.
1149 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1150 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1151 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]1152 "type": "A String", # The type of the phone number. The type can be custom or predefined.
1153 # Possible values include, but are not limited to, the following:
1154 #
1155 # * `home`
1156 # * `work`
1157 # * `mobile`
1158 # * `homeFax`
1159 # * `workFax`
1160 # * `otherFax`
1161 # * `pager`
1162 # * `workMobile`
1163 # * `workPager`
1164 # * `main`
1165 # * `googleVoice`
1166 # * `other`
1167 "value": "A String", # The phone number.
1168 "canonicalForm": "A String", # The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)
1169 # form of the phone number.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1170 },
1171 ],
1172 "names": [ # The person's names.
1173 { # A person's name. If the name is a mononym, the family name is empty.
1174 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
1175 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
1176 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1177 "displayName": "A String", # The read-only display name formatted according to the locale specified by
1178 # the viewer's account or the <code>Accept-Language</code> HTTP header.
1179 "displayNameLastFirst": "A String", # The read-only display name with the last name first formatted according to
1180 # the locale specified by the viewer's account or the
1181 # <code>Accept-Language</code> HTTP header.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1182 "middleName": "A String", # The middle name(s).
1183 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
1184 "familyName": "A String", # The family name.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1185 "phoneticFullName": "A String", # The full name spelled as it sounds.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1186 "phoneticGivenName": "A String", # The given name spelled as it sounds.
1187 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
1188 "givenName": "A String", # The given name.
1189 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
1190 "metadata": { # Metadata about a field. # Metadata about the name.
1191 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1192 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1193 # source. Used for web cache validation. Only populated in
1194 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1195 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1196 "id": "A String", # The unique identifier within the source type generated by the server.
1197 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1198 "objectType": "A String", # The profile object type.
1199 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1200 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1201 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1202 # verified field is typically a name, email address, phone number, or
1203 # website that has been confirmed to be owned by the person.
1204 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1205 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1206 },
1207 },
1208 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1209 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string
1210 # with a max length of 27 characters. Always starts with `people/`.
1211 "ageRanges": [ # The person's age ranges.
1212 { # A person's age range.
1213 "ageRange": "A String", # The age range.
1214 "metadata": { # Metadata about a field. # Metadata about the age range.
1215 "source": { # The source of a field. # The source of the field.
1216 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1217 # source. Used for web cache validation. Only populated in
1218 # person.metadata.sources.
1219 "type": "A String", # The source type.
1220 "id": "A String", # The unique identifier within the source type generated by the server.
1221 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1222 "objectType": "A String", # The profile object type.
1223 },
1224 },
1225 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1226 # verified field is typically a name, email address, phone number, or
1227 # website that has been confirmed to be owned by the person.
1228 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1229 # field.
1230 },
1231 },
1232 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1233 "birthdays": [ # The person's birthdays.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1234 { # A person's birthday. At least one of the `date` and `text` fields are
1235 # specified. The `date` and `text` fields typically represent the same
1236 # date, but are not guaranteed to.
1237 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the birthday.
1238 # of day and time zone are either specified elsewhere or are not
1239 # significant. The date is relative to the
1240 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
1241 # The day may be 0 to represent a year and month where the day is not
1242 # significant. The year may be 0 to represent a month and day independent
1243 # of year; for example, anniversary date.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1244 "month": 42, # Month of year. Must be from 1 to 12.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1245 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1246 # if specifying a year/month where the day is not significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1247 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1248 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1249 },
1250 "text": "A String", # A free-form string representing the user's birthday.
1251 "metadata": { # Metadata about a field. # Metadata about the birthday.
1252 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1253 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1254 # source. Used for web cache validation. Only populated in
1255 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1256 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1257 "id": "A String", # The unique identifier within the source type generated by the server.
1258 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1259 "objectType": "A String", # The profile object type.
1260 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1261 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1262 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1263 # verified field is typically a name, email address, phone number, or
1264 # website that has been confirmed to be owned by the person.
1265 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1266 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1267 },
1268 },
1269 ],
1270 "relations": [ # The person's relations.
1271 { # A person's relation to another person.
1272 "person": "A String", # The name of the other person this relation refers to.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1273 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account
1274 # locale or the locale specified in the Accept-Language HTTP header.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1275 "type": "A String", # The person's relation to the other person. The type can be custom or predefined.
1276 # Possible values include, but are not limited to, the following values:
1277 #
1278 # * `spouse`
1279 # * `child`
1280 # * `mother`
1281 # * `father`
1282 # * `parent`
1283 # * `brother`
1284 # * `sister`
1285 # * `friend`
1286 # * `relative`
1287 # * `domesticPartner`
1288 # * `manager`
1289 # * `assistant`
1290 # * `referredBy`
1291 # * `partner`
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1292 "metadata": { # Metadata about a field. # Metadata about the relation.
1293 "source": { # The source of a field. # The source of the field.
1294 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1295 # source. Used for web cache validation. Only populated in
1296 # person.metadata.sources.
1297 "type": "A String", # The source type.
1298 "id": "A String", # The unique identifier within the source type generated by the server.
1299 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1300 "objectType": "A String", # The profile object type.
1301 },
1302 },
1303 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1304 # verified field is typically a name, email address, phone number, or
1305 # website that has been confirmed to be owned by the person.
1306 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1307 # field.
1308 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1309 },
1310 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1311 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1312 # resource. Used for web cache validation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1313 "relationshipStatuses": [ # The person's relationship statuses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1314 { # A person's read-only relationship status.
1315 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in
1316 # the viewer's account locale or the `Accept-Language` HTTP header locale.
1317 "value": "A String", # The relationship status. The value can be custom or predefined.
1318 # Possible values include, but are not limited to, the following:
1319 #
1320 # * `single`
1321 # * `inARelationship`
1322 # * `engaged`
1323 # * `married`
1324 # * `itsComplicated`
1325 # * `openRelationship`
1326 # * `widowed`
1327 # * `inDomesticPartnership`
1328 # * `inCivilUnion`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1329 "metadata": { # Metadata about a field. # Metadata about the relationship status.
1330 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1331 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1332 # source. Used for web cache validation. Only populated in
1333 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1334 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1335 "id": "A String", # The unique identifier within the source type generated by the server.
1336 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1337 "objectType": "A String", # The profile object type.
1338 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1339 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1340 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1341 # verified field is typically a name, email address, phone number, or
1342 # website that has been confirmed to be owned by the person.
1343 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1344 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1345 },
1346 },
1347 ],
1348 "skills": [ # The person's skills.
1349 { # A skill that the person has.
1350 "value": "A String", # The skill; for example, `underwater basket weaving`.
1351 "metadata": { # Metadata about a field. # Metadata about the skill.
1352 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1353 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1354 # source. Used for web cache validation. Only populated in
1355 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1356 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1357 "id": "A String", # The unique identifier within the source type generated by the server.
1358 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1359 "objectType": "A String", # The profile object type.
1360 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1361 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1362 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1363 # verified field is typically a name, email address, phone number, or
1364 # website that has been confirmed to be owned by the person.
1365 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1366 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1367 },
1368 },
1369 ],
1370 "imClients": [ # The person's instant messaging clients.
1371 { # A person's instant messaging client.
1372 "username": "A String", # The user name used in the IM client.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1373 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the
1374 # viewer's account locale or the `Accept-Language` HTTP header locale.
1375 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined.
1376 # Possible values include, but are not limited to, the following:
1377 #
1378 # * `aim`
1379 # * `msn`
1380 # * `yahoo`
1381 # * `skype`
1382 # * `qq`
1383 # * `googleTalk`
1384 # * `icq`
1385 # * `jabber`
1386 # * `netMeeting`
1387 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account
1388 # locale or the `Accept-Language` HTTP header locale.
1389 "type": "A String", # The type of the IM client. The type can be custom or predefined.
1390 # Possible values include, but are not limited to, the following:
1391 #
1392 # * `home`
1393 # * `work`
1394 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1395 "metadata": { # Metadata about a field. # Metadata about the IM client.
1396 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1397 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1398 # source. Used for web cache validation. Only populated in
1399 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1400 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1401 "id": "A String", # The unique identifier within the source type generated by the server.
1402 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1403 "objectType": "A String", # The profile object type.
1404 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1405 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1411 },
1412 },
1413 ],
1414 "events": [ # The person's events.
1415 { # An event related to the person.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1416 "date": { # Represents a whole calendar date, for example a date of birth. The time # The date of the event.
1417 # of day and time zone are either specified elsewhere or are not
1418 # significant. The date is relative to the
1419 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
1420 # The day may be 0 to represent a year and month where the day is not
1421 # significant. The year may be 0 to represent a month and day independent
1422 # of year; for example, anniversary date.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1423 "month": 42, # Month of year. Must be from 1 to 12.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1424 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1425 # if specifying a year/month where the day is not significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1426 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1427 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1428 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1429 "formattedType": "A String", # The read-only type of the event translated and formatted in the
1430 # viewer's account locale or the `Accept-Language` HTTP header locale.
1431 "type": "A String", # The type of the event. The type can be custom or predefined.
1432 # Possible values include, but are not limited to, the following:
1433 #
1434 # * `anniversary`
1435 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1436 "metadata": { # Metadata about a field. # Metadata about the event.
1437 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1438 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1439 # source. Used for web cache validation. Only populated in
1440 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1441 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1442 "id": "A String", # The unique identifier within the source type generated by the server.
1443 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1444 "objectType": "A String", # The profile object type.
1445 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1446 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1447 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1448 # verified field is typically a name, email address, phone number, or
1449 # website that has been confirmed to be owned by the person.
1450 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1451 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1452 },
1453 },
1454 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1455 "metadata": { # The read-only metadata about a person. # Metadata about the person.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]1456 "previousResourceNames": [ # Any former resource names this person has had. Populated only for
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1457 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
1458 # that include a sync token.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]1459 #
1460 # The resource name may change when adding or removing fields that link a
1461 # contact and profile such as a verified email, verified phone number, or
1462 # profile URL.
1463 "A String",
1464 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1465 "sources": [ # The sources of data for the person.
1466 { # The source of a field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1467 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1468 # source. Used for web cache validation. Only populated in
1469 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1470 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1471 "id": "A String", # The unique identifier within the source type generated by the server.
1472 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1473 "objectType": "A String", # The profile object type.
1474 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1475 },
1476 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1477 "linkedPeopleResourceNames": [ # Resource names of people linked to this resource.
1478 "A String",
1479 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]1480 "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]1481 # [`connections.list`](/people/api/rest/v1/people.connections/list) requests
1482 # that include a sync token.
1483 "objectType": "A String", # DEPRECATED(Please read person.metadata.sources.profile_metadata instead).
1484 # The type of the person object.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1485 },
1486 "interests": [ # The person's interests.
1487 { # One of the person's interests.
1488 "value": "A String", # The interest; for example, `stargazing`.
1489 "metadata": { # Metadata about a field. # Metadata about the interest.
1490 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1491 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1492 # source. Used for web cache validation. Only populated in
1493 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1494 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1495 "id": "A String", # The unique identifier within the source type generated by the server.
1496 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1497 "objectType": "A String", # The profile object type.
1498 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1499 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1500 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1501 # verified field is typically a name, email address, phone number, or
1502 # website that has been confirmed to be owned by the person.
1503 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1504 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1505 },
1506 },
1507 ],
1508 "photos": [ # The person's photos.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1509 { # A person's read-only photo. A picture shown next to the person's name to
1510 # help others recognize the person.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1511 "url": "A String", # The URL of the photo.
1512 "metadata": { # Metadata about a field. # Metadata about the photo.
1513 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1514 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1515 # source. Used for web cache validation. Only populated in
1516 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1517 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1518 "id": "A String", # The unique identifier within the source type generated by the server.
1519 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1520 "objectType": "A String", # The profile object type.
1521 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1522 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1523 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1524 # verified field is typically a name, email address, phone number, or
1525 # website that has been confirmed to be owned by the person.
1526 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1527 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1528 },
1529 },
1530 ],
1531 "residences": [ # The person's residences.
1532 { # A person's past or current residence.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1533 "current": True or False, # True if the residence is the person's current residence;
1534 # false if the residence is a past residence.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1535 "value": "A String", # The address of the residence.
1536 "metadata": { # Metadata about a field. # Metadata about the residence.
1537 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1538 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1539 # source. Used for web cache validation. Only populated in
1540 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1541 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1542 "id": "A String", # The unique identifier within the source type generated by the server.
1543 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1544 "objectType": "A String", # The profile object type.
1545 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1546 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1547 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1548 # verified field is typically a name, email address, phone number, or
1549 # website that has been confirmed to be owned by the person.
1550 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1551 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1552 },
1553 },
1554 ],
1555 "relationshipInterests": [ # The kind of relationship the person is looking for.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1556 { # A person's read-only relationship interest .
1557 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the
1558 # viewer's account locale or the locale specified in the Accept-Language
1559 # HTTP header.
1560 "value": "A String", # The kind of relationship the person is looking for. The value can be custom
1561 # or predefined. Possible values include, but are not limited to, the
1562 # following values:
1563 #
1564 # * `friend`
1565 # * `date`
1566 # * `relationship`
1567 # * `networking`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1568 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
1569 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1570 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1571 # source. Used for web cache validation. Only populated in
1572 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1573 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1574 "id": "A String", # The unique identifier within the source type generated by the server.
1575 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1576 "objectType": "A String", # The profile object type.
1577 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1578 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1579 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1580 # verified field is typically a name, email address, phone number, or
1581 # website that has been confirmed to be owned by the person.
1582 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1583 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1584 },
1585 },
1586 ],
1587 "coverPhotos": [ # The person's cover photos.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1588 { # A person's read-only cover photo. A large image shown on the person's
1589 # profile page that represents who they are or what they care about.
1590 "default": True or False, # True if the cover photo is the default cover photo;
1591 # false if the cover photo is a user-provided cover photo.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1592 "url": "A String", # The URL of the cover photo.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1593 "metadata": { # Metadata about a field. # Metadata about the cover photo.
1594 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1595 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1596 # source. Used for web cache validation. Only populated in
1597 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1598 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1599 "id": "A String", # The unique identifier within the source type generated by the server.
1600 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1601 "objectType": "A String", # The profile object type.
1602 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1603 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1604 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1605 # verified field is typically a name, email address, phone number, or
1606 # website that has been confirmed to be owned by the person.
1607 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1608 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1609 },
1610 },
1611 ],
1612 "locales": [ # The person's locale preferences.
1613 { # A person's locale preference.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1614 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)
1615 # language tag representing the locale.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1616 "metadata": { # Metadata about a field. # Metadata about the locale.
1617 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1618 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1619 # source. Used for web cache validation. Only populated in
1620 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1621 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1622 "id": "A String", # The unique identifier within the source type generated by the server.
1623 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1624 "objectType": "A String", # The profile object type.
1625 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1626 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1627 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1628 # verified field is typically a name, email address, phone number, or
1629 # website that has been confirmed to be owned by the person.
1630 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1631 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1632 },
1633 },
1634 ],
1635 "organizations": [ # The person's past or current organizations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1636 { # A person's past or current organization. Overlapping date ranges are
1637 # permitted.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]1638 "formattedType": "A String", # The read-only type of the organization translated and formatted in the
1639 # viewer's account locale or the `Accept-Language` HTTP header locale.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1640 "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1641 "endDate": { # Represents a whole calendar date, for example a date of birth. The time # The end date when the person left the organization.
1642 # of day and time zone are either specified elsewhere or are not
1643 # significant. The date is relative to the
1644 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
1645 # The day may be 0 to represent a year and month where the day is not
1646 # significant. The year may be 0 to represent a month and day independent
1647 # of year; for example, anniversary date.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1648 "month": 42, # Month of year. Must be from 1 to 12.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1649 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1650 # if specifying a year/month where the day is not significant.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1651 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1652 # a year.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1653 },
1654 "name": "A String", # The name of the organization.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]1655 "startDate": { # Represents a whole calendar date, for example a date of birth. The time # The start date when the person joined the organization.
1656 # of day and time zone are either specified elsewhere or are not
1657 # significant. The date is relative to the
1658 # [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).
1659 # The day may be 0 to represent a year and month where the day is not
1660 # significant. The year may be 0 to represent a month and day independent
1661 # of year; for example, anniversary date.
1662 "month": 42, # Month of year. Must be from 1 to 12.
1663 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0
1664 # if specifying a year/month where the day is not significant.
1665 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without
1666 # a year.
1667 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1668 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker
1669 # symbol, abbreviation, or acronym.
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]1670 "title": "A String", # The person's job title at the organization.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1671 "current": True or False, # True if the organization is the person's current organization;
1672 # false if the organization is a past organization.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1673 "jobDescription": "A String", # The person's job description at the organization.
1674 "location": "A String", # The location of the organization office the person works at.
1675 "department": "A String", # The person's department at the organization.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1676 "type": "A String", # The type of the organization. The type can be custom or predefined.
1677 # Possible values include, but are not limited to, the following:
1678 #
1679 # * `work`
1680 # * `school`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1681 "phoneticName": "A String", # The phonetic name of the organization.
1682 "metadata": { # Metadata about a field. # Metadata about the organization.
1683 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1684 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1685 # source. Used for web cache validation. Only populated in
1686 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1687 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1688 "id": "A String", # The unique identifier within the source type generated by the server.
1689 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1690 "objectType": "A String", # The profile object type.
1691 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1692 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1693 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1694 # verified field is typically a name, email address, phone number, or
1695 # website that has been confirmed to be owned by the person.
1696 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1697 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1698 },
1699 },
1700 ],
1701 "biographies": [ # The person's biographies.
1702 { # A person's short biography.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1703 "contentType": "A String", # The content type of the biography.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1704 "value": "A String", # The short biography.
1705 "metadata": { # Metadata about a field. # Metadata about the biography.
1706 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1707 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1708 # source. Used for web cache validation. Only populated in
1709 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1710 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1711 "id": "A String", # The unique identifier within the source type generated by the server.
1712 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1713 "objectType": "A String", # The profile object type.
1714 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1715 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1716 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1717 # verified field is typically a name, email address, phone number, or
1718 # website that has been confirmed to be owned by the person.
1719 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1720 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1721 },
1722 },
1723 ],
1724 "memberships": [ # The person's group memberships.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1725 { # A person's read-only membership in a group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1726 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1727 "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group
1728 # ID can be custom or predefined. Possible values include, but are not
1729 # limited to, the following:
1730 #
1731 # * `myContacts`
1732 # * `starred`
1733 # * A numerical ID for user-created groups.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1734 },
1735 "domainMembership": { # A Google Apps Domain membership. # The domain membership.
1736 "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
1737 },
1738 "metadata": { # Metadata about a field. # Metadata about the membership.
1739 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1740 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1741 # source. Used for web cache validation. Only populated in
1742 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1743 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1744 "id": "A String", # The unique identifier within the source type generated by the server.
1745 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1746 "objectType": "A String", # The profile object type.
1747 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1748 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1749 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1750 # verified field is typically a name, email address, phone number, or
1751 # website that has been confirmed to be owned by the person.
1752 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1753 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1754 },
1755 },
1756 ],
1757 "taglines": [ # The person's taglines.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1758 { # A read-only brief one-line description of the person.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1759 "value": "A String", # The tagline.
1760 "metadata": { # Metadata about a field. # Metadata about the tagline.
1761 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1762 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1763 # source. Used for web cache validation. Only populated in
1764 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1765 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1766 "id": "A String", # The unique identifier within the source type generated by the server.
1767 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1768 "objectType": "A String", # The profile object type.
1769 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1770 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1771 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1772 # verified field is typically a name, email address, phone number, or
1773 # website that has been confirmed to be owned by the person.
1774 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1775 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1776 },
1777 },
1778 ],
1779 "urls": [ # The person's associated URLs.
1780 { # A person's associated URLs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1781 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's
1782 # account locale or the `Accept-Language` HTTP header locale.
1783 "type": "A String", # The type of the URL. The type can be custom or predefined.
1784 # Possible values include, but are not limited to, the following:
1785 #
1786 # * `home`
1787 # * `work`
1788 # * `blog`
1789 # * `profile`
1790 # * `homePage`
1791 # * `ftp`
1792 # * `reservations`
1793 # * `appInstallPage`: website for a Google+ application.
1794 # * `other`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1795 "value": "A String", # The URL.
1796 "metadata": { # Metadata about a field. # Metadata about the URL.
1797 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1798 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1799 # source. Used for web cache validation. Only populated in
1800 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1801 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1802 "id": "A String", # The unique identifier within the source type generated by the server.
1803 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1804 "objectType": "A String", # The profile object type.
1805 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1806 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1807 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1808 # verified field is typically a name, email address, phone number, or
1809 # website that has been confirmed to be owned by the person.
1810 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1811 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1812 },
1813 },
1814 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1815 "ageRange": "A String", # DEPRECATED(Please read person.age_ranges instead). The person's age range.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1816 "genders": [ # The person's genders.
1817 { # A person's gender.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1818 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's
1819 # account locale or the `Accept-Language` HTTP header locale.
1820 "value": "A String", # The gender for the person. The gender can be custom or predefined.
1821 # Possible values include, but are not limited to, the
1822 # following:
1823 #
1824 # * `male`
1825 # * `female`
1826 # * `other`
1827 # * `unknown`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1828 "metadata": { # Metadata about a field. # Metadata about the gender.
1829 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1830 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1831 # source. Used for web cache validation. Only populated in
1832 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1833 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1834 "id": "A String", # The unique identifier within the source type generated by the server.
1835 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1836 "objectType": "A String", # The profile object type.
1837 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1838 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1839 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1840 # verified field is typically a name, email address, phone number, or
1841 # website that has been confirmed to be owned by the person.
1842 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1843 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1844 },
1845 },
1846 ],
1847 "emailAddresses": [ # The person's email addresses.
1848 { # A person's email address.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1849 "formattedType": "A String", # The read-only type of the email address translated and formatted in the
1850 # viewer's account locale or the `Accept-Language` HTTP header locale.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1851 "type": "A String", # The type of the email address. The type can be custom or predefined.
1852 # Possible values include, but are not limited to, the following:
1853 #
1854 # * `home`
1855 # * `work`
1856 # * `other`
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1857 "displayName": "A String", # The display name of the email.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1858 "value": "A String", # The email address.
1859 "metadata": { # Metadata about a field. # Metadata about the email address.
1860 "source": { # The source of a field. # The source of the field.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1861 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the
1862 # source. Used for web cache validation. Only populated in
1863 # person.metadata.sources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1864 "type": "A String", # The source type.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1865 "id": "A String", # The unique identifier within the source type generated by the server.
1866 "profileMetadata": { # The read-only metadata about a profile. # Metadata about a source of type PROFILE.
1867 "objectType": "A String", # The profile object type.
1868 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1869 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1870 "verified": True or False, # True if the field is verified; false if the field is unverified. A
1871 # verified field is typically a name, email address, phone number, or
1872 # website that has been confirmed to be owned by the person.
1873 "primary": True or False, # True if the field is the primary field; false if the field is a secondary
1874 # field.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1875 },
1876 },
1877 ],
1878 },
1879 "httpStatusCode": 42, # [HTTP 1.1 status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
1880 },
1881 ],
1882 }</pre>
1883</div>
1884
1885</body></html>