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

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

Issue 1797933002: Api-roll 33: 2016-03-14 (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Added resources/*/CHANGELOG.md, addresssed comments Created 4 years, 9 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
OLDNEW
(Empty)
1 {
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/contacts": {
6 "description": "Manage your contacts"
7 },
8 "https://www.googleapis.com/auth/contacts.readonly": {
9 "description": "View your contacts"
10 },
11 "https://www.googleapis.com/auth/plus.login": {
12 "description": "Know your basic profile info and list of peo ple in your circles."
13 },
14 "https://www.googleapis.com/auth/user.addresses.read": {
15 "description": "View your street addresses"
16 },
17 "https://www.googleapis.com/auth/user.birthday.read": {
18 "description": "View your complete date of birth"
19 },
20 "https://www.googleapis.com/auth/user.emails.read": {
21 "description": "View your email addresses"
22 },
23 "https://www.googleapis.com/auth/user.phonenumbers.read": {
24 "description": "View your phone numbers"
25 },
26 "https://www.googleapis.com/auth/userinfo.email": {
27 "description": "View your email address"
28 },
29 "https://www.googleapis.com/auth/userinfo.profile": {
30 "description": "View your basic profile info"
31 }
32 }
33 }
34 },
35 "basePath": "",
36 "baseUrl": "https://people.googleapis.com/",
37 "batchPath": "batch",
38 "description": "The Google People API service gives access to information ab out profiles and contacts.",
39 "discoveryVersion": "v1",
40 "documentationLink": "https://developers.google.com/people/",
41 "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/tzwJjoO4XDFgwNQjmiM8lPsFMzA\"",
42 "icons": {
43 "x16": "http://www.google.com/images/icons/product/search-16.gif",
44 "x32": "http://www.google.com/images/icons/product/search-32.gif"
45 },
46 "id": "people:v1",
47 "kind": "discovery#restDescription",
48 "name": "people",
49 "ownerDomain": "google.com",
50 "ownerName": "Google",
51 "parameters": {
52 "access_token": {
53 "description": "OAuth access token.",
54 "location": "query",
55 "type": "string"
56 },
57 "alt": {
58 "default": "json",
59 "description": "Data format for response.",
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 "bearer_token": {
69 "description": "OAuth bearer token.",
70 "location": "query",
71 "type": "string"
72 },
73 "callback": {
74 "description": "JSONP",
75 "location": "query",
76 "type": "string"
77 },
78 "fields": {
79 "description": "Selector specifying which fields to include in a par tial response.",
80 "location": "query",
81 "type": "string"
82 },
83 "key": {
84 "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.",
85 "location": "query",
86 "type": "string"
87 },
88 "oauth_token": {
89 "description": "OAuth 2.0 token for the current user.",
90 "location": "query",
91 "type": "string"
92 },
93 "pp": {
94 "default": "true",
95 "description": "Pretty-print response.",
96 "location": "query",
97 "type": "boolean"
98 },
99 "prettyPrint": {
100 "default": "true",
101 "description": "Returns response with indentations and line breaks." ,
102 "location": "query",
103 "type": "boolean"
104 },
105 "quotaUser": {
106 "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.",
107 "location": "query",
108 "type": "string"
109 },
110 "upload_protocol": {
111 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
112 "location": "query",
113 "type": "string"
114 },
115 "uploadType": {
116 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
117 "location": "query",
118 "type": "string"
119 },
120 "$.xgafv": {
121 "description": "V1 error format.",
122 "enumDescriptions": [
123 "v1 error format",
124 "v2 error format"
125 ],
126 "location": "query",
127 "type": "string"
128 }
129 },
130 "protocol": "rest",
131 "resources": {
132 "people": {
133 "methods": {
134 "get": {
135 "description": "Provides information about a person resource for a resource name. Use `people/me` to indicate the authenticated user.",
136 "httpMethod": "GET",
137 "id": "people.people.get",
138 "parameterOrder": [
139 "resourceName"
140 ],
141 "parameters": {
142 "resourceName": {
143 "description": "The resource name of the person to p rovide information about. - To get information about the authenticated user, spe cify `people/me`. - To get information about any user, specify the resource name that identifies the user, such as the resource names returned by [`people.conne ctions.list`](/people/api/rest/v1/people.connections/list).",
144 "location": "path",
145 "pattern": "^people/[^/]*$",
146 "required": true,
147 "type": "string"
148 },
149 "requestMask.includeField": {
150 "description": "Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each pat h should start with `person.`: for example, `person.names` or `person.photos`.",
151 "location": "query",
152 "type": "string"
153 }
154 },
155 "path": "v1/{+resourceName}",
156 "response": {
157 "$ref": "Person"
158 },
159 "scopes": [
160 "https://www.googleapis.com/auth/contacts",
161 "https://www.googleapis.com/auth/contacts.readonly",
162 "https://www.googleapis.com/auth/plus.login",
163 "https://www.googleapis.com/auth/user.addresses.read",
164 "https://www.googleapis.com/auth/user.birthday.read",
165 "https://www.googleapis.com/auth/user.emails.read",
166 "https://www.googleapis.com/auth/user.phonenumbers.read" ,
167 "https://www.googleapis.com/auth/userinfo.email",
168 "https://www.googleapis.com/auth/userinfo.profile"
169 ]
170 },
171 "getBatchGet": {
172 "description": "Provides information about a list of specifi c people by specifying a list of requested resource names. Use `people/me` to in dicate the authenticated user.",
173 "httpMethod": "GET",
174 "id": "people.people.getBatchGet",
175 "parameters": {
176 "resourceNames": {
177 "description": "The resource name, such as one retur ned by [`people.connections.list`](/people/api/rest/v1/people.connections/list), of one of the people to provide information about. You can include this paramet er up to 50 times in one request.",
178 "location": "query",
179 "repeated": true,
180 "type": "string"
181 },
182 "requestMask.includeField": {
183 "description": "Comma-separated list of fields to be included in the response. Omitting this field will include all fields. Each pat h should start with `person.`: for example, `person.names` or `person.photos`.",
184 "location": "query",
185 "type": "string"
186 }
187 },
188 "path": "v1/people:batchGet",
189 "response": {
190 "$ref": "GetPeopleResponse"
191 },
192 "scopes": [
193 "https://www.googleapis.com/auth/contacts",
194 "https://www.googleapis.com/auth/contacts.readonly",
195 "https://www.googleapis.com/auth/plus.login",
196 "https://www.googleapis.com/auth/user.addresses.read",
197 "https://www.googleapis.com/auth/user.birthday.read",
198 "https://www.googleapis.com/auth/user.emails.read",
199 "https://www.googleapis.com/auth/user.phonenumbers.read" ,
200 "https://www.googleapis.com/auth/userinfo.email",
201 "https://www.googleapis.com/auth/userinfo.profile"
202 ]
203 }
204 },
205 "resources": {
206 "connections": {
207 "methods": {
208 "list": {
209 "description": "Provides a list of the authenticated user's contacts merged with any linked profiles.",
210 "httpMethod": "GET",
211 "id": "people.people.connections.list",
212 "parameterOrder": [
213 "resourceName"
214 ],
215 "parameters": {
216 "resourceName": {
217 "description": "The resource name to return connections for. Only `people/me` is valid.",
218 "location": "path",
219 "pattern": "^people/[^/]*$",
220 "required": true,
221 "type": "string"
222 },
223 "pageToken": {
224 "description": "The token of the page to be returned.",
225 "location": "query",
226 "type": "string"
227 },
228 "pageSize": {
229 "description": "The number of connections to include in the response. Valid values are between 1 and 500, inclusive. Default s to 100.",
230 "format": "int32",
231 "location": "query",
232 "type": "integer"
233 },
234 "sortOrder": {
235 "description": "The order in which the conne ctions should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`.",
236 "enum": [
237 "LAST_MODIFIED_ASCENDING",
238 "FIRST_NAME_ASCENDING",
239 "LAST_NAME_ASCENDING"
240 ],
241 "location": "query",
242 "type": "string"
243 },
244 "syncToken": {
245 "description": "A sync token, returned by a previous call to `people.connections.list`. Only resources changed since the syn c token was created are returned.",
246 "location": "query",
247 "type": "string"
248 },
249 "requestMask.includeField": {
250 "description": "Comma-separated list of fiel ds to be included in the response. Omitting this field will include all fields. Each path should start with `person.`: for example, `person.names` or `person.ph otos`.",
251 "location": "query",
252 "type": "string"
253 }
254 },
255 "path": "v1/{+resourceName}/connections",
256 "response": {
257 "$ref": "ListConnectionsResponse"
258 },
259 "scopes": [
260 "https://www.googleapis.com/auth/contacts",
261 "https://www.googleapis.com/auth/contacts.readon ly"
262 ]
263 }
264 }
265 }
266 }
267 }
268 },
269 "revision": "20160210",
270 "rootUrl": "https://people.googleapis.com/",
271 "schemas": {
272 "Person": {
273 "description": "Information about a person merged from various data sources such as the authenticated user's contacts and profile data. Fields other than IDs, metadata, and group memberships are user-edited. Most fields can have multiple items. The items in a field have no guaranteed order, but each non-emp ty field is guaranteed to have exactly one field with `metadata.primary` set to true.",
274 "id": "Person",
275 "properties": {
276 "resourceName": {
277 "description": "The resource name for the person, assigned b y the server. An ASCII string with a max length of 27 characters. Always starts with `people/`.",
278 "type": "string"
279 },
280 "etag": {
281 "description": "The [HTTP entity tag](https://en.wikipedia.o rg/wiki/HTTP_ETag) of the resource. Used for web cache validation.",
282 "type": "string"
283 },
284 "metadata": {
285 "$ref": "PersonMetadata",
286 "description": "Metadata about the person."
287 },
288 "locales": {
289 "description": "The person's locale preferences.",
290 "items": {
291 "$ref": "Locale"
292 },
293 "type": "array"
294 },
295 "names": {
296 "description": "The person's names.",
297 "items": {
298 "$ref": "Name"
299 },
300 "type": "array"
301 },
302 "nicknames": {
303 "description": "The person's nicknames.",
304 "items": {
305 "$ref": "Nickname"
306 },
307 "type": "array"
308 },
309 "coverPhotos": {
310 "description": "The person's cover photos.",
311 "items": {
312 "$ref": "CoverPhoto"
313 },
314 "type": "array"
315 },
316 "photos": {
317 "description": "The person's photos.",
318 "items": {
319 "$ref": "Photo"
320 },
321 "type": "array"
322 },
323 "genders": {
324 "description": "The person's genders.",
325 "items": {
326 "$ref": "Gender"
327 },
328 "type": "array"
329 },
330 "ageRange": {
331 "description": "The person's age range.",
332 "enum": [
333 "AGE_RANGE_UNSPECIFIED",
334 "LESS_THAN_EIGHTEEN",
335 "EIGHTEEN_TO_TWENTY",
336 "TWENTY_ONE_OR_OLDER"
337 ],
338 "type": "string"
339 },
340 "birthdays": {
341 "description": "The person's birthdays.",
342 "items": {
343 "$ref": "Birthday"
344 },
345 "type": "array"
346 },
347 "events": {
348 "description": "The person's events.",
349 "items": {
350 "$ref": "Event"
351 },
352 "type": "array"
353 },
354 "addresses": {
355 "description": "The person's street addresses.",
356 "items": {
357 "$ref": "Address"
358 },
359 "type": "array"
360 },
361 "residences": {
362 "description": "The person's residences.",
363 "items": {
364 "$ref": "Residence"
365 },
366 "type": "array"
367 },
368 "emailAddresses": {
369 "description": "The person's email addresses.",
370 "items": {
371 "$ref": "EmailAddress"
372 },
373 "type": "array"
374 },
375 "phoneNumbers": {
376 "description": "The person's phone numbers.",
377 "items": {
378 "$ref": "PhoneNumber"
379 },
380 "type": "array"
381 },
382 "imClients": {
383 "description": "The person's instant messaging clients.",
384 "items": {
385 "$ref": "ImClient"
386 },
387 "type": "array"
388 },
389 "taglines": {
390 "description": "The person's taglines.",
391 "items": {
392 "$ref": "Tagline"
393 },
394 "type": "array"
395 },
396 "biographies": {
397 "description": "The person's biographies.",
398 "items": {
399 "$ref": "Biography"
400 },
401 "type": "array"
402 },
403 "urls": {
404 "description": "The person's associated URLs.",
405 "items": {
406 "$ref": "Url"
407 },
408 "type": "array"
409 },
410 "organizations": {
411 "description": "The person's past or current organizations." ,
412 "items": {
413 "$ref": "Organization"
414 },
415 "type": "array"
416 },
417 "occupations": {
418 "description": "The person's occupations.",
419 "items": {
420 "$ref": "Occupation"
421 },
422 "type": "array"
423 },
424 "interests": {
425 "description": "The person's interests.",
426 "items": {
427 "$ref": "Interest"
428 },
429 "type": "array"
430 },
431 "skills": {
432 "description": "The person's skills.",
433 "items": {
434 "$ref": "Skill"
435 },
436 "type": "array"
437 },
438 "braggingRights": {
439 "description": "The person's bragging rights.",
440 "items": {
441 "$ref": "BraggingRights"
442 },
443 "type": "array"
444 },
445 "relations": {
446 "description": "The person's relations.",
447 "items": {
448 "$ref": "Relation"
449 },
450 "type": "array"
451 },
452 "relationshipInterests": {
453 "description": "The kind of relationship the person is looki ng for.",
454 "items": {
455 "$ref": "RelationshipInterest"
456 },
457 "type": "array"
458 },
459 "relationshipStatuses": {
460 "description": "The person's relationship statuses.",
461 "items": {
462 "$ref": "RelationshipStatus"
463 },
464 "type": "array"
465 },
466 "memberships": {
467 "description": "The person's group memberships.",
468 "items": {
469 "$ref": "Membership"
470 },
471 "type": "array"
472 }
473 },
474 "type": "object"
475 },
476 "PersonMetadata": {
477 "description": "Metadata about a person.",
478 "id": "PersonMetadata",
479 "properties": {
480 "sources": {
481 "description": "The sources of data for the person.",
482 "items": {
483 "$ref": "Source"
484 },
485 "type": "array"
486 },
487 "previousResourceNames": {
488 "description": "Any former resource names this person has ha d. Populated only for [`connections.list`](/people/api/rest/v1/people.connection s/list) requests that include a sync token. The resource name may change when ad ding or removing fields that link a contact and profile such as a verified email , verified phone number, or profile URL.",
489 "items": {
490 "type": "string"
491 },
492 "type": "array"
493 },
494 "deleted": {
495 "description": "True if the person resource has been deleted . Populated only for [`connections.list`](/people/api/rest/v1/people.connections /list) requests that include a sync token.",
496 "type": "boolean"
497 },
498 "objectType": {
499 "description": "The type of the person object.",
500 "enum": [
501 "OBJECT_TYPE_UNSPECIFIED",
502 "PERSON",
503 "PAGE"
504 ],
505 "type": "string"
506 }
507 },
508 "type": "object"
509 },
510 "Source": {
511 "description": "The source of a field.",
512 "id": "Source",
513 "properties": {
514 "type": {
515 "description": "The source type.",
516 "enum": [
517 "OTHER",
518 "ACCOUNT",
519 "PROFILE",
520 "DOMAIN_PROFILE",
521 "CONTACT"
522 ],
523 "type": "string"
524 },
525 "id": {
526 "description": "A unique identifier within the source type g enerated by the server.",
527 "type": "string"
528 }
529 },
530 "type": "object"
531 },
532 "Locale": {
533 "description": "A person's locale preference.",
534 "id": "Locale",
535 "properties": {
536 "metadata": {
537 "$ref": "FieldMetadata",
538 "description": "Metadata about the locale."
539 },
540 "value": {
541 "description": "The well-formed [IETF BCP 47](https://tools. ietf.org/html/bcp47) language tag representing the locale.",
542 "type": "string"
543 }
544 },
545 "type": "object"
546 },
547 "FieldMetadata": {
548 "description": "Metadata about a field.",
549 "id": "FieldMetadata",
550 "properties": {
551 "primary": {
552 "description": "True if the field is the primary field; fals e if the field is a secondary field.",
553 "type": "boolean"
554 },
555 "verified": {
556 "description": "True if the field is verified; false if the field is unverified. A verified field is typically a name, email address, phone number, or website that has been confirmed to be owned by the person.",
557 "type": "boolean"
558 },
559 "source": {
560 "$ref": "Source",
561 "description": "The source of the field."
562 }
563 },
564 "type": "object"
565 },
566 "Name": {
567 "description": "A person's name. If the name is a mononym, the famil y name is empty.",
568 "id": "Name",
569 "properties": {
570 "metadata": {
571 "$ref": "FieldMetadata",
572 "description": "Metadata about the name."
573 },
574 "displayName": {
575 "description": "The display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.",
576 "type": "string"
577 },
578 "familyName": {
579 "description": "The family name.",
580 "type": "string"
581 },
582 "givenName": {
583 "description": "The given name.",
584 "type": "string"
585 },
586 "middleName": {
587 "description": "The middle name(s).",
588 "type": "string"
589 },
590 "honorificPrefix": {
591 "description": "The honorific prefixes, such as `Mrs.` or `D r.`",
592 "type": "string"
593 },
594 "honorificSuffix": {
595 "description": "The honorific suffixes, such as `Jr.`",
596 "type": "string"
597 },
598 "phoneticFamilyName": {
599 "description": "The family name spelled as it sounds.",
600 "type": "string"
601 },
602 "phoneticGivenName": {
603 "description": "The given name spelled as it sounds.",
604 "type": "string"
605 },
606 "phoneticMiddleName": {
607 "description": "The middle name(s) spelled as they sound.",
608 "type": "string"
609 },
610 "phoneticHonorificPrefix": {
611 "description": "The honorific prefixes spelled as they sound .",
612 "type": "string"
613 },
614 "phoneticHonorificSuffix": {
615 "description": "The honorific suffixes spelled as they sound .",
616 "type": "string"
617 }
618 },
619 "type": "object"
620 },
621 "Nickname": {
622 "description": "A person's nickname.",
623 "id": "Nickname",
624 "properties": {
625 "metadata": {
626 "$ref": "FieldMetadata",
627 "description": "Metadata about the nickname."
628 },
629 "value": {
630 "description": "The nickname.",
631 "type": "string"
632 },
633 "type": {
634 "description": "The type of the nickname.",
635 "enum": [
636 "DEFAULT",
637 "MAIDEN_NAME",
638 "INITIALS",
639 "GPLUS",
640 "OTHER_NAME"
641 ],
642 "type": "string"
643 }
644 },
645 "type": "object"
646 },
647 "CoverPhoto": {
648 "description": "A person's cover photo. A large image shown on the p erson's profile page that represents who they are or what they care about.",
649 "id": "CoverPhoto",
650 "properties": {
651 "metadata": {
652 "$ref": "FieldMetadata",
653 "description": "Metadata about the cover photo."
654 },
655 "url": {
656 "description": "The URL of the cover photo.",
657 "type": "string"
658 },
659 "default": {
660 "description": "True if the cover photo is the default cover photo; false if the cover photo is a user-provided cover photo.",
661 "type": "boolean"
662 }
663 },
664 "type": "object"
665 },
666 "Photo": {
667 "description": "A person's photo. A picture shown next to the person 's name to help others recognize the person.",
668 "id": "Photo",
669 "properties": {
670 "metadata": {
671 "$ref": "FieldMetadata",
672 "description": "Metadata about the photo."
673 },
674 "url": {
675 "description": "The URL of the photo.",
676 "type": "string"
677 }
678 },
679 "type": "object"
680 },
681 "Gender": {
682 "description": "A person's gender.",
683 "id": "Gender",
684 "properties": {
685 "metadata": {
686 "$ref": "FieldMetadata",
687 "description": "Metadata about the gender."
688 },
689 "value": {
690 "description": "The gender for the person. The gender can be custom or predefined. Possible values include, but are not limited to, the foll owing: * `male` * `female` * `other` * `unknown`",
691 "type": "string"
692 },
693 "formattedValue": {
694 "description": "The read-only value of the gender translated and formatted in the viewer's account locale or the `Accept-Language` HTTP head er locale.",
695 "type": "string"
696 }
697 },
698 "type": "object"
699 },
700 "Birthday": {
701 "description": "A person's birthday. At least one of the `date` and `text` fields are specified. The `date` and `text` fields typically represent th e same date, but are not guaranteed to.",
702 "id": "Birthday",
703 "properties": {
704 "metadata": {
705 "$ref": "FieldMetadata",
706 "description": "Metadata about the birthday."
707 },
708 "date": {
709 "$ref": "Date",
710 "description": "The date of the birthday."
711 },
712 "text": {
713 "description": "A free-form string representing the user's b irthday.",
714 "type": "string"
715 }
716 },
717 "type": "object"
718 },
719 "Date": {
720 "description": "Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are n ot significant. The date is relative to the [Proleptic Gregorian Calendar](https ://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The day may be 0 to repr esent a year and month where the day is not significant. The year may be 0 to re present a month and day independent of year; for example, anniversary date.",
721 "id": "Date",
722 "properties": {
723 "year": {
724 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without a year.",
725 "format": "int32",
726 "type": "integer"
727 },
728 "month": {
729 "description": "Month of year. Must be from 1 to 12.",
730 "format": "int32",
731 "type": "integer"
732 },
733 "day": {
734 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not si gnificant.",
735 "format": "int32",
736 "type": "integer"
737 }
738 },
739 "type": "object"
740 },
741 "Event": {
742 "description": "An event related to the person.",
743 "id": "Event",
744 "properties": {
745 "metadata": {
746 "$ref": "FieldMetadata",
747 "description": "Metadata about the event."
748 },
749 "date": {
750 "$ref": "Date",
751 "description": "The date of the event."
752 },
753 "type": {
754 "description": "The type of the event. The type can be custo m or predefined. Possible values include, but are not limited to, the following: * `anniversary` * `other`",
755 "type": "string"
756 },
757 "formattedType": {
758 "description": "The read-only type of the event translated a nd formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
759 "type": "string"
760 }
761 },
762 "type": "object"
763 },
764 "Address": {
765 "description": "A person's physical address. May be a P.O. box or st reet address. All fields are optional.",
766 "id": "Address",
767 "properties": {
768 "metadata": {
769 "$ref": "FieldMetadata",
770 "description": "Metadata about the address."
771 },
772 "formattedValue": {
773 "description": "The read-only value of the address formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
774 "type": "string"
775 },
776 "type": {
777 "description": "The type of the address. The type can be cus tom or predefined. Possible values include, but are not limited to, the followin g: * `home` * `work` * `other`",
778 "type": "string"
779 },
780 "formattedType": {
781 "description": "The read-only type of the address translated and formatted in the viewer's account locale or the `Accept-Language` HTTP head er locale.",
782 "type": "string"
783 },
784 "poBox": {
785 "description": "The P.O. box of the address.",
786 "type": "string"
787 },
788 "streetAddress": {
789 "description": "The street address.",
790 "type": "string"
791 },
792 "extendedAddress": {
793 "description": "The extended address of the address; for exa mple, the apartment number.",
794 "type": "string"
795 },
796 "city": {
797 "description": "The city of the address.",
798 "type": "string"
799 },
800 "region": {
801 "description": "The region of the address; for example, the state or province.",
802 "type": "string"
803 },
804 "postalCode": {
805 "description": "The postal code of the address.",
806 "type": "string"
807 },
808 "country": {
809 "description": "The country of the address.",
810 "type": "string"
811 },
812 "countryCode": {
813 "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/ iso/country_codes.htm) country code of the address.",
814 "type": "string"
815 }
816 },
817 "type": "object"
818 },
819 "Residence": {
820 "description": "A person's past or current residence.",
821 "id": "Residence",
822 "properties": {
823 "metadata": {
824 "$ref": "FieldMetadata",
825 "description": "Metadata about the residence."
826 },
827 "value": {
828 "description": "The address of the residence.",
829 "type": "string"
830 },
831 "current": {
832 "description": "True if the residence is the person's curren t residence; false if the residence is a past residence.",
833 "type": "boolean"
834 }
835 },
836 "type": "object"
837 },
838 "EmailAddress": {
839 "description": "A person's email address.",
840 "id": "EmailAddress",
841 "properties": {
842 "metadata": {
843 "$ref": "FieldMetadata",
844 "description": "Metadata about the email address."
845 },
846 "value": {
847 "description": "The email address.",
848 "type": "string"
849 },
850 "type": {
851 "description": "The type of the email address. The type can be custom or predefined. Possible values include, but are not limited to, the fo llowing: * `home` * `work` * `other`",
852 "type": "string"
853 },
854 "formattedType": {
855 "description": "The read-only type of the email address tran slated and formatted in the viewer's account locale or the `Accept-Language` HTT P header locale.",
856 "type": "string"
857 }
858 },
859 "type": "object"
860 },
861 "PhoneNumber": {
862 "description": "A person's phone number.",
863 "id": "PhoneNumber",
864 "properties": {
865 "metadata": {
866 "$ref": "FieldMetadata",
867 "description": "Metadata about the phone number."
868 },
869 "value": {
870 "description": "The phone number.",
871 "type": "string"
872 },
873 "canonicalForm": {
874 "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) form of the ph one number.",
875 "type": "string"
876 },
877 "type": {
878 "description": "The type of the phone number. The type can b e custom or predefined. Possible values include, but are not limited to, the fol lowing: * `home` * `work` * `mobile` * `homeFax` * `workFax` * `otherFax` * `pag er` * `workMobile` * `workPager` * `main` * `googleVoice` * `other`",
879 "type": "string"
880 },
881 "formattedType": {
882 "description": "The read-only type of the phone number trans lated and formatted in the viewer's account locale or the the `Accept-Language` HTTP header locale.",
883 "type": "string"
884 }
885 },
886 "type": "object"
887 },
888 "ImClient": {
889 "description": "A person's instant messaging client.",
890 "id": "ImClient",
891 "properties": {
892 "metadata": {
893 "$ref": "FieldMetadata",
894 "description": "Metadata about the IM client."
895 },
896 "username": {
897 "description": "The user name used in the IM client.",
898 "type": "string"
899 },
900 "type": {
901 "description": "The type of the IM client. The type can be c ustom or predefined. Possible values include, but are not limited to, the follow ing: * `home` * `work` * `other`",
902 "type": "string"
903 },
904 "formattedType": {
905 "description": "The read-only type of the IM client translat ed and formatted in the viewer's account locale or the `Accept-Language` HTTP he ader locale.",
906 "type": "string"
907 },
908 "protocol": {
909 "description": "The protocol of the IM client. The protocol can be custom or predefined. Possible values include, but are not limited to, th e following: * `aim` * `msn` * `yahoo` * `skype` * `qq` * `googleTalk` * `icq` * `jabber` * `netMeeting`",
910 "type": "string"
911 },
912 "formattedProtocol": {
913 "description": "The read-only protocol of the IM client form atted in the viewer's account locale or the `Accept-Language` HTTP header locale .",
914 "type": "string"
915 }
916 },
917 "type": "object"
918 },
919 "Tagline": {
920 "description": "A brief one-line description of the person.",
921 "id": "Tagline",
922 "properties": {
923 "metadata": {
924 "$ref": "FieldMetadata",
925 "description": "Metadata about the tagline."
926 },
927 "value": {
928 "description": "The tagline.",
929 "type": "string"
930 }
931 },
932 "type": "object"
933 },
934 "Biography": {
935 "description": "A person's short biography.",
936 "id": "Biography",
937 "properties": {
938 "metadata": {
939 "$ref": "FieldMetadata",
940 "description": "Metadata about the biography."
941 },
942 "value": {
943 "description": "The short biography.",
944 "type": "string"
945 }
946 },
947 "type": "object"
948 },
949 "Url": {
950 "description": "A person's associated URLs.",
951 "id": "Url",
952 "properties": {
953 "metadata": {
954 "$ref": "FieldMetadata",
955 "description": "Metadata about the URL."
956 },
957 "value": {
958 "description": "The URL.",
959 "type": "string"
960 },
961 "type": {
962 "description": "The type of the URL. The type can be custom or predefined. Possible values include, but are not limited to, the following: * `home` * `work` * `blog` * `profile` * `homePage` * `ftp` * `reservations` * `a ppInstallPage`: website for a Google+ application. * `other`",
963 "type": "string"
964 },
965 "formattedType": {
966 "description": "The read-only type of the URL translated and formatted in the viewer's account locale or the `Accept-Language` HTTP header l ocale.",
967 "type": "string"
968 }
969 },
970 "type": "object"
971 },
972 "Organization": {
973 "description": "A person's past or current organization. Overlapping date ranges are permitted.",
974 "id": "Organization",
975 "properties": {
976 "metadata": {
977 "$ref": "FieldMetadata",
978 "description": "Metadata about the organization."
979 },
980 "type": {
981 "description": "The type of the organization. The type can b e custom or predefined. Possible values include, but are not limited to, the fol lowing: * `work` * `school`",
982 "type": "string"
983 },
984 "formattedType": {
985 "description": "The read-only type of the organization trans lated and formatted in the viewer's account locale or the `Accept-Language` HTTP header locale.",
986 "type": "string"
987 },
988 "startDate": {
989 "$ref": "Date",
990 "description": "The start date when the person joined the or ganization."
991 },
992 "endDate": {
993 "$ref": "Date",
994 "description": "The end date when the person left the organi zation."
995 },
996 "current": {
997 "description": "True if the organization is the person's cur rent organization; false if the organization is a past organization.",
998 "type": "boolean"
999 },
1000 "name": {
1001 "description": "The name of the organization.",
1002 "type": "string"
1003 },
1004 "phoneticName": {
1005 "description": "The phonetic name of the organization.",
1006 "type": "string"
1007 },
1008 "department": {
1009 "description": "The person's department at the organization. ",
1010 "type": "string"
1011 },
1012 "title": {
1013 "description": "The person's job title at the organization." ,
1014 "type": "string"
1015 },
1016 "jobDescription": {
1017 "description": "The person's job description at the organiza tion.",
1018 "type": "string"
1019 },
1020 "symbol": {
1021 "description": "The symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.",
1022 "type": "string"
1023 },
1024 "domain": {
1025 "description": "The domain name associated with the organiza tion; for example, `google.com`.",
1026 "type": "string"
1027 },
1028 "location": {
1029 "description": "The location of the organization office the person works at.",
1030 "type": "string"
1031 }
1032 },
1033 "type": "object"
1034 },
1035 "Occupation": {
1036 "description": "A person's occupation.",
1037 "id": "Occupation",
1038 "properties": {
1039 "metadata": {
1040 "$ref": "FieldMetadata",
1041 "description": "Metadata about the occupation."
1042 },
1043 "value": {
1044 "description": "The occupation; for example, `carpenter`.",
1045 "type": "string"
1046 }
1047 },
1048 "type": "object"
1049 },
1050 "Interest": {
1051 "description": "One of the person's interests.",
1052 "id": "Interest",
1053 "properties": {
1054 "metadata": {
1055 "$ref": "FieldMetadata",
1056 "description": "Metadata about the interest."
1057 },
1058 "value": {
1059 "description": "The interest; for example, `stargazing`.",
1060 "type": "string"
1061 }
1062 },
1063 "type": "object"
1064 },
1065 "Skill": {
1066 "description": "A skill that the person has.",
1067 "id": "Skill",
1068 "properties": {
1069 "metadata": {
1070 "$ref": "FieldMetadata",
1071 "description": "Metadata about the skill."
1072 },
1073 "value": {
1074 "description": "The skill; for example, `underwater basket w eaving`.",
1075 "type": "string"
1076 }
1077 },
1078 "type": "object"
1079 },
1080 "BraggingRights": {
1081 "description": "A person's bragging rights.",
1082 "id": "BraggingRights",
1083 "properties": {
1084 "metadata": {
1085 "$ref": "FieldMetadata",
1086 "description": "Metadata about the bragging rights."
1087 },
1088 "value": {
1089 "description": "The bragging rights; for example, `climbed m ount everest`.",
1090 "type": "string"
1091 }
1092 },
1093 "type": "object"
1094 },
1095 "Relation": {
1096 "description": "A person's relation to another person.",
1097 "id": "Relation",
1098 "properties": {
1099 "metadata": {
1100 "$ref": "FieldMetadata",
1101 "description": "Metadata about the relation."
1102 },
1103 "person": {
1104 "description": "The name of the other person this relation r efers to.",
1105 "type": "string"
1106 },
1107 "type": {
1108 "description": "The person's relation to the other person. T he type can be custom or predefined. Possible values include, but are not limite d to, the following values: * `spouse` * `child` * `mother` * `father` * `parent ` * `brother` * `sister` * `friend` * `relative` * `domesticPartner` * `manager` * `assistant` * `referredBy` * `partner`",
1109 "type": "string"
1110 },
1111 "formattedType": {
1112 "description": "The type of the relation translated and form atted in the viewer's account locale or the locale specified in the Accept-Langu age HTTP header.",
1113 "type": "string"
1114 }
1115 },
1116 "type": "object"
1117 },
1118 "RelationshipInterest": {
1119 "description": "The kind of relationship the person is looking for." ,
1120 "id": "RelationshipInterest",
1121 "properties": {
1122 "metadata": {
1123 "$ref": "FieldMetadata",
1124 "description": "Metadata about the relationship interest."
1125 },
1126 "value": {
1127 "description": "The kind of relationship the person is looki ng for. The value can be custom or predefined. Possible values include, but are not limited to, the following values: * `friend` * `date` * `relationship` * `ne tworking`",
1128 "type": "string"
1129 },
1130 "formattedValue": {
1131 "description": "The value of the relationship interest trans lated and formatted in the viewer's account locale or the locale specified in th e Accept-Language HTTP header.",
1132 "type": "string"
1133 }
1134 },
1135 "type": "object"
1136 },
1137 "RelationshipStatus": {
1138 "description": "A person's relationship status.",
1139 "id": "RelationshipStatus",
1140 "properties": {
1141 "metadata": {
1142 "$ref": "FieldMetadata",
1143 "description": "Metadata about the relationship status."
1144 },
1145 "value": {
1146 "description": "The relationship status. The value can be cu stom or predefined. Possible values include, but are not limited to, the followi ng: * `single` * `inARelationship` * `engaged` * `married` * `itsComplicated` * `openRelationship` * `widowed` * `inDomesticPartnership` * `inCivilUnion`",
1147 "type": "string"
1148 },
1149 "formattedValue": {
1150 "description": "The read-only value of the relationship stat us translated and formatted in the viewer's account locale or the `Accept-Langua ge` HTTP header locale.",
1151 "type": "string"
1152 }
1153 },
1154 "type": "object"
1155 },
1156 "Membership": {
1157 "description": "A person's membership in a group.",
1158 "id": "Membership",
1159 "properties": {
1160 "metadata": {
1161 "$ref": "FieldMetadata",
1162 "description": "Metadata about the membership."
1163 },
1164 "contactGroupMembership": {
1165 "$ref": "ContactGroupMembership",
1166 "description": "The contact group membership."
1167 },
1168 "domainMembership": {
1169 "$ref": "DomainMembership",
1170 "description": "The domain membership."
1171 }
1172 },
1173 "type": "object"
1174 },
1175 "ContactGroupMembership": {
1176 "description": "A Google contact group membership.",
1177 "id": "ContactGroupMembership",
1178 "properties": {
1179 "contactGroupId": {
1180 "description": "The contact group ID for the contact group m embership. The contact group ID can be custom or predefined. Possible values inc lude, but are not limited to, the following: * `myContacts` * `starred` * A nume rical ID for user-created groups.",
1181 "type": "string"
1182 }
1183 },
1184 "type": "object"
1185 },
1186 "DomainMembership": {
1187 "description": "A Google Apps Domain membership.",
1188 "id": "DomainMembership",
1189 "properties": {
1190 "inViewerDomain": {
1191 "description": "True if the person is in the viewer's Google Apps domain.",
1192 "type": "boolean"
1193 }
1194 },
1195 "type": "object"
1196 },
1197 "GetPeopleResponse": {
1198 "id": "GetPeopleResponse",
1199 "properties": {
1200 "responses": {
1201 "description": "The response for each requested resource nam e.",
1202 "items": {
1203 "$ref": "PersonResponse"
1204 },
1205 "type": "array"
1206 }
1207 },
1208 "type": "object"
1209 },
1210 "PersonResponse": {
1211 "description": "The response for a single person",
1212 "id": "PersonResponse",
1213 "properties": {
1214 "httpStatusCode": {
1215 "description": "[HTTP 1.1 status code](http://www.w3.org/Pro tocols/rfc2616/rfc2616-sec10.html).",
1216 "format": "int32",
1217 "type": "integer"
1218 },
1219 "person": {
1220 "$ref": "Person",
1221 "description": "The person."
1222 },
1223 "requestedResourceName": {
1224 "description": "The original requested resource name. May be different than the resource name on the returned person. The resource name can change when adding or removing fields that link a contact and profile such as a verified email, verified phone number, or a profile URL.",
1225 "type": "string"
1226 }
1227 },
1228 "type": "object"
1229 },
1230 "ListConnectionsResponse": {
1231 "id": "ListConnectionsResponse",
1232 "properties": {
1233 "connections": {
1234 "description": "The list of people that the requestor is con nected to.",
1235 "items": {
1236 "$ref": "Person"
1237 },
1238 "type": "array"
1239 },
1240 "nextPageToken": {
1241 "description": "The token that can be used to retrieve the n ext page of results.",
1242 "type": "string"
1243 },
1244 "nextSyncToken": {
1245 "description": "The token that can be used to retrieve chang es since the last request.",
1246 "type": "string"
1247 }
1248 },
1249 "type": "object"
1250 }
1251 },
1252 "servicePath": "",
1253 "title": "Google People API",
1254 "version": "v1"
1255 }
OLDNEW
« no previous file with comments | « discovery/googleapis/pagespeedonline__v2.json ('k') | discovery/googleapis/plusDomains__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698