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