Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / people_v1.people.html
blob: 4ed3fa25bd708923bb0599dd511004a962d2f631 [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">
83 <code><a href="#get">get(resourceName, x__xgafv=None, requestMask_includeField=None)</a></code></p>
84<p class="firstline">Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user.</p>
85<p class="toc_element">
86 <code><a href="#getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None)</a></code></p>
87<p class="firstline">Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.</p>
88<h3>Method Details</h3>
89<div class="method">
90 <code class="details" id="get">get(resourceName, x__xgafv=None, requestMask_includeField=None)</code>
91 <pre>Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user.
92
93Args:
94 resourceName: string, The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about any user, specify the resource name that identifies the user, such as the resource names returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). (required)
95 x__xgafv: string, V1 error format.
96 requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.
97
98Returns:
99 An object of the form:
100
101 { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true.
102 "phoneNumbers": [ # The person's phone numbers.
103 { # A person's phone number.
104 "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) form of the phone number.
105 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.
106 "type": "A String", # The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
107 "value": "A String", # The phone number.
108 "metadata": { # Metadata about a field. # Metadata about the phone number.
109 "source": { # The source of a field. # The source of the field.
110 "type": "A String", # The source type.
111 "id": "A String", # A unique identifier within the source type generated by the server.
112 },
113 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
114 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
115 },
116 },
117 ],
118 "addresses": [ # The person's street addresses.
119 { # A person's physical address. May be a P.O. box or street address. All fields are optional.
120 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
121 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
122 "city": "A String", # The city of the address.
123 "formattedValue": "A String", # The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
124 "region": "A String", # The region of the address; for example, the state or province.
125 "poBox": "A String", # The P.O. box of the address.
126 "streetAddress": "A String", # The street address.
127 "country": "A String", # The country of the address.
128 "postalCode": "A String", # The postal code of the address.
129 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
130 "type": "A String", # The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
131 "metadata": { # Metadata about a field. # Metadata about the address.
132 "source": { # The source of a field. # The source of the field.
133 "type": "A String", # The source type.
134 "id": "A String", # A unique identifier within the source type generated by the server.
135 },
136 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
137 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
138 },
139 },
140 ],
141 "nicknames": [ # The person's nicknames.
142 { # A person's nickname.
143 "type": "A String", # The type of the nickname.
144 "value": "A String", # The nickname.
145 "metadata": { # Metadata about a field. # Metadata about the nickname.
146 "source": { # The source of a field. # The source of the field.
147 "type": "A String", # The source type.
148 "id": "A String", # A unique identifier within the source type generated by the server.
149 },
150 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
151 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
152 },
153 },
154 ],
155 "occupations": [ # The person's occupations.
156 { # A person's occupation.
157 "value": "A String", # The occupation; for example, `carpenter`.
158 "metadata": { # Metadata about a field. # Metadata about the occupation.
159 "source": { # The source of a field. # The source of the field.
160 "type": "A String", # The source type.
161 "id": "A String", # A unique identifier within the source type generated by the server.
162 },
163 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
164 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
165 },
166 },
167 ],
168 "braggingRights": [ # The person's bragging rights.
169 { # A person's bragging rights.
170 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
171 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
172 "source": { # The source of a field. # The source of the field.
173 "type": "A String", # The source type.
174 "id": "A String", # A unique identifier within the source type generated by the server.
175 },
176 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
177 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
178 },
179 },
180 ],
181 "names": [ # The person's names.
182 { # A person's name. If the name is a mononym, the family name is empty.
183 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
184 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
185 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
186 "displayName": "A String", # The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
187 "middleName": "A String", # The middle name(s).
188 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
189 "familyName": "A String", # The family name.
190 "phoneticGivenName": "A String", # The given name spelled as it sounds.
191 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
192 "givenName": "A String", # The given name.
193 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
194 "metadata": { # Metadata about a field. # Metadata about the name.
195 "source": { # The source of a field. # The source of the field.
196 "type": "A String", # The source type.
197 "id": "A String", # A unique identifier within the source type generated by the server.
198 },
199 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
200 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
201 },
202 },
203 ],
204 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.
205 "birthdays": [ # The person's birthdays.
206 { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
207 "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the birthday.
208 "month": 42, # Month of year. Must be from 1 to 12.
209 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
210 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
211 },
212 "text": "A String", # A free-form string representing the user's birthday.
213 "metadata": { # Metadata about a field. # Metadata about the birthday.
214 "source": { # The source of a field. # The source of the field.
215 "type": "A String", # The source type.
216 "id": "A String", # A unique identifier within the source type generated by the server.
217 },
218 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
219 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
220 },
221 },
222 ],
223 "relations": [ # The person's relations.
224 { # A person's relation to another person.
225 "person": "A String", # The name of the other person this relation refers to.
226 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
227 "type": "A String", # The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
228 "metadata": { # Metadata about a field. # Metadata about the relation.
229 "source": { # The source of a field. # The source of the field.
230 "type": "A String", # The source type.
231 "id": "A String", # A unique identifier within the source type generated by the server.
232 },
233 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
234 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
235 },
236 },
237 ],
238 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
239 "relationshipStatuses": [ # The person's relationship statuses.
240 { # A person's relationship status.
241 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
242 "value": "A String", # The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
243 "metadata": { # Metadata about a field. # Metadata about the relationship status.
244 "source": { # The source of a field. # The source of the field.
245 "type": "A String", # The source type.
246 "id": "A String", # A unique identifier within the source type generated by the server.
247 },
248 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
249 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
250 },
251 },
252 ],
253 "skills": [ # The person's skills.
254 { # A skill that the person has.
255 "value": "A String", # The skill; for example, `underwater basket weaving`.
256 "metadata": { # Metadata about a field. # Metadata about the skill.
257 "source": { # The source of a field. # The source of the field.
258 "type": "A String", # The source type.
259 "id": "A String", # A unique identifier within the source type generated by the server.
260 },
261 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or 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 field.
263 },
264 },
265 ],
266 "imClients": [ # The person's instant messaging clients.
267 { # A person's instant messaging client.
268 "username": "A String", # The user name used in the IM client.
269 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
270 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
271 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
272 "type": "A String", # The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
273 "metadata": { # Metadata about a field. # Metadata about the IM client.
274 "source": { # The source of a field. # The source of the field.
275 "type": "A String", # The source type.
276 "id": "A String", # A unique identifier within the source type generated by the server.
277 },
278 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
279 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
280 },
281 },
282 ],
283 "events": [ # The person's events.
284 { # An event related to the person.
285 "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the event.
286 "month": 42, # Month of year. Must be from 1 to 12.
287 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
288 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
289 },
290 "formattedType": "A String", # The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
291 "type": "A String", # The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`
292 "metadata": { # Metadata about a field. # Metadata about the event.
293 "source": { # The source of a field. # The source of the field.
294 "type": "A String", # The source type.
295 "id": "A String", # A unique identifier within the source type generated by the server.
296 },
297 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
298 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
299 },
300 },
301 ],
302 "metadata": { # Metadata about a person. # Metadata about the person.
303 "previousResourceNames": [ # Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
304 "A String",
305 ],
306 "sources": [ # The sources of data for the person.
307 { # The source of a field.
308 "type": "A String", # The source type.
309 "id": "A String", # A unique identifier within the source type generated by the server.
310 },
311 ],
312 "deleted": True or False, # True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
313 "objectType": "A String", # The type of the person object.
314 },
315 "interests": [ # The person's interests.
316 { # One of the person's interests.
317 "value": "A String", # The interest; for example, `stargazing`.
318 "metadata": { # Metadata about a field. # Metadata about the interest.
319 "source": { # The source of a field. # The source of the field.
320 "type": "A String", # The source type.
321 "id": "A String", # A unique identifier within the source type generated by the server.
322 },
323 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
324 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
325 },
326 },
327 ],
328 "photos": [ # The person's photos.
329 { # A person's photo. A picture shown next to the person's name to help others recognize the person.
330 "url": "A String", # The URL of the photo.
331 "metadata": { # Metadata about a field. # Metadata about the photo.
332 "source": { # The source of a field. # The source of the field.
333 "type": "A String", # The source type.
334 "id": "A String", # A unique identifier within the source type generated by the server.
335 },
336 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
337 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
338 },
339 },
340 ],
341 "residences": [ # The person's residences.
342 { # A person's past or current residence.
343 "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
344 "value": "A String", # The address of the residence.
345 "metadata": { # Metadata about a field. # Metadata about the residence.
346 "source": { # The source of a field. # The source of the field.
347 "type": "A String", # The source type.
348 "id": "A String", # A unique identifier within the source type generated by the server.
349 },
350 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
351 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
352 },
353 },
354 ],
355 "relationshipInterests": [ # The kind of relationship the person is looking for.
356 { # The kind of relationship the person is looking for.
357 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
358 "value": "A String", # The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`
359 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
360 "source": { # The source of a field. # The source of the field.
361 "type": "A String", # The source type.
362 "id": "A String", # A unique identifier within the source type generated by the server.
363 },
364 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
365 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
366 },
367 },
368 ],
369 "coverPhotos": [ # The person's cover photos.
370 { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
371 "url": "A String", # The URL of the cover photo.
372 "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
373 "metadata": { # Metadata about a field. # Metadata about the cover photo.
374 "source": { # The source of a field. # The source of the field.
375 "type": "A String", # The source type.
376 "id": "A String", # A unique identifier within the source type generated by the server.
377 },
378 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
379 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
380 },
381 },
382 ],
383 "locales": [ # The person's locale preferences.
384 { # A person's locale preference.
385 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
386 "metadata": { # Metadata about a field. # Metadata about the locale.
387 "source": { # The source of a field. # The source of the field.
388 "type": "A String", # The source type.
389 "id": "A String", # A unique identifier within the source type generated by the server.
390 },
391 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
392 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
393 },
394 },
395 ],
396 "organizations": [ # The person's past or current organizations.
397 { # A person's past or current organization. Overlapping date ranges are permitted.
398 "formattedType": "A String", # The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
399 "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
400 "endDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The end date when the person left the organization.
401 "month": 42, # Month of year. Must be from 1 to 12.
402 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
403 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
404 },
405 "name": "A String", # The name of the organization.
406 "startDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The start date when the person joined the organization.
407 "month": 42, # Month of year. Must be from 1 to 12.
408 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
409 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
410 },
411 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
412 "title": "A String", # The person's job title at the organization.
413 "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
414 "jobDescription": "A String", # The person's job description at the organization.
415 "location": "A String", # The location of the organization office the person works at.
416 "department": "A String", # The person's department at the organization.
417 "type": "A String", # The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`
418 "phoneticName": "A String", # The phonetic name of the organization.
419 "metadata": { # Metadata about a field. # Metadata about the organization.
420 "source": { # The source of a field. # The source of the field.
421 "type": "A String", # The source type.
422 "id": "A String", # A unique identifier within the source type generated by the server.
423 },
424 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
425 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
426 },
427 },
428 ],
429 "biographies": [ # The person's biographies.
430 { # A person's short biography.
431 "value": "A String", # The short biography.
432 "metadata": { # Metadata about a field. # Metadata about the biography.
433 "source": { # The source of a field. # The source of the field.
434 "type": "A String", # The source type.
435 "id": "A String", # A unique identifier within the source type generated by the server.
436 },
437 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or 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 field.
439 },
440 },
441 ],
442 "memberships": [ # The person's group memberships.
443 { # A person's membership in a group.
444 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
445 "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.
446 },
447 "domainMembership": { # A Google Apps Domain membership. # The domain membership.
448 "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
449 },
450 "metadata": { # Metadata about a field. # Metadata about the membership.
451 "source": { # The source of a field. # The source of the field.
452 "type": "A String", # The source type.
453 "id": "A String", # A unique identifier within the source type generated by the server.
454 },
455 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
456 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
457 },
458 },
459 ],
460 "taglines": [ # The person's taglines.
461 { # A brief one-line description of the person.
462 "value": "A String", # The tagline.
463 "metadata": { # Metadata about a field. # Metadata about the tagline.
464 "source": { # The source of a field. # The source of the field.
465 "type": "A String", # The source type.
466 "id": "A String", # A unique identifier within the source type generated by the server.
467 },
468 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
469 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
470 },
471 },
472 ],
473 "urls": [ # The person's associated URLs.
474 { # A person's associated URLs.
475 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
476 "type": "A String", # The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
477 "value": "A String", # The URL.
478 "metadata": { # Metadata about a field. # Metadata about the URL.
479 "source": { # The source of a field. # The source of the field.
480 "type": "A String", # The source type.
481 "id": "A String", # A unique identifier within the source type generated by the server.
482 },
483 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
484 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
485 },
486 },
487 ],
488 "ageRange": "A String", # The person's age range.
489 "genders": [ # The person's genders.
490 { # A person's gender.
491 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
492 "value": "A String", # The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`
493 "metadata": { # Metadata about a field. # Metadata about the gender.
494 "source": { # The source of a field. # The source of the field.
495 "type": "A String", # The source type.
496 "id": "A String", # A unique identifier within the source type generated by the server.
497 },
498 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
499 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
500 },
501 },
502 ],
503 "emailAddresses": [ # The person's email addresses.
504 { # A person's email address.
505 "formattedType": "A String", # The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
506 "type": "A String", # The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
507 "value": "A String", # The email address.
508 "metadata": { # Metadata about a field. # Metadata about the email address.
509 "source": { # The source of a field. # The source of the field.
510 "type": "A String", # The source type.
511 "id": "A String", # A unique identifier within the source type generated by the server.
512 },
513 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
514 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
515 },
516 },
517 ],
518 }</pre>
519</div>
520
521<div class="method">
522 <code class="details" id="getBatchGet">getBatchGet(resourceNames=None, x__xgafv=None, requestMask_includeField=None)</code>
523 <pre>Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.
524
525Args:
526 resourceNames: string, The resource name, such as one returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list), of one of the people to provide information about. You can include this parameter up to 50 times in one request. (repeated)
527 x__xgafv: string, V1 error format.
528 requestMask_includeField: string, Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.photos`.
529
530Returns:
531 An object of the form:
532
533 {
534 "responses": [ # The response for each requested resource name.
535 { # The response for a single person
536 "requestedResourceName": "A String", # The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.
537 "person": { # Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-empty field is guaranteed to have exactly one field with `metadata.primary` set to true. # The person.
538 "phoneNumbers": [ # The person's phone numbers.
539 { # A person's phone number.
540 "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) form of the phone number.
541 "formattedType": "A String", # The read-only type of the phone number translated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.
542 "type": "A String", # The type of the phone number. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pager` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`
543 "value": "A String", # The phone number.
544 "metadata": { # Metadata about a field. # Metadata about the phone number.
545 "source": { # The source of a field. # The source of the field.
546 "type": "A String", # The source type.
547 "id": "A String", # A unique identifier within the source type generated by the server.
548 },
549 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
550 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
551 },
552 },
553 ],
554 "addresses": [ # The person's street addresses.
555 { # A person's physical address. May be a P.O. box or street address. All fields are optional.
556 "formattedType": "A String", # The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
557 "countryCode": "A String", # The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country code of the address.
558 "city": "A String", # The city of the address.
559 "formattedValue": "A String", # The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
560 "region": "A String", # The region of the address; for example, the state or province.
561 "poBox": "A String", # The P.O. box of the address.
562 "streetAddress": "A String", # The street address.
563 "country": "A String", # The country of the address.
564 "postalCode": "A String", # The postal code of the address.
565 "extendedAddress": "A String", # The extended address of the address; for example, the apartment number.
566 "type": "A String", # The type of the address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
567 "metadata": { # Metadata about a field. # Metadata about the address.
568 "source": { # The source of a field. # The source of the field.
569 "type": "A String", # The source type.
570 "id": "A String", # A unique identifier within the source type generated by the server.
571 },
572 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
573 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
574 },
575 },
576 ],
577 "nicknames": [ # The person's nicknames.
578 { # A person's nickname.
579 "type": "A String", # The type of the nickname.
580 "value": "A String", # The nickname.
581 "metadata": { # Metadata about a field. # Metadata about the nickname.
582 "source": { # The source of a field. # The source of the field.
583 "type": "A String", # The source type.
584 "id": "A String", # A unique identifier within the source type generated by the server.
585 },
586 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
587 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
588 },
589 },
590 ],
591 "occupations": [ # The person's occupations.
592 { # A person's occupation.
593 "value": "A String", # The occupation; for example, `carpenter`.
594 "metadata": { # Metadata about a field. # Metadata about the occupation.
595 "source": { # The source of a field. # The source of the field.
596 "type": "A String", # The source type.
597 "id": "A String", # A unique identifier within the source type generated by the server.
598 },
599 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
600 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
601 },
602 },
603 ],
604 "braggingRights": [ # The person's bragging rights.
605 { # A person's bragging rights.
606 "value": "A String", # The bragging rights; for example, `climbed mount everest`.
607 "metadata": { # Metadata about a field. # Metadata about the bragging rights.
608 "source": { # The source of a field. # The source of the field.
609 "type": "A String", # The source type.
610 "id": "A String", # A unique identifier within the source type generated by the server.
611 },
612 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
613 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
614 },
615 },
616 ],
617 "names": [ # The person's names.
618 { # A person's name. If the name is a mononym, the family name is empty.
619 "phoneticMiddleName": "A String", # The middle name(s) spelled as they sound.
620 "honorificPrefix": "A String", # The honorific prefixes, such as `Mrs.` or `Dr.`
621 "phoneticFamilyName": "A String", # The family name spelled as it sounds.
622 "displayName": "A String", # The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.
623 "middleName": "A String", # The middle name(s).
624 "phoneticHonorificPrefix": "A String", # The honorific prefixes spelled as they sound.
625 "familyName": "A String", # The family name.
626 "phoneticGivenName": "A String", # The given name spelled as it sounds.
627 "phoneticHonorificSuffix": "A String", # The honorific suffixes spelled as they sound.
628 "givenName": "A String", # The given name.
629 "honorificSuffix": "A String", # The honorific suffixes, such as `Jr.`
630 "metadata": { # Metadata about a field. # Metadata about the name.
631 "source": { # The source of a field. # The source of the field.
632 "type": "A String", # The source type.
633 "id": "A String", # A unique identifier within the source type generated by the server.
634 },
635 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
636 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
637 },
638 },
639 ],
640 "resourceName": "A String", # The resource name for the person, assigned by the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.
641 "birthdays": [ # The person's birthdays.
642 { # A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent the same date, but are not guaranteed to.
643 "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the birthday.
644 "month": 42, # Month of year. Must be from 1 to 12.
645 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
646 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
647 },
648 "text": "A String", # A free-form string representing the user's birthday.
649 "metadata": { # Metadata about a field. # Metadata about the birthday.
650 "source": { # The source of a field. # The source of the field.
651 "type": "A String", # The source type.
652 "id": "A String", # A unique identifier within the source type generated by the server.
653 },
654 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
655 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
656 },
657 },
658 ],
659 "relations": [ # The person's relations.
660 { # A person's relation to another person.
661 "person": "A String", # The name of the other person this relation refers to.
662 "formattedType": "A String", # The type of the relation translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
663 "type": "A String", # The person's relation to the other person. The type can be custom or predefined. Possible values include, but are not limited to, the following values: * `spouse` * `child` * `mother` * `father` * `parent` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`
664 "metadata": { # Metadata about a field. # Metadata about the relation.
665 "source": { # The source of a field. # The source of the field.
666 "type": "A String", # The source type.
667 "id": "A String", # A unique identifier within the source type generated by the server.
668 },
669 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
670 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
671 },
672 },
673 ],
674 "etag": "A String", # The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the resource. Used for web cache validation.
675 "relationshipStatuses": [ # The person's relationship statuses.
676 { # A person's relationship status.
677 "formattedValue": "A String", # The read-only value of the relationship status translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
678 "value": "A String", # The relationship status. The value can be custom or predefined. Possible values include, but are not limited to, the following: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`
679 "metadata": { # Metadata about a field. # Metadata about the relationship status.
680 "source": { # The source of a field. # The source of the field.
681 "type": "A String", # The source type.
682 "id": "A String", # A unique identifier within the source type generated by the server.
683 },
684 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
685 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
686 },
687 },
688 ],
689 "skills": [ # The person's skills.
690 { # A skill that the person has.
691 "value": "A String", # The skill; for example, `underwater basket weaving`.
692 "metadata": { # Metadata about a field. # Metadata about the skill.
693 "source": { # The source of a field. # The source of the field.
694 "type": "A String", # The source type.
695 "id": "A String", # A unique identifier within the source type generated by the server.
696 },
697 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
698 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
699 },
700 },
701 ],
702 "imClients": [ # The person's instant messaging clients.
703 { # A person's instant messaging client.
704 "username": "A String", # The user name used in the IM client.
705 "formattedType": "A String", # The read-only type of the IM client translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
706 "protocol": "A String", # The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, the following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`
707 "formattedProtocol": "A String", # The read-only protocol of the IM client formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
708 "type": "A String", # The type of the IM client. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
709 "metadata": { # Metadata about a field. # Metadata about the IM client.
710 "source": { # The source of a field. # The source of the field.
711 "type": "A String", # The source type.
712 "id": "A String", # A unique identifier within the source type generated by the server.
713 },
714 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
715 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
716 },
717 },
718 ],
719 "events": [ # The person's events.
720 { # An event related to the person.
721 "date": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The date of the event.
722 "month": 42, # Month of year. Must be from 1 to 12.
723 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
724 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
725 },
726 "formattedType": "A String", # The read-only type of the event translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
727 "type": "A String", # The type of the event. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`
728 "metadata": { # Metadata about a field. # Metadata about the event.
729 "source": { # The source of a field. # The source of the field.
730 "type": "A String", # The source type.
731 "id": "A String", # A unique identifier within the source type generated by the server.
732 },
733 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
734 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
735 },
736 },
737 ],
738 "metadata": { # Metadata about a person. # Metadata about the person.
739 "previousResourceNames": [ # Any former resource names this person has had. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token. The resource name may change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or profile URL.
740 "A String",
741 ],
742 "sources": [ # The sources of data for the person.
743 { # The source of a field.
744 "type": "A String", # The source type.
745 "id": "A String", # A unique identifier within the source type generated by the server.
746 },
747 ],
748 "deleted": True or False, # True if the person resource has been deleted. Populated only for [`connections.list`](/people/api/rest/v1/people.connections/list) requests that include a sync token.
749 "objectType": "A String", # The type of the person object.
750 },
751 "interests": [ # The person's interests.
752 { # One of the person's interests.
753 "value": "A String", # The interest; for example, `stargazing`.
754 "metadata": { # Metadata about a field. # Metadata about the interest.
755 "source": { # The source of a field. # The source of the field.
756 "type": "A String", # The source type.
757 "id": "A String", # A unique identifier within the source type generated by the server.
758 },
759 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
760 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
761 },
762 },
763 ],
764 "photos": [ # The person's photos.
765 { # A person's photo. A picture shown next to the person's name to help others recognize the person.
766 "url": "A String", # The URL of the photo.
767 "metadata": { # Metadata about a field. # Metadata about the photo.
768 "source": { # The source of a field. # The source of the field.
769 "type": "A String", # The source type.
770 "id": "A String", # A unique identifier within the source type generated by the server.
771 },
772 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
773 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
774 },
775 },
776 ],
777 "residences": [ # The person's residences.
778 { # A person's past or current residence.
779 "current": True or False, # True if the residence is the person's current residence; false if the residence is a past residence.
780 "value": "A String", # The address of the residence.
781 "metadata": { # Metadata about a field. # Metadata about the residence.
782 "source": { # The source of a field. # The source of the field.
783 "type": "A String", # The source type.
784 "id": "A String", # A unique identifier within the source type generated by the server.
785 },
786 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
787 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
788 },
789 },
790 ],
791 "relationshipInterests": [ # The kind of relationship the person is looking for.
792 { # The kind of relationship the person is looking for.
793 "formattedValue": "A String", # The value of the relationship interest translated and formatted in the viewer's account locale or the locale specified in the Accept-Language HTTP header.
794 "value": "A String", # The kind of relationship the person is looking for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `networking`
795 "metadata": { # Metadata about a field. # Metadata about the relationship interest.
796 "source": { # The source of a field. # The source of the field.
797 "type": "A String", # The source type.
798 "id": "A String", # A unique identifier within the source type generated by the server.
799 },
800 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
801 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
802 },
803 },
804 ],
805 "coverPhotos": [ # The person's cover photos.
806 { # A person's cover photo. A large image shown on the person's profile page that represents who they are or what they care about.
807 "url": "A String", # The URL of the cover photo.
808 "default": True or False, # True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.
809 "metadata": { # Metadata about a field. # Metadata about the cover photo.
810 "source": { # The source of a field. # The source of the field.
811 "type": "A String", # The source type.
812 "id": "A String", # A unique identifier within the source type generated by the server.
813 },
814 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
815 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
816 },
817 },
818 ],
819 "locales": [ # The person's locale preferences.
820 { # A person's locale preference.
821 "value": "A String", # The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47) language tag representing the locale.
822 "metadata": { # Metadata about a field. # Metadata about the locale.
823 "source": { # The source of a field. # The source of the field.
824 "type": "A String", # The source type.
825 "id": "A String", # A unique identifier within the source type generated by the server.
826 },
827 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
828 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
829 },
830 },
831 ],
832 "organizations": [ # The person's past or current organizations.
833 { # A person's past or current organization. Overlapping date ranges are permitted.
834 "formattedType": "A String", # The read-only type of the organization translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
835 "domain": "A String", # The domain name associated with the organization; for example, `google.com`.
836 "endDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The end date when the person left the organization.
837 "month": 42, # Month of year. Must be from 1 to 12.
838 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
839 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
840 },
841 "name": "A String", # The name of the organization.
842 "startDate": { # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to represent a year and month where the day is not significant. The year may be 0 to represent a month and day independent of year; for example, anniversary date. # The start date when the person joined the organization.
843 "month": 42, # Month of year. Must be from 1 to 12.
844 "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
845 "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
846 },
847 "symbol": "A String", # The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
848 "title": "A String", # The person's job title at the organization.
849 "current": True or False, # True if the organization is the person's current organization; false if the organization is a past organization.
850 "jobDescription": "A String", # The person's job description at the organization.
851 "location": "A String", # The location of the organization office the person works at.
852 "department": "A String", # The person's department at the organization.
853 "type": "A String", # The type of the organization. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `work` * `school`
854 "phoneticName": "A String", # The phonetic name of the organization.
855 "metadata": { # Metadata about a field. # Metadata about the organization.
856 "source": { # The source of a field. # The source of the field.
857 "type": "A String", # The source type.
858 "id": "A String", # A unique identifier within the source type generated by the server.
859 },
860 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
861 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
862 },
863 },
864 ],
865 "biographies": [ # The person's biographies.
866 { # A person's short biography.
867 "value": "A String", # The short biography.
868 "metadata": { # Metadata about a field. # Metadata about the biography.
869 "source": { # The source of a field. # The source of the field.
870 "type": "A String", # The source type.
871 "id": "A String", # A unique identifier within the source type generated by the server.
872 },
873 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
874 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
875 },
876 },
877 ],
878 "memberships": [ # The person's group memberships.
879 { # A person's membership in a group.
880 "contactGroupMembership": { # A Google contact group membership. # The contact group membership.
881 "contactGroupId": "A String", # The contact group ID for the contact group membership. The contact group ID can be custom or predefined. Possible values include, but are not limited to, the following: * `myContacts` * `starred` * A numerical ID for user-created groups.
882 },
883 "domainMembership": { # A Google Apps Domain membership. # The domain membership.
884 "inViewerDomain": True or False, # True if the person is in the viewer's Google Apps domain.
885 },
886 "metadata": { # Metadata about a field. # Metadata about the membership.
887 "source": { # The source of a field. # The source of the field.
888 "type": "A String", # The source type.
889 "id": "A String", # A unique identifier within the source type generated by the server.
890 },
891 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
892 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
893 },
894 },
895 ],
896 "taglines": [ # The person's taglines.
897 { # A brief one-line description of the person.
898 "value": "A String", # The tagline.
899 "metadata": { # Metadata about a field. # Metadata about the tagline.
900 "source": { # The source of a field. # The source of the field.
901 "type": "A String", # The source type.
902 "id": "A String", # A unique identifier within the source type generated by the server.
903 },
904 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
905 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
906 },
907 },
908 ],
909 "urls": [ # The person's associated URLs.
910 { # A person's associated URLs.
911 "formattedType": "A String", # The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
912 "type": "A String", # The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `appInstallPage`: website for a Google+ application. * `other`
913 "value": "A String", # The URL.
914 "metadata": { # Metadata about a field. # Metadata about the URL.
915 "source": { # The source of a field. # The source of the field.
916 "type": "A String", # The source type.
917 "id": "A String", # A unique identifier within the source type generated by the server.
918 },
919 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
920 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
921 },
922 },
923 ],
924 "ageRange": "A String", # The person's age range.
925 "genders": [ # The person's genders.
926 { # A person's gender.
927 "formattedValue": "A String", # The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
928 "value": "A String", # The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the following: * `male` * `female` * `other` * `unknown`
929 "metadata": { # Metadata about a field. # Metadata about the gender.
930 "source": { # The source of a field. # The source of the field.
931 "type": "A String", # The source type.
932 "id": "A String", # A unique identifier within the source type generated by the server.
933 },
934 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
935 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
936 },
937 },
938 ],
939 "emailAddresses": [ # The person's email addresses.
940 { # A person's email address.
941 "formattedType": "A String", # The read-only type of the email address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.
942 "type": "A String", # The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `other`
943 "value": "A String", # The email address.
944 "metadata": { # Metadata about a field. # Metadata about the email address.
945 "source": { # The source of a field. # The source of the field.
946 "type": "A String", # The source type.
947 "id": "A String", # A unique identifier within the source type generated by the server.
948 },
949 "verified": True or False, # True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.
950 "primary": True or False, # True if the field is the primary field; false if the field is a secondary field.
951 },
952 },
953 ],
954 },
955 "httpStatusCode": 42, # [HTTP 1.1 status code](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).
956 },
957 ],
958 }</pre>
959</div>
960
961</body></html>