Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(323)

Side by Side Diff: discovery/googleapis/people__v1.json

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)
Patch Set: Created 3 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/partners__v2.json ('k') | discovery/googleapis/playmoviespartner__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/userinfo.profile": {
6 "description": "View your basic profile info"
7 },
8 "https://www.googleapis.com/auth/user.emails.read": { 5 "https://www.googleapis.com/auth/user.emails.read": {
9 "description": "View your email addresses" 6 "description": "View your email addresses"
10 }, 7 },
11 "https://www.googleapis.com/auth/contacts": { 8 "https://www.googleapis.com/auth/contacts": {
12 "description": "Manage your contacts" 9 "description": "Manage your contacts"
13 }, 10 },
14 "https://www.googleapis.com/auth/user.addresses.read": { 11 "https://www.googleapis.com/auth/user.addresses.read": {
15 "description": "View your street addresses" 12 "description": "View your street addresses"
16 }, 13 },
14 "https://www.googleapis.com/auth/user.phonenumbers.read": {
15 "description": "View your phone numbers"
16 },
17 "https://www.googleapis.com/auth/userinfo.email": { 17 "https://www.googleapis.com/auth/userinfo.email": {
18 "description": "View your email address" 18 "description": "View your email address"
19 }, 19 },
20 "https://www.googleapis.com/auth/user.phonenumbers.read": {
21 "description": "View your phone numbers"
22 },
23 "https://www.googleapis.com/auth/contacts.readonly": { 20 "https://www.googleapis.com/auth/contacts.readonly": {
24 "description": "View your contacts" 21 "description": "View your contacts"
25 }, 22 },
26 "https://www.googleapis.com/auth/user.birthday.read": { 23 "https://www.googleapis.com/auth/user.birthday.read": {
27 "description": "View your complete date of birth" 24 "description": "View your complete date of birth"
28 }, 25 },
29 "https://www.googleapis.com/auth/plus.login": { 26 "https://www.googleapis.com/auth/plus.login": {
30 "description": "Know the list of people in your circles, you r age range, and language" 27 "description": "Know the list of people in your circles, you r age range, and language"
28 },
29 "https://www.googleapis.com/auth/userinfo.profile": {
30 "description": "View your basic profile info"
31 } 31 }
32 } 32 }
33 } 33 }
34 }, 34 },
35 "basePath": "", 35 "basePath": "",
36 "baseUrl": "https://people.googleapis.com/", 36 "baseUrl": "https://people.googleapis.com/",
37 "batchPath": "batch", 37 "batchPath": "batch",
38 "canonicalName": "People Service", 38 "canonicalName": "People Service",
39 "description": "Provides access to information about profiles and contacts." , 39 "description": "Provides access to information about profiles and contacts." ,
40 "discoveryVersion": "v1", 40 "discoveryVersion": "v1",
41 "documentationLink": "https://developers.google.com/people/", 41 "documentationLink": "https://developers.google.com/people/",
42 "icons": { 42 "icons": {
43 "x16": "http://www.google.com/images/icons/product/search-16.gif", 43 "x16": "http://www.google.com/images/icons/product/search-16.gif",
44 "x32": "http://www.google.com/images/icons/product/search-32.gif" 44 "x32": "http://www.google.com/images/icons/product/search-32.gif"
45 }, 45 },
46 "id": "people:v1", 46 "id": "people:v1",
47 "kind": "discovery#restDescription", 47 "kind": "discovery#restDescription",
48 "name": "people", 48 "name": "people",
49 "ownerDomain": "google.com", 49 "ownerDomain": "google.com",
50 "ownerName": "Google", 50 "ownerName": "Google",
51 "parameters": { 51 "parameters": {
52 "alt": {
53 "default": "json",
54 "description": "Data format for response.",
55 "enum": [
56 "json",
57 "media",
58 "proto"
59 ],
60 "enumDescriptions": [
61 "Responses with Content-Type of application/json",
62 "Media download with context-dependent Content-Type",
63 "Responses with Content-Type of application/x-protobuf"
64 ],
65 "location": "query",
66 "type": "string"
67 },
68 "key": {
69 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
70 "location": "query",
71 "type": "string"
72 },
73 "access_token": {
74 "description": "OAuth access token.",
75 "location": "query",
76 "type": "string"
77 },
78 "quotaUser": {
79 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
80 "location": "query",
81 "type": "string"
82 },
83 "pp": {
84 "default": "true",
85 "description": "Pretty-print response.",
86 "location": "query",
87 "type": "boolean"
88 },
52 "bearer_token": { 89 "bearer_token": {
53 "description": "OAuth bearer token.", 90 "description": "OAuth bearer token.",
54 "location": "query", 91 "location": "query",
55 "type": "string" 92 "type": "string"
56 }, 93 },
57 "oauth_token": { 94 "oauth_token": {
58 "description": "OAuth 2.0 token for the current user.", 95 "description": "OAuth 2.0 token for the current user.",
59 "location": "query", 96 "location": "query",
60 "type": "string" 97 "type": "string"
61 }, 98 },
(...skipping 28 matching lines...) Expand all
90 "v1 error format", 127 "v1 error format",
91 "v2 error format" 128 "v2 error format"
92 ], 129 ],
93 "location": "query", 130 "location": "query",
94 "type": "string" 131 "type": "string"
95 }, 132 },
96 "callback": { 133 "callback": {
97 "description": "JSONP", 134 "description": "JSONP",
98 "location": "query", 135 "location": "query",
99 "type": "string" 136 "type": "string"
100 },
101 "alt": {
102 "default": "json",
103 "description": "Data format for response.",
104 "enum": [
105 "json",
106 "media",
107 "proto"
108 ],
109 "enumDescriptions": [
110 "Responses with Content-Type of application/json",
111 "Media download with context-dependent Content-Type",
112 "Responses with Content-Type of application/x-protobuf"
113 ],
114 "location": "query",
115 "type": "string"
116 },
117 "key": {
118 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
119 "location": "query",
120 "type": "string"
121 },
122 "access_token": {
123 "description": "OAuth access token.",
124 "location": "query",
125 "type": "string"
126 },
127 "quotaUser": {
128 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
129 "location": "query",
130 "type": "string"
131 },
132 "pp": {
133 "default": "true",
134 "description": "Pretty-print response.",
135 "location": "query",
136 "type": "boolean"
137 } 137 }
138 }, 138 },
139 "protocol": "rest", 139 "protocol": "rest",
140 "resources": { 140 "resources": {
141 "people": { 141 "people": {
142 "methods": { 142 "methods": {
143 "getBatchGet": { 143 "getBatchGet": {
144 "description": "Provides information about a list of specifi c people by specifying a list\nof requested resource names. Use `people/me` to i ndicate the authenticated\nuser.", 144 "description": "Provides information about a list of specifi c people by specifying a list\nof requested resource names. Use `people/me` to i ndicate the authenticated\nuser.",
145 "httpMethod": "GET", 145 "httpMethod": "GET",
146 "id": "people.people.getBatchGet", 146 "id": "people.people.getBatchGet",
(...skipping 29 matching lines...) Expand all
176 ] 176 ]
177 }, 177 },
178 "get": { 178 "get": {
179 "description": "Provides information about a person by speci fying a resource name. Use\n`people/me` to indicate the authenticated user.", 179 "description": "Provides information about a person by speci fying a resource name. Use\n`people/me` to indicate the authenticated user.",
180 "httpMethod": "GET", 180 "httpMethod": "GET",
181 "id": "people.people.get", 181 "id": "people.people.get",
182 "parameterOrder": [ 182 "parameterOrder": [
183 "resourceName" 183 "resourceName"
184 ], 184 ],
185 "parameters": { 185 "parameters": {
186 "requestMask.includeField": {
187 "description": "Required. Comma-separated list of pe rson fields to be included in the\nresponse. Each path should start with `person .`: for example,\n`person.names` or `person.photos`.",
188 "format": "google-fieldmask",
189 "location": "query",
190 "type": "string"
191 },
192 "resourceName": { 186 "resourceName": {
193 "description": "The resource name of the person to p rovide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about any user, specify the resource name that\n identifies the user, such as the resource names returned by\n [`pe ople.connections.list`](/people/api/rest/v1/people.connections/list).", 187 "description": "The resource name of the person to p rovide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about any user, specify the resource name that\n identifies the user, such as the resource names returned by\n [`pe ople.connections.list`](/people/api/rest/v1/people.connections/list).",
194 "location": "path", 188 "location": "path",
195 "pattern": "^people/[^/]+$", 189 "pattern": "^people/[^/]+$",
196 "required": true, 190 "required": true,
197 "type": "string" 191 "type": "string"
192 },
193 "requestMask.includeField": {
194 "description": "Required. Comma-separated list of pe rson fields to be included in the\nresponse. Each path should start with `person .`: for example,\n`person.names` or `person.photos`.",
195 "format": "google-fieldmask",
196 "location": "query",
197 "type": "string"
198 } 198 }
199 }, 199 },
200 "path": "v1/{+resourceName}", 200 "path": "v1/{+resourceName}",
201 "response": { 201 "response": {
202 "$ref": "Person" 202 "$ref": "Person"
203 }, 203 },
204 "scopes": [ 204 "scopes": [
205 "https://www.googleapis.com/auth/contacts", 205 "https://www.googleapis.com/auth/contacts",
206 "https://www.googleapis.com/auth/contacts.readonly", 206 "https://www.googleapis.com/auth/contacts.readonly",
207 "https://www.googleapis.com/auth/plus.login", 207 "https://www.googleapis.com/auth/plus.login",
(...skipping 10 matching lines...) Expand all
218 "connections": { 218 "connections": {
219 "methods": { 219 "methods": {
220 "list": { 220 "list": {
221 "description": "Provides a list of the authenticated user's contacts merged with any\nlinked profiles.", 221 "description": "Provides a list of the authenticated user's contacts merged with any\nlinked profiles.",
222 "httpMethod": "GET", 222 "httpMethod": "GET",
223 "id": "people.people.connections.list", 223 "id": "people.people.connections.list",
224 "parameterOrder": [ 224 "parameterOrder": [
225 "resourceName" 225 "resourceName"
226 ], 226 ],
227 "parameters": { 227 "parameters": {
228 "requestMask.includeField": {
229 "description": "Required. Comma-separated li st of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
230 "format": "google-fieldmask",
231 "location": "query",
232 "type": "string"
233 },
234 "pageSize": {
235 "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defau lts to 100.",
236 "format": "int32",
237 "location": "query",
238 "type": "integer"
239 },
228 "syncToken": { 240 "syncToken": {
229 "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sy nc token was created will be returned.", 241 "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sy nc token was created will be returned.",
230 "location": "query", 242 "location": "query",
231 "type": "string" 243 "type": "string"
232 }, 244 },
233 "sortOrder": { 245 "sortOrder": {
234 "description": "The order in which the conne ctions should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.", 246 "description": "The order in which the conne ctions should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
235 "enum": [ 247 "enum": [
236 "LAST_MODIFIED_ASCENDING", 248 "LAST_MODIFIED_ASCENDING",
237 "FIRST_NAME_ASCENDING", 249 "FIRST_NAME_ASCENDING",
(...skipping 11 matching lines...) Expand all
249 "description": "The resource name to return connections for. Only `people/me` is valid.", 261 "description": "The resource name to return connections for. Only `people/me` is valid.",
250 "location": "path", 262 "location": "path",
251 "pattern": "^people/[^/]+$", 263 "pattern": "^people/[^/]+$",
252 "required": true, 264 "required": true,
253 "type": "string" 265 "type": "string"
254 }, 266 },
255 "pageToken": { 267 "pageToken": {
256 "description": "The token of the page to be returned.", 268 "description": "The token of the page to be returned.",
257 "location": "query", 269 "location": "query",
258 "type": "string" 270 "type": "string"
259 },
260 "pageSize": {
261 "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defau lts to 100.",
262 "format": "int32",
263 "location": "query",
264 "type": "integer"
265 },
266 "requestMask.includeField": {
267 "description": "Required. Comma-separated li st of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.",
268 "format": "google-fieldmask",
269 "location": "query",
270 "type": "string"
271 } 271 }
272 }, 272 },
273 "path": "v1/{+resourceName}/connections", 273 "path": "v1/{+resourceName}/connections",
274 "response": { 274 "response": {
275 "$ref": "ListConnectionsResponse" 275 "$ref": "ListConnectionsResponse"
276 }, 276 },
277 "scopes": [ 277 "scopes": [
278 "https://www.googleapis.com/auth/contacts", 278 "https://www.googleapis.com/auth/contacts",
279 "https://www.googleapis.com/auth/contacts.readon ly" 279 "https://www.googleapis.com/auth/contacts.readon ly"
280 ] 280 ]
281 } 281 }
282 } 282 }
283 } 283 }
284 } 284 }
285 } 285 }
286 }, 286 },
287 "revision": "20170520", 287 "revision": "20170608",
288 "rootUrl": "https://people.googleapis.com/", 288 "rootUrl": "https://people.googleapis.com/",
289 "schemas": { 289 "schemas": {
290 "Residence": {
291 "description": "A person's past or current residence.",
292 "id": "Residence",
293 "properties": {
294 "current": {
295 "description": "True if the residence is the person's curren t residence;\nfalse if the residence is a past residence.",
296 "type": "boolean"
297 },
298 "metadata": {
299 "$ref": "FieldMetadata",
300 "description": "Metadata about the residence."
301 },
302 "value": {
303 "description": "The address of the residence.",
304 "type": "string"
305 }
306 },
307 "type": "object"
308 },
309 "Address": {
310 "description": "A person's physical address. May be a P.O. box or st reet address. All fields\nare optional.",
311 "id": "Address",
312 "properties": {
313 "formattedValue": {
314 "description": "The unstructured value of the address. If th is is not set by the user it\nwill be automatically constructed from structured values.",
315 "type": "string"
316 },
317 "country": {
318 "description": "The country of the address.",
319 "type": "string"
320 },
321 "type": {
322 "description": "The type of the address. The type can be cus tom or predefined.\nPossible values include, but are not limited to, the followi ng:\n\n* `home`\n* `work`\n* `other`",
323 "type": "string"
324 },
325 "extendedAddress": {
326 "description": "The extended address of the address; for exa mple, the apartment number.",
327 "type": "string"
328 },
329 "poBox": {
330 "description": "The P.O. box of the address.",
331 "type": "string"
332 },
333 "postalCode": {
334 "description": "The postal code of the address.",
335 "type": "string"
336 },
337 "region": {
338 "description": "The region of the address; for example, the state or province.",
339 "type": "string"
340 },
341 "streetAddress": {
342 "description": "The street address.",
343 "type": "string"
344 },
345 "metadata": {
346 "$ref": "FieldMetadata",
347 "description": "Metadata about the address."
348 },
349 "countryCode": {
350 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/ iso/country_codes.htm) country\ncode of the address.",
351 "type": "string"
352 },
353 "formattedType": {
354 "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP hea der locale.",
355 "type": "string"
356 },
357 "city": {
358 "description": "The city of the address.",
359 "type": "string"
360 }
361 },
362 "type": "object"
363 },
364 "Status": {
365 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
366 "id": "Status",
367 "properties": {
368 "details": {
369 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
370 "items": {
371 "additionalProperties": {
372 "description": "Properties of the object. Contains f ield @type with type URL.",
373 "type": "any"
374 },
375 "type": "object"
376 },
377 "type": "array"
378 },
379 "code": {
380 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
381 "format": "int32",
382 "type": "integer"
383 },
384 "message": {
385 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
386 "type": "string"
387 }
388 },
389 "type": "object"
390 },
391 "ContactGroupMembership": {
392 "description": "A Google contact group membership.",
393 "id": "ContactGroupMembership",
394 "properties": {
395 "contactGroupId": {
396 "description": "The contact group ID for the contact group m embership. The contact group\nID can be custom or predefined. Possible values in clude, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\ n* A numerical ID for user-created groups.",
397 "type": "string"
398 }
399 },
400 "type": "object"
401 },
402 "PersonMetadata": {
403 "description": "The read-only metadata about a person.",
404 "id": "PersonMetadata",
405 "properties": {
406 "objectType": {
407 "description": "DEPRECATED(Please read person.metadata.sourc es.profile_metadata instead).\nThe type of the person object.",
408 "enum": [
409 "OBJECT_TYPE_UNSPECIFIED",
410 "PERSON",
411 "PAGE"
412 ],
413 "enumDescriptions": [
414 "Unspecified.",
415 "Person.",
416 "[Google+ Page.](http://www.google.com/+/brands/)"
417 ],
418 "type": "string"
419 },
420 "linkedPeopleResourceNames": {
421 "description": "Resource names of people linked to this reso urce.",
422 "items": {
423 "type": "string"
424 },
425 "type": "array"
426 },
427 "previousResourceNames": {
428 "description": "Any former resource names this person has ha d. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connectio ns/list) requests\nthat include a sync token.\n\nThe resource name may change wh en adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
429 "items": {
430 "type": "string"
431 },
432 "type": "array"
433 },
434 "sources": {
435 "description": "The sources of data for the person.",
436 "items": {
437 "$ref": "Source"
438 },
439 "type": "array"
440 },
441 "deleted": {
442 "description": "True if the person resource has been deleted . Populated only for\n[`connections.list`](/people/api/rest/v1/people.connection s/list) requests\nthat include a sync token.",
443 "type": "boolean"
444 }
445 },
446 "type": "object"
447 },
448 "Event": {
449 "description": "An event related to the person.",
450 "id": "Event",
451 "properties": {
452 "type": {
453 "description": "The type of the event. The type can be custo m or predefined.\nPossible values include, but are not limited to, the following :\n\n* `anniversary`\n* `other`",
454 "type": "string"
455 },
456 "metadata": {
457 "$ref": "FieldMetadata",
458 "description": "Metadata about the event."
459 },
460 "date": {
461 "$ref": "Date",
462 "description": "The date of the event."
463 },
464 "formattedType": {
465 "description": "The read-only type of the event translated a nd formatted in the\nviewer's account locale or the `Accept-Language` HTTP heade r locale.",
466 "type": "string"
467 }
468 },
469 "type": "object"
470 },
471 "ProfileMetadata": {
472 "description": "The read-only metadata about a profile.",
473 "id": "ProfileMetadata",
474 "properties": {
475 "objectType": {
476 "description": "The profile object type.",
477 "enum": [
478 "OBJECT_TYPE_UNSPECIFIED",
479 "PERSON",
480 "PAGE"
481 ],
482 "enumDescriptions": [
483 "Unspecified.",
484 "Person.",
485 "[Google+ Page.](http://www.google.com/+/brands/)"
486 ],
487 "type": "string"
488 }
489 },
490 "type": "object"
491 },
492 "Url": {
493 "description": "A person's associated URLs.",
494 "id": "Url",
495 "properties": {
496 "formattedType": {
497 "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
498 "type": "string"
499 },
500 "type": {
501 "description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\ n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservat ions`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
502 "type": "string"
503 },
504 "metadata": {
505 "$ref": "FieldMetadata",
506 "description": "Metadata about the URL."
507 },
508 "value": {
509 "description": "The URL.",
510 "type": "string"
511 }
512 },
513 "type": "object"
514 },
515 "Gender": {
516 "description": "A person's gender.",
517 "id": "Gender",
518 "properties": {
519 "formattedValue": {
520 "description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP hea der locale.",
521 "type": "string"
522 },
523 "metadata": {
524 "$ref": "FieldMetadata",
525 "description": "Metadata about the gender."
526 },
527 "value": {
528 "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfo llowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
529 "type": "string"
530 }
531 },
532 "type": "object"
533 },
534 "CoverPhoto": { 290 "CoverPhoto": {
535 "description": "A person's read-only cover photo. A large image show n on the person's\nprofile page that represents who they are or what they care a bout.", 291 "description": "A person's read-only cover photo. A large image show n on the person's\nprofile page that represents who they are or what they care a bout.",
536 "id": "CoverPhoto", 292 "id": "CoverPhoto",
537 "properties": { 293 "properties": {
538 "default": { 294 "default": {
539 "description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.", 295 "description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
540 "type": "boolean" 296 "type": "boolean"
541 }, 297 },
542 "metadata": { 298 "metadata": {
543 "$ref": "FieldMetadata", 299 "$ref": "FieldMetadata",
544 "description": "Metadata about the cover photo." 300 "description": "Metadata about the cover photo."
545 }, 301 },
546 "url": { 302 "url": {
547 "description": "The URL of the cover photo.", 303 "description": "The URL of the cover photo.",
548 "type": "string" 304 "type": "string"
549 } 305 }
550 }, 306 },
551 "type": "object" 307 "type": "object"
552 }, 308 },
309 "Interest": {
310 "description": "One of the person's interests.",
311 "id": "Interest",
312 "properties": {
313 "value": {
314 "description": "The interest; for example, `stargazing`.",
315 "type": "string"
316 },
317 "metadata": {
318 "$ref": "FieldMetadata",
319 "description": "Metadata about the interest."
320 }
321 },
322 "type": "object"
323 },
553 "ImClient": { 324 "ImClient": {
554 "description": "A person's instant messaging client.", 325 "description": "A person's instant messaging client.",
555 "id": "ImClient", 326 "id": "ImClient",
556 "properties": { 327 "properties": {
557 "formattedProtocol": { 328 "formattedProtocol": {
558 "description": "The read-only protocol of the IM client form atted in the viewer's account\nlocale or the `Accept-Language` HTTP header local e.", 329 "description": "The read-only protocol of the IM client form atted in the viewer's account\nlocale or the `Accept-Language` HTTP header local e.",
559 "type": "string" 330 "type": "string"
560 }, 331 },
561 "formattedType": { 332 "formattedType": {
562 "description": "The read-only type of the IM client translat ed and formatted in the\nviewer's account locale or the `Accept-Language` HTTP h eader locale.", 333 "description": "The read-only type of the IM client translat ed and formatted in the\nviewer's account locale or the `Accept-Language` HTTP h eader locale.",
(...skipping 11 matching lines...) Expand all
574 "description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, t he following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\ n* `icq`\n* `jabber`\n* `netMeeting`", 345 "description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, t he following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\ n* `icq`\n* `jabber`\n* `netMeeting`",
575 "type": "string" 346 "type": "string"
576 }, 347 },
577 "username": { 348 "username": {
578 "description": "The user name used in the IM client.", 349 "description": "The user name used in the IM client.",
579 "type": "string" 350 "type": "string"
580 } 351 }
581 }, 352 },
582 "type": "object" 353 "type": "object"
583 }, 354 },
584 "Interest": {
585 "description": "One of the person's interests.",
586 "id": "Interest",
587 "properties": {
588 "value": {
589 "description": "The interest; for example, `stargazing`.",
590 "type": "string"
591 },
592 "metadata": {
593 "$ref": "FieldMetadata",
594 "description": "Metadata about the interest."
595 }
596 },
597 "type": "object"
598 },
599 "EmailAddress": {
600 "description": "A person's email address.",
601 "id": "EmailAddress",
602 "properties": {
603 "displayName": {
604 "description": "The display name of the email.",
605 "type": "string"
606 },
607 "type": {
608 "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the f ollowing:\n\n* `home`\n* `work`\n* `other`",
609 "type": "string"
610 },
611 "metadata": {
612 "$ref": "FieldMetadata",
613 "description": "Metadata about the email address."
614 },
615 "value": {
616 "description": "The email address.",
617 "type": "string"
618 },
619 "formattedType": {
620 "description": "The read-only type of the email address tran slated and formatted in the\nviewer's account locale or the `Accept-Language` HT TP header locale.",
621 "type": "string"
622 }
623 },
624 "type": "object"
625 },
626 "Nickname": { 355 "Nickname": {
627 "description": "A person's nickname.", 356 "description": "A person's nickname.",
628 "id": "Nickname", 357 "id": "Nickname",
629 "properties": { 358 "properties": {
630 "type": { 359 "type": {
631 "description": "The type of the nickname.", 360 "description": "The type of the nickname.",
632 "enum": [ 361 "enum": [
633 "DEFAULT", 362 "DEFAULT",
634 "MAIDEN_NAME", 363 "MAIDEN_NAME",
635 "INITIALS", 364 "INITIALS",
(...skipping 13 matching lines...) Expand all
649 "$ref": "FieldMetadata", 378 "$ref": "FieldMetadata",
650 "description": "Metadata about the nickname." 379 "description": "Metadata about the nickname."
651 }, 380 },
652 "value": { 381 "value": {
653 "description": "The nickname.", 382 "description": "The nickname.",
654 "type": "string" 383 "type": "string"
655 } 384 }
656 }, 385 },
657 "type": "object" 386 "type": "object"
658 }, 387 },
388 "EmailAddress": {
389 "description": "A person's email address.",
390 "id": "EmailAddress",
391 "properties": {
392 "displayName": {
393 "description": "The display name of the email.",
394 "type": "string"
395 },
396 "type": {
397 "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the f ollowing:\n\n* `home`\n* `work`\n* `other`",
398 "type": "string"
399 },
400 "metadata": {
401 "$ref": "FieldMetadata",
402 "description": "Metadata about the email address."
403 },
404 "value": {
405 "description": "The email address.",
406 "type": "string"
407 },
408 "formattedType": {
409 "description": "The read-only type of the email address tran slated and formatted in the\nviewer's account locale or the `Accept-Language` HT TP header locale.",
410 "type": "string"
411 }
412 },
413 "type": "object"
414 },
659 "Skill": { 415 "Skill": {
660 "description": "A skill that the person has.", 416 "description": "A skill that the person has.",
661 "id": "Skill", 417 "id": "Skill",
662 "properties": { 418 "properties": {
663 "metadata": { 419 "metadata": {
664 "$ref": "FieldMetadata", 420 "$ref": "FieldMetadata",
665 "description": "Metadata about the skill." 421 "description": "Metadata about the skill."
666 }, 422 },
667 "value": { 423 "value": {
668 "description": "The skill; for example, `underwater basket w eaving`.", 424 "description": "The skill; for example, `underwater basket w eaving`.",
(...skipping 29 matching lines...) Expand all
698 "$ref": "ContactGroupMembership", 454 "$ref": "ContactGroupMembership",
699 "description": "The contact group membership." 455 "description": "The contact group membership."
700 } 456 }
701 }, 457 },
702 "type": "object" 458 "type": "object"
703 }, 459 },
704 "RelationshipStatus": { 460 "RelationshipStatus": {
705 "description": "A person's read-only relationship status.", 461 "description": "A person's read-only relationship status.",
706 "id": "RelationshipStatus", 462 "id": "RelationshipStatus",
707 "properties": { 463 "properties": {
708 "value": {
709 "description": "The relationship status. The value can be cu stom or predefined.\nPossible values include, but are not limited to, the follow ing:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplic ated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilU nion`",
710 "type": "string"
711 },
712 "formattedValue": { 464 "formattedValue": {
713 "description": "The read-only value of the relationship stat us translated and formatted in\nthe viewer's account locale or the `Accept-Langu age` HTTP header locale.", 465 "description": "The read-only value of the relationship stat us translated and formatted in\nthe viewer's account locale or the `Accept-Langu age` HTTP header locale.",
714 "type": "string" 466 "type": "string"
715 }, 467 },
716 "metadata": { 468 "metadata": {
717 "$ref": "FieldMetadata", 469 "$ref": "FieldMetadata",
718 "description": "Metadata about the relationship status." 470 "description": "Metadata about the relationship status."
719 }
720 },
721 "type": "object"
722 },
723 "Tagline": {
724 "description": "A read-only brief one-line description of the person .",
725 "id": "Tagline",
726 "properties": {
727 "metadata": {
728 "$ref": "FieldMetadata",
729 "description": "Metadata about the tagline."
730 }, 471 },
731 "value": { 472 "value": {
732 "description": "The tagline.", 473 "description": "The relationship status. The value can be cu stom or predefined.\nPossible values include, but are not limited to, the follow ing:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplic ated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilU nion`",
733 "type": "string" 474 "type": "string"
734 } 475 }
735 }, 476 },
736 "type": "object" 477 "type": "object"
737 }, 478 },
738 "Date": { 479 "Date": {
739 "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](ht tps://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date .", 480 "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](ht tps://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date .",
740 "id": "Date", 481 "id": "Date",
741 "properties": { 482 "properties": {
742 "day": { 483 "day": {
743 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not s ignificant.", 484 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not s ignificant.",
744 "format": "int32", 485 "format": "int32",
745 "type": "integer" 486 "type": "integer"
746 }, 487 },
747 "year": { 488 "year": {
748 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.", 489 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.",
749 "format": "int32", 490 "format": "int32",
750 "type": "integer" 491 "type": "integer"
751 }, 492 },
752 "month": { 493 "month": {
753 "description": "Month of year. Must be from 1 to 12.", 494 "description": "Month of year. Must be from 1 to 12.",
754 "format": "int32", 495 "format": "int32",
755 "type": "integer" 496 "type": "integer"
756 } 497 }
757 }, 498 },
758 "type": "object" 499 "type": "object"
759 }, 500 },
501 "Tagline": {
502 "description": "A read-only brief one-line description of the person .",
503 "id": "Tagline",
504 "properties": {
505 "metadata": {
506 "$ref": "FieldMetadata",
507 "description": "Metadata about the tagline."
508 },
509 "value": {
510 "description": "The tagline.",
511 "type": "string"
512 }
513 },
514 "type": "object"
515 },
760 "Name": { 516 "Name": {
761 "description": "A person's name. If the name is a mononym, the famil y name is empty.", 517 "description": "A person's name. If the name is a mononym, the famil y name is empty.",
762 "id": "Name", 518 "id": "Name",
763 "properties": { 519 "properties": {
764 "displayName": {
765 "description": "The read-only display name formatted accordi ng to the locale specified by\nthe viewer's account or the <code>Accept-Language </code> HTTP header.",
766 "type": "string"
767 },
768 "honorificSuffix": {
769 "description": "The honorific suffixes, such as `Jr.`",
770 "type": "string"
771 },
772 "honorificPrefix": { 520 "honorificPrefix": {
773 "description": "The honorific prefixes, such as `Mrs.` or `D r.`", 521 "description": "The honorific prefixes, such as `Mrs.` or `D r.`",
774 "type": "string" 522 "type": "string"
775 }, 523 },
776 "phoneticHonorificSuffix": { 524 "phoneticHonorificSuffix": {
777 "description": "The honorific suffixes spelled as they sound .", 525 "description": "The honorific suffixes spelled as they sound .",
778 "type": "string" 526 "type": "string"
779 }, 527 },
528 "givenName": {
529 "description": "The given name.",
530 "type": "string"
531 },
780 "middleName": { 532 "middleName": {
781 "description": "The middle name(s).", 533 "description": "The middle name(s).",
782 "type": "string" 534 "type": "string"
783 }, 535 },
784 "givenName": {
785 "description": "The given name.",
786 "type": "string"
787 },
788 "phoneticHonorificPrefix": { 536 "phoneticHonorificPrefix": {
789 "description": "The honorific prefixes spelled as they sound .", 537 "description": "The honorific prefixes spelled as they sound .",
790 "type": "string" 538 "type": "string"
791 }, 539 },
792 "phoneticGivenName": { 540 "phoneticGivenName": {
793 "description": "The given name spelled as it sounds.", 541 "description": "The given name spelled as it sounds.",
794 "type": "string" 542 "type": "string"
795 }, 543 },
796 "phoneticFamilyName": { 544 "phoneticFamilyName": {
797 "description": "The family name spelled as it sounds.", 545 "description": "The family name spelled as it sounds.",
(...skipping 11 matching lines...) Expand all
809 "$ref": "FieldMetadata", 557 "$ref": "FieldMetadata",
810 "description": "Metadata about the name." 558 "description": "Metadata about the name."
811 }, 559 },
812 "phoneticFullName": { 560 "phoneticFullName": {
813 "description": "The full name spelled as it sounds.", 561 "description": "The full name spelled as it sounds.",
814 "type": "string" 562 "type": "string"
815 }, 563 },
816 "displayNameLastFirst": { 564 "displayNameLastFirst": {
817 "description": "The read-only display name with the last nam e first formatted according to\nthe locale specified by the viewer's account or the\n<code>Accept-Language</code> HTTP header.", 565 "description": "The read-only display name with the last nam e first formatted according to\nthe locale specified by the viewer's account or the\n<code>Accept-Language</code> HTTP header.",
818 "type": "string" 566 "type": "string"
567 },
568 "displayName": {
569 "description": "The read-only display name formatted accordi ng to the locale specified by\nthe viewer's account or the <code>Accept-Language </code> HTTP header.",
570 "type": "string"
571 },
572 "honorificSuffix": {
573 "description": "The honorific suffixes, such as `Jr.`",
574 "type": "string"
819 } 575 }
820 }, 576 },
821 "type": "object" 577 "type": "object"
822 }, 578 },
823 "BraggingRights": { 579 "BraggingRights": {
824 "description": "A person's bragging rights.", 580 "description": "A person's bragging rights.",
825 "id": "BraggingRights", 581 "id": "BraggingRights",
826 "properties": { 582 "properties": {
827 "metadata": { 583 "metadata": {
828 "$ref": "FieldMetadata", 584 "$ref": "FieldMetadata",
829 "description": "Metadata about the bragging rights." 585 "description": "Metadata about the bragging rights."
830 }, 586 },
831 "value": { 587 "value": {
832 "description": "The bragging rights; for example, `climbed m ount everest`.", 588 "description": "The bragging rights; for example, `climbed m ount everest`.",
833 "type": "string" 589 "type": "string"
834 } 590 }
835 }, 591 },
836 "type": "object" 592 "type": "object"
837 }, 593 },
838 "Locale": { 594 "Locale": {
839 "description": "A person's locale preference.", 595 "description": "A person's locale preference.",
840 "id": "Locale", 596 "id": "Locale",
841 "properties": { 597 "properties": {
598 "value": {
599 "description": "The well-formed [IETF BCP 47](https://tools. ietf.org/html/bcp47)\nlanguage tag representing the locale.",
600 "type": "string"
601 },
842 "metadata": { 602 "metadata": {
843 "$ref": "FieldMetadata", 603 "$ref": "FieldMetadata",
844 "description": "Metadata about the locale." 604 "description": "Metadata about the locale."
845 },
846 "value": {
847 "description": "The well-formed [IETF BCP 47](https://tools. ietf.org/html/bcp47)\nlanguage tag representing the locale.",
848 "type": "string"
849 } 605 }
850 }, 606 },
851 "type": "object" 607 "type": "object"
852 }, 608 },
853 "Organization": { 609 "Organization": {
854 "description": "A person's past or current organization. Overlapping date ranges are\npermitted.", 610 "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
855 "id": "Organization", 611 "id": "Organization",
856 "properties": { 612 "properties": {
857 "domain": {
858 "description": "The domain name associated with the organiza tion; for example, `google.com`.",
859 "type": "string"
860 },
861 "department": {
862 "description": "The person's department at the organization. ",
863 "type": "string"
864 },
865 "type": {
866 "description": "The type of the organization. The type can b e custom or predefined.\nPossible values include, but are not limited to, the fo llowing:\n\n* `work`\n* `school`",
867 "type": "string"
868 },
869 "phoneticName": {
870 "description": "The phonetic name of the organization.",
871 "type": "string"
872 },
873 "jobDescription": {
874 "description": "The person's job description at the organiza tion.",
875 "type": "string"
876 },
877 "endDate": {
878 "$ref": "Date",
879 "description": "The end date when the person left the organi zation."
880 },
881 "symbol": { 613 "symbol": {
882 "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.", 614 "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
883 "type": "string" 615 "type": "string"
884 }, 616 },
885 "name": { 617 "name": {
886 "description": "The name of the organization.", 618 "description": "The name of the organization.",
887 "type": "string" 619 "type": "string"
888 }, 620 },
889 "metadata": { 621 "metadata": {
890 "$ref": "FieldMetadata", 622 "$ref": "FieldMetadata",
891 "description": "Metadata about the organization." 623 "description": "Metadata about the organization."
892 }, 624 },
625 "location": {
626 "description": "The location of the organization office the person works at.",
627 "type": "string"
628 },
893 "title": { 629 "title": {
894 "description": "The person's job title at the organization." , 630 "description": "The person's job title at the organization." ,
895 "type": "string" 631 "type": "string"
896 }, 632 },
897 "location": {
898 "description": "The location of the organization office the person works at.",
899 "type": "string"
900 },
901 "current": { 633 "current": {
902 "description": "True if the organization is the person's cur rent organization;\nfalse if the organization is a past organization.", 634 "description": "True if the organization is the person's cur rent organization;\nfalse if the organization is a past organization.",
903 "type": "boolean" 635 "type": "boolean"
904 }, 636 },
905 "startDate": { 637 "startDate": {
906 "$ref": "Date", 638 "$ref": "Date",
907 "description": "The start date when the person joined the or ganization." 639 "description": "The start date when the person joined the or ganization."
908 }, 640 },
909 "formattedType": { 641 "formattedType": {
910 "description": "The read-only type of the organization trans lated and formatted in the\nviewer's account locale or the `Accept-Language` HTT P header locale.", 642 "description": "The read-only type of the organization trans lated and formatted in the\nviewer's account locale or the `Accept-Language` HTT P header locale.",
911 "type": "string" 643 "type": "string"
644 },
645 "domain": {
646 "description": "The domain name associated with the organiza tion; for example, `google.com`.",
647 "type": "string"
648 },
649 "department": {
650 "description": "The person's department at the organization. ",
651 "type": "string"
652 },
653 "type": {
654 "description": "The type of the organization. The type can b e custom or predefined.\nPossible values include, but are not limited to, the fo llowing:\n\n* `work`\n* `school`",
655 "type": "string"
656 },
657 "phoneticName": {
658 "description": "The phonetic name of the organization.",
659 "type": "string"
660 },
661 "jobDescription": {
662 "description": "The person's job description at the organiza tion.",
663 "type": "string"
664 },
665 "endDate": {
666 "$ref": "Date",
667 "description": "The end date when the person left the organi zation."
912 } 668 }
913 }, 669 },
914 "type": "object" 670 "type": "object"
915 }, 671 },
916 "Biography": { 672 "Biography": {
917 "description": "A person's short biography.", 673 "description": "A person's short biography.",
918 "id": "Biography", 674 "id": "Biography",
919 "properties": { 675 "properties": {
676 "metadata": {
677 "$ref": "FieldMetadata",
678 "description": "Metadata about the biography."
679 },
680 "value": {
681 "description": "The short biography.",
682 "type": "string"
683 },
920 "contentType": { 684 "contentType": {
921 "description": "The content type of the biography.", 685 "description": "The content type of the biography.",
922 "enum": [ 686 "enum": [
923 "CONTENT_TYPE_UNSPECIFIED", 687 "CONTENT_TYPE_UNSPECIFIED",
924 "TEXT_PLAIN", 688 "TEXT_PLAIN",
925 "TEXT_HTML" 689 "TEXT_HTML"
926 ], 690 ],
927 "enumDescriptions": [ 691 "enumDescriptions": [
928 "Unspecified.", 692 "Unspecified.",
929 "Plain text.", 693 "Plain text.",
930 "HTML text." 694 "HTML text."
931 ], 695 ],
932 "type": "string" 696 "type": "string"
933 },
934 "metadata": {
935 "$ref": "FieldMetadata",
936 "description": "Metadata about the biography."
937 },
938 "value": {
939 "description": "The short biography.",
940 "type": "string"
941 } 697 }
942 }, 698 },
943 "type": "object" 699 "type": "object"
944 }, 700 },
945 "AgeRangeType": { 701 "AgeRangeType": {
946 "description": "A person's age range.", 702 "description": "A person's age range.",
947 "id": "AgeRangeType", 703 "id": "AgeRangeType",
948 "properties": { 704 "properties": {
949 "metadata": {
950 "$ref": "FieldMetadata",
951 "description": "Metadata about the age range."
952 },
953 "ageRange": { 705 "ageRange": {
954 "description": "The age range.", 706 "description": "The age range.",
955 "enum": [ 707 "enum": [
956 "AGE_RANGE_UNSPECIFIED", 708 "AGE_RANGE_UNSPECIFIED",
957 "LESS_THAN_EIGHTEEN", 709 "LESS_THAN_EIGHTEEN",
958 "EIGHTEEN_TO_TWENTY", 710 "EIGHTEEN_TO_TWENTY",
959 "TWENTY_ONE_OR_OLDER" 711 "TWENTY_ONE_OR_OLDER"
960 ], 712 ],
961 "enumDescriptions": [ 713 "enumDescriptions": [
962 "Unspecified.", 714 "Unspecified.",
963 "Younger than eighteen.", 715 "Younger than eighteen.",
964 "Between eighteen and twenty.", 716 "Between eighteen and twenty.",
965 "Twenty-one and older." 717 "Twenty-one and older."
966 ], 718 ],
967 "type": "string" 719 "type": "string"
720 },
721 "metadata": {
722 "$ref": "FieldMetadata",
723 "description": "Metadata about the age range."
968 } 724 }
969 }, 725 },
970 "type": "object" 726 "type": "object"
971 }, 727 },
972 "FieldMetadata": { 728 "FieldMetadata": {
973 "description": "Metadata about a field.", 729 "description": "Metadata about a field.",
974 "id": "FieldMetadata", 730 "id": "FieldMetadata",
975 "properties": { 731 "properties": {
976 "verified": {
977 "description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
978 "type": "boolean"
979 },
980 "primary": { 732 "primary": {
981 "description": "True if the field is the primary field; fals e if the field is a secondary\nfield.", 733 "description": "True if the field is the primary field; fals e if the field is a secondary\nfield.",
982 "type": "boolean" 734 "type": "boolean"
983 }, 735 },
984 "source": { 736 "source": {
985 "$ref": "Source", 737 "$ref": "Source",
986 "description": "The source of the field." 738 "description": "The source of the field."
739 },
740 "verified": {
741 "description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
742 "type": "boolean"
987 } 743 }
988 }, 744 },
989 "type": "object" 745 "type": "object"
990 },
991 "Source": {
992 "description": "The source of a field.",
993 "id": "Source",
994 "properties": {
995 "profileMetadata": {
996 "$ref": "ProfileMetadata",
997 "description": "Metadata about a source of type PROFILE."
998 },
999 "type": {
1000 "description": "The source type.",
1001 "enum": [
1002 "SOURCE_TYPE_UNSPECIFIED",
1003 "ACCOUNT",
1004 "PROFILE",
1005 "DOMAIN_PROFILE",
1006 "CONTACT"
1007 ],
1008 "enumDescriptions": [
1009 "Unspecified.",
1010 "[Google Account](https://accounts.google.com).",
1011 "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/<id> where <id> is the source\n id.",
1012 "[Google Apps domain profile](https://admin.google.com). ",
1013 "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/<id> where <id> is the source\ni d."
1014 ],
1015 "type": "string"
1016 },
1017 "etag": {
1018 "description": "The [HTTP entity tag](https://en.wikipedia.o rg/wiki/HTTP_ETag) of the\nsource. Used for web cache validation. Only populated in\nperson.metadata.sources.",
1019 "type": "string"
1020 },
1021 "id": {
1022 "description": "The unique identifier within the source type generated by the server.",
1023 "type": "string"
1024 }
1025 },
1026 "type": "object"
1027 }, 746 },
1028 "PersonResponse": { 747 "PersonResponse": {
1029 "description": "The response for a single person", 748 "description": "The response for a single person",
1030 "id": "PersonResponse", 749 "id": "PersonResponse",
1031 "properties": { 750 "properties": {
1032 "httpStatusCode": { 751 "httpStatusCode": {
1033 "description": "DEPRECATED(Please use status instead).\n[HTT P 1.1 status\ncode](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).", 752 "description": "DEPRECATED(Please use status instead).\n[HTT P 1.1 status\ncode](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
1034 "format": "int32", 753 "format": "int32",
1035 "type": "integer" 754 "type": "integer"
1036 }, 755 },
1037 "requestedResourceName": { 756 "requestedResourceName": {
1038 "description": "The original requested resource name. May be different than the resource\nname on the returned person.\n\nThe resource name can change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or a\nprofile URL.", 757 "description": "The original requested resource name. May be different than the resource\nname on the returned person.\n\nThe resource name can change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or a\nprofile URL.",
1039 "type": "string" 758 "type": "string"
1040 }, 759 },
1041 "person": { 760 "person": {
1042 "$ref": "Person", 761 "$ref": "Person",
1043 "description": "The person." 762 "description": "The person."
1044 }, 763 },
1045 "status": { 764 "status": {
1046 "$ref": "Status", 765 "$ref": "Status",
1047 "description": "The status of the response." 766 "description": "The status of the response."
1048 } 767 }
1049 }, 768 },
1050 "type": "object" 769 "type": "object"
1051 }, 770 },
1052 "RelationshipInterest": { 771 "RelationshipInterest": {
1053 "description": "A person's read-only relationship interest .", 772 "description": "A person's read-only relationship interest .",
1054 "id": "RelationshipInterest", 773 "id": "RelationshipInterest",
1055 "properties": { 774 "properties": {
775 "value": {
776 "description": "The kind of relationship the person is looki ng for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship `\n* `networking`",
777 "type": "string"
778 },
1056 "formattedValue": { 779 "formattedValue": {
1057 "description": "The value of the relationship interest trans lated and formatted in the\nviewer's account locale or the locale specified in t he Accept-Language\nHTTP header.", 780 "description": "The value of the relationship interest trans lated and formatted in the\nviewer's account locale or the locale specified in t he Accept-Language\nHTTP header.",
1058 "type": "string" 781 "type": "string"
1059 }, 782 },
1060 "metadata": { 783 "metadata": {
1061 "$ref": "FieldMetadata", 784 "$ref": "FieldMetadata",
1062 "description": "Metadata about the relationship interest." 785 "description": "Metadata about the relationship interest."
786 }
787 },
788 "type": "object"
789 },
790 "Source": {
791 "description": "The source of a field.",
792 "id": "Source",
793 "properties": {
794 "etag": {
795 "description": "The [HTTP entity tag](https://en.wikipedia.o rg/wiki/HTTP_ETag) of the\nsource. Used for web cache validation. Only populated in\nperson.metadata.sources.",
796 "type": "string"
1063 }, 797 },
1064 "value": { 798 "id": {
1065 "description": "The kind of relationship the person is looki ng for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship `\n* `networking`", 799 "description": "The unique identifier within the source type generated by the server.",
800 "type": "string"
801 },
802 "profileMetadata": {
803 "$ref": "ProfileMetadata",
804 "description": "Metadata about a source of type PROFILE."
805 },
806 "type": {
807 "description": "The source type.",
808 "enum": [
809 "SOURCE_TYPE_UNSPECIFIED",
810 "ACCOUNT",
811 "PROFILE",
812 "DOMAIN_PROFILE",
813 "CONTACT"
814 ],
815 "enumDescriptions": [
816 "Unspecified.",
817 "[Google Account](https://accounts.google.com).",
818 "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/<id> where <id> is the source\n id.",
819 "[Google Apps domain profile](https://admin.google.com). ",
820 "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/<id> where <id> is the source\ni d."
821 ],
1066 "type": "string" 822 "type": "string"
1067 } 823 }
1068 }, 824 },
1069 "type": "object" 825 "type": "object"
1070 }, 826 },
1071 "Relation": { 827 "Relation": {
1072 "description": "A person's relation to another person.", 828 "description": "A person's relation to another person.",
1073 "id": "Relation", 829 "id": "Relation",
1074 "properties": { 830 "properties": {
1075 "formattedType": {
1076 "description": "The type of the relation translated and form atted in the viewer's account\nlocale or the locale specified in the Accept-Lang uage HTTP header.",
1077 "type": "string"
1078 },
1079 "person": {
1080 "description": "The name of the other person this relation r efers to.",
1081 "type": "string"
1082 },
1083 "type": { 831 "type": {
1084 "description": "The person's relation to the other person. T he type can be custom or predefined.\nPossible values include, but are not limit ed to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner `\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`", 832 "description": "The person's relation to the other person. T he type can be custom or predefined.\nPossible values include, but are not limit ed to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner `\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`",
1085 "type": "string" 833 "type": "string"
1086 }, 834 },
1087 "metadata": { 835 "metadata": {
1088 "$ref": "FieldMetadata", 836 "$ref": "FieldMetadata",
1089 "description": "Metadata about the relation." 837 "description": "Metadata about the relation."
838 },
839 "formattedType": {
840 "description": "The type of the relation translated and form atted in the viewer's account\nlocale or the locale specified in the Accept-Lang uage HTTP header.",
841 "type": "string"
842 },
843 "person": {
844 "description": "The name of the other person this relation r efers to.",
845 "type": "string"
1090 } 846 }
1091 }, 847 },
1092 "type": "object" 848 "type": "object"
1093 }, 849 },
1094 "Occupation": { 850 "Occupation": {
1095 "description": "A person's occupation.", 851 "description": "A person's occupation.",
1096 "id": "Occupation", 852 "id": "Occupation",
1097 "properties": { 853 "properties": {
1098 "metadata": { 854 "metadata": {
1099 "$ref": "FieldMetadata", 855 "$ref": "FieldMetadata",
1100 "description": "Metadata about the occupation." 856 "description": "Metadata about the occupation."
1101 }, 857 },
1102 "value": { 858 "value": {
1103 "description": "The occupation; for example, `carpenter`.", 859 "description": "The occupation; for example, `carpenter`.",
1104 "type": "string" 860 "type": "string"
1105 } 861 }
1106 }, 862 },
1107 "type": "object" 863 "type": "object"
1108 }, 864 },
1109 "Person": { 865 "Person": {
1110 "description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data.\n\nMost fie lds can have multiple items. The items in a field have no guaranteed\norder, but each non-empty field is guaranteed to have exactly one field with\n`metadata.pr imary` set to true.", 866 "description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data.\n\nMost fie lds can have multiple items. The items in a field have no guaranteed\norder, but each non-empty field is guaranteed to have exactly one field with\n`metadata.pr imary` set to true.",
1111 "id": "Person", 867 "id": "Person",
1112 "properties": { 868 "properties": {
1113 "birthdays": { 869 "resourceName": {
1114 "description": "The person's birthdays.", 870 "description": "The resource name for the person, assigned b y the server. An ASCII string\nwith a max length of 27 characters, in the form o f `people/<person_id>`.",
1115 "items": {
1116 "$ref": "Birthday"
1117 },
1118 "type": "array"
1119 },
1120 "locales": {
1121 "description": "The person's locale preferences.",
1122 "items": {
1123 "$ref": "Locale"
1124 },
1125 "type": "array"
1126 },
1127 "relationshipInterests": {
1128 "description": "The kind of relationship the person is looki ng for.",
1129 "items": {
1130 "$ref": "RelationshipInterest"
1131 },
1132 "type": "array"
1133 },
1134 "urls": {
1135 "description": "The person's associated URLs.",
1136 "items": {
1137 "$ref": "Url"
1138 },
1139 "type": "array"
1140 },
1141 "nicknames": {
1142 "description": "The person's nicknames.",
1143 "items": {
1144 "$ref": "Nickname"
1145 },
1146 "type": "array"
1147 },
1148 "relations": {
1149 "description": "The person's relations.",
1150 "items": {
1151 "$ref": "Relation"
1152 },
1153 "type": "array"
1154 },
1155 "names": {
1156 "description": "The person's names.",
1157 "items": {
1158 "$ref": "Name"
1159 },
1160 "type": "array"
1161 },
1162 "occupations": {
1163 "description": "The person's occupations.",
1164 "items": {
1165 "$ref": "Occupation"
1166 },
1167 "type": "array"
1168 },
1169 "emailAddresses": {
1170 "description": "The person's email addresses.",
1171 "items": {
1172 "$ref": "EmailAddress"
1173 },
1174 "type": "array"
1175 },
1176 "organizations": {
1177 "description": "The person's past or current organizations." ,
1178 "items": {
1179 "$ref": "Organization"
1180 },
1181 "type": "array"
1182 },
1183 "etag": {
1184 "description": "The [HTTP entity tag](https://en.wikipedia.o rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
1185 "type": "string" 871 "type": "string"
1186 }, 872 },
1187 "braggingRights": {
1188 "description": "The person's bragging rights.",
1189 "items": {
1190 "$ref": "BraggingRights"
1191 },
1192 "type": "array"
1193 },
1194 "metadata": {
1195 "$ref": "PersonMetadata",
1196 "description": "Metadata about the person."
1197 },
1198 "residences": {
1199 "description": "The person's residences.",
1200 "items": {
1201 "$ref": "Residence"
1202 },
1203 "type": "array"
1204 },
1205 "genders": {
1206 "description": "The person's genders.",
1207 "items": {
1208 "$ref": "Gender"
1209 },
1210 "type": "array"
1211 },
1212 "interests": { 873 "interests": {
1213 "description": "The person's interests.", 874 "description": "The person's interests.",
1214 "items": { 875 "items": {
1215 "$ref": "Interest" 876 "$ref": "Interest"
1216 }, 877 },
1217 "type": "array" 878 "type": "array"
1218 }, 879 },
1219 "resourceName": {
1220 "description": "The resource name for the person, assigned b y the server. An ASCII string\nwith a max length of 27 characters, in the form o f `people/<person_id>`.",
1221 "type": "string"
1222 },
1223 "biographies": { 880 "biographies": {
1224 "description": "The person's biographies.", 881 "description": "The person's biographies.",
1225 "items": { 882 "items": {
1226 "$ref": "Biography" 883 "$ref": "Biography"
1227 }, 884 },
1228 "type": "array" 885 "type": "array"
1229 }, 886 },
1230 "skills": { 887 "skills": {
1231 "description": "The person's skills.", 888 "description": "The person's skills.",
1232 "items": { 889 "items": {
(...skipping 79 matching lines...) Expand 10 before | Expand all | Expand 10 after
1312 "$ref": "CoverPhoto" 969 "$ref": "CoverPhoto"
1313 }, 970 },
1314 "type": "array" 971 "type": "array"
1315 }, 972 },
1316 "imClients": { 973 "imClients": {
1317 "description": "The person's instant messaging clients.", 974 "description": "The person's instant messaging clients.",
1318 "items": { 975 "items": {
1319 "$ref": "ImClient" 976 "$ref": "ImClient"
1320 }, 977 },
1321 "type": "array" 978 "type": "array"
979 },
980 "birthdays": {
981 "description": "The person's birthdays.",
982 "items": {
983 "$ref": "Birthday"
984 },
985 "type": "array"
986 },
987 "locales": {
988 "description": "The person's locale preferences.",
989 "items": {
990 "$ref": "Locale"
991 },
992 "type": "array"
993 },
994 "relationshipInterests": {
995 "description": "The kind of relationship the person is looki ng for.",
996 "items": {
997 "$ref": "RelationshipInterest"
998 },
999 "type": "array"
1000 },
1001 "urls": {
1002 "description": "The person's associated URLs.",
1003 "items": {
1004 "$ref": "Url"
1005 },
1006 "type": "array"
1007 },
1008 "nicknames": {
1009 "description": "The person's nicknames.",
1010 "items": {
1011 "$ref": "Nickname"
1012 },
1013 "type": "array"
1014 },
1015 "names": {
1016 "description": "The person's names.",
1017 "items": {
1018 "$ref": "Name"
1019 },
1020 "type": "array"
1021 },
1022 "relations": {
1023 "description": "The person's relations.",
1024 "items": {
1025 "$ref": "Relation"
1026 },
1027 "type": "array"
1028 },
1029 "occupations": {
1030 "description": "The person's occupations.",
1031 "items": {
1032 "$ref": "Occupation"
1033 },
1034 "type": "array"
1035 },
1036 "emailAddresses": {
1037 "description": "The person's email addresses.",
1038 "items": {
1039 "$ref": "EmailAddress"
1040 },
1041 "type": "array"
1042 },
1043 "organizations": {
1044 "description": "The person's past or current organizations." ,
1045 "items": {
1046 "$ref": "Organization"
1047 },
1048 "type": "array"
1049 },
1050 "etag": {
1051 "description": "The [HTTP entity tag](https://en.wikipedia.o rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
1052 "type": "string"
1053 },
1054 "braggingRights": {
1055 "description": "The person's bragging rights.",
1056 "items": {
1057 "$ref": "BraggingRights"
1058 },
1059 "type": "array"
1060 },
1061 "metadata": {
1062 "$ref": "PersonMetadata",
1063 "description": "Metadata about the person."
1064 },
1065 "residences": {
1066 "description": "The person's residences.",
1067 "items": {
1068 "$ref": "Residence"
1069 },
1070 "type": "array"
1071 },
1072 "genders": {
1073 "description": "The person's genders.",
1074 "items": {
1075 "$ref": "Gender"
1076 },
1077 "type": "array"
1322 } 1078 }
1323 }, 1079 },
1324 "type": "object" 1080 "type": "object"
1325 }, 1081 },
1326 "GetPeopleResponse": { 1082 "GetPeopleResponse": {
1327 "id": "GetPeopleResponse", 1083 "id": "GetPeopleResponse",
1328 "properties": { 1084 "properties": {
1329 "responses": { 1085 "responses": {
1330 "description": "The response for each requested resource nam e.", 1086 "description": "The response for each requested resource nam e.",
1331 "items": { 1087 "items": {
1332 "$ref": "PersonResponse" 1088 "$ref": "PersonResponse"
1333 }, 1089 },
1334 "type": "array" 1090 "type": "array"
1335 } 1091 }
1336 }, 1092 },
1337 "type": "object" 1093 "type": "object"
1338 }, 1094 },
1339 "Photo": { 1095 "Photo": {
1340 "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.", 1096 "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
1341 "id": "Photo", 1097 "id": "Photo",
1342 "properties": { 1098 "properties": {
1099 "url": {
1100 "description": "The URL of the photo. You can change the des ired size by appending a query\nparameter `sz=<size>` at the end of the url. Exa mple:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/0 0gzXvDBYqw/s100/photo.jpg?sz=50`",
1101 "type": "string"
1102 },
1343 "metadata": { 1103 "metadata": {
1344 "$ref": "FieldMetadata", 1104 "$ref": "FieldMetadata",
1345 "description": "Metadata about the photo." 1105 "description": "Metadata about the photo."
1346 },
1347 "url": {
1348 "description": "The URL of the photo. You can change the des ired size by appending a query\nparameter `sz=<size>` at the end of the url. Exa mple:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/0 0gzXvDBYqw/s100/photo.jpg?sz=50`",
1349 "type": "string"
1350 } 1106 }
1351 }, 1107 },
1352 "type": "object" 1108 "type": "object"
1353 }, 1109 },
1354 "PhoneNumber": { 1110 "PhoneNumber": {
1355 "description": "A person's phone number.", 1111 "description": "A person's phone number.",
1356 "id": "PhoneNumber", 1112 "id": "PhoneNumber",
1357 "properties": { 1113 "properties": {
1358 "type": { 1114 "type": {
1359 "description": "The type of the phone number. The type can b e custom or predefined.\nPossible values include, but are not limited to, the fo llowing:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFa x`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `othe r`", 1115 "description": "The type of the phone number. The type can b e custom or predefined.\nPossible values include, but are not limited to, the fo llowing:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFa x`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `othe r`",
(...skipping 60 matching lines...) Expand 10 before | Expand all | Expand 10 after
1420 "metadata": { 1176 "metadata": {
1421 "$ref": "FieldMetadata", 1177 "$ref": "FieldMetadata",
1422 "description": "Metadata about the birthday." 1178 "description": "Metadata about the birthday."
1423 }, 1179 },
1424 "date": { 1180 "date": {
1425 "$ref": "Date", 1181 "$ref": "Date",
1426 "description": "The date of the birthday." 1182 "description": "The date of the birthday."
1427 } 1183 }
1428 }, 1184 },
1429 "type": "object" 1185 "type": "object"
1186 },
1187 "Address": {
1188 "description": "A person's physical address. May be a P.O. box or st reet address. All fields\nare optional.",
1189 "id": "Address",
1190 "properties": {
1191 "region": {
1192 "description": "The region of the address; for example, the state or province.",
1193 "type": "string"
1194 },
1195 "streetAddress": {
1196 "description": "The street address.",
1197 "type": "string"
1198 },
1199 "metadata": {
1200 "$ref": "FieldMetadata",
1201 "description": "Metadata about the address."
1202 },
1203 "countryCode": {
1204 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/ iso/country_codes.htm) country\ncode of the address.",
1205 "type": "string"
1206 },
1207 "formattedType": {
1208 "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP hea der locale.",
1209 "type": "string"
1210 },
1211 "city": {
1212 "description": "The city of the address.",
1213 "type": "string"
1214 },
1215 "formattedValue": {
1216 "description": "The unstructured value of the address. If th is is not set by the user it\nwill be automatically constructed from structured values.",
1217 "type": "string"
1218 },
1219 "country": {
1220 "description": "The country of the address.",
1221 "type": "string"
1222 },
1223 "type": {
1224 "description": "The type of the address. The type can be cus tom or predefined.\nPossible values include, but are not limited to, the followi ng:\n\n* `home`\n* `work`\n* `other`",
1225 "type": "string"
1226 },
1227 "extendedAddress": {
1228 "description": "The extended address of the address; for exa mple, the apartment number.",
1229 "type": "string"
1230 },
1231 "poBox": {
1232 "description": "The P.O. box of the address.",
1233 "type": "string"
1234 },
1235 "postalCode": {
1236 "description": "The postal code of the address.",
1237 "type": "string"
1238 }
1239 },
1240 "type": "object"
1241 },
1242 "Residence": {
1243 "description": "A person's past or current residence.",
1244 "id": "Residence",
1245 "properties": {
1246 "current": {
1247 "description": "True if the residence is the person's curren t residence;\nfalse if the residence is a past residence.",
1248 "type": "boolean"
1249 },
1250 "metadata": {
1251 "$ref": "FieldMetadata",
1252 "description": "Metadata about the residence."
1253 },
1254 "value": {
1255 "description": "The address of the residence.",
1256 "type": "string"
1257 }
1258 },
1259 "type": "object"
1260 },
1261 "Status": {
1262 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
1263 "id": "Status",
1264 "properties": {
1265 "code": {
1266 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1267 "format": "int32",
1268 "type": "integer"
1269 },
1270 "message": {
1271 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
1272 "type": "string"
1273 },
1274 "details": {
1275 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.",
1276 "items": {
1277 "additionalProperties": {
1278 "description": "Properties of the object. Contains f ield @type with type URL.",
1279 "type": "any"
1280 },
1281 "type": "object"
1282 },
1283 "type": "array"
1284 }
1285 },
1286 "type": "object"
1287 },
1288 "ContactGroupMembership": {
1289 "description": "A Google contact group membership.",
1290 "id": "ContactGroupMembership",
1291 "properties": {
1292 "contactGroupId": {
1293 "description": "The contact group ID for the contact group m embership. The contact group\nID can be custom or predefined. Possible values in clude, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\ n* A numerical ID for user-created groups.",
1294 "type": "string"
1295 }
1296 },
1297 "type": "object"
1298 },
1299 "PersonMetadata": {
1300 "description": "The read-only metadata about a person.",
1301 "id": "PersonMetadata",
1302 "properties": {
1303 "previousResourceNames": {
1304 "description": "Any former resource names this person has ha d. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connectio ns/list) requests\nthat include a sync token.\n\nThe resource name may change wh en adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
1305 "items": {
1306 "type": "string"
1307 },
1308 "type": "array"
1309 },
1310 "sources": {
1311 "description": "The sources of data for the person.",
1312 "items": {
1313 "$ref": "Source"
1314 },
1315 "type": "array"
1316 },
1317 "deleted": {
1318 "description": "True if the person resource has been deleted . Populated only for\n[`connections.list`](/people/api/rest/v1/people.connection s/list) requests\nthat include a sync token.",
1319 "type": "boolean"
1320 },
1321 "objectType": {
1322 "description": "DEPRECATED(Please read person.metadata.sourc es.profile_metadata instead).\nThe type of the person object.",
1323 "enum": [
1324 "OBJECT_TYPE_UNSPECIFIED",
1325 "PERSON",
1326 "PAGE"
1327 ],
1328 "enumDescriptions": [
1329 "Unspecified.",
1330 "Person.",
1331 "[Google+ Page.](http://www.google.com/+/brands/)"
1332 ],
1333 "type": "string"
1334 },
1335 "linkedPeopleResourceNames": {
1336 "description": "Resource names of people linked to this reso urce.",
1337 "items": {
1338 "type": "string"
1339 },
1340 "type": "array"
1341 }
1342 },
1343 "type": "object"
1344 },
1345 "Event": {
1346 "description": "An event related to the person.",
1347 "id": "Event",
1348 "properties": {
1349 "formattedType": {
1350 "description": "The read-only type of the event translated a nd formatted in the\nviewer's account locale or the `Accept-Language` HTTP heade r locale.",
1351 "type": "string"
1352 },
1353 "type": {
1354 "description": "The type of the event. The type can be custo m or predefined.\nPossible values include, but are not limited to, the following :\n\n* `anniversary`\n* `other`",
1355 "type": "string"
1356 },
1357 "metadata": {
1358 "$ref": "FieldMetadata",
1359 "description": "Metadata about the event."
1360 },
1361 "date": {
1362 "$ref": "Date",
1363 "description": "The date of the event."
1364 }
1365 },
1366 "type": "object"
1367 },
1368 "ProfileMetadata": {
1369 "description": "The read-only metadata about a profile.",
1370 "id": "ProfileMetadata",
1371 "properties": {
1372 "objectType": {
1373 "description": "The profile object type.",
1374 "enum": [
1375 "OBJECT_TYPE_UNSPECIFIED",
1376 "PERSON",
1377 "PAGE"
1378 ],
1379 "enumDescriptions": [
1380 "Unspecified.",
1381 "Person.",
1382 "[Google+ Page.](http://www.google.com/+/brands/)"
1383 ],
1384 "type": "string"
1385 }
1386 },
1387 "type": "object"
1388 },
1389 "Gender": {
1390 "description": "A person's gender.",
1391 "id": "Gender",
1392 "properties": {
1393 "formattedValue": {
1394 "description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP hea der locale.",
1395 "type": "string"
1396 },
1397 "metadata": {
1398 "$ref": "FieldMetadata",
1399 "description": "Metadata about the gender."
1400 },
1401 "value": {
1402 "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfo llowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
1403 "type": "string"
1404 }
1405 },
1406 "type": "object"
1407 },
1408 "Url": {
1409 "description": "A person's associated URLs.",
1410 "id": "Url",
1411 "properties": {
1412 "type": {
1413 "description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\ n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservat ions`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
1414 "type": "string"
1415 },
1416 "metadata": {
1417 "$ref": "FieldMetadata",
1418 "description": "Metadata about the URL."
1419 },
1420 "value": {
1421 "description": "The URL.",
1422 "type": "string"
1423 },
1424 "formattedType": {
1425 "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
1426 "type": "string"
1427 }
1428 },
1429 "type": "object"
1430 } 1430 }
1431 }, 1431 },
1432 "servicePath": "", 1432 "servicePath": "",
1433 "title": "Google People API", 1433 "title": "Google People API",
1434 "version": "v1" 1434 "version": "v1"
1435 } 1435 }
OLDNEW
« no previous file with comments | « discovery/googleapis/partners__v2.json ('k') | discovery/googleapis/playmoviespartner__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698