OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/plus.login": { | 5 "https://www.googleapis.com/auth/plus.login": { |
6 "description": "Know the list of people in your circles, you
r age range, and language" | 6 "description": "Know the list of people in your circles, you
r age range, and language" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/userinfo.profile": { | 8 "https://www.googleapis.com/auth/userinfo.profile": { |
9 "description": "View your basic profile info" | 9 "description": "View your basic profile info" |
10 }, | 10 }, |
11 "https://www.googleapis.com/auth/user.addresses.read": { | 11 "https://www.googleapis.com/auth/user.addresses.read": { |
12 "description": "View your street addresses" | 12 "description": "View your street addresses" |
13 }, | 13 }, |
14 "https://www.googleapis.com/auth/contacts": { | 14 "https://www.googleapis.com/auth/contacts": { |
15 "description": "Manage your contacts" | 15 "description": "Manage your contacts" |
16 }, | 16 }, |
17 "https://www.googleapis.com/auth/user.emails.read": { | 17 "https://www.googleapis.com/auth/user.emails.read": { |
18 "description": "View your email addresses" | 18 "description": "View your email addresses" |
19 }, | 19 }, |
| 20 "https://www.googleapis.com/auth/user.phonenumbers.read": { |
| 21 "description": "View your phone numbers" |
| 22 }, |
20 "https://www.googleapis.com/auth/userinfo.email": { | 23 "https://www.googleapis.com/auth/userinfo.email": { |
21 "description": "View your email address" | 24 "description": "View your email address" |
22 }, | 25 }, |
23 "https://www.googleapis.com/auth/user.phonenumbers.read": { | |
24 "description": "View your phone numbers" | |
25 }, | |
26 "https://www.googleapis.com/auth/user.birthday.read": { | 26 "https://www.googleapis.com/auth/user.birthday.read": { |
27 "description": "View your complete date of birth" | 27 "description": "View your complete date of birth" |
28 }, | 28 }, |
29 "https://www.googleapis.com/auth/contacts.readonly": { | 29 "https://www.googleapis.com/auth/contacts.readonly": { |
30 "description": "View your contacts" | 30 "description": "View your contacts" |
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 "bearer_token": { |
| 53 "description": "OAuth bearer token.", |
| 54 "location": "query", |
| 55 "type": "string" |
| 56 }, |
| 57 "oauth_token": { |
| 58 "description": "OAuth 2.0 token for the current user.", |
| 59 "location": "query", |
| 60 "type": "string" |
| 61 }, |
| 62 "upload_protocol": { |
| 63 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 64 "location": "query", |
| 65 "type": "string" |
| 66 }, |
| 67 "prettyPrint": { |
| 68 "default": "true", |
| 69 "description": "Returns response with indentations and line breaks."
, |
| 70 "location": "query", |
| 71 "type": "boolean" |
| 72 }, |
52 "fields": { | 73 "fields": { |
53 "description": "Selector specifying which fields to include in a par
tial response.", | 74 "description": "Selector specifying which fields to include in a par
tial response.", |
54 "location": "query", | 75 "location": "query", |
55 "type": "string" | 76 "type": "string" |
56 }, | 77 }, |
57 "uploadType": { | 78 "uploadType": { |
58 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 79 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
59 "location": "query", | 80 "location": "query", |
60 "type": "string" | 81 "type": "string" |
61 }, | 82 }, |
(...skipping 24 matching lines...) Expand all Loading... |
86 "proto" | 107 "proto" |
87 ], | 108 ], |
88 "enumDescriptions": [ | 109 "enumDescriptions": [ |
89 "Responses with Content-Type of application/json", | 110 "Responses with Content-Type of application/json", |
90 "Media download with context-dependent Content-Type", | 111 "Media download with context-dependent Content-Type", |
91 "Responses with Content-Type of application/x-protobuf" | 112 "Responses with Content-Type of application/x-protobuf" |
92 ], | 113 ], |
93 "location": "query", | 114 "location": "query", |
94 "type": "string" | 115 "type": "string" |
95 }, | 116 }, |
| 117 "access_token": { |
| 118 "description": "OAuth access token.", |
| 119 "location": "query", |
| 120 "type": "string" |
| 121 }, |
96 "key": { | 122 "key": { |
97 "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.", | 123 "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.", |
98 "location": "query", | 124 "location": "query", |
99 "type": "string" | 125 "type": "string" |
100 }, | 126 }, |
101 "access_token": { | |
102 "description": "OAuth access token.", | |
103 "location": "query", | |
104 "type": "string" | |
105 }, | |
106 "quotaUser": { | 127 "quotaUser": { |
107 "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.", | 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.", |
108 "location": "query", | 129 "location": "query", |
109 "type": "string" | 130 "type": "string" |
110 }, | 131 }, |
111 "pp": { | 132 "pp": { |
112 "default": "true", | 133 "default": "true", |
113 "description": "Pretty-print response.", | 134 "description": "Pretty-print response.", |
114 "location": "query", | 135 "location": "query", |
115 "type": "boolean" | 136 "type": "boolean" |
116 }, | |
117 "bearer_token": { | |
118 "description": "OAuth bearer token.", | |
119 "location": "query", | |
120 "type": "string" | |
121 }, | |
122 "oauth_token": { | |
123 "description": "OAuth 2.0 token for the current user.", | |
124 "location": "query", | |
125 "type": "string" | |
126 }, | |
127 "upload_protocol": { | |
128 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
129 "location": "query", | |
130 "type": "string" | |
131 }, | |
132 "prettyPrint": { | |
133 "default": "true", | |
134 "description": "Returns response with indentations and line breaks."
, | |
135 "location": "query", | |
136 "type": "boolean" | |
137 } | 137 } |
138 }, | 138 }, |
139 "protocol": "rest", | 139 "protocol": "rest", |
140 "resources": { | 140 "resources": { |
141 "contactGroups": { | 141 "contactGroups": { |
142 "methods": { | 142 "methods": { |
143 "get": { | 143 "get": { |
144 "description": "Get a specific contact group owned by the au
thenticated user by specifying\na contact group resource name.", | 144 "description": "Get a specific contact group owned by the au
thenticated user by specifying\na contact group resource name.", |
145 "httpMethod": "GET", | 145 "httpMethod": "GET", |
146 "id": "people.contactGroups.get", | 146 "id": "people.contactGroups.get", |
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
197 "scopes": [ | 197 "scopes": [ |
198 "https://www.googleapis.com/auth/contacts" | 198 "https://www.googleapis.com/auth/contacts" |
199 ] | 199 ] |
200 }, | 200 }, |
201 "batchGet": { | 201 "batchGet": { |
202 "description": "Get a list of contact groups owned by the au
thenticated user by specifying\na list of contact group resource names.", | 202 "description": "Get a list of contact groups owned by the au
thenticated user by specifying\na list of contact group resource names.", |
203 "httpMethod": "GET", | 203 "httpMethod": "GET", |
204 "id": "people.contactGroups.batchGet", | 204 "id": "people.contactGroups.batchGet", |
205 "parameterOrder": [], | 205 "parameterOrder": [], |
206 "parameters": { | 206 "parameters": { |
| 207 "maxMembers": { |
| 208 "description": "Specifies the maximum number of memb
ers to return for each group.", |
| 209 "format": "int32", |
| 210 "location": "query", |
| 211 "type": "integer" |
| 212 }, |
207 "resourceNames": { | 213 "resourceNames": { |
208 "description": "The resource names of the contact gr
oups to get.", | 214 "description": "The resource names of the contact gr
oups to get.", |
209 "location": "query", | 215 "location": "query", |
210 "repeated": true, | 216 "repeated": true, |
211 "type": "string" | 217 "type": "string" |
212 }, | |
213 "maxMembers": { | |
214 "description": "Specifies the maximum number of memb
ers to return for each group.", | |
215 "format": "int32", | |
216 "location": "query", | |
217 "type": "integer" | |
218 } | 218 } |
219 }, | 219 }, |
220 "path": "v1/contactGroups:batchGet", | 220 "path": "v1/contactGroups:batchGet", |
221 "response": { | 221 "response": { |
222 "$ref": "BatchGetContactGroupsResponse" | 222 "$ref": "BatchGetContactGroupsResponse" |
223 }, | 223 }, |
224 "scopes": [ | 224 "scopes": [ |
225 "https://www.googleapis.com/auth/contacts", | 225 "https://www.googleapis.com/auth/contacts", |
226 "https://www.googleapis.com/auth/contacts.readonly" | 226 "https://www.googleapis.com/auth/contacts.readonly" |
227 ] | 227 ] |
228 }, | 228 }, |
229 "delete": { | 229 "delete": { |
230 "description": "Delete an existing contact group owned by th
e authenticated user by\nspecifying a contact group resource name.", | 230 "description": "Delete an existing contact group owned by th
e authenticated user by\nspecifying a contact group resource name.", |
231 "httpMethod": "DELETE", | 231 "httpMethod": "DELETE", |
232 "id": "people.contactGroups.delete", | 232 "id": "people.contactGroups.delete", |
233 "parameterOrder": [ | 233 "parameterOrder": [ |
234 "resourceName" | 234 "resourceName" |
235 ], | 235 ], |
236 "parameters": { | 236 "parameters": { |
| 237 "deleteContacts": { |
| 238 "description": "Set to true to also delete the conta
cts in the specified group.", |
| 239 "location": "query", |
| 240 "type": "boolean" |
| 241 }, |
237 "resourceName": { | 242 "resourceName": { |
238 "description": "The resource name of the contact gro
up to delete.", | 243 "description": "The resource name of the contact gro
up to delete.", |
239 "location": "path", | 244 "location": "path", |
240 "pattern": "^contactGroups/[^/]+$", | 245 "pattern": "^contactGroups/[^/]+$", |
241 "required": true, | 246 "required": true, |
242 "type": "string" | 247 "type": "string" |
243 }, | |
244 "deleteContacts": { | |
245 "description": "Set to true to also delete the conta
cts in the specified group.", | |
246 "location": "query", | |
247 "type": "boolean" | |
248 } | 248 } |
249 }, | 249 }, |
250 "path": "v1/{+resourceName}", | 250 "path": "v1/{+resourceName}", |
251 "response": { | 251 "response": { |
252 "$ref": "Empty" | 252 "$ref": "Empty" |
253 }, | 253 }, |
254 "scopes": [ | 254 "scopes": [ |
255 "https://www.googleapis.com/auth/contacts" | 255 "https://www.googleapis.com/auth/contacts" |
256 ] | 256 ] |
257 }, | 257 }, |
258 "list": { | 258 "list": { |
259 "description": "List all contact groups owned by the authent
icated user. Members of the\ncontact groups are not populated.", | 259 "description": "List all contact groups owned by the authent
icated user. Members of the\ncontact groups are not populated.", |
260 "httpMethod": "GET", | 260 "httpMethod": "GET", |
261 "id": "people.contactGroups.list", | 261 "id": "people.contactGroups.list", |
262 "parameterOrder": [], | 262 "parameterOrder": [], |
263 "parameters": { | 263 "parameters": { |
| 264 "pageToken": { |
| 265 "description": "The next_page_token value returned f
rom a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/li
st).\nRequests the next page of resources.", |
| 266 "location": "query", |
| 267 "type": "string" |
| 268 }, |
264 "pageSize": { | 269 "pageSize": { |
265 "description": "The maximum number of resources to r
eturn.", | 270 "description": "The maximum number of resources to r
eturn.", |
266 "format": "int32", | 271 "format": "int32", |
267 "location": "query", | 272 "location": "query", |
268 "type": "integer" | 273 "type": "integer" |
269 }, | 274 }, |
270 "syncToken": { | 275 "syncToken": { |
271 "description": "A sync token, returned by a previous
call to `contactgroups.list`.\nOnly resources changed since the sync token was
created will be returned.", | 276 "description": "A sync token, returned by a previous
call to `contactgroups.list`.\nOnly resources changed since the sync token was
created will be returned.", |
272 "location": "query", | 277 "location": "query", |
273 "type": "string" | 278 "type": "string" |
274 }, | |
275 "pageToken": { | |
276 "description": "The next_page_token value returned f
rom a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/li
st).\nRequests the next page of resources.", | |
277 "location": "query", | |
278 "type": "string" | |
279 } | 279 } |
280 }, | 280 }, |
281 "path": "v1/contactGroups", | 281 "path": "v1/contactGroups", |
282 "response": { | 282 "response": { |
283 "$ref": "ListContactGroupsResponse" | 283 "$ref": "ListContactGroupsResponse" |
284 }, | 284 }, |
285 "scopes": [ | 285 "scopes": [ |
286 "https://www.googleapis.com/auth/contacts", | 286 "https://www.googleapis.com/auth/contacts", |
287 "https://www.googleapis.com/auth/contacts.readonly" | 287 "https://www.googleapis.com/auth/contacts.readonly" |
288 ] | 288 ] |
(...skipping 75 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
364 "scopes": [ | 364 "scopes": [ |
365 "https://www.googleapis.com/auth/contacts" | 365 "https://www.googleapis.com/auth/contacts" |
366 ] | 366 ] |
367 }, | 367 }, |
368 "getBatchGet": { | 368 "getBatchGet": { |
369 "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.\n<br>\nThe request throws a 400 error if 'perso
nFields' is not specified.", | 369 "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.\n<br>\nThe request throws a 400 error if 'perso
nFields' is not specified.", |
370 "httpMethod": "GET", | 370 "httpMethod": "GET", |
371 "id": "people.people.getBatchGet", | 371 "id": "people.people.getBatchGet", |
372 "parameterOrder": [], | 372 "parameterOrder": [], |
373 "parameters": { | 373 "parameters": { |
374 "personFields": { | |
375 "description": "**Required.** A field mask to restri
ct which fields on each person are\nreturned. Valid values are:\n\n* addresses\n
* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emai
lAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* membersh
ips\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNu
mbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n*
residences\n* skills\n* taglines\n* urls", | |
376 "format": "google-fieldmask", | |
377 "location": "query", | |
378 "type": "string" | |
379 }, | |
380 "requestMask.includeField": { | 374 "requestMask.includeField": { |
381 "description": "**Required.** Comma-separated list o
f person fields to be included in the\nresponse. Each path should start with `pe
rson.`: for example,\n`person.names` or `person.photos`.", | 375 "description": "**Required.** Comma-separated list o
f person fields to be included in the\nresponse. Each path should start with `pe
rson.`: for example,\n`person.names` or `person.photos`.", |
382 "format": "google-fieldmask", | 376 "format": "google-fieldmask", |
383 "location": "query", | 377 "location": "query", |
384 "type": "string" | 378 "type": "string" |
385 }, | 379 }, |
386 "resourceNames": { | 380 "resourceNames": { |
387 "description": "The resource names of the people to
provide information about.\n\n- To get information about the authenticated user,
specify `people/me`.\n- To get information about a google account, specify\n `
people/`<var>account_id</var>.\n- To get information about a contact, specify th
e resource name that\n identifies the contact as returned by\n[`people.connecti
ons.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up t
o 50 resource names in one request.", | 381 "description": "The resource names of the people to
provide information about.\n\n- To get information about the authenticated user,
specify `people/me`.\n- To get information about a google account, specify\n `
people/`<var>account_id</var>.\n- To get information about a contact, specify th
e resource name that\n identifies the contact as returned by\n[`people.connecti
ons.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up t
o 50 resource names in one request.", |
388 "location": "query", | 382 "location": "query", |
389 "repeated": true, | 383 "repeated": true, |
390 "type": "string" | 384 "type": "string" |
| 385 }, |
| 386 "personFields": { |
| 387 "description": "**Required.** A field mask to restri
ct which fields on each person are\nreturned. Valid values are:\n\n* addresses\n
* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emai
lAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* membersh
ips\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNu
mbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n*
residences\n* skills\n* taglines\n* urls", |
| 388 "format": "google-fieldmask", |
| 389 "location": "query", |
| 390 "type": "string" |
391 } | 391 } |
392 }, | 392 }, |
393 "path": "v1/people:batchGet", | 393 "path": "v1/people:batchGet", |
394 "response": { | 394 "response": { |
395 "$ref": "GetPeopleResponse" | 395 "$ref": "GetPeopleResponse" |
396 }, | 396 }, |
397 "scopes": [ | 397 "scopes": [ |
398 "https://www.googleapis.com/auth/contacts", | 398 "https://www.googleapis.com/auth/contacts", |
399 "https://www.googleapis.com/auth/contacts.readonly", | 399 "https://www.googleapis.com/auth/contacts.readonly", |
400 "https://www.googleapis.com/auth/plus.login", | 400 "https://www.googleapis.com/auth/plus.login", |
401 "https://www.googleapis.com/auth/user.addresses.read", | 401 "https://www.googleapis.com/auth/user.addresses.read", |
402 "https://www.googleapis.com/auth/user.birthday.read", | 402 "https://www.googleapis.com/auth/user.birthday.read", |
403 "https://www.googleapis.com/auth/user.emails.read", | 403 "https://www.googleapis.com/auth/user.emails.read", |
404 "https://www.googleapis.com/auth/user.phonenumbers.read"
, | 404 "https://www.googleapis.com/auth/user.phonenumbers.read"
, |
405 "https://www.googleapis.com/auth/userinfo.email", | 405 "https://www.googleapis.com/auth/userinfo.email", |
406 "https://www.googleapis.com/auth/userinfo.profile" | 406 "https://www.googleapis.com/auth/userinfo.profile" |
407 ] | 407 ] |
408 }, | 408 }, |
409 "get": { | 409 "get": { |
410 "description": "Provides information about a person by speci
fying a resource name. Use\n`people/me` to indicate the authenticated user.\n<br
>\nThe request throws a 400 error if 'personFields' is not specified.", | 410 "description": "Provides information about a person by speci
fying a resource name. Use\n`people/me` to indicate the authenticated user.\n<br
>\nThe request throws a 400 error if 'personFields' is not specified.", |
411 "httpMethod": "GET", | 411 "httpMethod": "GET", |
412 "id": "people.people.get", | 412 "id": "people.people.get", |
413 "parameterOrder": [ | 413 "parameterOrder": [ |
414 "resourceName" | 414 "resourceName" |
415 ], | 415 ], |
416 "parameters": { | 416 "parameters": { |
| 417 "requestMask.includeField": { |
| 418 "description": "**Required.** Comma-separated list o
f person fields to be included in the\nresponse. Each path should start with `pe
rson.`: for example,\n`person.names` or `person.photos`.", |
| 419 "format": "google-fieldmask", |
| 420 "location": "query", |
| 421 "type": "string" |
| 422 }, |
417 "personFields": { | 423 "personFields": { |
418 "description": "**Required.** A field mask to restri
ct which fields on the person are\nreturned. Valid values are:\n\n* addresses\n*
ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* email
Addresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* membershi
ps\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNum
bers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n*
residences\n* skills\n* taglines\n* urls", | 424 "description": "**Required.** A field mask to restri
ct which fields on the person are\nreturned. Valid values are:\n\n* addresses\n*
ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* email
Addresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* membershi
ps\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNum
bers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n*
residences\n* skills\n* taglines\n* urls", |
419 "format": "google-fieldmask", | 425 "format": "google-fieldmask", |
420 "location": "query", | 426 "location": "query", |
421 "type": "string" | 427 "type": "string" |
422 }, | 428 }, |
423 "resourceName": { | 429 "resourceName": { |
424 "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 a google account, specify\n `pe
ople/`<var>account_id</var>.\n- To get information about a contact, specify the
resource name that\n identifies the contact as returned by\n[`people.connection
s.list`](/people/api/rest/v1/people.connections/list).", | 430 "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 a google account, specify\n `pe
ople/`<var>account_id</var>.\n- To get information about a contact, specify the
resource name that\n identifies the contact as returned by\n[`people.connection
s.list`](/people/api/rest/v1/people.connections/list).", |
425 "location": "path", | 431 "location": "path", |
426 "pattern": "^people/[^/]+$", | 432 "pattern": "^people/[^/]+$", |
427 "required": true, | 433 "required": true, |
428 "type": "string" | 434 "type": "string" |
429 }, | |
430 "requestMask.includeField": { | |
431 "description": "**Required.** Comma-separated list o
f person fields to be included in the\nresponse. Each path should start with `pe
rson.`: for example,\n`person.names` or `person.photos`.", | |
432 "format": "google-fieldmask", | |
433 "location": "query", | |
434 "type": "string" | |
435 } | 435 } |
436 }, | 436 }, |
437 "path": "v1/{+resourceName}", | 437 "path": "v1/{+resourceName}", |
438 "response": { | 438 "response": { |
439 "$ref": "Person" | 439 "$ref": "Person" |
440 }, | 440 }, |
441 "scopes": [ | 441 "scopes": [ |
442 "https://www.googleapis.com/auth/contacts", | 442 "https://www.googleapis.com/auth/contacts", |
443 "https://www.googleapis.com/auth/contacts.readonly", | 443 "https://www.googleapis.com/auth/contacts.readonly", |
444 "https://www.googleapis.com/auth/plus.login", | 444 "https://www.googleapis.com/auth/plus.login", |
(...skipping 99 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
544 "location": "query", | 544 "location": "query", |
545 "type": "string" | 545 "type": "string" |
546 }, | 546 }, |
547 "resourceName": { | 547 "resourceName": { |
548 "description": "The resource name to return
connections for. Only `people/me` is valid.", | 548 "description": "The resource name to return
connections for. Only `people/me` is valid.", |
549 "location": "path", | 549 "location": "path", |
550 "pattern": "^people/[^/]+$", | 550 "pattern": "^people/[^/]+$", |
551 "required": true, | 551 "required": true, |
552 "type": "string" | 552 "type": "string" |
553 }, | 553 }, |
| 554 "requestMask.includeField": { |
| 555 "description": "**Required.** Comma-separate
d list of person fields to be included in the\nresponse. Each path should start
with `person.`: for example,\n`person.names` or `person.photos`.", |
| 556 "format": "google-fieldmask", |
| 557 "location": "query", |
| 558 "type": "string" |
| 559 }, |
554 "pageSize": { | 560 "pageSize": { |
555 "description": "The number of connections to
include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defau
lts to 100.", | 561 "description": "The number of connections to
include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defau
lts to 100.", |
556 "format": "int32", | 562 "format": "int32", |
557 "location": "query", | 563 "location": "query", |
558 "type": "integer" | 564 "type": "integer" |
559 }, | 565 }, |
560 "requestMask.includeField": { | |
561 "description": "**Required.** Comma-separate
d list of person fields to be included in the\nresponse. Each path should start
with `person.`: for example,\n`person.names` or `person.photos`.", | |
562 "format": "google-fieldmask", | |
563 "location": "query", | |
564 "type": "string" | |
565 }, | |
566 "syncToken": { | 566 "syncToken": { |
567 "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.", | 567 "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.", |
568 "location": "query", | 568 "location": "query", |
569 "type": "string" | 569 "type": "string" |
570 } | 570 } |
571 }, | 571 }, |
572 "path": "v1/{+resourceName}/connections", | 572 "path": "v1/{+resourceName}/connections", |
573 "response": { | 573 "response": { |
574 "$ref": "ListConnectionsResponse" | 574 "$ref": "ListConnectionsResponse" |
575 }, | 575 }, |
576 "scopes": [ | 576 "scopes": [ |
577 "https://www.googleapis.com/auth/contacts", | 577 "https://www.googleapis.com/auth/contacts", |
578 "https://www.googleapis.com/auth/contacts.readon
ly" | 578 "https://www.googleapis.com/auth/contacts.readon
ly" |
579 ] | 579 ] |
580 } | 580 } |
581 } | 581 } |
582 } | 582 } |
583 } | 583 } |
584 } | 584 } |
585 }, | 585 }, |
586 "revision": "20170727", | 586 "revision": "20170817", |
587 "rootUrl": "https://people.googleapis.com/", | 587 "rootUrl": "https://people.googleapis.com/", |
588 "schemas": { | 588 "schemas": { |
589 "Biography": { | |
590 "description": "A person's short biography.", | |
591 "id": "Biography", | |
592 "properties": { | |
593 "metadata": { | |
594 "$ref": "FieldMetadata", | |
595 "description": "Metadata about the biography." | |
596 }, | |
597 "value": { | |
598 "description": "The short biography.", | |
599 "type": "string" | |
600 }, | |
601 "contentType": { | |
602 "description": "The content type of the biography.", | |
603 "enum": [ | |
604 "CONTENT_TYPE_UNSPECIFIED", | |
605 "TEXT_PLAIN", | |
606 "TEXT_HTML" | |
607 ], | |
608 "enumDescriptions": [ | |
609 "Unspecified.", | |
610 "Plain text.", | |
611 "HTML text." | |
612 ], | |
613 "type": "string" | |
614 } | |
615 }, | |
616 "type": "object" | |
617 }, | |
618 "FieldMetadata": { | |
619 "description": "Metadata about a field.", | |
620 "id": "FieldMetadata", | |
621 "properties": { | |
622 "primary": { | |
623 "description": "True if the field is the primary field; fals
e if the field is a secondary\nfield.", | |
624 "type": "boolean" | |
625 }, | |
626 "source": { | |
627 "$ref": "Source", | |
628 "description": "The source of the field." | |
629 }, | |
630 "verified": { | |
631 "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.", | |
632 "type": "boolean" | |
633 } | |
634 }, | |
635 "type": "object" | |
636 }, | |
637 "RelationshipInterest": { | |
638 "description": "A person's read-only relationship interest .", | |
639 "id": "RelationshipInterest", | |
640 "properties": { | |
641 "metadata": { | |
642 "$ref": "FieldMetadata", | |
643 "description": "Metadata about the relationship interest." | |
644 }, | |
645 "value": { | |
646 "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`", | |
647 "type": "string" | |
648 }, | |
649 "formattedValue": { | |
650 "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.", | |
651 "type": "string" | |
652 } | |
653 }, | |
654 "type": "object" | |
655 }, | |
656 "Source": { | |
657 "description": "The source of a field.", | |
658 "id": "Source", | |
659 "properties": { | |
660 "updateTime": { | |
661 "description": "**Only populated in `person.metadata.sources
`.**\n\nLast update timestamp of this source.", | |
662 "format": "google-datetime", | |
663 "type": "string" | |
664 }, | |
665 "type": { | |
666 "description": "The source type.", | |
667 "enum": [ | |
668 "SOURCE_TYPE_UNSPECIFIED", | |
669 "ACCOUNT", | |
670 "PROFILE", | |
671 "DOMAIN_PROFILE", | |
672 "CONTACT" | |
673 ], | |
674 "enumDescriptions": [ | |
675 "Unspecified.", | |
676 "[Google Account](https://accounts.google.com).", | |
677 "[Google profile](https://profiles.google.com). You can
view the\nprofile at https://profiles.google.com/<var>id</var> where\n<var>id</v
ar> is the source id.", | |
678 "[Google Apps domain profile](https://admin.google.com).
", | |
679 "[Google contact](https://contacts.google.com). You can
view the\ncontact at https://contact.google.com/<var>id</var> where <var>id</var
>\nis the source id." | |
680 ], | |
681 "type": "string" | |
682 }, | |
683 "etag": { | |
684 "description": "**Only populated in `person.metadata.sources
`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\ns
ource. Used for web cache validation.", | |
685 "type": "string" | |
686 }, | |
687 "id": { | |
688 "description": "The unique identifier within the source type
generated by the server.", | |
689 "type": "string" | |
690 }, | |
691 "profileMetadata": { | |
692 "$ref": "ProfileMetadata", | |
693 "description": "**Only populated in `person.metadata.sources
`.**\n\nMetadata about a source of type PROFILE." | |
694 } | |
695 }, | |
696 "type": "object" | |
697 }, | |
698 "GetPeopleResponse": { | |
699 "id": "GetPeopleResponse", | |
700 "properties": { | |
701 "responses": { | |
702 "description": "The response for each requested resource nam
e.", | |
703 "items": { | |
704 "$ref": "PersonResponse" | |
705 }, | |
706 "type": "array" | |
707 } | |
708 }, | |
709 "type": "object" | |
710 }, | |
711 "PhoneNumber": { | |
712 "description": "A person's phone number.", | |
713 "id": "PhoneNumber", | |
714 "properties": { | |
715 "type": { | |
716 "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`", | |
717 "type": "string" | |
718 }, | |
719 "metadata": { | |
720 "$ref": "FieldMetadata", | |
721 "description": "Metadata about the phone number." | |
722 }, | |
723 "value": { | |
724 "description": "The phone number.", | |
725 "type": "string" | |
726 }, | |
727 "formattedType": { | |
728 "description": "The read-only type of the phone number trans
lated and formatted in the\nviewer's account locale or the `Accept-Language` HTT
P header locale.", | |
729 "type": "string" | |
730 }, | |
731 "canonicalForm": { | |
732 "description": "The read-only canonicalized [ITU-T E.164](ht
tps://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the p
hone number.", | |
733 "type": "string" | |
734 } | |
735 }, | |
736 "type": "object" | |
737 }, | |
738 "Photo": { | |
739 "description": "A person's read-only photo. A picture shown next to
the person's name to\nhelp others recognize the person.", | |
740 "id": "Photo", | |
741 "properties": { | |
742 "metadata": { | |
743 "$ref": "FieldMetadata", | |
744 "description": "Metadata about the photo." | |
745 }, | |
746 "url": { | |
747 "description": "The URL of the photo. You can change the des
ired size by appending a query\nparameter `sz=`<var>size</var> at the end of the
url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAA
AAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`", | |
748 "type": "string" | |
749 } | |
750 }, | |
751 "type": "object" | |
752 }, | |
753 "ListConnectionsResponse": { | |
754 "id": "ListConnectionsResponse", | |
755 "properties": { | |
756 "totalPeople": { | |
757 "description": "**DEPRECATED** (Please use totalItems)\nThe
total number of people in the list without pagination.", | |
758 "format": "int32", | |
759 "type": "integer" | |
760 }, | |
761 "nextPageToken": { | |
762 "description": "The token that can be used to retrieve the n
ext page of results.", | |
763 "type": "string" | |
764 }, | |
765 "totalItems": { | |
766 "description": "The total number of items in the list withou
t pagination.", | |
767 "format": "int32", | |
768 "type": "integer" | |
769 }, | |
770 "nextSyncToken": { | |
771 "description": "The token that can be used to retrieve chang
es since the last request.", | |
772 "type": "string" | |
773 }, | |
774 "connections": { | |
775 "description": "The list of people that the requestor is con
nected to.", | |
776 "items": { | |
777 "$ref": "Person" | |
778 }, | |
779 "type": "array" | |
780 } | |
781 }, | |
782 "type": "object" | |
783 }, | |
784 "Birthday": { | |
785 "description": "A person's birthday. At least one of the `date` and
`text` fields are\nspecified. The `date` and `text` fields typically represent t
he same\ndate, but are not guaranteed to.", | |
786 "id": "Birthday", | |
787 "properties": { | |
788 "date": { | |
789 "$ref": "Date", | |
790 "description": "The date of the birthday." | |
791 }, | |
792 "text": { | |
793 "description": "A free-form string representing the user's b
irthday.", | |
794 "type": "string" | |
795 }, | |
796 "metadata": { | |
797 "$ref": "FieldMetadata", | |
798 "description": "Metadata about the birthday." | |
799 } | |
800 }, | |
801 "type": "object" | |
802 }, | |
803 "CreateContactGroupRequest": { | |
804 "description": "A request to create a new contact group.", | |
805 "id": "CreateContactGroupRequest", | |
806 "properties": { | |
807 "contactGroup": { | |
808 "$ref": "ContactGroup", | |
809 "description": "The contact group to create." | |
810 } | |
811 }, | |
812 "type": "object" | |
813 }, | |
814 "Address": { | |
815 "description": "A person's physical address. May be a P.O. box or st
reet address. All fields\nare optional.", | |
816 "id": "Address", | |
817 "properties": { | |
818 "formattedType": { | |
819 "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.", | |
820 "type": "string" | |
821 }, | |
822 "city": { | |
823 "description": "The city of the address.", | |
824 "type": "string" | |
825 }, | |
826 "formattedValue": { | |
827 "description": "The unstructured value of the address. If th
is is not set by the user it\nwill be automatically constructed from structured
values.", | |
828 "type": "string" | |
829 }, | |
830 "country": { | |
831 "description": "The country of the address.", | |
832 "type": "string" | |
833 }, | |
834 "type": { | |
835 "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`", | |
836 "type": "string" | |
837 }, | |
838 "extendedAddress": { | |
839 "description": "The extended address of the address; for exa
mple, the apartment number.", | |
840 "type": "string" | |
841 }, | |
842 "poBox": { | |
843 "description": "The P.O. box of the address.", | |
844 "type": "string" | |
845 }, | |
846 "postalCode": { | |
847 "description": "The postal code of the address.", | |
848 "type": "string" | |
849 }, | |
850 "region": { | |
851 "description": "The region of the address; for example, the
state or province.", | |
852 "type": "string" | |
853 }, | |
854 "streetAddress": { | |
855 "description": "The street address.", | |
856 "type": "string" | |
857 }, | |
858 "metadata": { | |
859 "$ref": "FieldMetadata", | |
860 "description": "Metadata about the address." | |
861 }, | |
862 "countryCode": { | |
863 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/
iso/country_codes.htm) country\ncode of the address.", | |
864 "type": "string" | |
865 } | |
866 }, | |
867 "type": "object" | |
868 }, | |
869 "Status": { | |
870 "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.", | |
871 "id": "Status", | |
872 "properties": { | |
873 "message": { | |
874 "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.", | |
875 "type": "string" | |
876 }, | |
877 "details": { | |
878 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", | |
879 "items": { | |
880 "additionalProperties": { | |
881 "description": "Properties of the object. Contains f
ield @type with type URL.", | |
882 "type": "any" | |
883 }, | |
884 "type": "object" | |
885 }, | |
886 "type": "array" | |
887 }, | |
888 "code": { | |
889 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", | |
890 "format": "int32", | |
891 "type": "integer" | |
892 } | |
893 }, | |
894 "type": "object" | |
895 }, | |
896 "ContactGroupMembership": { | |
897 "description": "A Google contact group membership.", | |
898 "id": "ContactGroupMembership", | |
899 "properties": { | |
900 "contactGroupId": { | |
901 "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.", | |
902 "type": "string" | |
903 } | |
904 }, | |
905 "type": "object" | |
906 }, | |
907 "PersonMetadata": { | |
908 "description": "The read-only metadata about a person.", | |
909 "id": "PersonMetadata", | |
910 "properties": { | |
911 "objectType": { | |
912 "description": "**DEPRECATED** (Please use\n`person.metadata
.sources.profileMetadata.objectType` instead)\n\nThe type of the person object."
, | |
913 "enum": [ | |
914 "OBJECT_TYPE_UNSPECIFIED", | |
915 "PERSON", | |
916 "PAGE" | |
917 ], | |
918 "enumDescriptions": [ | |
919 "Unspecified.", | |
920 "Person.", | |
921 "[Google+ Page.](http://www.google.com/+/brands/)" | |
922 ], | |
923 "type": "string" | |
924 }, | |
925 "linkedPeopleResourceNames": { | |
926 "description": "Resource names of people linked to this reso
urce.", | |
927 "items": { | |
928 "type": "string" | |
929 }, | |
930 "type": "array" | |
931 }, | |
932 "previousResourceNames": { | |
933 "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.", | |
934 "items": { | |
935 "type": "string" | |
936 }, | |
937 "type": "array" | |
938 }, | |
939 "sources": { | |
940 "description": "The sources of data for the person.", | |
941 "items": { | |
942 "$ref": "Source" | |
943 }, | |
944 "type": "array" | |
945 }, | |
946 "deleted": { | |
947 "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.", | |
948 "type": "boolean" | |
949 } | |
950 }, | |
951 "type": "object" | |
952 }, | |
953 "ModifyContactGroupMembersRequest": { | |
954 "description": "A request to modify an existing contact group's memb
ers.", | |
955 "id": "ModifyContactGroupMembersRequest", | |
956 "properties": { | |
957 "resourceNamesToAdd": { | |
958 "description": "The resource names of the contact people to
add in the form of in the form\n`people/`<var>person_id</var>.", | |
959 "items": { | |
960 "type": "string" | |
961 }, | |
962 "type": "array" | |
963 }, | |
964 "resourceNamesToRemove": { | |
965 "description": "The resource names of the contact people to
remove in the form of in the\nform of `people/`<var>person_id</var>.", | |
966 "items": { | |
967 "type": "string" | |
968 }, | |
969 "type": "array" | |
970 } | |
971 }, | |
972 "type": "object" | |
973 }, | |
974 "ContactGroupResponse": { | |
975 "description": "The response for a specific contact group.", | |
976 "id": "ContactGroupResponse", | |
977 "properties": { | |
978 "contactGroup": { | |
979 "$ref": "ContactGroup", | |
980 "description": "The contact group." | |
981 }, | |
982 "status": { | |
983 "$ref": "Status", | |
984 "description": "The status of the response." | |
985 }, | |
986 "requestedResourceName": { | |
987 "description": "The original requested resource name.", | |
988 "type": "string" | |
989 } | |
990 }, | |
991 "type": "object" | |
992 }, | |
993 "Url": { | |
994 "description": "A person's associated URLs.", | |
995 "id": "Url", | |
996 "properties": { | |
997 "formattedType": { | |
998 "description": "The read-only type of the URL translated and
formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header
locale.", | |
999 "type": "string" | |
1000 }, | |
1001 "type": { | |
1002 "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`", | |
1003 "type": "string" | |
1004 }, | |
1005 "metadata": { | |
1006 "$ref": "FieldMetadata", | |
1007 "description": "Metadata about the URL." | |
1008 }, | |
1009 "value": { | |
1010 "description": "The URL.", | |
1011 "type": "string" | |
1012 } | |
1013 }, | |
1014 "type": "object" | |
1015 }, | |
1016 "ImClient": { | |
1017 "description": "A person's instant messaging client.", | |
1018 "id": "ImClient", | |
1019 "properties": { | |
1020 "formattedProtocol": { | |
1021 "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.", | |
1022 "type": "string" | |
1023 }, | |
1024 "formattedType": { | |
1025 "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.", | |
1026 "type": "string" | |
1027 }, | |
1028 "metadata": { | |
1029 "$ref": "FieldMetadata", | |
1030 "description": "Metadata about the IM client." | |
1031 }, | |
1032 "type": { | |
1033 "description": "The type of the IM client. The type can be c
ustom or predefined.\nPossible values include, but are not limited to, the follo
wing:\n\n* `home`\n* `work`\n* `other`", | |
1034 "type": "string" | |
1035 }, | |
1036 "protocol": { | |
1037 "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`", | |
1038 "type": "string" | |
1039 }, | |
1040 "username": { | |
1041 "description": "The user name used in the IM client.", | |
1042 "type": "string" | |
1043 } | |
1044 }, | |
1045 "type": "object" | |
1046 }, | |
1047 "DomainMembership": { | 589 "DomainMembership": { |
1048 "description": "A Google Apps Domain membership.", | 590 "description": "A Google Apps Domain membership.", |
1049 "id": "DomainMembership", | 591 "id": "DomainMembership", |
1050 "properties": { | 592 "properties": { |
1051 "inViewerDomain": { | 593 "inViewerDomain": { |
1052 "description": "True if the person is in the viewer's Google
Apps domain.", | 594 "description": "True if the person is in the viewer's Google
Apps domain.", |
1053 "type": "boolean" | 595 "type": "boolean" |
1054 } | 596 } |
1055 }, | 597 }, |
1056 "type": "object" | 598 "type": "object" |
(...skipping 28 matching lines...) Expand all Loading... |
1085 "$ref": "ContactGroupMembership", | 627 "$ref": "ContactGroupMembership", |
1086 "description": "The contact group membership." | 628 "description": "The contact group membership." |
1087 } | 629 } |
1088 }, | 630 }, |
1089 "type": "object" | 631 "type": "object" |
1090 }, | 632 }, |
1091 "RelationshipStatus": { | 633 "RelationshipStatus": { |
1092 "description": "A person's read-only relationship status.", | 634 "description": "A person's read-only relationship status.", |
1093 "id": "RelationshipStatus", | 635 "id": "RelationshipStatus", |
1094 "properties": { | 636 "properties": { |
| 637 "value": { |
| 638 "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`", |
| 639 "type": "string" |
| 640 }, |
1095 "formattedValue": { | 641 "formattedValue": { |
1096 "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.", | 642 "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.", |
1097 "type": "string" | 643 "type": "string" |
1098 }, | 644 }, |
1099 "metadata": { | 645 "metadata": { |
1100 "$ref": "FieldMetadata", | 646 "$ref": "FieldMetadata", |
1101 "description": "Metadata about the relationship status." | 647 "description": "Metadata about the relationship status." |
1102 }, | |
1103 "value": { | |
1104 "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`", | |
1105 "type": "string" | |
1106 } | 648 } |
1107 }, | 649 }, |
1108 "type": "object" | 650 "type": "object" |
1109 }, | 651 }, |
1110 "BraggingRights": { | 652 "BraggingRights": { |
1111 "description": "A person's bragging rights.", | 653 "description": "A person's bragging rights.", |
1112 "id": "BraggingRights", | 654 "id": "BraggingRights", |
1113 "properties": { | 655 "properties": { |
1114 "metadata": { | 656 "metadata": { |
1115 "$ref": "FieldMetadata", | 657 "$ref": "FieldMetadata", |
1116 "description": "Metadata about the bragging rights." | 658 "description": "Metadata about the bragging rights." |
1117 }, | 659 }, |
1118 "value": { | 660 "value": { |
1119 "description": "The bragging rights; for example, `climbed m
ount everest`.", | 661 "description": "The bragging rights; for example, `climbed m
ount everest`.", |
1120 "type": "string" | 662 "type": "string" |
1121 } | 663 } |
1122 }, | 664 }, |
1123 "type": "object" | 665 "type": "object" |
1124 }, | 666 }, |
1125 "Organization": { | 667 "Organization": { |
1126 "description": "A person's past or current organization. Overlapping
date ranges are\npermitted.", | 668 "description": "A person's past or current organization. Overlapping
date ranges are\npermitted.", |
1127 "id": "Organization", | 669 "id": "Organization", |
1128 "properties": { | 670 "properties": { |
1129 "type": { | |
1130 "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`", | |
1131 "type": "string" | |
1132 }, | |
1133 "phoneticName": { | |
1134 "description": "The phonetic name of the organization.", | |
1135 "type": "string" | |
1136 }, | |
1137 "jobDescription": { | |
1138 "description": "The person's job description at the organiza
tion.", | |
1139 "type": "string" | |
1140 }, | |
1141 "endDate": { | 671 "endDate": { |
1142 "$ref": "Date", | 672 "$ref": "Date", |
1143 "description": "The end date when the person left the organi
zation." | 673 "description": "The end date when the person left the organi
zation." |
1144 }, | 674 }, |
1145 "symbol": { | 675 "symbol": { |
1146 "description": "The symbol associated with the organization;
for example, a stock ticker\nsymbol, abbreviation, or acronym.", | 676 "description": "The symbol associated with the organization;
for example, a stock ticker\nsymbol, abbreviation, or acronym.", |
1147 "type": "string" | 677 "type": "string" |
1148 }, | 678 }, |
1149 "name": { | 679 "name": { |
1150 "description": "The name of the organization.", | 680 "description": "The name of the organization.", |
1151 "type": "string" | 681 "type": "string" |
1152 }, | 682 }, |
1153 "metadata": { | 683 "metadata": { |
1154 "$ref": "FieldMetadata", | 684 "$ref": "FieldMetadata", |
1155 "description": "Metadata about the organization." | 685 "description": "Metadata about the organization." |
1156 }, | 686 }, |
1157 "location": { | 687 "location": { |
1158 "description": "The location of the organization office the
person works at.", | 688 "description": "The location of the organization office the
person works at.", |
1159 "type": "string" | 689 "type": "string" |
1160 }, | 690 }, |
1161 "title": { | 691 "title": { |
1162 "description": "The person's job title at the organization."
, | 692 "description": "The person's job title at the organization."
, |
1163 "type": "string" | 693 "type": "string" |
1164 }, | 694 }, |
1165 "current": { | 695 "current": { |
1166 "description": "True if the organization is the person's cur
rent organization;\nfalse if the organization is a past organization.", | 696 "description": "True if the organization is the person's cur
rent organization;\nfalse if the organization is a past organization.", |
1167 "type": "boolean" | 697 "type": "boolean" |
1168 }, | 698 }, |
| 699 "formattedType": { |
| 700 "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.", |
| 701 "type": "string" |
| 702 }, |
1169 "startDate": { | 703 "startDate": { |
1170 "$ref": "Date", | 704 "$ref": "Date", |
1171 "description": "The start date when the person joined the or
ganization." | 705 "description": "The start date when the person joined the or
ganization." |
1172 }, | 706 }, |
1173 "formattedType": { | |
1174 "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.", | |
1175 "type": "string" | |
1176 }, | |
1177 "domain": { | 707 "domain": { |
1178 "description": "The domain name associated with the organiza
tion; for example, `google.com`.", | 708 "description": "The domain name associated with the organiza
tion; for example, `google.com`.", |
1179 "type": "string" | 709 "type": "string" |
1180 }, | 710 }, |
1181 "department": { | 711 "department": { |
1182 "description": "The person's department at the organization.
", | 712 "description": "The person's department at the organization.
", |
1183 "type": "string" | 713 "type": "string" |
| 714 }, |
| 715 "type": { |
| 716 "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`", |
| 717 "type": "string" |
| 718 }, |
| 719 "phoneticName": { |
| 720 "description": "The phonetic name of the organization.", |
| 721 "type": "string" |
| 722 }, |
| 723 "jobDescription": { |
| 724 "description": "The person's job description at the organiza
tion.", |
| 725 "type": "string" |
1184 } | 726 } |
1185 }, | 727 }, |
1186 "type": "object" | 728 "type": "object" |
1187 }, | 729 }, |
1188 "AgeRangeType": { | 730 "AgeRangeType": { |
1189 "description": "A person's age range.", | 731 "description": "A person's age range.", |
1190 "id": "AgeRangeType", | 732 "id": "AgeRangeType", |
1191 "properties": { | 733 "properties": { |
| 734 "metadata": { |
| 735 "$ref": "FieldMetadata", |
| 736 "description": "Metadata about the age range." |
| 737 }, |
1192 "ageRange": { | 738 "ageRange": { |
1193 "description": "The age range.", | 739 "description": "The age range.", |
1194 "enum": [ | 740 "enum": [ |
1195 "AGE_RANGE_UNSPECIFIED", | 741 "AGE_RANGE_UNSPECIFIED", |
1196 "LESS_THAN_EIGHTEEN", | 742 "LESS_THAN_EIGHTEEN", |
| 743 "EIGHTEEN_TO_TWENTY", |
| 744 "TWENTY_ONE_OR_OLDER" |
| 745 ], |
| 746 "enumDescriptions": [ |
| 747 "Unspecified.", |
| 748 "Younger than eighteen.", |
| 749 "Between eighteen and twenty.", |
| 750 "Twenty-one and older." |
| 751 ], |
| 752 "type": "string" |
| 753 } |
| 754 }, |
| 755 "type": "object" |
| 756 }, |
| 757 "ListContactGroupsResponse": { |
| 758 "description": "The response to a list contact groups request.", |
| 759 "id": "ListContactGroupsResponse", |
| 760 "properties": { |
| 761 "contactGroups": { |
| 762 "description": "The list of contact groups. Members of the c
ontact groups are not\npopulated.", |
| 763 "items": { |
| 764 "$ref": "ContactGroup" |
| 765 }, |
| 766 "type": "array" |
| 767 }, |
| 768 "nextPageToken": { |
| 769 "description": "The token that can be used to retrieve the n
ext page of results.", |
| 770 "type": "string" |
| 771 }, |
| 772 "nextSyncToken": { |
| 773 "description": "The token that can be used to retrieve chang
es since the last request.", |
| 774 "type": "string" |
| 775 }, |
| 776 "totalItems": { |
| 777 "description": "The total number of items in the list withou
t pagination.", |
| 778 "format": "int32", |
| 779 "type": "integer" |
| 780 } |
| 781 }, |
| 782 "type": "object" |
| 783 }, |
| 784 "PersonResponse": { |
| 785 "description": "The response for a single person", |
| 786 "id": "PersonResponse", |
| 787 "properties": { |
| 788 "person": { |
| 789 "$ref": "Person", |
| 790 "description": "The person." |
| 791 }, |
| 792 "status": { |
| 793 "$ref": "Status", |
| 794 "description": "The status of the response." |
| 795 }, |
| 796 "httpStatusCode": { |
| 797 "description": "**DEPRECATED** (Please use status instead)\n
\n[HTTP 1.1 status code]\n(http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.htm
l).", |
| 798 "format": "int32", |
| 799 "type": "integer" |
| 800 }, |
| 801 "requestedResourceName": { |
| 802 "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.", |
| 803 "type": "string" |
| 804 } |
| 805 }, |
| 806 "type": "object" |
| 807 }, |
| 808 "Relation": { |
| 809 "description": "A person's relation to another person.", |
| 810 "id": "Relation", |
| 811 "properties": { |
| 812 "type": { |
| 813 "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`", |
| 814 "type": "string" |
| 815 }, |
| 816 "metadata": { |
| 817 "$ref": "FieldMetadata", |
| 818 "description": "Metadata about the relation." |
| 819 }, |
| 820 "formattedType": { |
| 821 "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.", |
| 822 "type": "string" |
| 823 }, |
| 824 "person": { |
| 825 "description": "The name of the other person this relation r
efers to.", |
| 826 "type": "string" |
| 827 } |
| 828 }, |
| 829 "type": "object" |
| 830 }, |
| 831 "Occupation": { |
| 832 "description": "A person's occupation.", |
| 833 "id": "Occupation", |
| 834 "properties": { |
| 835 "metadata": { |
| 836 "$ref": "FieldMetadata", |
| 837 "description": "Metadata about the occupation." |
| 838 }, |
| 839 "value": { |
| 840 "description": "The occupation; for example, `carpenter`.", |
| 841 "type": "string" |
| 842 } |
| 843 }, |
| 844 "type": "object" |
| 845 }, |
| 846 "ContactGroup": { |
| 847 "description": "A contact group.", |
| 848 "id": "ContactGroup", |
| 849 "properties": { |
| 850 "memberCount": { |
| 851 "description": "The total number of contacts in the group ir
respective of max members in\nspecified in the request.", |
| 852 "format": "int32", |
| 853 "type": "integer" |
| 854 }, |
| 855 "metadata": { |
| 856 "$ref": "ContactGroupMetadata", |
| 857 "description": "Metadata about the contact group." |
| 858 }, |
| 859 "resourceName": { |
| 860 "description": "The resource name for the contact group, ass
igned by the server. An ASCII\nstring, in the form of `contactGroups/`<var>conta
ct_group_id</var>.", |
| 861 "type": "string" |
| 862 }, |
| 863 "etag": { |
| 864 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.", |
| 865 "type": "string" |
| 866 }, |
| 867 "formattedName": { |
| 868 "description": "The read-only name translated and formatted
in the viewer's account locale\nor the `Accept-Language` HTTP header locale for
system groups names.\nGroup names set by the owner are the same as name.", |
| 869 "type": "string" |
| 870 }, |
| 871 "groupType": { |
| 872 "description": "The read-only contact group type.", |
| 873 "enum": [ |
| 874 "GROUP_TYPE_UNSPECIFIED", |
| 875 "USER_CONTACT_GROUP", |
| 876 "SYSTEM_CONTACT_GROUP" |
| 877 ], |
| 878 "enumDescriptions": [ |
| 879 "Unspecified.", |
| 880 "User defined contact group.", |
| 881 "System defined contact group." |
| 882 ], |
| 883 "type": "string" |
| 884 }, |
| 885 "memberResourceNames": { |
| 886 "description": "The list of contact person resource names th
at are members of the contact\ngroup. The field is not populated for LIST reques
ts and can only be updated\nthrough the\n[ModifyContactGroupMembers](/people/api
/rest/v1/contactgroups/members/modify).", |
| 887 "items": { |
| 888 "type": "string" |
| 889 }, |
| 890 "type": "array" |
| 891 }, |
| 892 "name": { |
| 893 "description": "The contact group name set by the group owne
r or a system provided name\nfor system groups.", |
| 894 "type": "string" |
| 895 } |
| 896 }, |
| 897 "type": "object" |
| 898 }, |
| 899 "Person": { |
| 900 "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.", |
| 901 "id": "Person", |
| 902 "properties": { |
| 903 "coverPhotos": { |
| 904 "description": "The person's read-only cover photos.", |
| 905 "items": { |
| 906 "$ref": "CoverPhoto" |
| 907 }, |
| 908 "type": "array" |
| 909 }, |
| 910 "imClients": { |
| 911 "description": "The person's instant messaging clients.", |
| 912 "items": { |
| 913 "$ref": "ImClient" |
| 914 }, |
| 915 "type": "array" |
| 916 }, |
| 917 "birthdays": { |
| 918 "description": "The person's birthdays.", |
| 919 "items": { |
| 920 "$ref": "Birthday" |
| 921 }, |
| 922 "type": "array" |
| 923 }, |
| 924 "locales": { |
| 925 "description": "The person's locale preferences.", |
| 926 "items": { |
| 927 "$ref": "Locale" |
| 928 }, |
| 929 "type": "array" |
| 930 }, |
| 931 "relationshipInterests": { |
| 932 "description": "The person's read-only relationship interest
s.", |
| 933 "items": { |
| 934 "$ref": "RelationshipInterest" |
| 935 }, |
| 936 "type": "array" |
| 937 }, |
| 938 "urls": { |
| 939 "description": "The person's associated URLs.", |
| 940 "items": { |
| 941 "$ref": "Url" |
| 942 }, |
| 943 "type": "array" |
| 944 }, |
| 945 "nicknames": { |
| 946 "description": "The person's nicknames.", |
| 947 "items": { |
| 948 "$ref": "Nickname" |
| 949 }, |
| 950 "type": "array" |
| 951 }, |
| 952 "names": { |
| 953 "description": "The person's names.", |
| 954 "items": { |
| 955 "$ref": "Name" |
| 956 }, |
| 957 "type": "array" |
| 958 }, |
| 959 "relations": { |
| 960 "description": "The person's relations.", |
| 961 "items": { |
| 962 "$ref": "Relation" |
| 963 }, |
| 964 "type": "array" |
| 965 }, |
| 966 "occupations": { |
| 967 "description": "The person's occupations.", |
| 968 "items": { |
| 969 "$ref": "Occupation" |
| 970 }, |
| 971 "type": "array" |
| 972 }, |
| 973 "emailAddresses": { |
| 974 "description": "The person's email addresses.", |
| 975 "items": { |
| 976 "$ref": "EmailAddress" |
| 977 }, |
| 978 "type": "array" |
| 979 }, |
| 980 "organizations": { |
| 981 "description": "The person's past or current organizations."
, |
| 982 "items": { |
| 983 "$ref": "Organization" |
| 984 }, |
| 985 "type": "array" |
| 986 }, |
| 987 "etag": { |
| 988 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.", |
| 989 "type": "string" |
| 990 }, |
| 991 "braggingRights": { |
| 992 "description": "The person's bragging rights.", |
| 993 "items": { |
| 994 "$ref": "BraggingRights" |
| 995 }, |
| 996 "type": "array" |
| 997 }, |
| 998 "metadata": { |
| 999 "$ref": "PersonMetadata", |
| 1000 "description": "Read-only metadata about the person." |
| 1001 }, |
| 1002 "residences": { |
| 1003 "description": "The person's residences.", |
| 1004 "items": { |
| 1005 "$ref": "Residence" |
| 1006 }, |
| 1007 "type": "array" |
| 1008 }, |
| 1009 "genders": { |
| 1010 "description": "The person's genders.", |
| 1011 "items": { |
| 1012 "$ref": "Gender" |
| 1013 }, |
| 1014 "type": "array" |
| 1015 }, |
| 1016 "interests": { |
| 1017 "description": "The person's interests.", |
| 1018 "items": { |
| 1019 "$ref": "Interest" |
| 1020 }, |
| 1021 "type": "array" |
| 1022 }, |
| 1023 "resourceName": { |
| 1024 "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\n`people/`<var>person_id</var>.", |
| 1025 "type": "string" |
| 1026 }, |
| 1027 "biographies": { |
| 1028 "description": "The person's biographies.", |
| 1029 "items": { |
| 1030 "$ref": "Biography" |
| 1031 }, |
| 1032 "type": "array" |
| 1033 }, |
| 1034 "skills": { |
| 1035 "description": "The person's skills.", |
| 1036 "items": { |
| 1037 "$ref": "Skill" |
| 1038 }, |
| 1039 "type": "array" |
| 1040 }, |
| 1041 "relationshipStatuses": { |
| 1042 "description": "The person's read-only relationship statuses
.", |
| 1043 "items": { |
| 1044 "$ref": "RelationshipStatus" |
| 1045 }, |
| 1046 "type": "array" |
| 1047 }, |
| 1048 "photos": { |
| 1049 "description": "The person's read-only photos.", |
| 1050 "items": { |
| 1051 "$ref": "Photo" |
| 1052 }, |
| 1053 "type": "array" |
| 1054 }, |
| 1055 "ageRange": { |
| 1056 "description": "**DEPRECATED** (Please use `person.ageRanges
` instead)**\n\nThe person's read-only age range.", |
| 1057 "enum": [ |
| 1058 "AGE_RANGE_UNSPECIFIED", |
| 1059 "LESS_THAN_EIGHTEEN", |
1197 "EIGHTEEN_TO_TWENTY", | 1060 "EIGHTEEN_TO_TWENTY", |
1198 "TWENTY_ONE_OR_OLDER" | 1061 "TWENTY_ONE_OR_OLDER" |
1199 ], | 1062 ], |
1200 "enumDescriptions": [ | 1063 "enumDescriptions": [ |
1201 "Unspecified.", | 1064 "Unspecified.", |
1202 "Younger than eighteen.", | 1065 "Younger than eighteen.", |
1203 "Between eighteen and twenty.", | 1066 "Between eighteen and twenty.", |
1204 "Twenty-one and older." | 1067 "Twenty-one and older." |
1205 ], | 1068 ], |
1206 "type": "string" | 1069 "type": "string" |
1207 }, | 1070 }, |
1208 "metadata": { | |
1209 "$ref": "FieldMetadata", | |
1210 "description": "Metadata about the age range." | |
1211 } | |
1212 }, | |
1213 "type": "object" | |
1214 }, | |
1215 "ListContactGroupsResponse": { | |
1216 "description": "The response to a list contact groups request.", | |
1217 "id": "ListContactGroupsResponse", | |
1218 "properties": { | |
1219 "contactGroups": { | |
1220 "description": "The list of contact groups. Members of the c
ontact groups are not\npopulated.", | |
1221 "items": { | |
1222 "$ref": "ContactGroup" | |
1223 }, | |
1224 "type": "array" | |
1225 }, | |
1226 "nextPageToken": { | |
1227 "description": "The token that can be used to retrieve the n
ext page of results.", | |
1228 "type": "string" | |
1229 }, | |
1230 "nextSyncToken": { | |
1231 "description": "The token that can be used to retrieve chang
es since the last request.", | |
1232 "type": "string" | |
1233 }, | |
1234 "totalItems": { | |
1235 "description": "The total number of items in the list withou
t pagination.", | |
1236 "format": "int32", | |
1237 "type": "integer" | |
1238 } | |
1239 }, | |
1240 "type": "object" | |
1241 }, | |
1242 "PersonResponse": { | |
1243 "description": "The response for a single person", | |
1244 "id": "PersonResponse", | |
1245 "properties": { | |
1246 "person": { | |
1247 "$ref": "Person", | |
1248 "description": "The person." | |
1249 }, | |
1250 "status": { | |
1251 "$ref": "Status", | |
1252 "description": "The status of the response." | |
1253 }, | |
1254 "httpStatusCode": { | |
1255 "description": "**DEPRECATED** (Please use status instead)\n
\n[HTTP 1.1 status code]\n(http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.htm
l).", | |
1256 "format": "int32", | |
1257 "type": "integer" | |
1258 }, | |
1259 "requestedResourceName": { | |
1260 "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.", | |
1261 "type": "string" | |
1262 } | |
1263 }, | |
1264 "type": "object" | |
1265 }, | |
1266 "Relation": { | |
1267 "description": "A person's relation to another person.", | |
1268 "id": "Relation", | |
1269 "properties": { | |
1270 "type": { | |
1271 "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`", | |
1272 "type": "string" | |
1273 }, | |
1274 "metadata": { | |
1275 "$ref": "FieldMetadata", | |
1276 "description": "Metadata about the relation." | |
1277 }, | |
1278 "formattedType": { | |
1279 "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.", | |
1280 "type": "string" | |
1281 }, | |
1282 "person": { | |
1283 "description": "The name of the other person this relation r
efers to.", | |
1284 "type": "string" | |
1285 } | |
1286 }, | |
1287 "type": "object" | |
1288 }, | |
1289 "Occupation": { | |
1290 "description": "A person's occupation.", | |
1291 "id": "Occupation", | |
1292 "properties": { | |
1293 "metadata": { | |
1294 "$ref": "FieldMetadata", | |
1295 "description": "Metadata about the occupation." | |
1296 }, | |
1297 "value": { | |
1298 "description": "The occupation; for example, `carpenter`.", | |
1299 "type": "string" | |
1300 } | |
1301 }, | |
1302 "type": "object" | |
1303 }, | |
1304 "ContactGroup": { | |
1305 "description": "A contact group.", | |
1306 "id": "ContactGroup", | |
1307 "properties": { | |
1308 "resourceName": { | |
1309 "description": "The resource name for the contact group, ass
igned by the server. An ASCII\nstring, in the form of `contactGroups/`<var>conta
ct_group_id</var>.", | |
1310 "type": "string" | |
1311 }, | |
1312 "etag": { | |
1313 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.", | |
1314 "type": "string" | |
1315 }, | |
1316 "groupType": { | |
1317 "description": "The read-only contact group type.", | |
1318 "enum": [ | |
1319 "GROUP_TYPE_UNSPECIFIED", | |
1320 "USER_CONTACT_GROUP", | |
1321 "SYSTEM_CONTACT_GROUP" | |
1322 ], | |
1323 "enumDescriptions": [ | |
1324 "Unspecified.", | |
1325 "User defined contact group.", | |
1326 "System defined contact group." | |
1327 ], | |
1328 "type": "string" | |
1329 }, | |
1330 "formattedName": { | |
1331 "description": "The read-only name translated and formatted
in the viewer's account locale\nor the `Accept-Language` HTTP header locale for
system groups names.\nGroup names set by the owner are the same as name.", | |
1332 "type": "string" | |
1333 }, | |
1334 "memberResourceNames": { | |
1335 "description": "The list of contact person resource names th
at are members of the contact\ngroup. The field is not populated for LIST reques
ts and can only be updated\nthrough the\n[ModifyContactGroupMembers](/people/api
/rest/v1/contactgroups/members/modify).", | |
1336 "items": { | |
1337 "type": "string" | |
1338 }, | |
1339 "type": "array" | |
1340 }, | |
1341 "name": { | |
1342 "description": "The contact group name set by the group owne
r or a system provided name\nfor system groups.", | |
1343 "type": "string" | |
1344 }, | |
1345 "metadata": { | |
1346 "$ref": "ContactGroupMetadata", | |
1347 "description": "Metadata about the contact group." | |
1348 }, | |
1349 "memberCount": { | |
1350 "description": "The total number of contacts in the group ir
respective of max members in\nspecified in the request.", | |
1351 "format": "int32", | |
1352 "type": "integer" | |
1353 } | |
1354 }, | |
1355 "type": "object" | |
1356 }, | |
1357 "Person": { | |
1358 "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.", | |
1359 "id": "Person", | |
1360 "properties": { | |
1361 "relationshipStatuses": { | |
1362 "description": "The person's read-only relationship statuses
.", | |
1363 "items": { | |
1364 "$ref": "RelationshipStatus" | |
1365 }, | |
1366 "type": "array" | |
1367 }, | |
1368 "photos": { | |
1369 "description": "The person's read-only photos.", | |
1370 "items": { | |
1371 "$ref": "Photo" | |
1372 }, | |
1373 "type": "array" | |
1374 }, | |
1375 "ageRange": { | |
1376 "description": "**DEPRECATED** (Please use `person.ageRanges
` instead)**\n\nThe person's read-only age range.", | |
1377 "enum": [ | |
1378 "AGE_RANGE_UNSPECIFIED", | |
1379 "LESS_THAN_EIGHTEEN", | |
1380 "EIGHTEEN_TO_TWENTY", | |
1381 "TWENTY_ONE_OR_OLDER" | |
1382 ], | |
1383 "enumDescriptions": [ | |
1384 "Unspecified.", | |
1385 "Younger than eighteen.", | |
1386 "Between eighteen and twenty.", | |
1387 "Twenty-one and older." | |
1388 ], | |
1389 "type": "string" | |
1390 }, | |
1391 "taglines": { | 1071 "taglines": { |
1392 "description": "The person's read-only taglines.", | 1072 "description": "The person's read-only taglines.", |
1393 "items": { | 1073 "items": { |
1394 "$ref": "Tagline" | 1074 "$ref": "Tagline" |
1395 }, | 1075 }, |
1396 "type": "array" | 1076 "type": "array" |
1397 }, | 1077 }, |
1398 "ageRanges": { | 1078 "ageRanges": { |
1399 "description": "The person's read-only age ranges.", | 1079 "description": "The person's read-only age ranges.", |
1400 "items": { | 1080 "items": { |
(...skipping 21 matching lines...) Expand all Loading... |
1422 "$ref": "Membership" | 1102 "$ref": "Membership" |
1423 }, | 1103 }, |
1424 "type": "array" | 1104 "type": "array" |
1425 }, | 1105 }, |
1426 "phoneNumbers": { | 1106 "phoneNumbers": { |
1427 "description": "The person's phone numbers.", | 1107 "description": "The person's phone numbers.", |
1428 "items": { | 1108 "items": { |
1429 "$ref": "PhoneNumber" | 1109 "$ref": "PhoneNumber" |
1430 }, | 1110 }, |
1431 "type": "array" | 1111 "type": "array" |
1432 }, | |
1433 "coverPhotos": { | |
1434 "description": "The person's read-only cover photos.", | |
1435 "items": { | |
1436 "$ref": "CoverPhoto" | |
1437 }, | |
1438 "type": "array" | |
1439 }, | |
1440 "imClients": { | |
1441 "description": "The person's instant messaging clients.", | |
1442 "items": { | |
1443 "$ref": "ImClient" | |
1444 }, | |
1445 "type": "array" | |
1446 }, | |
1447 "birthdays": { | |
1448 "description": "The person's birthdays.", | |
1449 "items": { | |
1450 "$ref": "Birthday" | |
1451 }, | |
1452 "type": "array" | |
1453 }, | |
1454 "locales": { | |
1455 "description": "The person's locale preferences.", | |
1456 "items": { | |
1457 "$ref": "Locale" | |
1458 }, | |
1459 "type": "array" | |
1460 }, | |
1461 "relationshipInterests": { | |
1462 "description": "The person's read-only relationship interest
s.", | |
1463 "items": { | |
1464 "$ref": "RelationshipInterest" | |
1465 }, | |
1466 "type": "array" | |
1467 }, | |
1468 "urls": { | |
1469 "description": "The person's associated URLs.", | |
1470 "items": { | |
1471 "$ref": "Url" | |
1472 }, | |
1473 "type": "array" | |
1474 }, | |
1475 "nicknames": { | |
1476 "description": "The person's nicknames.", | |
1477 "items": { | |
1478 "$ref": "Nickname" | |
1479 }, | |
1480 "type": "array" | |
1481 }, | |
1482 "relations": { | |
1483 "description": "The person's relations.", | |
1484 "items": { | |
1485 "$ref": "Relation" | |
1486 }, | |
1487 "type": "array" | |
1488 }, | |
1489 "names": { | |
1490 "description": "The person's names.", | |
1491 "items": { | |
1492 "$ref": "Name" | |
1493 }, | |
1494 "type": "array" | |
1495 }, | |
1496 "occupations": { | |
1497 "description": "The person's occupations.", | |
1498 "items": { | |
1499 "$ref": "Occupation" | |
1500 }, | |
1501 "type": "array" | |
1502 }, | |
1503 "emailAddresses": { | |
1504 "description": "The person's email addresses.", | |
1505 "items": { | |
1506 "$ref": "EmailAddress" | |
1507 }, | |
1508 "type": "array" | |
1509 }, | |
1510 "organizations": { | |
1511 "description": "The person's past or current organizations."
, | |
1512 "items": { | |
1513 "$ref": "Organization" | |
1514 }, | |
1515 "type": "array" | |
1516 }, | |
1517 "etag": { | |
1518 "description": "The [HTTP entity tag](https://en.wikipedia.o
rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.", | |
1519 "type": "string" | |
1520 }, | |
1521 "braggingRights": { | |
1522 "description": "The person's bragging rights.", | |
1523 "items": { | |
1524 "$ref": "BraggingRights" | |
1525 }, | |
1526 "type": "array" | |
1527 }, | |
1528 "metadata": { | |
1529 "$ref": "PersonMetadata", | |
1530 "description": "Read-only metadata about the person." | |
1531 }, | |
1532 "residences": { | |
1533 "description": "The person's residences.", | |
1534 "items": { | |
1535 "$ref": "Residence" | |
1536 }, | |
1537 "type": "array" | |
1538 }, | |
1539 "genders": { | |
1540 "description": "The person's genders.", | |
1541 "items": { | |
1542 "$ref": "Gender" | |
1543 }, | |
1544 "type": "array" | |
1545 }, | |
1546 "resourceName": { | |
1547 "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\n`people/`<var>person_id</var>.", | |
1548 "type": "string" | |
1549 }, | |
1550 "interests": { | |
1551 "description": "The person's interests.", | |
1552 "items": { | |
1553 "$ref": "Interest" | |
1554 }, | |
1555 "type": "array" | |
1556 }, | |
1557 "biographies": { | |
1558 "description": "The person's biographies.", | |
1559 "items": { | |
1560 "$ref": "Biography" | |
1561 }, | |
1562 "type": "array" | |
1563 }, | |
1564 "skills": { | |
1565 "description": "The person's skills.", | |
1566 "items": { | |
1567 "$ref": "Skill" | |
1568 }, | |
1569 "type": "array" | |
1570 } | 1112 } |
1571 }, | 1113 }, |
1572 "type": "object" | 1114 "type": "object" |
1573 }, | 1115 }, |
1574 "UpdateContactGroupRequest": { | 1116 "UpdateContactGroupRequest": { |
1575 "description": "A request to update an existing contact group. Only
the name can be updated.", | 1117 "description": "A request to update an existing contact group. Only
the name can be updated.", |
1576 "id": "UpdateContactGroupRequest", | 1118 "id": "UpdateContactGroupRequest", |
1577 "properties": { | 1119 "properties": { |
1578 "contactGroup": { | 1120 "contactGroup": { |
1579 "$ref": "ContactGroup", | 1121 "$ref": "ContactGroup", |
1580 "description": "The contact group to update." | 1122 "description": "The contact group to update." |
1581 } | 1123 } |
1582 }, | 1124 }, |
1583 "type": "object" | 1125 "type": "object" |
1584 }, | 1126 }, |
1585 "ContactGroupMetadata": { | 1127 "ContactGroupMetadata": { |
1586 "description": "The read-only metadata about a contact group.", | 1128 "description": "The read-only metadata about a contact group.", |
1587 "id": "ContactGroupMetadata", | 1129 "id": "ContactGroupMetadata", |
1588 "properties": { | 1130 "properties": { |
| 1131 "updateTime": { |
| 1132 "description": "The time the group was last updated.", |
| 1133 "format": "google-datetime", |
| 1134 "type": "string" |
| 1135 }, |
1589 "deleted": { | 1136 "deleted": { |
1590 "description": "True if the contact group resource has been
deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgr
oups/list) requests\nthat include a sync token.", | 1137 "description": "True if the contact group resource has been
deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgr
oups/list) requests\nthat include a sync token.", |
1591 "type": "boolean" | 1138 "type": "boolean" |
1592 }, | |
1593 "updateTime": { | |
1594 "description": "The time the group was last updated.", | |
1595 "format": "google-datetime", | |
1596 "type": "string" | |
1597 } | 1139 } |
1598 }, | 1140 }, |
1599 "type": "object" | 1141 "type": "object" |
1600 }, | 1142 }, |
1601 "Residence": { | 1143 "Residence": { |
1602 "description": "A person's past or current residence.", | 1144 "description": "A person's past or current residence.", |
1603 "id": "Residence", | 1145 "id": "Residence", |
1604 "properties": { | 1146 "properties": { |
1605 "current": { | 1147 "current": { |
1606 "description": "True if the residence is the person's curren
t residence;\nfalse if the residence is a past residence.", | 1148 "description": "True if the residence is the person's curren
t residence;\nfalse if the residence is a past residence.", |
1607 "type": "boolean" | 1149 "type": "boolean" |
1608 }, | 1150 }, |
1609 "metadata": { | 1151 "metadata": { |
1610 "$ref": "FieldMetadata", | 1152 "$ref": "FieldMetadata", |
1611 "description": "Metadata about the residence." | 1153 "description": "Metadata about the residence." |
1612 }, | 1154 }, |
1613 "value": { | 1155 "value": { |
1614 "description": "The address of the residence.", | 1156 "description": "The address of the residence.", |
1615 "type": "string" | 1157 "type": "string" |
1616 } | 1158 } |
1617 }, | 1159 }, |
1618 "type": "object" | 1160 "type": "object" |
1619 }, | 1161 }, |
1620 "Event": { | 1162 "Event": { |
1621 "description": "An event related to the person.", | 1163 "description": "An event related to the person.", |
1622 "id": "Event", | 1164 "id": "Event", |
1623 "properties": { | 1165 "properties": { |
1624 "type": { | |
1625 "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`", | |
1626 "type": "string" | |
1627 }, | |
1628 "metadata": { | |
1629 "$ref": "FieldMetadata", | |
1630 "description": "Metadata about the event." | |
1631 }, | |
1632 "date": { | 1166 "date": { |
1633 "$ref": "Date", | 1167 "$ref": "Date", |
1634 "description": "The date of the event." | 1168 "description": "The date of the event." |
1635 }, | 1169 }, |
1636 "formattedType": { | 1170 "formattedType": { |
1637 "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.", | 1171 "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.", |
1638 "type": "string" | 1172 "type": "string" |
| 1173 }, |
| 1174 "type": { |
| 1175 "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`", |
| 1176 "type": "string" |
| 1177 }, |
| 1178 "metadata": { |
| 1179 "$ref": "FieldMetadata", |
| 1180 "description": "Metadata about the event." |
1639 } | 1181 } |
1640 }, | 1182 }, |
1641 "type": "object" | 1183 "type": "object" |
1642 }, | 1184 }, |
1643 "ModifyContactGroupMembersResponse": { | 1185 "ModifyContactGroupMembersResponse": { |
1644 "description": "The response to a modify contact group members reque
st.", | 1186 "description": "The response to a modify contact group members reque
st.", |
1645 "id": "ModifyContactGroupMembersResponse", | 1187 "id": "ModifyContactGroupMembersResponse", |
1646 "properties": { | 1188 "properties": { |
1647 "notFoundResourceNames": { | 1189 "notFoundResourceNames": { |
1648 "description": "The contact people resource names that were
not found.", | 1190 "description": "The contact people resource names that were
not found.", |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1691 }, | 1233 }, |
1692 "type": "array" | 1234 "type": "array" |
1693 } | 1235 } |
1694 }, | 1236 }, |
1695 "type": "object" | 1237 "type": "object" |
1696 }, | 1238 }, |
1697 "Gender": { | 1239 "Gender": { |
1698 "description": "A person's gender.", | 1240 "description": "A person's gender.", |
1699 "id": "Gender", | 1241 "id": "Gender", |
1700 "properties": { | 1242 "properties": { |
| 1243 "metadata": { |
| 1244 "$ref": "FieldMetadata", |
| 1245 "description": "Metadata about the gender." |
| 1246 }, |
| 1247 "value": { |
| 1248 "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`", |
| 1249 "type": "string" |
| 1250 }, |
1701 "formattedValue": { | 1251 "formattedValue": { |
1702 "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.", | 1252 "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.", |
1703 "type": "string" | 1253 "type": "string" |
1704 }, | |
1705 "metadata": { | |
1706 "$ref": "FieldMetadata", | |
1707 "description": "Metadata about the gender." | |
1708 }, | |
1709 "value": { | |
1710 "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`", | |
1711 "type": "string" | |
1712 } | 1254 } |
1713 }, | 1255 }, |
1714 "type": "object" | 1256 "type": "object" |
1715 }, | 1257 }, |
1716 "CoverPhoto": { | 1258 "CoverPhoto": { |
1717 "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.", | 1259 "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.", |
1718 "id": "CoverPhoto", | 1260 "id": "CoverPhoto", |
1719 "properties": { | 1261 "properties": { |
| 1262 "url": { |
| 1263 "description": "The URL of the cover photo.", |
| 1264 "type": "string" |
| 1265 }, |
1720 "default": { | 1266 "default": { |
1721 "description": "True if the cover photo is the default cover
photo;\nfalse if the cover photo is a user-provided cover photo.", | 1267 "description": "True if the cover photo is the default cover
photo;\nfalse if the cover photo is a user-provided cover photo.", |
1722 "type": "boolean" | 1268 "type": "boolean" |
1723 }, | 1269 }, |
1724 "metadata": { | 1270 "metadata": { |
1725 "$ref": "FieldMetadata", | 1271 "$ref": "FieldMetadata", |
1726 "description": "Metadata about the cover photo." | 1272 "description": "Metadata about the cover photo." |
1727 }, | |
1728 "url": { | |
1729 "description": "The URL of the cover photo.", | |
1730 "type": "string" | |
1731 } | 1273 } |
1732 }, | 1274 }, |
1733 "type": "object" | 1275 "type": "object" |
1734 }, | 1276 }, |
1735 "Interest": { | 1277 "Interest": { |
1736 "description": "One of the person's interests.", | 1278 "description": "One of the person's interests.", |
1737 "id": "Interest", | 1279 "id": "Interest", |
1738 "properties": { | 1280 "properties": { |
1739 "metadata": { | 1281 "metadata": { |
1740 "$ref": "FieldMetadata", | 1282 "$ref": "FieldMetadata", |
1741 "description": "Metadata about the interest." | 1283 "description": "Metadata about the interest." |
1742 }, | 1284 }, |
1743 "value": { | 1285 "value": { |
1744 "description": "The interest; for example, `stargazing`.", | 1286 "description": "The interest; for example, `stargazing`.", |
1745 "type": "string" | 1287 "type": "string" |
1746 } | 1288 } |
1747 }, | 1289 }, |
1748 "type": "object" | 1290 "type": "object" |
1749 }, | 1291 }, |
| 1292 "EmailAddress": { |
| 1293 "description": "A person's email address.", |
| 1294 "id": "EmailAddress", |
| 1295 "properties": { |
| 1296 "value": { |
| 1297 "description": "The email address.", |
| 1298 "type": "string" |
| 1299 }, |
| 1300 "formattedType": { |
| 1301 "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.", |
| 1302 "type": "string" |
| 1303 }, |
| 1304 "displayName": { |
| 1305 "description": "The display name of the email.", |
| 1306 "type": "string" |
| 1307 }, |
| 1308 "type": { |
| 1309 "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`", |
| 1310 "type": "string" |
| 1311 }, |
| 1312 "metadata": { |
| 1313 "$ref": "FieldMetadata", |
| 1314 "description": "Metadata about the email address." |
| 1315 } |
| 1316 }, |
| 1317 "type": "object" |
| 1318 }, |
1750 "Nickname": { | 1319 "Nickname": { |
1751 "description": "A person's nickname.", | 1320 "description": "A person's nickname.", |
1752 "id": "Nickname", | 1321 "id": "Nickname", |
1753 "properties": { | 1322 "properties": { |
1754 "value": { | |
1755 "description": "The nickname.", | |
1756 "type": "string" | |
1757 }, | |
1758 "type": { | 1323 "type": { |
1759 "description": "The type of the nickname.", | 1324 "description": "The type of the nickname.", |
1760 "enum": [ | 1325 "enum": [ |
1761 "DEFAULT", | 1326 "DEFAULT", |
1762 "MAIDEN_NAME", | 1327 "MAIDEN_NAME", |
1763 "INITIALS", | 1328 "INITIALS", |
1764 "GPLUS", | 1329 "GPLUS", |
1765 "OTHER_NAME" | 1330 "OTHER_NAME" |
1766 ], | 1331 ], |
1767 "enumDescriptions": [ | 1332 "enumDescriptions": [ |
1768 "Generic nickname.", | 1333 "Generic nickname.", |
1769 "Maiden name or birth family name. Used when the person'
s family name has\nchanged as a result of marriage.", | 1334 "Maiden name or birth family name. Used when the person'
s family name has\nchanged as a result of marriage.", |
1770 "Initials.", | 1335 "Initials.", |
1771 "Google+ profile nickname.", | 1336 "Google+ profile nickname.", |
1772 "A professional affiliation or other name; for example,
`Dr. Smith.`" | 1337 "A professional affiliation or other name; for example,
`Dr. Smith.`" |
1773 ], | 1338 ], |
1774 "type": "string" | 1339 "type": "string" |
1775 }, | 1340 }, |
1776 "metadata": { | 1341 "metadata": { |
1777 "$ref": "FieldMetadata", | 1342 "$ref": "FieldMetadata", |
1778 "description": "Metadata about the nickname." | 1343 "description": "Metadata about the nickname." |
1779 } | 1344 }, |
1780 }, | 1345 "value": { |
1781 "type": "object" | 1346 "description": "The nickname.", |
1782 }, | |
1783 "EmailAddress": { | |
1784 "description": "A person's email address.", | |
1785 "id": "EmailAddress", | |
1786 "properties": { | |
1787 "formattedType": { | |
1788 "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.", | |
1789 "type": "string" | |
1790 }, | |
1791 "displayName": { | |
1792 "description": "The display name of the email.", | |
1793 "type": "string" | |
1794 }, | |
1795 "type": { | |
1796 "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`", | |
1797 "type": "string" | |
1798 }, | |
1799 "metadata": { | |
1800 "$ref": "FieldMetadata", | |
1801 "description": "Metadata about the email address." | |
1802 }, | |
1803 "value": { | |
1804 "description": "The email address.", | |
1805 "type": "string" | 1347 "type": "string" |
1806 } | 1348 } |
1807 }, | 1349 }, |
1808 "type": "object" | 1350 "type": "object" |
1809 }, | 1351 }, |
1810 "Skill": { | 1352 "Skill": { |
1811 "description": "A skill that the person has.", | 1353 "description": "A skill that the person has.", |
1812 "id": "Skill", | 1354 "id": "Skill", |
1813 "properties": { | 1355 "properties": { |
1814 "metadata": { | 1356 "metadata": { |
1815 "$ref": "FieldMetadata", | 1357 "$ref": "FieldMetadata", |
1816 "description": "Metadata about the skill." | 1358 "description": "Metadata about the skill." |
1817 }, | 1359 }, |
1818 "value": { | 1360 "value": { |
1819 "description": "The skill; for example, `underwater basket w
eaving`.", | 1361 "description": "The skill; for example, `underwater basket w
eaving`.", |
1820 "type": "string" | 1362 "type": "string" |
1821 } | 1363 } |
1822 }, | 1364 }, |
1823 "type": "object" | 1365 "type": "object" |
1824 }, | 1366 }, |
| 1367 "Tagline": { |
| 1368 "description": "A read-only brief one-line description of the person
.", |
| 1369 "id": "Tagline", |
| 1370 "properties": { |
| 1371 "metadata": { |
| 1372 "$ref": "FieldMetadata", |
| 1373 "description": "Metadata about the tagline." |
| 1374 }, |
| 1375 "value": { |
| 1376 "description": "The tagline.", |
| 1377 "type": "string" |
| 1378 } |
| 1379 }, |
| 1380 "type": "object" |
| 1381 }, |
1825 "Date": { | 1382 "Date": { |
1826 "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
.", | 1383 "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
.", |
1827 "id": "Date", | 1384 "id": "Date", |
1828 "properties": { | 1385 "properties": { |
| 1386 "month": { |
| 1387 "description": "Month of year. Must be from 1 to 12.", |
| 1388 "format": "int32", |
| 1389 "type": "integer" |
| 1390 }, |
1829 "day": { | 1391 "day": { |
1830 "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.", | 1392 "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.", |
1831 "format": "int32", | 1393 "format": "int32", |
1832 "type": "integer" | 1394 "type": "integer" |
1833 }, | 1395 }, |
1834 "year": { | 1396 "year": { |
1835 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", | 1397 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
1836 "format": "int32", | 1398 "format": "int32", |
1837 "type": "integer" | 1399 "type": "integer" |
1838 }, | |
1839 "month": { | |
1840 "description": "Month of year. Must be from 1 to 12.", | |
1841 "format": "int32", | |
1842 "type": "integer" | |
1843 } | |
1844 }, | |
1845 "type": "object" | |
1846 }, | |
1847 "Tagline": { | |
1848 "description": "A read-only brief one-line description of the person
.", | |
1849 "id": "Tagline", | |
1850 "properties": { | |
1851 "value": { | |
1852 "description": "The tagline.", | |
1853 "type": "string" | |
1854 }, | |
1855 "metadata": { | |
1856 "$ref": "FieldMetadata", | |
1857 "description": "Metadata about the tagline." | |
1858 } | 1400 } |
1859 }, | 1401 }, |
1860 "type": "object" | 1402 "type": "object" |
1861 }, | 1403 }, |
1862 "Name": { | 1404 "Name": { |
1863 "description": "A person's name. If the name is a mononym, the famil
y name is empty.", | 1405 "description": "A person's name. If the name is a mononym, the famil
y name is empty.", |
1864 "id": "Name", | 1406 "id": "Name", |
1865 "properties": { | 1407 "properties": { |
| 1408 "displayName": { |
| 1409 "description": "The read-only display name formatted accordi
ng to the locale specified by\nthe viewer's account or the `Accept-Language` HTT
P header.", |
| 1410 "type": "string" |
| 1411 }, |
| 1412 "honorificSuffix": { |
| 1413 "description": "The honorific suffixes, such as `Jr.`", |
| 1414 "type": "string" |
| 1415 }, |
| 1416 "honorificPrefix": { |
| 1417 "description": "The honorific prefixes, such as `Mrs.` or `D
r.`", |
| 1418 "type": "string" |
| 1419 }, |
| 1420 "phoneticHonorificSuffix": { |
| 1421 "description": "The honorific suffixes spelled as they sound
.", |
| 1422 "type": "string" |
| 1423 }, |
| 1424 "givenName": { |
| 1425 "description": "The given name.", |
| 1426 "type": "string" |
| 1427 }, |
| 1428 "middleName": { |
| 1429 "description": "The middle name(s).", |
| 1430 "type": "string" |
| 1431 }, |
1866 "phoneticHonorificPrefix": { | 1432 "phoneticHonorificPrefix": { |
1867 "description": "The honorific prefixes spelled as they sound
.", | 1433 "description": "The honorific prefixes spelled as they sound
.", |
1868 "type": "string" | 1434 "type": "string" |
1869 }, | 1435 }, |
1870 "phoneticGivenName": { | 1436 "phoneticGivenName": { |
1871 "description": "The given name spelled as it sounds.", | 1437 "description": "The given name spelled as it sounds.", |
1872 "type": "string" | 1438 "type": "string" |
1873 }, | 1439 }, |
1874 "phoneticFamilyName": { | 1440 "phoneticFamilyName": { |
1875 "description": "The family name spelled as it sounds.", | 1441 "description": "The family name spelled as it sounds.", |
1876 "type": "string" | 1442 "type": "string" |
1877 }, | 1443 }, |
1878 "familyName": { | 1444 "familyName": { |
1879 "description": "The family name.", | 1445 "description": "The family name.", |
1880 "type": "string" | 1446 "type": "string" |
1881 }, | 1447 }, |
1882 "metadata": { | |
1883 "$ref": "FieldMetadata", | |
1884 "description": "Metadata about the name." | |
1885 }, | |
1886 "phoneticMiddleName": { | 1448 "phoneticMiddleName": { |
1887 "description": "The middle name(s) spelled as they sound.", | 1449 "description": "The middle name(s) spelled as they sound.", |
1888 "type": "string" | 1450 "type": "string" |
1889 }, | 1451 }, |
| 1452 "metadata": { |
| 1453 "$ref": "FieldMetadata", |
| 1454 "description": "Metadata about the name." |
| 1455 }, |
1890 "phoneticFullName": { | 1456 "phoneticFullName": { |
1891 "description": "The full name spelled as it sounds.", | 1457 "description": "The full name spelled as it sounds.", |
1892 "type": "string" | 1458 "type": "string" |
1893 }, | 1459 }, |
1894 "displayNameLastFirst": { | 1460 "displayNameLastFirst": { |
1895 "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`Accept-Language` HTTP header.", | 1461 "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`Accept-Language` HTTP header.", |
1896 "type": "string" | 1462 "type": "string" |
1897 }, | |
1898 "displayName": { | |
1899 "description": "The read-only display name formatted accordi
ng to the locale specified by\nthe viewer's account or the `Accept-Language` HTT
P header.", | |
1900 "type": "string" | |
1901 }, | |
1902 "honorificSuffix": { | |
1903 "description": "The honorific suffixes, such as `Jr.`", | |
1904 "type": "string" | |
1905 }, | |
1906 "honorificPrefix": { | |
1907 "description": "The honorific prefixes, such as `Mrs.` or `D
r.`", | |
1908 "type": "string" | |
1909 }, | |
1910 "phoneticHonorificSuffix": { | |
1911 "description": "The honorific suffixes spelled as they sound
.", | |
1912 "type": "string" | |
1913 }, | |
1914 "middleName": { | |
1915 "description": "The middle name(s).", | |
1916 "type": "string" | |
1917 }, | |
1918 "givenName": { | |
1919 "description": "The given name.", | |
1920 "type": "string" | |
1921 } | 1463 } |
1922 }, | 1464 }, |
1923 "type": "object" | 1465 "type": "object" |
1924 }, | 1466 }, |
1925 "Locale": { | 1467 "Locale": { |
1926 "description": "A person's locale preference.", | 1468 "description": "A person's locale preference.", |
1927 "id": "Locale", | 1469 "id": "Locale", |
1928 "properties": { | 1470 "properties": { |
1929 "metadata": { | 1471 "metadata": { |
1930 "$ref": "FieldMetadata", | 1472 "$ref": "FieldMetadata", |
1931 "description": "Metadata about the locale." | 1473 "description": "Metadata about the locale." |
1932 }, | 1474 }, |
1933 "value": { | 1475 "value": { |
1934 "description": "The well-formed [IETF BCP 47](https://tools.
ietf.org/html/bcp47)\nlanguage tag representing the locale.", | 1476 "description": "The well-formed [IETF BCP 47](https://tools.
ietf.org/html/bcp47)\nlanguage tag representing the locale.", |
1935 "type": "string" | 1477 "type": "string" |
1936 } | 1478 } |
1937 }, | 1479 }, |
1938 "type": "object" | 1480 "type": "object" |
1939 }, | 1481 }, |
1940 "Empty": { | 1482 "Empty": { |
1941 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | 1483 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
1942 "id": "Empty", | 1484 "id": "Empty", |
1943 "properties": {}, | 1485 "properties": {}, |
1944 "type": "object" | 1486 "type": "object" |
| 1487 }, |
| 1488 "Biography": { |
| 1489 "description": "A person's short biography.", |
| 1490 "id": "Biography", |
| 1491 "properties": { |
| 1492 "contentType": { |
| 1493 "description": "The content type of the biography.", |
| 1494 "enum": [ |
| 1495 "CONTENT_TYPE_UNSPECIFIED", |
| 1496 "TEXT_PLAIN", |
| 1497 "TEXT_HTML" |
| 1498 ], |
| 1499 "enumDescriptions": [ |
| 1500 "Unspecified.", |
| 1501 "Plain text.", |
| 1502 "HTML text." |
| 1503 ], |
| 1504 "type": "string" |
| 1505 }, |
| 1506 "metadata": { |
| 1507 "$ref": "FieldMetadata", |
| 1508 "description": "Metadata about the biography." |
| 1509 }, |
| 1510 "value": { |
| 1511 "description": "The short biography.", |
| 1512 "type": "string" |
| 1513 } |
| 1514 }, |
| 1515 "type": "object" |
| 1516 }, |
| 1517 "FieldMetadata": { |
| 1518 "description": "Metadata about a field.", |
| 1519 "id": "FieldMetadata", |
| 1520 "properties": { |
| 1521 "verified": { |
| 1522 "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.", |
| 1523 "type": "boolean" |
| 1524 }, |
| 1525 "primary": { |
| 1526 "description": "True if the field is the primary field; fals
e if the field is a secondary\nfield.", |
| 1527 "type": "boolean" |
| 1528 }, |
| 1529 "source": { |
| 1530 "$ref": "Source", |
| 1531 "description": "The source of the field." |
| 1532 } |
| 1533 }, |
| 1534 "type": "object" |
| 1535 }, |
| 1536 "Source": { |
| 1537 "description": "The source of a field.", |
| 1538 "id": "Source", |
| 1539 "properties": { |
| 1540 "etag": { |
| 1541 "description": "**Only populated in `person.metadata.sources
`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\ns
ource. Used for web cache validation.", |
| 1542 "type": "string" |
| 1543 }, |
| 1544 "id": { |
| 1545 "description": "The unique identifier within the source type
generated by the server.", |
| 1546 "type": "string" |
| 1547 }, |
| 1548 "profileMetadata": { |
| 1549 "$ref": "ProfileMetadata", |
| 1550 "description": "**Only populated in `person.metadata.sources
`.**\n\nMetadata about a source of type PROFILE." |
| 1551 }, |
| 1552 "updateTime": { |
| 1553 "description": "**Only populated in `person.metadata.sources
`.**\n\nLast update timestamp of this source.", |
| 1554 "format": "google-datetime", |
| 1555 "type": "string" |
| 1556 }, |
| 1557 "type": { |
| 1558 "description": "The source type.", |
| 1559 "enum": [ |
| 1560 "SOURCE_TYPE_UNSPECIFIED", |
| 1561 "ACCOUNT", |
| 1562 "PROFILE", |
| 1563 "DOMAIN_PROFILE", |
| 1564 "CONTACT" |
| 1565 ], |
| 1566 "enumDescriptions": [ |
| 1567 "Unspecified.", |
| 1568 "[Google Account](https://accounts.google.com).", |
| 1569 "[Google profile](https://profiles.google.com). You can
view the\nprofile at https://profiles.google.com/<var>id</var> where\n<var>id</v
ar> is the source id.", |
| 1570 "[Google Apps domain profile](https://admin.google.com).
", |
| 1571 "[Google contact](https://contacts.google.com). You can
view the\ncontact at https://contact.google.com/<var>id</var> where <var>id</var
>\nis the source id." |
| 1572 ], |
| 1573 "type": "string" |
| 1574 } |
| 1575 }, |
| 1576 "type": "object" |
| 1577 }, |
| 1578 "RelationshipInterest": { |
| 1579 "description": "A person's read-only relationship interest .", |
| 1580 "id": "RelationshipInterest", |
| 1581 "properties": { |
| 1582 "formattedValue": { |
| 1583 "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.", |
| 1584 "type": "string" |
| 1585 }, |
| 1586 "metadata": { |
| 1587 "$ref": "FieldMetadata", |
| 1588 "description": "Metadata about the relationship interest." |
| 1589 }, |
| 1590 "value": { |
| 1591 "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`", |
| 1592 "type": "string" |
| 1593 } |
| 1594 }, |
| 1595 "type": "object" |
| 1596 }, |
| 1597 "GetPeopleResponse": { |
| 1598 "id": "GetPeopleResponse", |
| 1599 "properties": { |
| 1600 "responses": { |
| 1601 "description": "The response for each requested resource nam
e.", |
| 1602 "items": { |
| 1603 "$ref": "PersonResponse" |
| 1604 }, |
| 1605 "type": "array" |
| 1606 } |
| 1607 }, |
| 1608 "type": "object" |
| 1609 }, |
| 1610 "Photo": { |
| 1611 "description": "A person's read-only photo. A picture shown next to
the person's name to\nhelp others recognize the person.", |
| 1612 "id": "Photo", |
| 1613 "properties": { |
| 1614 "metadata": { |
| 1615 "$ref": "FieldMetadata", |
| 1616 "description": "Metadata about the photo." |
| 1617 }, |
| 1618 "url": { |
| 1619 "description": "The URL of the photo. You can change the des
ired size by appending a query\nparameter `sz=`<var>size</var> at the end of the
url. Example:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAA
AAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50`", |
| 1620 "type": "string" |
| 1621 } |
| 1622 }, |
| 1623 "type": "object" |
| 1624 }, |
| 1625 "PhoneNumber": { |
| 1626 "description": "A person's phone number.", |
| 1627 "id": "PhoneNumber", |
| 1628 "properties": { |
| 1629 "formattedType": { |
| 1630 "description": "The read-only type of the phone number trans
lated and formatted in the\nviewer's account locale or the `Accept-Language` HTT
P header locale.", |
| 1631 "type": "string" |
| 1632 }, |
| 1633 "canonicalForm": { |
| 1634 "description": "The read-only canonicalized [ITU-T E.164](ht
tps://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the p
hone number.", |
| 1635 "type": "string" |
| 1636 }, |
| 1637 "type": { |
| 1638 "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`", |
| 1639 "type": "string" |
| 1640 }, |
| 1641 "metadata": { |
| 1642 "$ref": "FieldMetadata", |
| 1643 "description": "Metadata about the phone number." |
| 1644 }, |
| 1645 "value": { |
| 1646 "description": "The phone number.", |
| 1647 "type": "string" |
| 1648 } |
| 1649 }, |
| 1650 "type": "object" |
| 1651 }, |
| 1652 "ListConnectionsResponse": { |
| 1653 "id": "ListConnectionsResponse", |
| 1654 "properties": { |
| 1655 "nextPageToken": { |
| 1656 "description": "The token that can be used to retrieve the n
ext page of results.", |
| 1657 "type": "string" |
| 1658 }, |
| 1659 "totalItems": { |
| 1660 "description": "The total number of items in the list withou
t pagination.", |
| 1661 "format": "int32", |
| 1662 "type": "integer" |
| 1663 }, |
| 1664 "nextSyncToken": { |
| 1665 "description": "The token that can be used to retrieve chang
es since the last request.", |
| 1666 "type": "string" |
| 1667 }, |
| 1668 "connections": { |
| 1669 "description": "The list of people that the requestor is con
nected to.", |
| 1670 "items": { |
| 1671 "$ref": "Person" |
| 1672 }, |
| 1673 "type": "array" |
| 1674 }, |
| 1675 "totalPeople": { |
| 1676 "description": "**DEPRECATED** (Please use totalItems)\nThe
total number of people in the list without pagination.", |
| 1677 "format": "int32", |
| 1678 "type": "integer" |
| 1679 } |
| 1680 }, |
| 1681 "type": "object" |
| 1682 }, |
| 1683 "Birthday": { |
| 1684 "description": "A person's birthday. At least one of the `date` and
`text` fields are\nspecified. The `date` and `text` fields typically represent t
he same\ndate, but are not guaranteed to.", |
| 1685 "id": "Birthday", |
| 1686 "properties": { |
| 1687 "text": { |
| 1688 "description": "A free-form string representing the user's b
irthday.", |
| 1689 "type": "string" |
| 1690 }, |
| 1691 "metadata": { |
| 1692 "$ref": "FieldMetadata", |
| 1693 "description": "Metadata about the birthday." |
| 1694 }, |
| 1695 "date": { |
| 1696 "$ref": "Date", |
| 1697 "description": "The date of the birthday." |
| 1698 } |
| 1699 }, |
| 1700 "type": "object" |
| 1701 }, |
| 1702 "CreateContactGroupRequest": { |
| 1703 "description": "A request to create a new contact group.", |
| 1704 "id": "CreateContactGroupRequest", |
| 1705 "properties": { |
| 1706 "contactGroup": { |
| 1707 "$ref": "ContactGroup", |
| 1708 "description": "The contact group to create." |
| 1709 } |
| 1710 }, |
| 1711 "type": "object" |
| 1712 }, |
| 1713 "Address": { |
| 1714 "description": "A person's physical address. May be a P.O. box or st
reet address. All fields\nare optional.", |
| 1715 "id": "Address", |
| 1716 "properties": { |
| 1717 "extendedAddress": { |
| 1718 "description": "The extended address of the address; for exa
mple, the apartment number.", |
| 1719 "type": "string" |
| 1720 }, |
| 1721 "poBox": { |
| 1722 "description": "The P.O. box of the address.", |
| 1723 "type": "string" |
| 1724 }, |
| 1725 "postalCode": { |
| 1726 "description": "The postal code of the address.", |
| 1727 "type": "string" |
| 1728 }, |
| 1729 "region": { |
| 1730 "description": "The region of the address; for example, the
state or province.", |
| 1731 "type": "string" |
| 1732 }, |
| 1733 "streetAddress": { |
| 1734 "description": "The street address.", |
| 1735 "type": "string" |
| 1736 }, |
| 1737 "metadata": { |
| 1738 "$ref": "FieldMetadata", |
| 1739 "description": "Metadata about the address." |
| 1740 }, |
| 1741 "countryCode": { |
| 1742 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/
iso/country_codes.htm) country\ncode of the address.", |
| 1743 "type": "string" |
| 1744 }, |
| 1745 "formattedType": { |
| 1746 "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.", |
| 1747 "type": "string" |
| 1748 }, |
| 1749 "city": { |
| 1750 "description": "The city of the address.", |
| 1751 "type": "string" |
| 1752 }, |
| 1753 "formattedValue": { |
| 1754 "description": "The unstructured value of the address. If th
is is not set by the user it\nwill be automatically constructed from structured
values.", |
| 1755 "type": "string" |
| 1756 }, |
| 1757 "country": { |
| 1758 "description": "The country of the address.", |
| 1759 "type": "string" |
| 1760 }, |
| 1761 "type": { |
| 1762 "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`", |
| 1763 "type": "string" |
| 1764 } |
| 1765 }, |
| 1766 "type": "object" |
| 1767 }, |
| 1768 "ContactGroupMembership": { |
| 1769 "description": "A Google contact group membership.", |
| 1770 "id": "ContactGroupMembership", |
| 1771 "properties": { |
| 1772 "contactGroupId": { |
| 1773 "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.", |
| 1774 "type": "string" |
| 1775 } |
| 1776 }, |
| 1777 "type": "object" |
| 1778 }, |
| 1779 "Status": { |
| 1780 "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.", |
| 1781 "id": "Status", |
| 1782 "properties": { |
| 1783 "code": { |
| 1784 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 1785 "format": "int32", |
| 1786 "type": "integer" |
| 1787 }, |
| 1788 "message": { |
| 1789 "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.", |
| 1790 "type": "string" |
| 1791 }, |
| 1792 "details": { |
| 1793 "description": "A list of messages that carry the error deta
ils. There is a common set of\nmessage types for APIs to use.", |
| 1794 "items": { |
| 1795 "additionalProperties": { |
| 1796 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 1797 "type": "any" |
| 1798 }, |
| 1799 "type": "object" |
| 1800 }, |
| 1801 "type": "array" |
| 1802 } |
| 1803 }, |
| 1804 "type": "object" |
| 1805 }, |
| 1806 "PersonMetadata": { |
| 1807 "description": "The read-only metadata about a person.", |
| 1808 "id": "PersonMetadata", |
| 1809 "properties": { |
| 1810 "previousResourceNames": { |
| 1811 "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.", |
| 1812 "items": { |
| 1813 "type": "string" |
| 1814 }, |
| 1815 "type": "array" |
| 1816 }, |
| 1817 "sources": { |
| 1818 "description": "The sources of data for the person.", |
| 1819 "items": { |
| 1820 "$ref": "Source" |
| 1821 }, |
| 1822 "type": "array" |
| 1823 }, |
| 1824 "deleted": { |
| 1825 "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.", |
| 1826 "type": "boolean" |
| 1827 }, |
| 1828 "objectType": { |
| 1829 "description": "**DEPRECATED** (Please use\n`person.metadata
.sources.profileMetadata.objectType` instead)\n\nThe type of the person object."
, |
| 1830 "enum": [ |
| 1831 "OBJECT_TYPE_UNSPECIFIED", |
| 1832 "PERSON", |
| 1833 "PAGE" |
| 1834 ], |
| 1835 "enumDescriptions": [ |
| 1836 "Unspecified.", |
| 1837 "Person.", |
| 1838 "[Google+ Page.](http://www.google.com/+/brands/)" |
| 1839 ], |
| 1840 "type": "string" |
| 1841 }, |
| 1842 "linkedPeopleResourceNames": { |
| 1843 "description": "Resource names of people linked to this reso
urce.", |
| 1844 "items": { |
| 1845 "type": "string" |
| 1846 }, |
| 1847 "type": "array" |
| 1848 } |
| 1849 }, |
| 1850 "type": "object" |
| 1851 }, |
| 1852 "ModifyContactGroupMembersRequest": { |
| 1853 "description": "A request to modify an existing contact group's memb
ers.", |
| 1854 "id": "ModifyContactGroupMembersRequest", |
| 1855 "properties": { |
| 1856 "resourceNamesToRemove": { |
| 1857 "description": "The resource names of the contact people to
remove in the form of in the\nform of `people/`<var>person_id</var>.", |
| 1858 "items": { |
| 1859 "type": "string" |
| 1860 }, |
| 1861 "type": "array" |
| 1862 }, |
| 1863 "resourceNamesToAdd": { |
| 1864 "description": "The resource names of the contact people to
add in the form of in the form\n`people/`<var>person_id</var>.", |
| 1865 "items": { |
| 1866 "type": "string" |
| 1867 }, |
| 1868 "type": "array" |
| 1869 } |
| 1870 }, |
| 1871 "type": "object" |
| 1872 }, |
| 1873 "ContactGroupResponse": { |
| 1874 "description": "The response for a specific contact group.", |
| 1875 "id": "ContactGroupResponse", |
| 1876 "properties": { |
| 1877 "status": { |
| 1878 "$ref": "Status", |
| 1879 "description": "The status of the response." |
| 1880 }, |
| 1881 "requestedResourceName": { |
| 1882 "description": "The original requested resource name.", |
| 1883 "type": "string" |
| 1884 }, |
| 1885 "contactGroup": { |
| 1886 "$ref": "ContactGroup", |
| 1887 "description": "The contact group." |
| 1888 } |
| 1889 }, |
| 1890 "type": "object" |
| 1891 }, |
| 1892 "Url": { |
| 1893 "description": "A person's associated URLs.", |
| 1894 "id": "Url", |
| 1895 "properties": { |
| 1896 "formattedType": { |
| 1897 "description": "The read-only type of the URL translated and
formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header
locale.", |
| 1898 "type": "string" |
| 1899 }, |
| 1900 "type": { |
| 1901 "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`", |
| 1902 "type": "string" |
| 1903 }, |
| 1904 "metadata": { |
| 1905 "$ref": "FieldMetadata", |
| 1906 "description": "Metadata about the URL." |
| 1907 }, |
| 1908 "value": { |
| 1909 "description": "The URL.", |
| 1910 "type": "string" |
| 1911 } |
| 1912 }, |
| 1913 "type": "object" |
| 1914 }, |
| 1915 "ImClient": { |
| 1916 "description": "A person's instant messaging client.", |
| 1917 "id": "ImClient", |
| 1918 "properties": { |
| 1919 "protocol": { |
| 1920 "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`", |
| 1921 "type": "string" |
| 1922 }, |
| 1923 "metadata": { |
| 1924 "$ref": "FieldMetadata", |
| 1925 "description": "Metadata about the IM client." |
| 1926 }, |
| 1927 "type": { |
| 1928 "description": "The type of the IM client. The type can be c
ustom or predefined.\nPossible values include, but are not limited to, the follo
wing:\n\n* `home`\n* `work`\n* `other`", |
| 1929 "type": "string" |
| 1930 }, |
| 1931 "username": { |
| 1932 "description": "The user name used in the IM client.", |
| 1933 "type": "string" |
| 1934 }, |
| 1935 "formattedProtocol": { |
| 1936 "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.", |
| 1937 "type": "string" |
| 1938 }, |
| 1939 "formattedType": { |
| 1940 "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.", |
| 1941 "type": "string" |
| 1942 } |
| 1943 }, |
| 1944 "type": "object" |
1945 } | 1945 } |
1946 }, | 1946 }, |
1947 "servicePath": "", | 1947 "servicePath": "", |
1948 "title": "Google People API", | 1948 "title": "Google People API", |
1949 "version": "v1" | 1949 "version": "v1" |
1950 } | 1950 } |
OLD | NEW |