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

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

Issue 2973303002: Api-Roll 51: 2017-07-10 (Closed)
Patch Set: Created 3 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/partners__v2.json ('k') | discovery/googleapis/playmoviespartner__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/user.emails.read": {
6 "description": "View your email addresses"
7 },
8 "https://www.googleapis.com/auth/contacts": {
9 "description": "Manage your contacts"
10 },
11 "https://www.googleapis.com/auth/user.addresses.read": {
12 "description": "View your street addresses"
13 },
14 "https://www.googleapis.com/auth/user.phonenumbers.read": { 5 "https://www.googleapis.com/auth/user.phonenumbers.read": {
15 "description": "View your phone numbers" 6 "description": "View your phone numbers"
16 }, 7 },
17 "https://www.googleapis.com/auth/userinfo.email": { 8 "https://www.googleapis.com/auth/userinfo.email": {
18 "description": "View your email address" 9 "description": "View your email address"
19 }, 10 },
20 "https://www.googleapis.com/auth/contacts.readonly": { 11 "https://www.googleapis.com/auth/contacts.readonly": {
21 "description": "View your contacts" 12 "description": "View your contacts"
22 }, 13 },
23 "https://www.googleapis.com/auth/user.birthday.read": { 14 "https://www.googleapis.com/auth/user.birthday.read": {
24 "description": "View your complete date of birth" 15 "description": "View your complete date of birth"
25 }, 16 },
26 "https://www.googleapis.com/auth/plus.login": { 17 "https://www.googleapis.com/auth/plus.login": {
27 "description": "Know the list of people in your circles, you r age range, and language" 18 "description": "Know the list of people in your circles, you r age range, and language"
28 }, 19 },
29 "https://www.googleapis.com/auth/userinfo.profile": { 20 "https://www.googleapis.com/auth/userinfo.profile": {
30 "description": "View your basic profile info" 21 "description": "View your basic profile info"
22 },
23 "https://www.googleapis.com/auth/user.emails.read": {
24 "description": "View your email addresses"
25 },
26 "https://www.googleapis.com/auth/contacts": {
27 "description": "Manage your contacts"
28 },
29 "https://www.googleapis.com/auth/user.addresses.read": {
30 "description": "View your street addresses"
31 } 31 }
32 } 32 }
33 } 33 }
34 }, 34 },
35 "basePath": "", 35 "basePath": "",
36 "baseUrl": "https://people.googleapis.com/", 36 "baseUrl": "https://people.googleapis.com/",
37 "batchPath": "batch", 37 "batchPath": "batch",
38 "canonicalName": "People Service", 38 "canonicalName": "People Service",
39 "description": "Provides access to information about profiles and contacts." , 39 "description": "Provides access to information about profiles and contacts." ,
40 "discoveryVersion": "v1", 40 "discoveryVersion": "v1",
41 "documentationLink": "https://developers.google.com/people/", 41 "documentationLink": "https://developers.google.com/people/",
42 "icons": { 42 "icons": {
43 "x16": "http://www.google.com/images/icons/product/search-16.gif", 43 "x16": "http://www.google.com/images/icons/product/search-16.gif",
44 "x32": "http://www.google.com/images/icons/product/search-32.gif" 44 "x32": "http://www.google.com/images/icons/product/search-32.gif"
45 }, 45 },
46 "id": "people:v1", 46 "id": "people:v1",
47 "kind": "discovery#restDescription", 47 "kind": "discovery#restDescription",
48 "name": "people", 48 "name": "people",
49 "ownerDomain": "google.com", 49 "ownerDomain": "google.com",
50 "ownerName": "Google", 50 "ownerName": "Google",
51 "parameters": { 51 "parameters": {
52 "alt": {
53 "default": "json",
54 "description": "Data format for response.",
55 "enum": [
56 "json",
57 "media",
58 "proto"
59 ],
60 "enumDescriptions": [
61 "Responses with Content-Type of application/json",
62 "Media download with context-dependent Content-Type",
63 "Responses with Content-Type of application/x-protobuf"
64 ],
65 "location": "query",
66 "type": "string"
67 },
68 "key": {
69 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
70 "location": "query",
71 "type": "string"
72 },
73 "access_token": {
74 "description": "OAuth access token.",
75 "location": "query",
76 "type": "string"
77 },
78 "quotaUser": { 52 "quotaUser": {
79 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 53 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
80 "location": "query", 54 "location": "query",
81 "type": "string" 55 "type": "string"
82 }, 56 },
83 "pp": { 57 "pp": {
84 "default": "true", 58 "default": "true",
85 "description": "Pretty-print response.", 59 "description": "Pretty-print response.",
86 "location": "query", 60 "location": "query",
87 "type": "boolean" 61 "type": "boolean"
88 }, 62 },
63 "oauth_token": {
64 "description": "OAuth 2.0 token for the current user.",
65 "location": "query",
66 "type": "string"
67 },
89 "bearer_token": { 68 "bearer_token": {
90 "description": "OAuth bearer token.", 69 "description": "OAuth bearer token.",
91 "location": "query", 70 "location": "query",
92 "type": "string" 71 "type": "string"
93 }, 72 },
94 "oauth_token": {
95 "description": "OAuth 2.0 token for the current user.",
96 "location": "query",
97 "type": "string"
98 },
99 "upload_protocol": { 73 "upload_protocol": {
100 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 74 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
101 "location": "query", 75 "location": "query",
102 "type": "string" 76 "type": "string"
103 }, 77 },
104 "prettyPrint": { 78 "prettyPrint": {
105 "default": "true", 79 "default": "true",
106 "description": "Returns response with indentations and line breaks." , 80 "description": "Returns response with indentations and line breaks." ,
107 "location": "query", 81 "location": "query",
108 "type": "boolean" 82 "type": "boolean"
109 }, 83 },
84 "uploadType": {
85 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
86 "location": "query",
87 "type": "string"
88 },
110 "fields": { 89 "fields": {
111 "description": "Selector specifying which fields to include in a par tial response.", 90 "description": "Selector specifying which fields to include in a par tial response.",
112 "location": "query", 91 "location": "query",
113 "type": "string" 92 "type": "string"
114 }, 93 },
115 "uploadType": { 94 "callback": {
116 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 95 "description": "JSONP",
117 "location": "query", 96 "location": "query",
118 "type": "string" 97 "type": "string"
119 }, 98 },
120 "$.xgafv": { 99 "$.xgafv": {
121 "description": "V1 error format.", 100 "description": "V1 error format.",
122 "enum": [ 101 "enum": [
123 "1", 102 "1",
124 "2" 103 "2"
125 ], 104 ],
126 "enumDescriptions": [ 105 "enumDescriptions": [
127 "v1 error format", 106 "v1 error format",
128 "v2 error format" 107 "v2 error format"
129 ], 108 ],
130 "location": "query", 109 "location": "query",
131 "type": "string" 110 "type": "string"
132 }, 111 },
133 "callback": { 112 "alt": {
134 "description": "JSONP", 113 "default": "json",
114 "description": "Data format for response.",
115 "enum": [
116 "json",
117 "media",
118 "proto"
119 ],
120 "enumDescriptions": [
121 "Responses with Content-Type of application/json",
122 "Media download with context-dependent Content-Type",
123 "Responses with Content-Type of application/x-protobuf"
124 ],
125 "location": "query",
126 "type": "string"
127 },
128 "key": {
129 "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.",
130 "location": "query",
131 "type": "string"
132 },
133 "access_token": {
134 "description": "OAuth access token.",
135 "location": "query", 135 "location": "query",
136 "type": "string" 136 "type": "string"
137 } 137 }
138 }, 138 },
139 "protocol": "rest", 139 "protocol": "rest",
140 "resources": { 140 "resources": {
141 "contactGroups": {
142 "methods": {
143 "list": {
144 "description": "List all contact groups owned by the authent icated user. Members of the\ncontact groups are not populated.",
145 "httpMethod": "GET",
146 "id": "people.contactGroups.list",
147 "parameterOrder": [],
148 "parameters": {
149 "syncToken": {
150 "description": "A sync token, returned by a previous call to `contactgroups.list`.\nOnly resources changed since the sync token was created will be returned.",
151 "location": "query",
152 "type": "string"
153 },
154 "pageToken": {
155 "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.",
156 "location": "query",
157 "type": "string"
158 },
159 "pageSize": {
160 "description": "The maximum number of resources to r eturn.",
161 "format": "int32",
162 "location": "query",
163 "type": "integer"
164 }
165 },
166 "path": "v1/contactGroups",
167 "response": {
168 "$ref": "ListContactGroupsResponse"
169 },
170 "scopes": [
171 "https://www.googleapis.com/auth/contacts",
172 "https://www.googleapis.com/auth/contacts.readonly"
173 ]
174 },
175 "create": {
176 "description": "Create a new contact group owned by the auth enticated user.",
177 "httpMethod": "POST",
178 "id": "people.contactGroups.create",
179 "parameterOrder": [],
180 "parameters": {},
181 "path": "v1/contactGroups",
182 "request": {
183 "$ref": "CreateContactGroupRequest"
184 },
185 "response": {
186 "$ref": "ContactGroup"
187 },
188 "scopes": [
189 "https://www.googleapis.com/auth/contacts"
190 ]
191 },
192 "get": {
193 "description": "Get a specific contact group owned by the au thenticated user by specifying\na contact group resource name.",
194 "httpMethod": "GET",
195 "id": "people.contactGroups.get",
196 "parameterOrder": [
197 "resourceName"
198 ],
199 "parameters": {
200 "maxMembers": {
201 "description": "Specifies the maximum number of memb ers to return.",
202 "format": "int32",
203 "location": "query",
204 "type": "integer"
205 },
206 "resourceName": {
207 "description": "The resource name of the contact gro up to get.",
208 "location": "path",
209 "pattern": "^contactGroups/[^/]+$",
210 "required": true,
211 "type": "string"
212 }
213 },
214 "path": "v1/{+resourceName}",
215 "response": {
216 "$ref": "ContactGroup"
217 },
218 "scopes": [
219 "https://www.googleapis.com/auth/contacts",
220 "https://www.googleapis.com/auth/contacts.readonly"
221 ]
222 },
223 "update": {
224 "description": "Update the name of an existing contact group owned by the authenticated\nuser.",
225 "httpMethod": "PUT",
226 "id": "people.contactGroups.update",
227 "parameterOrder": [
228 "resourceName"
229 ],
230 "parameters": {
231 "resourceName": {
232 "description": "The resource name for the contact gr oup, assigned by the server. An ASCII\nstring, in the form of `contactGroups/<co ntact_group_id>`.",
233 "location": "path",
234 "pattern": "^contactGroups/[^/]+$",
235 "required": true,
236 "type": "string"
237 }
238 },
239 "path": "v1/{+resourceName}",
240 "request": {
241 "$ref": "UpdateContactGroupRequest"
242 },
243 "response": {
244 "$ref": "ContactGroup"
245 },
246 "scopes": [
247 "https://www.googleapis.com/auth/contacts"
248 ]
249 },
250 "batchGet": {
251 "description": "Get a list of contact groups owned by the au thenticated user by specifying\na list of contact group resource names.",
252 "httpMethod": "GET",
253 "id": "people.contactGroups.batchGet",
254 "parameterOrder": [],
255 "parameters": {
256 "maxMembers": {
257 "description": "Specifies the maximum number of memb ers to return for each group.",
258 "format": "int32",
259 "location": "query",
260 "type": "integer"
261 },
262 "resourceNames": {
263 "description": "The resource names of the contact gr oups to get.",
264 "location": "query",
265 "repeated": true,
266 "type": "string"
267 }
268 },
269 "path": "v1/contactGroups:batchGet",
270 "response": {
271 "$ref": "BatchGetContactGroupsResponse"
272 },
273 "scopes": [
274 "https://www.googleapis.com/auth/contacts",
275 "https://www.googleapis.com/auth/contacts.readonly"
276 ]
277 },
278 "delete": {
279 "description": "Delete an existing contact group owned by th e authenticated user by\nspecifying a contact group resource name.",
280 "httpMethod": "DELETE",
281 "id": "people.contactGroups.delete",
282 "parameterOrder": [
283 "resourceName"
284 ],
285 "parameters": {
286 "deleteContacts": {
287 "description": "Set to true to also delete the conta cts in the specified group.",
288 "location": "query",
289 "type": "boolean"
290 },
291 "resourceName": {
292 "description": "The resource name of the contact gro up to delete.",
293 "location": "path",
294 "pattern": "^contactGroups/[^/]+$",
295 "required": true,
296 "type": "string"
297 }
298 },
299 "path": "v1/{+resourceName}",
300 "response": {
301 "$ref": "Empty"
302 },
303 "scopes": [
304 "https://www.googleapis.com/auth/contacts"
305 ]
306 }
307 },
308 "resources": {
309 "members": {
310 "methods": {
311 "modify": {
312 "description": "Modify the members of a contact grou p owned by the authenticated user.",
313 "httpMethod": "POST",
314 "id": "people.contactGroups.members.modify",
315 "parameterOrder": [
316 "resourceName"
317 ],
318 "parameters": {
319 "resourceName": {
320 "description": "The resource name of the con tact group to modify.",
321 "location": "path",
322 "pattern": "^contactGroups/[^/]+$",
323 "required": true,
324 "type": "string"
325 }
326 },
327 "path": "v1/{+resourceName}/members:modify",
328 "request": {
329 "$ref": "ModifyContactGroupMembersRequest"
330 },
331 "response": {
332 "$ref": "ModifyContactGroupMembersResponse"
333 },
334 "scopes": [
335 "https://www.googleapis.com/auth/contacts"
336 ]
337 }
338 }
339 }
340 }
341 },
141 "people": { 342 "people": {
142 "methods": { 343 "methods": {
143 "getBatchGet": { 344 "getBatchGet": {
144 "description": "Provides information about a list of specifi c people by specifying a list\nof requested resource names. Use `people/me` to i ndicate the authenticated\nuser.", 345 "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.",
145 "httpMethod": "GET", 346 "httpMethod": "GET",
146 "id": "people.people.getBatchGet", 347 "id": "people.people.getBatchGet",
147 "parameterOrder": [], 348 "parameterOrder": [],
148 "parameters": { 349 "parameters": {
149 "requestMask.includeField": { 350 "requestMask.includeField": {
150 "description": "Required. Comma-separated list of pe rson fields to be included in the\nresponse. Each path should start with `person .`: for example,\n`person.names` or `person.photos`.", 351 "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`.",
151 "format": "google-fieldmask", 352 "format": "google-fieldmask",
152 "location": "query", 353 "location": "query",
153 "type": "string" 354 "type": "string"
154 }, 355 },
155 "resourceNames": { 356 "resourceNames": {
156 "description": "The resource name, such as one retur ned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list) ,\nof one of the people to provide information about. You can include this\npara meter up to 50 times in one request.", 357 "description": "The resource name, such as one retur ned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list) ,\nof one of the people to provide information about. You can include this\npara meter up to 50 times in one request.",
157 "location": "query", 358 "location": "query",
158 "repeated": true, 359 "repeated": true,
159 "type": "string" 360 "type": "string"
361 },
362 "personFields": {
363 "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",
364 "format": "google-fieldmask",
365 "location": "query",
366 "type": "string"
160 } 367 }
161 }, 368 },
162 "path": "v1/people:batchGet", 369 "path": "v1/people:batchGet",
163 "response": { 370 "response": {
164 "$ref": "GetPeopleResponse" 371 "$ref": "GetPeopleResponse"
165 }, 372 },
166 "scopes": [ 373 "scopes": [
167 "https://www.googleapis.com/auth/contacts", 374 "https://www.googleapis.com/auth/contacts",
168 "https://www.googleapis.com/auth/contacts.readonly", 375 "https://www.googleapis.com/auth/contacts.readonly",
169 "https://www.googleapis.com/auth/plus.login", 376 "https://www.googleapis.com/auth/plus.login",
170 "https://www.googleapis.com/auth/user.addresses.read", 377 "https://www.googleapis.com/auth/user.addresses.read",
171 "https://www.googleapis.com/auth/user.birthday.read", 378 "https://www.googleapis.com/auth/user.birthday.read",
172 "https://www.googleapis.com/auth/user.emails.read", 379 "https://www.googleapis.com/auth/user.emails.read",
173 "https://www.googleapis.com/auth/user.phonenumbers.read" , 380 "https://www.googleapis.com/auth/user.phonenumbers.read" ,
174 "https://www.googleapis.com/auth/userinfo.email", 381 "https://www.googleapis.com/auth/userinfo.email",
175 "https://www.googleapis.com/auth/userinfo.profile" 382 "https://www.googleapis.com/auth/userinfo.profile"
176 ] 383 ]
177 }, 384 },
178 "get": { 385 "get": {
179 "description": "Provides information about a person by speci fying a resource name. Use\n`people/me` to indicate the authenticated user.", 386 "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.",
180 "httpMethod": "GET", 387 "httpMethod": "GET",
181 "id": "people.people.get", 388 "id": "people.people.get",
182 "parameterOrder": [ 389 "parameterOrder": [
183 "resourceName" 390 "resourceName"
184 ], 391 ],
185 "parameters": { 392 "parameters": {
393 "personFields": {
394 "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",
395 "format": "google-fieldmask",
396 "location": "query",
397 "type": "string"
398 },
186 "resourceName": { 399 "resourceName": {
187 "description": "The resource name of the person to p rovide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about any user, specify the resource name that\n identifies the user, such as the resource names returned by\n [`pe ople.connections.list`](/people/api/rest/v1/people.connections/list).", 400 "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 `peop le/<account_id>`.\n- To get information about a contact, specify the resource na me that\n identifies the contact as returned by\n[`people.connections.list`](/p eople/api/rest/v1/people.connections/list).",
188 "location": "path", 401 "location": "path",
189 "pattern": "^people/[^/]+$", 402 "pattern": "^people/[^/]+$",
190 "required": true, 403 "required": true,
191 "type": "string" 404 "type": "string"
192 }, 405 },
193 "requestMask.includeField": { 406 "requestMask.includeField": {
194 "description": "Required. Comma-separated list of pe rson fields to be included in the\nresponse. Each path should start with `person .`: for example,\n`person.names` or `person.photos`.", 407 "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`.",
195 "format": "google-fieldmask", 408 "format": "google-fieldmask",
196 "location": "query", 409 "location": "query",
197 "type": "string" 410 "type": "string"
198 } 411 }
199 }, 412 },
200 "path": "v1/{+resourceName}", 413 "path": "v1/{+resourceName}",
201 "response": { 414 "response": {
202 "$ref": "Person" 415 "$ref": "Person"
203 }, 416 },
204 "scopes": [ 417 "scopes": [
205 "https://www.googleapis.com/auth/contacts", 418 "https://www.googleapis.com/auth/contacts",
206 "https://www.googleapis.com/auth/contacts.readonly", 419 "https://www.googleapis.com/auth/contacts.readonly",
207 "https://www.googleapis.com/auth/plus.login", 420 "https://www.googleapis.com/auth/plus.login",
208 "https://www.googleapis.com/auth/user.addresses.read", 421 "https://www.googleapis.com/auth/user.addresses.read",
209 "https://www.googleapis.com/auth/user.birthday.read", 422 "https://www.googleapis.com/auth/user.birthday.read",
210 "https://www.googleapis.com/auth/user.emails.read", 423 "https://www.googleapis.com/auth/user.emails.read",
211 "https://www.googleapis.com/auth/user.phonenumbers.read" , 424 "https://www.googleapis.com/auth/user.phonenumbers.read" ,
212 "https://www.googleapis.com/auth/userinfo.email", 425 "https://www.googleapis.com/auth/userinfo.email",
213 "https://www.googleapis.com/auth/userinfo.profile" 426 "https://www.googleapis.com/auth/userinfo.profile"
214 ] 427 ]
428 },
429 "updateContact": {
430 "description": "Update contact data for an existing contact person. Any non-contact data\nwill not be modified.\n\nThe request throws a 400 error if `updatePersonFields` is not specified.\n<br>\nThe request throws a 400 error if `person.metadata.sources` is not\nspecified for the contact to be updat ed.\n<br>\nThe request throws a 412 error if `person.metadata.sources.etag` is\n different than the contact's etag, which indicates the contact has changed\nsinc e its data was read. Clients should get the latest person and re-apply\ntheir up dates to the latest person.",
431 "httpMethod": "PATCH",
432 "id": "people.people.updateContact",
433 "parameterOrder": [
434 "resourceName"
435 ],
436 "parameters": {
437 "resourceName": {
438 "description": "The resource name for the person, as signed by the server. An ASCII string\nwith a max length of 27 characters, in th e form of `people/<person_id>`.",
439 "location": "path",
440 "pattern": "^people/[^/]+$",
441 "required": true,
442 "type": "string"
443 },
444 "updatePersonFields": {
445 "description": "**Required.** A field mask to restri ct which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* gender s\n* imClients\n* interests\n* locales\n* names\n* nicknames\n* occupations\n* o rganizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls",
446 "format": "google-fieldmask",
447 "location": "query",
448 "type": "string"
449 }
450 },
451 "path": "v1/{+resourceName}:updateContact",
452 "request": {
453 "$ref": "Person"
454 },
455 "response": {
456 "$ref": "Person"
457 },
458 "scopes": [
459 "https://www.googleapis.com/auth/contacts"
460 ]
461 },
462 "createContact": {
463 "description": "Create a new contact and return the person r esource for that contact.",
464 "httpMethod": "POST",
465 "id": "people.people.createContact",
466 "parameterOrder": [],
467 "parameters": {
468 "parent": {
469 "description": "The resource name of the owning pers on resource.",
470 "location": "query",
471 "type": "string"
472 }
473 },
474 "path": "v1/people:createContact",
475 "request": {
476 "$ref": "Person"
477 },
478 "response": {
479 "$ref": "Person"
480 },
481 "scopes": [
482 "https://www.googleapis.com/auth/contacts"
483 ]
484 },
485 "deleteContact": {
486 "description": "Delete a contact person. Any non-contact dat a will not be deleted.",
487 "httpMethod": "DELETE",
488 "id": "people.people.deleteContact",
489 "parameterOrder": [
490 "resourceName"
491 ],
492 "parameters": {
493 "resourceName": {
494 "description": "The resource name of the contact to delete.",
495 "location": "path",
496 "pattern": "^people/[^/]+$",
497 "required": true,
498 "type": "string"
499 }
500 },
501 "path": "v1/{+resourceName}:deleteContact",
502 "response": {
503 "$ref": "Empty"
504 },
505 "scopes": [
506 "https://www.googleapis.com/auth/contacts"
507 ]
215 } 508 }
216 }, 509 },
217 "resources": { 510 "resources": {
218 "connections": { 511 "connections": {
219 "methods": { 512 "methods": {
220 "list": { 513 "list": {
221 "description": "Provides a list of the authenticated user's contacts merged with any\nlinked profiles.", 514 "description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n<br>\nThe request throws a 400 error if 'personFields' is not specified.",
222 "httpMethod": "GET", 515 "httpMethod": "GET",
223 "id": "people.people.connections.list", 516 "id": "people.people.connections.list",
224 "parameterOrder": [ 517 "parameterOrder": [
225 "resourceName" 518 "resourceName"
226 ], 519 ],
227 "parameters": { 520 "parameters": {
228 "requestMask.includeField": { 521 "syncToken": {
229 "description": "Required. Comma-separated li st of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.", 522 "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sy nc token was created will be returned.",
230 "format": "google-fieldmask",
231 "location": "query", 523 "location": "query",
232 "type": "string" 524 "type": "string"
233 }, 525 },
234 "pageSize": { 526 "personFields": {
235 "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defau lts to 100.", 527 "description": "**Required.** A field mask t o restrict which fields on each person are\nreturned. Valid values are:\n\n* add resses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos \n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipSta tuses\n* residences\n* skills\n* taglines\n* urls",
236 "format": "int32", 528 "format": "google-fieldmask",
237 "location": "query",
238 "type": "integer"
239 },
240 "syncToken": {
241 "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sy nc token was created will be returned.",
242 "location": "query", 529 "location": "query",
243 "type": "string" 530 "type": "string"
244 }, 531 },
245 "sortOrder": { 532 "sortOrder": {
246 "description": "The order in which the conne ctions should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.", 533 "description": "The order in which the conne ctions should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
247 "enum": [ 534 "enum": [
248 "LAST_MODIFIED_ASCENDING", 535 "LAST_MODIFIED_ASCENDING",
249 "FIRST_NAME_ASCENDING", 536 "FIRST_NAME_ASCENDING",
250 "LAST_NAME_ASCENDING" 537 "LAST_NAME_ASCENDING"
251 ], 538 ],
252 "location": "query", 539 "location": "query",
253 "type": "string" 540 "type": "string"
254 }, 541 },
255 "requestSyncToken": { 542 "requestSyncToken": {
256 "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last reque st.", 543 "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last reque st.",
257 "location": "query", 544 "location": "query",
258 "type": "boolean" 545 "type": "boolean"
259 }, 546 },
547 "pageToken": {
548 "description": "The token of the page to be returned.",
549 "location": "query",
550 "type": "string"
551 },
260 "resourceName": { 552 "resourceName": {
261 "description": "The resource name to return connections for. Only `people/me` is valid.", 553 "description": "The resource name to return connections for. Only `people/me` is valid.",
262 "location": "path", 554 "location": "path",
263 "pattern": "^people/[^/]+$", 555 "pattern": "^people/[^/]+$",
264 "required": true, 556 "required": true,
265 "type": "string" 557 "type": "string"
266 }, 558 },
267 "pageToken": { 559 "pageSize": {
268 "description": "The token of the page to be returned.", 560 "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defau lts to 100.",
561 "format": "int32",
562 "location": "query",
563 "type": "integer"
564 },
565 "requestMask.includeField": {
566 "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`.",
567 "format": "google-fieldmask",
269 "location": "query", 568 "location": "query",
270 "type": "string" 569 "type": "string"
271 } 570 }
272 }, 571 },
273 "path": "v1/{+resourceName}/connections", 572 "path": "v1/{+resourceName}/connections",
274 "response": { 573 "response": {
275 "$ref": "ListConnectionsResponse" 574 "$ref": "ListConnectionsResponse"
276 }, 575 },
277 "scopes": [ 576 "scopes": [
278 "https://www.googleapis.com/auth/contacts", 577 "https://www.googleapis.com/auth/contacts",
279 "https://www.googleapis.com/auth/contacts.readon ly" 578 "https://www.googleapis.com/auth/contacts.readon ly"
280 ] 579 ]
281 } 580 }
282 } 581 }
283 } 582 }
284 } 583 }
285 } 584 }
286 }, 585 },
287 "revision": "20170608", 586 "revision": "20170706",
288 "rootUrl": "https://people.googleapis.com/", 587 "rootUrl": "https://people.googleapis.com/",
289 "schemas": { 588 "schemas": {
589 "AgeRangeType": {
590 "description": "A person's age range.",
591 "id": "AgeRangeType",
592 "properties": {
593 "metadata": {
594 "$ref": "FieldMetadata",
595 "description": "Metadata about the age range."
596 },
597 "ageRange": {
598 "description": "The age range.",
599 "enum": [
600 "AGE_RANGE_UNSPECIFIED",
601 "LESS_THAN_EIGHTEEN",
602 "EIGHTEEN_TO_TWENTY",
603 "TWENTY_ONE_OR_OLDER"
604 ],
605 "enumDescriptions": [
606 "Unspecified.",
607 "Younger than eighteen.",
608 "Between eighteen and twenty.",
609 "Twenty-one and older."
610 ],
611 "type": "string"
612 }
613 },
614 "type": "object"
615 },
616 "ListContactGroupsResponse": {
617 "description": "The response to a list contact groups request.",
618 "id": "ListContactGroupsResponse",
619 "properties": {
620 "contactGroups": {
621 "description": "The list of contact groups. Members of the c ontact groups are not\npopulated.",
622 "items": {
623 "$ref": "ContactGroup"
624 },
625 "type": "array"
626 },
627 "nextPageToken": {
628 "description": "The token that can be used to retrieve the n ext page of results.",
629 "type": "string"
630 },
631 "nextSyncToken": {
632 "description": "The token that can be used to retrieve chang es since the last request.",
633 "type": "string"
634 },
635 "totalItems": {
636 "description": "The total number of items in the list withou t pagination.",
637 "format": "int32",
638 "type": "integer"
639 }
640 },
641 "type": "object"
642 },
643 "PersonResponse": {
644 "description": "The response for a single person",
645 "id": "PersonResponse",
646 "properties": {
647 "person": {
648 "$ref": "Person",
649 "description": "The person."
650 },
651 "status": {
652 "$ref": "Status",
653 "description": "The status of the response."
654 },
655 "httpStatusCode": {
656 "description": "**DEPRECATED** (Please use status instead)\n \n[HTTP 1.1 status code]\n(http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.htm l).",
657 "format": "int32",
658 "type": "integer"
659 },
660 "requestedResourceName": {
661 "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.",
662 "type": "string"
663 }
664 },
665 "type": "object"
666 },
667 "Relation": {
668 "description": "A person's relation to another person.",
669 "id": "Relation",
670 "properties": {
671 "type": {
672 "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`",
673 "type": "string"
674 },
675 "metadata": {
676 "$ref": "FieldMetadata",
677 "description": "Metadata about the relation."
678 },
679 "formattedType": {
680 "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.",
681 "type": "string"
682 },
683 "person": {
684 "description": "The name of the other person this relation r efers to.",
685 "type": "string"
686 }
687 },
688 "type": "object"
689 },
690 "Occupation": {
691 "description": "A person's occupation.",
692 "id": "Occupation",
693 "properties": {
694 "metadata": {
695 "$ref": "FieldMetadata",
696 "description": "Metadata about the occupation."
697 },
698 "value": {
699 "description": "The occupation; for example, `carpenter`.",
700 "type": "string"
701 }
702 },
703 "type": "object"
704 },
705 "ContactGroup": {
706 "description": "A contact group.",
707 "id": "ContactGroup",
708 "properties": {
709 "memberResourceNames": {
710 "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).",
711 "items": {
712 "type": "string"
713 },
714 "type": "array"
715 },
716 "name": {
717 "description": "The contact group name set by the group owne r or a system provided name\nfor system groups.",
718 "type": "string"
719 },
720 "memberCount": {
721 "description": "The total number of contacts in the group ir respective of max members in\nspecified in the request.",
722 "format": "int32",
723 "type": "integer"
724 },
725 "metadata": {
726 "$ref": "ContactGroupMetadata",
727 "description": "Metadata about the contact group."
728 },
729 "resourceName": {
730 "description": "The resource name for the contact group, ass igned by the server. An ASCII\nstring, in the form of `contactGroups/<contact_gr oup_id>`.",
731 "type": "string"
732 },
733 "etag": {
734 "description": "The [HTTP entity tag](https://en.wikipedia.o rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
735 "type": "string"
736 },
737 "formattedName": {
738 "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.",
739 "type": "string"
740 },
741 "groupType": {
742 "description": "The read-only contact group type.",
743 "enum": [
744 "GROUP_TYPE_UNSPECIFIED",
745 "USER_CONTACT_GROUP",
746 "SYSTEM_CONTACT_GROUP"
747 ],
748 "enumDescriptions": [
749 "Unspecified.",
750 "User defined contact group.",
751 "System defined contact group."
752 ],
753 "type": "string"
754 }
755 },
756 "type": "object"
757 },
758 "Person": {
759 "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.",
760 "id": "Person",
761 "properties": {
762 "nicknames": {
763 "description": "The person's nicknames.",
764 "items": {
765 "$ref": "Nickname"
766 },
767 "type": "array"
768 },
769 "names": {
770 "description": "The person's names.",
771 "items": {
772 "$ref": "Name"
773 },
774 "type": "array"
775 },
776 "relations": {
777 "description": "The person's relations.",
778 "items": {
779 "$ref": "Relation"
780 },
781 "type": "array"
782 },
783 "occupations": {
784 "description": "The person's occupations.",
785 "items": {
786 "$ref": "Occupation"
787 },
788 "type": "array"
789 },
790 "emailAddresses": {
791 "description": "The person's email addresses.",
792 "items": {
793 "$ref": "EmailAddress"
794 },
795 "type": "array"
796 },
797 "organizations": {
798 "description": "The person's past or current organizations." ,
799 "items": {
800 "$ref": "Organization"
801 },
802 "type": "array"
803 },
804 "etag": {
805 "description": "The [HTTP entity tag](https://en.wikipedia.o rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
806 "type": "string"
807 },
808 "braggingRights": {
809 "description": "The person's bragging rights.",
810 "items": {
811 "$ref": "BraggingRights"
812 },
813 "type": "array"
814 },
815 "metadata": {
816 "$ref": "PersonMetadata",
817 "description": "Read-only metadata about the person."
818 },
819 "residences": {
820 "description": "The person's residences.",
821 "items": {
822 "$ref": "Residence"
823 },
824 "type": "array"
825 },
826 "genders": {
827 "description": "The person's genders.",
828 "items": {
829 "$ref": "Gender"
830 },
831 "type": "array"
832 },
833 "interests": {
834 "description": "The person's interests.",
835 "items": {
836 "$ref": "Interest"
837 },
838 "type": "array"
839 },
840 "resourceName": {
841 "description": "The resource name for the person, assigned b y the server. An ASCII string\nwith a max length of 27 characters, in the form o f `people/<person_id>`.",
842 "type": "string"
843 },
844 "biographies": {
845 "description": "The person's biographies.",
846 "items": {
847 "$ref": "Biography"
848 },
849 "type": "array"
850 },
851 "skills": {
852 "description": "The person's skills.",
853 "items": {
854 "$ref": "Skill"
855 },
856 "type": "array"
857 },
858 "relationshipStatuses": {
859 "description": "The person's read-only relationship statuses .",
860 "items": {
861 "$ref": "RelationshipStatus"
862 },
863 "type": "array"
864 },
865 "photos": {
866 "description": "The person's read-only photos.",
867 "items": {
868 "$ref": "Photo"
869 },
870 "type": "array"
871 },
872 "ageRange": {
873 "description": "**DEPRECATED** (Please use `person.ageRanges ` instead)**\n\nThe person's read-only age range.",
874 "enum": [
875 "AGE_RANGE_UNSPECIFIED",
876 "LESS_THAN_EIGHTEEN",
877 "EIGHTEEN_TO_TWENTY",
878 "TWENTY_ONE_OR_OLDER"
879 ],
880 "enumDescriptions": [
881 "Unspecified.",
882 "Younger than eighteen.",
883 "Between eighteen and twenty.",
884 "Twenty-one and older."
885 ],
886 "type": "string"
887 },
888 "taglines": {
889 "description": "The person's read-only taglines.",
890 "items": {
891 "$ref": "Tagline"
892 },
893 "type": "array"
894 },
895 "ageRanges": {
896 "description": "The person's read-only age ranges.",
897 "items": {
898 "$ref": "AgeRangeType"
899 },
900 "type": "array"
901 },
902 "addresses": {
903 "description": "The person's street addresses.",
904 "items": {
905 "$ref": "Address"
906 },
907 "type": "array"
908 },
909 "events": {
910 "description": "The person's events.",
911 "items": {
912 "$ref": "Event"
913 },
914 "type": "array"
915 },
916 "memberships": {
917 "description": "The person's read-only group memberships.",
918 "items": {
919 "$ref": "Membership"
920 },
921 "type": "array"
922 },
923 "phoneNumbers": {
924 "description": "The person's phone numbers.",
925 "items": {
926 "$ref": "PhoneNumber"
927 },
928 "type": "array"
929 },
930 "coverPhotos": {
931 "description": "The person's read-only cover photos.",
932 "items": {
933 "$ref": "CoverPhoto"
934 },
935 "type": "array"
936 },
937 "imClients": {
938 "description": "The person's instant messaging clients.",
939 "items": {
940 "$ref": "ImClient"
941 },
942 "type": "array"
943 },
944 "birthdays": {
945 "description": "The person's birthdays.",
946 "items": {
947 "$ref": "Birthday"
948 },
949 "type": "array"
950 },
951 "locales": {
952 "description": "The person's locale preferences.",
953 "items": {
954 "$ref": "Locale"
955 },
956 "type": "array"
957 },
958 "relationshipInterests": {
959 "description": "The person's read-only relationship interest s.",
960 "items": {
961 "$ref": "RelationshipInterest"
962 },
963 "type": "array"
964 },
965 "urls": {
966 "description": "The person's associated URLs.",
967 "items": {
968 "$ref": "Url"
969 },
970 "type": "array"
971 }
972 },
973 "type": "object"
974 },
975 "UpdateContactGroupRequest": {
976 "description": "A request to update an existing contact group. Only the name can be updated.",
977 "id": "UpdateContactGroupRequest",
978 "properties": {
979 "contactGroup": {
980 "$ref": "ContactGroup",
981 "description": "The contact group to update."
982 }
983 },
984 "type": "object"
985 },
986 "ContactGroupMetadata": {
987 "description": "The read-only metadata about a contact group.",
988 "id": "ContactGroupMetadata",
989 "properties": {
990 "updateTime": {
991 "description": "The time the group was last updated.",
992 "format": "google-datetime",
993 "type": "string"
994 },
995 "deleted": {
996 "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.",
997 "type": "boolean"
998 }
999 },
1000 "type": "object"
1001 },
1002 "Residence": {
1003 "description": "A person's past or current residence.",
1004 "id": "Residence",
1005 "properties": {
1006 "current": {
1007 "description": "True if the residence is the person's curren t residence;\nfalse if the residence is a past residence.",
1008 "type": "boolean"
1009 },
1010 "metadata": {
1011 "$ref": "FieldMetadata",
1012 "description": "Metadata about the residence."
1013 },
1014 "value": {
1015 "description": "The address of the residence.",
1016 "type": "string"
1017 }
1018 },
1019 "type": "object"
1020 },
1021 "Event": {
1022 "description": "An event related to the person.",
1023 "id": "Event",
1024 "properties": {
1025 "type": {
1026 "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`",
1027 "type": "string"
1028 },
1029 "metadata": {
1030 "$ref": "FieldMetadata",
1031 "description": "Metadata about the event."
1032 },
1033 "date": {
1034 "$ref": "Date",
1035 "description": "The date of the event."
1036 },
1037 "formattedType": {
1038 "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.",
1039 "type": "string"
1040 }
1041 },
1042 "type": "object"
1043 },
1044 "ModifyContactGroupMembersResponse": {
1045 "description": "The response to a modify contact group members reque st.",
1046 "id": "ModifyContactGroupMembersResponse",
1047 "properties": {
1048 "notFoundResourceNames": {
1049 "description": "The contact people resource names that were not found.",
1050 "items": {
1051 "type": "string"
1052 },
1053 "type": "array"
1054 }
1055 },
1056 "type": "object"
1057 },
1058 "ProfileMetadata": {
1059 "description": "The read-only metadata about a profile.",
1060 "id": "ProfileMetadata",
1061 "properties": {
1062 "objectType": {
1063 "description": "The profile object type.",
1064 "enum": [
1065 "OBJECT_TYPE_UNSPECIFIED",
1066 "PERSON",
1067 "PAGE"
1068 ],
1069 "enumDescriptions": [
1070 "Unspecified.",
1071 "Person.",
1072 "[Google+ Page.](http://www.google.com/+/brands/)"
1073 ],
1074 "type": "string"
1075 },
1076 "userTypes": {
1077 "description": "The user types.",
1078 "enumDescriptions": [
1079 "The user type is not known.",
1080 "The user is a Google user.",
1081 "The user is a Google+ user.",
1082 "The user is a Google Apps for Work user."
1083 ],
1084 "items": {
1085 "enum": [
1086 "USER_TYPE_UNKNOWN",
1087 "GOOGLE_USER",
1088 "GPLUS_USER",
1089 "GOOGLE_APPS_USER"
1090 ],
1091 "type": "string"
1092 },
1093 "type": "array"
1094 }
1095 },
1096 "type": "object"
1097 },
1098 "Gender": {
1099 "description": "A person's gender.",
1100 "id": "Gender",
1101 "properties": {
1102 "value": {
1103 "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`",
1104 "type": "string"
1105 },
1106 "formattedValue": {
1107 "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.",
1108 "type": "string"
1109 },
1110 "metadata": {
1111 "$ref": "FieldMetadata",
1112 "description": "Metadata about the gender."
1113 }
1114 },
1115 "type": "object"
1116 },
290 "CoverPhoto": { 1117 "CoverPhoto": {
291 "description": "A person's read-only cover photo. A large image show n on the person's\nprofile page that represents who they are or what they care a bout.", 1118 "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.",
292 "id": "CoverPhoto", 1119 "id": "CoverPhoto",
293 "properties": { 1120 "properties": {
1121 "url": {
1122 "description": "The URL of the cover photo.",
1123 "type": "string"
1124 },
294 "default": { 1125 "default": {
295 "description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.", 1126 "description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
296 "type": "boolean" 1127 "type": "boolean"
297 }, 1128 },
298 "metadata": { 1129 "metadata": {
299 "$ref": "FieldMetadata", 1130 "$ref": "FieldMetadata",
300 "description": "Metadata about the cover photo." 1131 "description": "Metadata about the cover photo."
301 },
302 "url": {
303 "description": "The URL of the cover photo.",
304 "type": "string"
305 } 1132 }
306 }, 1133 },
307 "type": "object" 1134 "type": "object"
308 }, 1135 },
309 "Interest": { 1136 "Interest": {
310 "description": "One of the person's interests.", 1137 "description": "One of the person's interests.",
311 "id": "Interest", 1138 "id": "Interest",
312 "properties": { 1139 "properties": {
1140 "metadata": {
1141 "$ref": "FieldMetadata",
1142 "description": "Metadata about the interest."
1143 },
313 "value": { 1144 "value": {
314 "description": "The interest; for example, `stargazing`.", 1145 "description": "The interest; for example, `stargazing`.",
315 "type": "string" 1146 "type": "string"
316 }, 1147 }
317 "metadata": { 1148 },
318 "$ref": "FieldMetadata", 1149 "type": "object"
319 "description": "Metadata about the interest." 1150 },
320 } 1151 "EmailAddress": {
321 }, 1152 "description": "A person's email address.",
322 "type": "object" 1153 "id": "EmailAddress",
323 }, 1154 "properties": {
324 "ImClient": { 1155 "displayName": {
325 "description": "A person's instant messaging client.", 1156 "description": "The display name of the email.",
326 "id": "ImClient", 1157 "type": "string"
327 "properties": { 1158 },
328 "formattedProtocol": { 1159 "type": {
329 "description": "The read-only protocol of the IM client form atted in the viewer's account\nlocale or the `Accept-Language` HTTP header local e.", 1160 "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`",
1161 "type": "string"
1162 },
1163 "metadata": {
1164 "$ref": "FieldMetadata",
1165 "description": "Metadata about the email address."
1166 },
1167 "value": {
1168 "description": "The email address.",
330 "type": "string" 1169 "type": "string"
331 }, 1170 },
332 "formattedType": { 1171 "formattedType": {
333 "description": "The read-only type of the IM client translat ed and formatted in the\nviewer's account locale or the `Accept-Language` HTTP h eader locale.", 1172 "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.",
334 "type": "string"
335 },
336 "metadata": {
337 "$ref": "FieldMetadata",
338 "description": "Metadata about the IM client."
339 },
340 "type": {
341 "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`",
342 "type": "string"
343 },
344 "protocol": {
345 "description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, t he following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\ n* `icq`\n* `jabber`\n* `netMeeting`",
346 "type": "string"
347 },
348 "username": {
349 "description": "The user name used in the IM client.",
350 "type": "string" 1173 "type": "string"
351 } 1174 }
352 }, 1175 },
353 "type": "object" 1176 "type": "object"
354 }, 1177 },
355 "Nickname": { 1178 "Nickname": {
356 "description": "A person's nickname.", 1179 "description": "A person's nickname.",
357 "id": "Nickname", 1180 "id": "Nickname",
358 "properties": { 1181 "properties": {
359 "type": { 1182 "type": {
(...skipping 18 matching lines...) Expand all
378 "$ref": "FieldMetadata", 1201 "$ref": "FieldMetadata",
379 "description": "Metadata about the nickname." 1202 "description": "Metadata about the nickname."
380 }, 1203 },
381 "value": { 1204 "value": {
382 "description": "The nickname.", 1205 "description": "The nickname.",
383 "type": "string" 1206 "type": "string"
384 } 1207 }
385 }, 1208 },
386 "type": "object" 1209 "type": "object"
387 }, 1210 },
388 "EmailAddress": {
389 "description": "A person's email address.",
390 "id": "EmailAddress",
391 "properties": {
392 "displayName": {
393 "description": "The display name of the email.",
394 "type": "string"
395 },
396 "type": {
397 "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the f ollowing:\n\n* `home`\n* `work`\n* `other`",
398 "type": "string"
399 },
400 "metadata": {
401 "$ref": "FieldMetadata",
402 "description": "Metadata about the email address."
403 },
404 "value": {
405 "description": "The email address.",
406 "type": "string"
407 },
408 "formattedType": {
409 "description": "The read-only type of the email address tran slated and formatted in the\nviewer's account locale or the `Accept-Language` HT TP header locale.",
410 "type": "string"
411 }
412 },
413 "type": "object"
414 },
415 "Skill": { 1211 "Skill": {
416 "description": "A skill that the person has.", 1212 "description": "A skill that the person has.",
417 "id": "Skill", 1213 "id": "Skill",
418 "properties": { 1214 "properties": {
419 "metadata": { 1215 "metadata": {
420 "$ref": "FieldMetadata", 1216 "$ref": "FieldMetadata",
421 "description": "Metadata about the skill." 1217 "description": "Metadata about the skill."
422 }, 1218 },
423 "value": { 1219 "value": {
424 "description": "The skill; for example, `underwater basket w eaving`.", 1220 "description": "The skill; for example, `underwater basket w eaving`.",
425 "type": "string" 1221 "type": "string"
426 } 1222 }
427 }, 1223 },
428 "type": "object" 1224 "type": "object"
429 }, 1225 },
430 "DomainMembership": { 1226 "Tagline": {
431 "description": "A Google Apps Domain membership.", 1227 "description": "A read-only brief one-line description of the person .",
432 "id": "DomainMembership", 1228 "id": "Tagline",
433 "properties": { 1229 "properties": {
434 "inViewerDomain": { 1230 "metadata": {
435 "description": "True if the person is in the viewer's Google Apps domain.", 1231 "$ref": "FieldMetadata",
436 "type": "boolean" 1232 "description": "Metadata about the tagline."
437 } 1233 },
438 }, 1234 "value": {
439 "type": "object" 1235 "description": "The tagline.",
440 },
441 "Membership": {
442 "description": "A person's read-only membership in a group.",
443 "id": "Membership",
444 "properties": {
445 "metadata": {
446 "$ref": "FieldMetadata",
447 "description": "Metadata about the membership."
448 },
449 "domainMembership": {
450 "$ref": "DomainMembership",
451 "description": "The domain membership."
452 },
453 "contactGroupMembership": {
454 "$ref": "ContactGroupMembership",
455 "description": "The contact group membership."
456 }
457 },
458 "type": "object"
459 },
460 "RelationshipStatus": {
461 "description": "A person's read-only relationship status.",
462 "id": "RelationshipStatus",
463 "properties": {
464 "formattedValue": {
465 "description": "The read-only value of the relationship stat us translated and formatted in\nthe viewer's account locale or the `Accept-Langu age` HTTP header locale.",
466 "type": "string"
467 },
468 "metadata": {
469 "$ref": "FieldMetadata",
470 "description": "Metadata about the relationship status."
471 },
472 "value": {
473 "description": "The relationship status. The value can be cu stom or predefined.\nPossible values include, but are not limited to, the follow ing:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplic ated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilU nion`",
474 "type": "string" 1236 "type": "string"
475 } 1237 }
476 }, 1238 },
477 "type": "object" 1239 "type": "object"
478 }, 1240 },
479 "Date": { 1241 "Date": {
480 "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](ht tps://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date .", 1242 "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 .",
481 "id": "Date", 1243 "id": "Date",
482 "properties": { 1244 "properties": {
483 "day": { 1245 "day": {
484 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not s ignificant.", 1246 "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.",
485 "format": "int32", 1247 "format": "int32",
486 "type": "integer" 1248 "type": "integer"
487 }, 1249 },
488 "year": { 1250 "year": {
489 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.", 1251 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.",
490 "format": "int32", 1252 "format": "int32",
491 "type": "integer" 1253 "type": "integer"
492 }, 1254 },
493 "month": { 1255 "month": {
494 "description": "Month of year. Must be from 1 to 12.", 1256 "description": "Month of year. Must be from 1 to 12.",
495 "format": "int32", 1257 "format": "int32",
496 "type": "integer" 1258 "type": "integer"
497 } 1259 }
498 }, 1260 },
499 "type": "object" 1261 "type": "object"
500 }, 1262 },
501 "Tagline": {
502 "description": "A read-only brief one-line description of the person .",
503 "id": "Tagline",
504 "properties": {
505 "metadata": {
506 "$ref": "FieldMetadata",
507 "description": "Metadata about the tagline."
508 },
509 "value": {
510 "description": "The tagline.",
511 "type": "string"
512 }
513 },
514 "type": "object"
515 },
516 "Name": { 1263 "Name": {
517 "description": "A person's name. If the name is a mononym, the famil y name is empty.", 1264 "description": "A person's name. If the name is a mononym, the famil y name is empty.",
518 "id": "Name", 1265 "id": "Name",
519 "properties": { 1266 "properties": {
520 "honorificPrefix": { 1267 "honorificPrefix": {
521 "description": "The honorific prefixes, such as `Mrs.` or `D r.`", 1268 "description": "The honorific prefixes, such as `Mrs.` or `D r.`",
522 "type": "string" 1269 "type": "string"
523 }, 1270 },
524 "phoneticHonorificSuffix": { 1271 "phoneticHonorificSuffix": {
525 "description": "The honorific suffixes spelled as they sound .", 1272 "description": "The honorific suffixes spelled as they sound .",
(...skipping 16 matching lines...) Expand all
542 "type": "string" 1289 "type": "string"
543 }, 1290 },
544 "phoneticFamilyName": { 1291 "phoneticFamilyName": {
545 "description": "The family name spelled as it sounds.", 1292 "description": "The family name spelled as it sounds.",
546 "type": "string" 1293 "type": "string"
547 }, 1294 },
548 "familyName": { 1295 "familyName": {
549 "description": "The family name.", 1296 "description": "The family name.",
550 "type": "string" 1297 "type": "string"
551 }, 1298 },
1299 "metadata": {
1300 "$ref": "FieldMetadata",
1301 "description": "Metadata about the name."
1302 },
552 "phoneticMiddleName": { 1303 "phoneticMiddleName": {
553 "description": "The middle name(s) spelled as they sound.", 1304 "description": "The middle name(s) spelled as they sound.",
554 "type": "string" 1305 "type": "string"
555 }, 1306 },
556 "metadata": {
557 "$ref": "FieldMetadata",
558 "description": "Metadata about the name."
559 },
560 "phoneticFullName": { 1307 "phoneticFullName": {
561 "description": "The full name spelled as it sounds.", 1308 "description": "The full name spelled as it sounds.",
562 "type": "string" 1309 "type": "string"
563 }, 1310 },
564 "displayNameLastFirst": { 1311 "displayNameLastFirst": {
565 "description": "The read-only display name with the last nam e first formatted according to\nthe locale specified by the viewer's account or the\n<code>Accept-Language</code> HTTP header.", 1312 "description": "The read-only display name with the last nam e first formatted according to\nthe locale specified by the viewer's account or the\n<code>Accept-Language</code> HTTP header.",
566 "type": "string" 1313 "type": "string"
567 }, 1314 },
568 "displayName": { 1315 "displayName": {
569 "description": "The read-only display name formatted accordi ng to the locale specified by\nthe viewer's account or the <code>Accept-Language </code> HTTP header.", 1316 "description": "The read-only display name formatted accordi ng to the locale specified by\nthe viewer's account or the <code>Accept-Language </code> HTTP header.",
570 "type": "string" 1317 "type": "string"
571 }, 1318 },
572 "honorificSuffix": { 1319 "honorificSuffix": {
573 "description": "The honorific suffixes, such as `Jr.`", 1320 "description": "The honorific suffixes, such as `Jr.`",
574 "type": "string" 1321 "type": "string"
575 } 1322 }
576 }, 1323 },
577 "type": "object" 1324 "type": "object"
578 }, 1325 },
579 "BraggingRights": {
580 "description": "A person's bragging rights.",
581 "id": "BraggingRights",
582 "properties": {
583 "metadata": {
584 "$ref": "FieldMetadata",
585 "description": "Metadata about the bragging rights."
586 },
587 "value": {
588 "description": "The bragging rights; for example, `climbed m ount everest`.",
589 "type": "string"
590 }
591 },
592 "type": "object"
593 },
594 "Locale": { 1326 "Locale": {
595 "description": "A person's locale preference.", 1327 "description": "A person's locale preference.",
596 "id": "Locale", 1328 "id": "Locale",
597 "properties": { 1329 "properties": {
1330 "metadata": {
1331 "$ref": "FieldMetadata",
1332 "description": "Metadata about the locale."
1333 },
598 "value": { 1334 "value": {
599 "description": "The well-formed [IETF BCP 47](https://tools. ietf.org/html/bcp47)\nlanguage tag representing the locale.", 1335 "description": "The well-formed [IETF BCP 47](https://tools. ietf.org/html/bcp47)\nlanguage tag representing the locale.",
600 "type": "string" 1336 "type": "string"
601 }, 1337 }
602 "metadata": { 1338 },
603 "$ref": "FieldMetadata", 1339 "type": "object"
604 "description": "Metadata about the locale." 1340 },
605 } 1341 "Empty": {
606 }, 1342 "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 `{}`.",
607 "type": "object" 1343 "id": "Empty",
608 }, 1344 "properties": {},
609 "Organization": {
610 "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
611 "id": "Organization",
612 "properties": {
613 "symbol": {
614 "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
615 "type": "string"
616 },
617 "name": {
618 "description": "The name of the organization.",
619 "type": "string"
620 },
621 "metadata": {
622 "$ref": "FieldMetadata",
623 "description": "Metadata about the organization."
624 },
625 "location": {
626 "description": "The location of the organization office the person works at.",
627 "type": "string"
628 },
629 "title": {
630 "description": "The person's job title at the organization." ,
631 "type": "string"
632 },
633 "current": {
634 "description": "True if the organization is the person's cur rent organization;\nfalse if the organization is a past organization.",
635 "type": "boolean"
636 },
637 "startDate": {
638 "$ref": "Date",
639 "description": "The start date when the person joined the or ganization."
640 },
641 "formattedType": {
642 "description": "The read-only type of the organization trans lated and formatted in the\nviewer's account locale or the `Accept-Language` HTT P header locale.",
643 "type": "string"
644 },
645 "domain": {
646 "description": "The domain name associated with the organiza tion; for example, `google.com`.",
647 "type": "string"
648 },
649 "department": {
650 "description": "The person's department at the organization. ",
651 "type": "string"
652 },
653 "type": {
654 "description": "The type of the organization. The type can b e custom or predefined.\nPossible values include, but are not limited to, the fo llowing:\n\n* `work`\n* `school`",
655 "type": "string"
656 },
657 "phoneticName": {
658 "description": "The phonetic name of the organization.",
659 "type": "string"
660 },
661 "jobDescription": {
662 "description": "The person's job description at the organiza tion.",
663 "type": "string"
664 },
665 "endDate": {
666 "$ref": "Date",
667 "description": "The end date when the person left the organi zation."
668 }
669 },
670 "type": "object" 1345 "type": "object"
671 }, 1346 },
672 "Biography": { 1347 "Biography": {
673 "description": "A person's short biography.", 1348 "description": "A person's short biography.",
674 "id": "Biography", 1349 "id": "Biography",
675 "properties": { 1350 "properties": {
676 "metadata": {
677 "$ref": "FieldMetadata",
678 "description": "Metadata about the biography."
679 },
680 "value": {
681 "description": "The short biography.",
682 "type": "string"
683 },
684 "contentType": { 1351 "contentType": {
685 "description": "The content type of the biography.", 1352 "description": "The content type of the biography.",
686 "enum": [ 1353 "enum": [
687 "CONTENT_TYPE_UNSPECIFIED", 1354 "CONTENT_TYPE_UNSPECIFIED",
688 "TEXT_PLAIN", 1355 "TEXT_PLAIN",
689 "TEXT_HTML" 1356 "TEXT_HTML"
690 ], 1357 ],
691 "enumDescriptions": [ 1358 "enumDescriptions": [
692 "Unspecified.", 1359 "Unspecified.",
693 "Plain text.", 1360 "Plain text.",
694 "HTML text." 1361 "HTML text."
695 ], 1362 ],
696 "type": "string" 1363 "type": "string"
697 } 1364 },
698 }, 1365 "metadata": {
699 "type": "object" 1366 "$ref": "FieldMetadata",
700 }, 1367 "description": "Metadata about the biography."
701 "AgeRangeType": { 1368 },
702 "description": "A person's age range.", 1369 "value": {
703 "id": "AgeRangeType", 1370 "description": "The short biography.",
704 "properties": { 1371 "type": "string"
705 "ageRange": {
706 "description": "The age range.",
707 "enum": [
708 "AGE_RANGE_UNSPECIFIED",
709 "LESS_THAN_EIGHTEEN",
710 "EIGHTEEN_TO_TWENTY",
711 "TWENTY_ONE_OR_OLDER"
712 ],
713 "enumDescriptions": [
714 "Unspecified.",
715 "Younger than eighteen.",
716 "Between eighteen and twenty.",
717 "Twenty-one and older."
718 ],
719 "type": "string"
720 },
721 "metadata": {
722 "$ref": "FieldMetadata",
723 "description": "Metadata about the age range."
724 } 1372 }
725 }, 1373 },
726 "type": "object" 1374 "type": "object"
727 }, 1375 },
728 "FieldMetadata": { 1376 "FieldMetadata": {
729 "description": "Metadata about a field.", 1377 "description": "Metadata about a field.",
730 "id": "FieldMetadata", 1378 "id": "FieldMetadata",
731 "properties": { 1379 "properties": {
1380 "source": {
1381 "$ref": "Source",
1382 "description": "The source of the field."
1383 },
1384 "verified": {
1385 "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.",
1386 "type": "boolean"
1387 },
732 "primary": { 1388 "primary": {
733 "description": "True if the field is the primary field; fals e if the field is a secondary\nfield.", 1389 "description": "True if the field is the primary field; fals e if the field is a secondary\nfield.",
734 "type": "boolean" 1390 "type": "boolean"
735 },
736 "source": {
737 "$ref": "Source",
738 "description": "The source of the field."
739 },
740 "verified": {
741 "description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
742 "type": "boolean"
743 }
744 },
745 "type": "object"
746 },
747 "PersonResponse": {
748 "description": "The response for a single person",
749 "id": "PersonResponse",
750 "properties": {
751 "httpStatusCode": {
752 "description": "DEPRECATED(Please use status instead).\n[HTT P 1.1 status\ncode](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).",
753 "format": "int32",
754 "type": "integer"
755 },
756 "requestedResourceName": {
757 "description": "The original requested resource name. May be different than the resource\nname on the returned person.\n\nThe resource name can change when adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or a\nprofile URL.",
758 "type": "string"
759 },
760 "person": {
761 "$ref": "Person",
762 "description": "The person."
763 },
764 "status": {
765 "$ref": "Status",
766 "description": "The status of the response."
767 }
768 },
769 "type": "object"
770 },
771 "RelationshipInterest": {
772 "description": "A person's read-only relationship interest .",
773 "id": "RelationshipInterest",
774 "properties": {
775 "value": {
776 "description": "The kind of relationship the person is looki ng for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship `\n* `networking`",
777 "type": "string"
778 },
779 "formattedValue": {
780 "description": "The value of the relationship interest trans lated and formatted in the\nviewer's account locale or the locale specified in t he Accept-Language\nHTTP header.",
781 "type": "string"
782 },
783 "metadata": {
784 "$ref": "FieldMetadata",
785 "description": "Metadata about the relationship interest."
786 } 1391 }
787 }, 1392 },
788 "type": "object" 1393 "type": "object"
789 }, 1394 },
790 "Source": { 1395 "Source": {
791 "description": "The source of a field.", 1396 "description": "The source of a field.",
792 "id": "Source", 1397 "id": "Source",
793 "properties": { 1398 "properties": {
794 "etag": { 1399 "etag": {
795 "description": "The [HTTP entity tag](https://en.wikipedia.o rg/wiki/HTTP_ETag) of the\nsource. Used for web cache validation. Only populated in\nperson.metadata.sources.", 1400 "description": "The [HTTP entity tag](https://en.wikipedia.o rg/wiki/HTTP_ETag) of the\nsource. Used for web cache validation. Only populated in\nperson.metadata.sources.",
796 "type": "string" 1401 "type": "string"
797 }, 1402 },
798 "id": { 1403 "id": {
799 "description": "The unique identifier within the source type generated by the server.", 1404 "description": "The unique identifier within the source type generated by the server.",
800 "type": "string" 1405 "type": "string"
801 }, 1406 },
802 "profileMetadata": { 1407 "profileMetadata": {
803 "$ref": "ProfileMetadata", 1408 "$ref": "ProfileMetadata",
804 "description": "Metadata about a source of type PROFILE." 1409 "description": "Metadata about a source of type PROFILE."
805 }, 1410 },
1411 "updateTime": {
1412 "description": "Last update timestamp of this source.",
1413 "format": "google-datetime",
1414 "type": "string"
1415 },
806 "type": { 1416 "type": {
807 "description": "The source type.", 1417 "description": "The source type.",
808 "enum": [ 1418 "enum": [
809 "SOURCE_TYPE_UNSPECIFIED", 1419 "SOURCE_TYPE_UNSPECIFIED",
810 "ACCOUNT", 1420 "ACCOUNT",
811 "PROFILE", 1421 "PROFILE",
812 "DOMAIN_PROFILE", 1422 "DOMAIN_PROFILE",
813 "CONTACT" 1423 "CONTACT"
814 ], 1424 ],
815 "enumDescriptions": [ 1425 "enumDescriptions": [
816 "Unspecified.", 1426 "Unspecified.",
817 "[Google Account](https://accounts.google.com).", 1427 "[Google Account](https://accounts.google.com).",
818 "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/<id> where <id> is the source\n id.", 1428 "[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.",
819 "[Google Apps domain profile](https://admin.google.com). ", 1429 "[Google Apps domain profile](https://admin.google.com). ",
820 "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/<id> where <id> is the source\ni d." 1430 "[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."
821 ], 1431 ],
822 "type": "string" 1432 "type": "string"
823 } 1433 }
824 }, 1434 },
825 "type": "object" 1435 "type": "object"
826 }, 1436 },
827 "Relation": { 1437 "RelationshipInterest": {
828 "description": "A person's relation to another person.", 1438 "description": "A person's read-only relationship interest .",
829 "id": "Relation", 1439 "id": "RelationshipInterest",
830 "properties": { 1440 "properties": {
831 "type": { 1441 "formattedValue": {
832 "description": "The person's relation to the other person. T he type can be custom or predefined.\nPossible values include, but are not limit ed to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner `\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`", 1442 "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.",
833 "type": "string" 1443 "type": "string"
834 }, 1444 },
835 "metadata": { 1445 "metadata": {
836 "$ref": "FieldMetadata", 1446 "$ref": "FieldMetadata",
837 "description": "Metadata about the relation." 1447 "description": "Metadata about the relationship interest."
838 }, 1448 },
839 "formattedType": { 1449 "value": {
840 "description": "The type of the relation translated and form atted in the viewer's account\nlocale or the locale specified in the Accept-Lang uage HTTP header.", 1450 "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`",
841 "type": "string" 1451 "type": "string"
842 }, 1452 }
843 "person": { 1453 },
844 "description": "The name of the other person this relation r efers to.", 1454 "type": "object"
845 "type": "string"
846 }
847 },
848 "type": "object"
849 },
850 "Occupation": {
851 "description": "A person's occupation.",
852 "id": "Occupation",
853 "properties": {
854 "metadata": {
855 "$ref": "FieldMetadata",
856 "description": "Metadata about the occupation."
857 },
858 "value": {
859 "description": "The occupation; for example, `carpenter`.",
860 "type": "string"
861 }
862 },
863 "type": "object"
864 },
865 "Person": {
866 "description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data.\n\nMost fie lds can have multiple items. The items in a field have no guaranteed\norder, but each non-empty field is guaranteed to have exactly one field with\n`metadata.pr imary` set to true.",
867 "id": "Person",
868 "properties": {
869 "resourceName": {
870 "description": "The resource name for the person, assigned b y the server. An ASCII string\nwith a max length of 27 characters, in the form o f `people/<person_id>`.",
871 "type": "string"
872 },
873 "interests": {
874 "description": "The person's interests.",
875 "items": {
876 "$ref": "Interest"
877 },
878 "type": "array"
879 },
880 "biographies": {
881 "description": "The person's biographies.",
882 "items": {
883 "$ref": "Biography"
884 },
885 "type": "array"
886 },
887 "skills": {
888 "description": "The person's skills.",
889 "items": {
890 "$ref": "Skill"
891 },
892 "type": "array"
893 },
894 "relationshipStatuses": {
895 "description": "The person's relationship statuses.",
896 "items": {
897 "$ref": "RelationshipStatus"
898 },
899 "type": "array"
900 },
901 "photos": {
902 "description": "The person's photos.",
903 "items": {
904 "$ref": "Photo"
905 },
906 "type": "array"
907 },
908 "ageRange": {
909 "description": "DEPRECATED(Please read person.age_ranges ins tead). The person's age range.",
910 "enum": [
911 "AGE_RANGE_UNSPECIFIED",
912 "LESS_THAN_EIGHTEEN",
913 "EIGHTEEN_TO_TWENTY",
914 "TWENTY_ONE_OR_OLDER"
915 ],
916 "enumDescriptions": [
917 "Unspecified.",
918 "Younger than eighteen.",
919 "Between eighteen and twenty.",
920 "Twenty-one and older."
921 ],
922 "type": "string"
923 },
924 "taglines": {
925 "description": "The person's taglines.",
926 "items": {
927 "$ref": "Tagline"
928 },
929 "type": "array"
930 },
931 "ageRanges": {
932 "description": "The person's age ranges.",
933 "items": {
934 "$ref": "AgeRangeType"
935 },
936 "type": "array"
937 },
938 "addresses": {
939 "description": "The person's street addresses.",
940 "items": {
941 "$ref": "Address"
942 },
943 "type": "array"
944 },
945 "events": {
946 "description": "The person's events.",
947 "items": {
948 "$ref": "Event"
949 },
950 "type": "array"
951 },
952 "memberships": {
953 "description": "The person's group memberships.",
954 "items": {
955 "$ref": "Membership"
956 },
957 "type": "array"
958 },
959 "phoneNumbers": {
960 "description": "The person's phone numbers.",
961 "items": {
962 "$ref": "PhoneNumber"
963 },
964 "type": "array"
965 },
966 "coverPhotos": {
967 "description": "The person's cover photos.",
968 "items": {
969 "$ref": "CoverPhoto"
970 },
971 "type": "array"
972 },
973 "imClients": {
974 "description": "The person's instant messaging clients.",
975 "items": {
976 "$ref": "ImClient"
977 },
978 "type": "array"
979 },
980 "birthdays": {
981 "description": "The person's birthdays.",
982 "items": {
983 "$ref": "Birthday"
984 },
985 "type": "array"
986 },
987 "locales": {
988 "description": "The person's locale preferences.",
989 "items": {
990 "$ref": "Locale"
991 },
992 "type": "array"
993 },
994 "relationshipInterests": {
995 "description": "The kind of relationship the person is looki ng for.",
996 "items": {
997 "$ref": "RelationshipInterest"
998 },
999 "type": "array"
1000 },
1001 "urls": {
1002 "description": "The person's associated URLs.",
1003 "items": {
1004 "$ref": "Url"
1005 },
1006 "type": "array"
1007 },
1008 "nicknames": {
1009 "description": "The person's nicknames.",
1010 "items": {
1011 "$ref": "Nickname"
1012 },
1013 "type": "array"
1014 },
1015 "names": {
1016 "description": "The person's names.",
1017 "items": {
1018 "$ref": "Name"
1019 },
1020 "type": "array"
1021 },
1022 "relations": {
1023 "description": "The person's relations.",
1024 "items": {
1025 "$ref": "Relation"
1026 },
1027 "type": "array"
1028 },
1029 "occupations": {
1030 "description": "The person's occupations.",
1031 "items": {
1032 "$ref": "Occupation"
1033 },
1034 "type": "array"
1035 },
1036 "emailAddresses": {
1037 "description": "The person's email addresses.",
1038 "items": {
1039 "$ref": "EmailAddress"
1040 },
1041 "type": "array"
1042 },
1043 "organizations": {
1044 "description": "The person's past or current organizations." ,
1045 "items": {
1046 "$ref": "Organization"
1047 },
1048 "type": "array"
1049 },
1050 "etag": {
1051 "description": "The [HTTP entity tag](https://en.wikipedia.o rg/wiki/HTTP_ETag) of the\nresource. Used for web cache validation.",
1052 "type": "string"
1053 },
1054 "braggingRights": {
1055 "description": "The person's bragging rights.",
1056 "items": {
1057 "$ref": "BraggingRights"
1058 },
1059 "type": "array"
1060 },
1061 "metadata": {
1062 "$ref": "PersonMetadata",
1063 "description": "Metadata about the person."
1064 },
1065 "residences": {
1066 "description": "The person's residences.",
1067 "items": {
1068 "$ref": "Residence"
1069 },
1070 "type": "array"
1071 },
1072 "genders": {
1073 "description": "The person's genders.",
1074 "items": {
1075 "$ref": "Gender"
1076 },
1077 "type": "array"
1078 }
1079 },
1080 "type": "object"
1081 }, 1455 },
1082 "GetPeopleResponse": { 1456 "GetPeopleResponse": {
1083 "id": "GetPeopleResponse", 1457 "id": "GetPeopleResponse",
1084 "properties": { 1458 "properties": {
1085 "responses": { 1459 "responses": {
1086 "description": "The response for each requested resource nam e.", 1460 "description": "The response for each requested resource nam e.",
1087 "items": { 1461 "items": {
1088 "$ref": "PersonResponse" 1462 "$ref": "PersonResponse"
1089 }, 1463 },
1090 "type": "array" 1464 "type": "array"
1091 } 1465 }
1092 }, 1466 },
1093 "type": "object" 1467 "type": "object"
1094 }, 1468 },
1095 "Photo": { 1469 "Photo": {
1096 "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.", 1470 "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
1097 "id": "Photo", 1471 "id": "Photo",
1098 "properties": { 1472 "properties": {
1473 "metadata": {
1474 "$ref": "FieldMetadata",
1475 "description": "Metadata about the photo."
1476 },
1099 "url": { 1477 "url": {
1100 "description": "The URL of the photo. You can change the des ired size by appending a query\nparameter `sz=<size>` at the end of the url. Exa mple:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/0 0gzXvDBYqw/s100/photo.jpg?sz=50`", 1478 "description": "The URL of the photo. You can change the des ired size by appending a query\nparameter `sz=<size>` at the end of the url. Exa mple:\n`https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/0 0gzXvDBYqw/s100/photo.jpg?sz=50`",
1101 "type": "string" 1479 "type": "string"
1102 },
1103 "metadata": {
1104 "$ref": "FieldMetadata",
1105 "description": "Metadata about the photo."
1106 } 1480 }
1107 }, 1481 },
1108 "type": "object" 1482 "type": "object"
1109 }, 1483 },
1110 "PhoneNumber": { 1484 "PhoneNumber": {
1111 "description": "A person's phone number.", 1485 "description": "A person's phone number.",
1112 "id": "PhoneNumber", 1486 "id": "PhoneNumber",
1113 "properties": { 1487 "properties": {
1114 "type": { 1488 "type": {
1115 "description": "The type of the phone number. The type can b e custom or predefined.\nPossible values include, but are not limited to, the fo llowing:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFa x`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `othe r`", 1489 "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`",
1116 "type": "string" 1490 "type": "string"
1117 }, 1491 },
1118 "metadata": { 1492 "metadata": {
1119 "$ref": "FieldMetadata", 1493 "$ref": "FieldMetadata",
1120 "description": "Metadata about the phone number." 1494 "description": "Metadata about the phone number."
1121 }, 1495 },
1122 "value": { 1496 "value": {
1123 "description": "The phone number.", 1497 "description": "The phone number.",
1124 "type": "string" 1498 "type": "string"
1125 }, 1499 },
1126 "formattedType": { 1500 "formattedType": {
1127 "description": "The read-only type of the phone number trans lated and formatted in the\nviewer's account locale or the the `Accept-Language` HTTP header locale.", 1501 "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.",
1128 "type": "string" 1502 "type": "string"
1129 }, 1503 },
1130 "canonicalForm": { 1504 "canonicalForm": {
1131 "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.", 1505 "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.",
1132 "type": "string" 1506 "type": "string"
1133 } 1507 }
1134 }, 1508 },
1135 "type": "object" 1509 "type": "object"
1136 }, 1510 },
1137 "ListConnectionsResponse": { 1511 "ListConnectionsResponse": {
(...skipping 13 matching lines...) Expand all
1151 "type": "string" 1525 "type": "string"
1152 }, 1526 },
1153 "connections": { 1527 "connections": {
1154 "description": "The list of people that the requestor is con nected to.", 1528 "description": "The list of people that the requestor is con nected to.",
1155 "items": { 1529 "items": {
1156 "$ref": "Person" 1530 "$ref": "Person"
1157 }, 1531 },
1158 "type": "array" 1532 "type": "array"
1159 }, 1533 },
1160 "totalPeople": { 1534 "totalPeople": {
1161 "description": "DEPRECATED(Please use total_items). The tota l number of people in the list\nwithout pagination.", 1535 "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.",
1162 "format": "int32", 1536 "format": "int32",
1163 "type": "integer" 1537 "type": "integer"
1164 } 1538 }
1165 }, 1539 },
1166 "type": "object" 1540 "type": "object"
1167 }, 1541 },
1168 "Birthday": { 1542 "Birthday": {
1169 "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.", 1543 "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.",
1170 "id": "Birthday", 1544 "id": "Birthday",
1171 "properties": { 1545 "properties": {
1546 "date": {
1547 "$ref": "Date",
1548 "description": "The date of the birthday."
1549 },
1172 "text": { 1550 "text": {
1173 "description": "A free-form string representing the user's b irthday.", 1551 "description": "A free-form string representing the user's b irthday.",
1174 "type": "string" 1552 "type": "string"
1175 }, 1553 },
1176 "metadata": { 1554 "metadata": {
1177 "$ref": "FieldMetadata", 1555 "$ref": "FieldMetadata",
1178 "description": "Metadata about the birthday." 1556 "description": "Metadata about the birthday."
1179 },
1180 "date": {
1181 "$ref": "Date",
1182 "description": "The date of the birthday."
1183 } 1557 }
1184 }, 1558 },
1185 "type": "object" 1559 "type": "object"
1560 },
1561 "CreateContactGroupRequest": {
1562 "description": "A request to create a new contact group.",
1563 "id": "CreateContactGroupRequest",
1564 "properties": {
1565 "contactGroup": {
1566 "$ref": "ContactGroup",
1567 "description": "The contact group to create."
1568 }
1569 },
1570 "type": "object"
1186 }, 1571 },
1187 "Address": { 1572 "Address": {
1188 "description": "A person's physical address. May be a P.O. box or st reet address. All fields\nare optional.", 1573 "description": "A person's physical address. May be a P.O. box or st reet address. All fields\nare optional.",
1189 "id": "Address", 1574 "id": "Address",
1190 "properties": { 1575 "properties": {
1191 "region": {
1192 "description": "The region of the address; for example, the state or province.",
1193 "type": "string"
1194 },
1195 "streetAddress": {
1196 "description": "The street address.",
1197 "type": "string"
1198 },
1199 "metadata": {
1200 "$ref": "FieldMetadata",
1201 "description": "Metadata about the address."
1202 },
1203 "countryCode": { 1576 "countryCode": {
1204 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/ iso/country_codes.htm) country\ncode of the address.", 1577 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/ iso/country_codes.htm) country\ncode of the address.",
1205 "type": "string" 1578 "type": "string"
1206 }, 1579 },
1207 "formattedType": { 1580 "formattedType": {
1208 "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP hea der locale.", 1581 "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP hea der locale.",
1209 "type": "string" 1582 "type": "string"
1210 }, 1583 },
1211 "city": { 1584 "city": {
1212 "description": "The city of the address.", 1585 "description": "The city of the address.",
(...skipping 15 matching lines...) Expand all
1228 "description": "The extended address of the address; for exa mple, the apartment number.", 1601 "description": "The extended address of the address; for exa mple, the apartment number.",
1229 "type": "string" 1602 "type": "string"
1230 }, 1603 },
1231 "poBox": { 1604 "poBox": {
1232 "description": "The P.O. box of the address.", 1605 "description": "The P.O. box of the address.",
1233 "type": "string" 1606 "type": "string"
1234 }, 1607 },
1235 "postalCode": { 1608 "postalCode": {
1236 "description": "The postal code of the address.", 1609 "description": "The postal code of the address.",
1237 "type": "string" 1610 "type": "string"
1611 },
1612 "region": {
1613 "description": "The region of the address; for example, the state or province.",
1614 "type": "string"
1615 },
1616 "streetAddress": {
1617 "description": "The street address.",
1618 "type": "string"
1619 },
1620 "metadata": {
1621 "$ref": "FieldMetadata",
1622 "description": "Metadata about the address."
1238 } 1623 }
1239 }, 1624 },
1240 "type": "object" 1625 "type": "object"
1241 },
1242 "Residence": {
1243 "description": "A person's past or current residence.",
1244 "id": "Residence",
1245 "properties": {
1246 "current": {
1247 "description": "True if the residence is the person's curren t residence;\nfalse if the residence is a past residence.",
1248 "type": "boolean"
1249 },
1250 "metadata": {
1251 "$ref": "FieldMetadata",
1252 "description": "Metadata about the residence."
1253 },
1254 "value": {
1255 "description": "The address of the residence.",
1256 "type": "string"
1257 }
1258 },
1259 "type": "object"
1260 }, 1626 },
1261 "Status": { 1627 "Status": {
1262 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", 1628 "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RP C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie ces of data: error code, error message,\nand error details. The error code shoul d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message tha t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa cing\nerror message is needed, put the localized message in the error details or \nlocalize it in the client. The optional error details may contain arbitrary\ni nformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Lang uage mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n \nThe error model and the `Status` message can be used in a variety of\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n - Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
1263 "id": "Status", 1629 "id": "Status",
1264 "properties": { 1630 "properties": {
1265 "code": { 1631 "code": {
1266 "description": "The status code, which should be an enum val ue of google.rpc.Code.", 1632 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
1267 "format": "int32", 1633 "format": "int32",
1268 "type": "integer" 1634 "type": "integer"
1269 }, 1635 },
1270 "message": { 1636 "message": {
1271 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", 1637 "description": "A developer-facing error message, which shou ld be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
1272 "type": "string" 1638 "type": "string"
1273 }, 1639 },
1274 "details": { 1640 "details": {
1275 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.", 1641 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.",
1276 "items": { 1642 "items": {
1277 "additionalProperties": { 1643 "additionalProperties": {
1278 "description": "Properties of the object. Contains f ield @type with type URL.", 1644 "description": "Properties of the object. Contains f ield @type with type URL.",
1279 "type": "any" 1645 "type": "any"
1280 }, 1646 },
1281 "type": "object" 1647 "type": "object"
1282 }, 1648 },
1283 "type": "array" 1649 "type": "array"
1284 } 1650 }
1285 }, 1651 },
1286 "type": "object" 1652 "type": "object"
1287 }, 1653 },
1288 "ContactGroupMembership": { 1654 "ContactGroupMembership": {
1289 "description": "A Google contact group membership.", 1655 "description": "A Google contact group membership.",
1290 "id": "ContactGroupMembership", 1656 "id": "ContactGroupMembership",
1291 "properties": { 1657 "properties": {
1292 "contactGroupId": { 1658 "contactGroupId": {
1293 "description": "The contact group ID for the contact group m embership. The contact group\nID can be custom or predefined. Possible values in clude, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\ n* A numerical ID for user-created groups.", 1659 "description": "The contact group ID for the contact group m embership. The contact group\nID can be custom or predefined. Possible values in clude, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\ n* A numerical ID for user-created groups.",
1294 "type": "string" 1660 "type": "string"
1295 } 1661 }
1296 }, 1662 },
1297 "type": "object" 1663 "type": "object"
1298 }, 1664 },
1299 "PersonMetadata": { 1665 "PersonMetadata": {
1300 "description": "The read-only metadata about a person.", 1666 "description": "The read-only metadata about a person.",
1301 "id": "PersonMetadata", 1667 "id": "PersonMetadata",
1302 "properties": { 1668 "properties": {
1669 "objectType": {
1670 "description": "**DEPRECATED** (Please use\n`person.metadata .sources.profileMetadata.objectType` instead)\n\nThe type of the person object." ,
1671 "enum": [
1672 "OBJECT_TYPE_UNSPECIFIED",
1673 "PERSON",
1674 "PAGE"
1675 ],
1676 "enumDescriptions": [
1677 "Unspecified.",
1678 "Person.",
1679 "[Google+ Page.](http://www.google.com/+/brands/)"
1680 ],
1681 "type": "string"
1682 },
1683 "linkedPeopleResourceNames": {
1684 "description": "Resource names of people linked to this reso urce.",
1685 "items": {
1686 "type": "string"
1687 },
1688 "type": "array"
1689 },
1303 "previousResourceNames": { 1690 "previousResourceNames": {
1304 "description": "Any former resource names this person has ha d. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connectio ns/list) requests\nthat include a sync token.\n\nThe resource name may change wh en adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.", 1691 "description": "Any former resource names this person has ha d. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connectio ns/list) requests\nthat include a sync token.\n\nThe resource name may change wh en adding or removing fields that link a\ncontact and profile such as a verified email, verified phone number, or\nprofile URL.",
1305 "items": { 1692 "items": {
1306 "type": "string" 1693 "type": "string"
1307 }, 1694 },
1308 "type": "array" 1695 "type": "array"
1309 }, 1696 },
1310 "sources": { 1697 "sources": {
1311 "description": "The sources of data for the person.", 1698 "description": "The sources of data for the person.",
1312 "items": { 1699 "items": {
1313 "$ref": "Source" 1700 "$ref": "Source"
1314 }, 1701 },
1315 "type": "array" 1702 "type": "array"
1316 }, 1703 },
1317 "deleted": { 1704 "deleted": {
1318 "description": "True if the person resource has been deleted . Populated only for\n[`connections.list`](/people/api/rest/v1/people.connection s/list) requests\nthat include a sync token.", 1705 "description": "True if the person resource has been deleted . Populated only for\n[`connections.list`](/people/api/rest/v1/people.connection s/list) requests\nthat include a sync token.",
1319 "type": "boolean" 1706 "type": "boolean"
1320 }, 1707 }
1321 "objectType": { 1708 },
1322 "description": "DEPRECATED(Please read person.metadata.sourc es.profile_metadata instead).\nThe type of the person object.", 1709 "type": "object"
1323 "enum": [ 1710 },
1324 "OBJECT_TYPE_UNSPECIFIED", 1711 "ModifyContactGroupMembersRequest": {
1325 "PERSON", 1712 "description": "A request to modify an existing contact group's memb ers.",
1326 "PAGE" 1713 "id": "ModifyContactGroupMembersRequest",
1327 ], 1714 "properties": {
1328 "enumDescriptions": [ 1715 "resourceNamesToRemove": {
1329 "Unspecified.", 1716 "description": "The resource names of the contact people to remove in the form of in the\nform of `people/<person_id>`.",
1330 "Person.",
1331 "[Google+ Page.](http://www.google.com/+/brands/)"
1332 ],
1333 "type": "string"
1334 },
1335 "linkedPeopleResourceNames": {
1336 "description": "Resource names of people linked to this reso urce.",
1337 "items": { 1717 "items": {
1338 "type": "string" 1718 "type": "string"
1339 }, 1719 },
1720 "type": "array"
1721 },
1722 "resourceNamesToAdd": {
1723 "description": "The resource names of the contact people to add in the form of in the form\n`people/<person_id>`.",
1724 "items": {
1725 "type": "string"
1726 },
1340 "type": "array" 1727 "type": "array"
1341 } 1728 }
1342 }, 1729 },
1343 "type": "object" 1730 "type": "object"
1344 }, 1731 },
1345 "Event": { 1732 "ContactGroupResponse": {
1346 "description": "An event related to the person.", 1733 "description": "The response for a specific contact group.",
1347 "id": "Event", 1734 "id": "ContactGroupResponse",
1348 "properties": { 1735 "properties": {
1349 "formattedType": { 1736 "contactGroup": {
1350 "description": "The read-only type of the event translated a nd formatted in the\nviewer's account locale or the `Accept-Language` HTTP heade r locale.", 1737 "$ref": "ContactGroup",
1351 "type": "string" 1738 "description": "The contact group."
1352 }, 1739 },
1353 "type": { 1740 "status": {
1354 "description": "The type of the event. The type can be custo m or predefined.\nPossible values include, but are not limited to, the following :\n\n* `anniversary`\n* `other`", 1741 "$ref": "Status",
1355 "type": "string" 1742 "description": "The status of the response."
1356 }, 1743 },
1357 "metadata": { 1744 "requestedResourceName": {
1358 "$ref": "FieldMetadata", 1745 "description": "The original requested resource name.",
1359 "description": "Metadata about the event."
1360 },
1361 "date": {
1362 "$ref": "Date",
1363 "description": "The date of the event."
1364 }
1365 },
1366 "type": "object"
1367 },
1368 "ProfileMetadata": {
1369 "description": "The read-only metadata about a profile.",
1370 "id": "ProfileMetadata",
1371 "properties": {
1372 "objectType": {
1373 "description": "The profile object type.",
1374 "enum": [
1375 "OBJECT_TYPE_UNSPECIFIED",
1376 "PERSON",
1377 "PAGE"
1378 ],
1379 "enumDescriptions": [
1380 "Unspecified.",
1381 "Person.",
1382 "[Google+ Page.](http://www.google.com/+/brands/)"
1383 ],
1384 "type": "string"
1385 }
1386 },
1387 "type": "object"
1388 },
1389 "Gender": {
1390 "description": "A person's gender.",
1391 "id": "Gender",
1392 "properties": {
1393 "formattedValue": {
1394 "description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP hea der locale.",
1395 "type": "string"
1396 },
1397 "metadata": {
1398 "$ref": "FieldMetadata",
1399 "description": "Metadata about the gender."
1400 },
1401 "value": {
1402 "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfo llowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
1403 "type": "string" 1746 "type": "string"
1404 } 1747 }
1405 }, 1748 },
1406 "type": "object" 1749 "type": "object"
1407 }, 1750 },
1408 "Url": { 1751 "Url": {
1409 "description": "A person's associated URLs.", 1752 "description": "A person's associated URLs.",
1410 "id": "Url", 1753 "id": "Url",
1411 "properties": { 1754 "properties": {
1412 "type": { 1755 "type": {
1413 "description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\ n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservat ions`\n* `appInstallPage`: website for a Google+ application.\n* `other`", 1756 "description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\ n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservat ions`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
1414 "type": "string" 1757 "type": "string"
1415 }, 1758 },
1416 "metadata": { 1759 "metadata": {
1417 "$ref": "FieldMetadata", 1760 "$ref": "FieldMetadata",
1418 "description": "Metadata about the URL." 1761 "description": "Metadata about the URL."
1419 }, 1762 },
1420 "value": { 1763 "value": {
1421 "description": "The URL.", 1764 "description": "The URL.",
1422 "type": "string" 1765 "type": "string"
1423 }, 1766 },
1424 "formattedType": { 1767 "formattedType": {
1425 "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.", 1768 "description": "The read-only type of the URL translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
1426 "type": "string" 1769 "type": "string"
1427 } 1770 }
1428 }, 1771 },
1772 "type": "object"
1773 },
1774 "ImClient": {
1775 "description": "A person's instant messaging client.",
1776 "id": "ImClient",
1777 "properties": {
1778 "formattedProtocol": {
1779 "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.",
1780 "type": "string"
1781 },
1782 "formattedType": {
1783 "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.",
1784 "type": "string"
1785 },
1786 "metadata": {
1787 "$ref": "FieldMetadata",
1788 "description": "Metadata about the IM client."
1789 },
1790 "type": {
1791 "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`",
1792 "type": "string"
1793 },
1794 "protocol": {
1795 "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`",
1796 "type": "string"
1797 },
1798 "username": {
1799 "description": "The user name used in the IM client.",
1800 "type": "string"
1801 }
1802 },
1803 "type": "object"
1804 },
1805 "DomainMembership": {
1806 "description": "A Google Apps Domain membership.",
1807 "id": "DomainMembership",
1808 "properties": {
1809 "inViewerDomain": {
1810 "description": "True if the person is in the viewer's Google Apps domain.",
1811 "type": "boolean"
1812 }
1813 },
1814 "type": "object"
1815 },
1816 "Membership": {
1817 "description": "A person's read-only membership in a group.",
1818 "id": "Membership",
1819 "properties": {
1820 "metadata": {
1821 "$ref": "FieldMetadata",
1822 "description": "Metadata about the membership."
1823 },
1824 "domainMembership": {
1825 "$ref": "DomainMembership",
1826 "description": "The domain membership."
1827 },
1828 "contactGroupMembership": {
1829 "$ref": "ContactGroupMembership",
1830 "description": "The contact group membership."
1831 }
1832 },
1833 "type": "object"
1834 },
1835 "BatchGetContactGroupsResponse": {
1836 "description": "The response to a batch get contact groups request." ,
1837 "id": "BatchGetContactGroupsResponse",
1838 "properties": {
1839 "responses": {
1840 "description": "The list of responses for each requested con tact group resource.",
1841 "items": {
1842 "$ref": "ContactGroupResponse"
1843 },
1844 "type": "array"
1845 }
1846 },
1847 "type": "object"
1848 },
1849 "RelationshipStatus": {
1850 "description": "A person's read-only relationship status.",
1851 "id": "RelationshipStatus",
1852 "properties": {
1853 "metadata": {
1854 "$ref": "FieldMetadata",
1855 "description": "Metadata about the relationship status."
1856 },
1857 "value": {
1858 "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`",
1859 "type": "string"
1860 },
1861 "formattedValue": {
1862 "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.",
1863 "type": "string"
1864 }
1865 },
1866 "type": "object"
1867 },
1868 "BraggingRights": {
1869 "description": "A person's bragging rights.",
1870 "id": "BraggingRights",
1871 "properties": {
1872 "metadata": {
1873 "$ref": "FieldMetadata",
1874 "description": "Metadata about the bragging rights."
1875 },
1876 "value": {
1877 "description": "The bragging rights; for example, `climbed m ount everest`.",
1878 "type": "string"
1879 }
1880 },
1881 "type": "object"
1882 },
1883 "Organization": {
1884 "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
1885 "id": "Organization",
1886 "properties": {
1887 "endDate": {
1888 "$ref": "Date",
1889 "description": "The end date when the person left the organi zation."
1890 },
1891 "symbol": {
1892 "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
1893 "type": "string"
1894 },
1895 "name": {
1896 "description": "The name of the organization.",
1897 "type": "string"
1898 },
1899 "metadata": {
1900 "$ref": "FieldMetadata",
1901 "description": "Metadata about the organization."
1902 },
1903 "location": {
1904 "description": "The location of the organization office the person works at.",
1905 "type": "string"
1906 },
1907 "title": {
1908 "description": "The person's job title at the organization." ,
1909 "type": "string"
1910 },
1911 "current": {
1912 "description": "True if the organization is the person's cur rent organization;\nfalse if the organization is a past organization.",
1913 "type": "boolean"
1914 },
1915 "formattedType": {
1916 "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.",
1917 "type": "string"
1918 },
1919 "startDate": {
1920 "$ref": "Date",
1921 "description": "The start date when the person joined the or ganization."
1922 },
1923 "domain": {
1924 "description": "The domain name associated with the organiza tion; for example, `google.com`.",
1925 "type": "string"
1926 },
1927 "department": {
1928 "description": "The person's department at the organization. ",
1929 "type": "string"
1930 },
1931 "type": {
1932 "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`",
1933 "type": "string"
1934 },
1935 "phoneticName": {
1936 "description": "The phonetic name of the organization.",
1937 "type": "string"
1938 },
1939 "jobDescription": {
1940 "description": "The person's job description at the organiza tion.",
1941 "type": "string"
1942 }
1943 },
1429 "type": "object" 1944 "type": "object"
1430 } 1945 }
1431 }, 1946 },
1432 "servicePath": "", 1947 "servicePath": "",
1433 "title": "Google People API", 1948 "title": "Google People API",
1434 "version": "v1" 1949 "version": "v1"
1435 } 1950 }
OLDNEW
« no previous file with comments | « discovery/googleapis/partners__v2.json ('k') | discovery/googleapis/playmoviespartner__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698