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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 559053002: Generate 0.1.0 version of googleapis/googleapis_beta (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 6 years, 3 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/mapsengine__v1.json ('k') | discovery/googleapis/oauth2__v2.json » ('j') | pubspec.yaml » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 {
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/glass.location": {
6 "description": "View your location"
7 },
8 "https://www.googleapis.com/auth/glass.timeline": {
9 "description": "View and manage your Glass timeline"
10 }
11 }
12 }
13 },
14 "basePath": "/mirror/v1/",
15 "baseUrl": "https://www.googleapis.com/mirror/v1/",
16 "batchPath": "batch",
17 "description": "API for interacting with Glass users via the timeline.",
18 "discoveryVersion": "v1",
19 "documentationLink": "https://developers.google.com/glass",
20 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/mHzQ-YLzhCvTUBkktYBjTjOWqUY\"",
21 "icons": {
22 "x16": "http://www.google.com/images/icons/product/search-16.gif",
23 "x32": "http://www.google.com/images/icons/product/search-32.gif"
24 },
25 "id": "mirror:v1",
26 "kind": "discovery#restDescription",
27 "labels": [
28 "limited_availability"
29 ],
30 "name": "mirror",
31 "ownerDomain": "google.com",
32 "ownerName": "Google",
33 "parameters": {
34 "alt": {
35 "default": "json",
36 "description": "Data format for the response.",
37 "enum": [
38 "json"
39 ],
40 "enumDescriptions": [
41 "Responses with Content-Type of application/json"
42 ],
43 "location": "query",
44 "type": "string"
45 },
46 "fields": {
47 "description": "Selector specifying which fields to include in a par tial response.",
48 "location": "query",
49 "type": "string"
50 },
51 "key": {
52 "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.",
53 "location": "query",
54 "type": "string"
55 },
56 "oauth_token": {
57 "description": "OAuth 2.0 token for the current user.",
58 "location": "query",
59 "type": "string"
60 },
61 "prettyPrint": {
62 "default": "true",
63 "description": "Returns response with indentations and line breaks." ,
64 "location": "query",
65 "type": "boolean"
66 },
67 "quotaUser": {
68 "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. Overrides userIp if both are provided.",
69 "location": "query",
70 "type": "string"
71 },
72 "userIp": {
73 "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
74 "location": "query",
75 "type": "string"
76 }
77 },
78 "protocol": "rest",
79 "resources": {
80 "accounts": {
81 "methods": {
82 "insert": {
83 "description": "Inserts a new account for a user",
84 "httpMethod": "POST",
85 "id": "mirror.accounts.insert",
86 "parameterOrder": [
87 "userToken",
88 "accountType",
89 "accountName"
90 ],
91 "parameters": {
92 "accountName": {
93 "description": "The name of the account to be passed to the Android Account Manager.",
94 "location": "path",
95 "required": true,
96 "type": "string"
97 },
98 "accountType": {
99 "description": "Account type to be passed to Android Account Manager.",
100 "location": "path",
101 "required": true,
102 "type": "string"
103 },
104 "userToken": {
105 "description": "The ID for the user.",
106 "location": "path",
107 "required": true,
108 "type": "string"
109 }
110 },
111 "path": "accounts/{userToken}/{accountType}/{accountName}",
112 "request": {
113 "$ref": "Account"
114 },
115 "response": {
116 "$ref": "Account"
117 }
118 }
119 }
120 },
121 "contacts": {
122 "methods": {
123 "delete": {
124 "description": "Deletes a contact.",
125 "httpMethod": "DELETE",
126 "id": "mirror.contacts.delete",
127 "parameterOrder": [
128 "id"
129 ],
130 "parameters": {
131 "id": {
132 "description": "The ID of the contact.",
133 "location": "path",
134 "required": true,
135 "type": "string"
136 }
137 },
138 "path": "contacts/{id}",
139 "scopes": [
140 "https://www.googleapis.com/auth/glass.timeline"
141 ]
142 },
143 "get": {
144 "description": "Gets a single contact by ID.",
145 "httpMethod": "GET",
146 "id": "mirror.contacts.get",
147 "parameterOrder": [
148 "id"
149 ],
150 "parameters": {
151 "id": {
152 "description": "The ID of the contact.",
153 "location": "path",
154 "required": true,
155 "type": "string"
156 }
157 },
158 "path": "contacts/{id}",
159 "response": {
160 "$ref": "Contact"
161 },
162 "scopes": [
163 "https://www.googleapis.com/auth/glass.timeline"
164 ]
165 },
166 "insert": {
167 "description": "Inserts a new contact.",
168 "httpMethod": "POST",
169 "id": "mirror.contacts.insert",
170 "path": "contacts",
171 "request": {
172 "$ref": "Contact"
173 },
174 "response": {
175 "$ref": "Contact"
176 },
177 "scopes": [
178 "https://www.googleapis.com/auth/glass.timeline"
179 ]
180 },
181 "list": {
182 "description": "Retrieves a list of contacts for the authent icated user.",
183 "httpMethod": "GET",
184 "id": "mirror.contacts.list",
185 "path": "contacts",
186 "response": {
187 "$ref": "ContactsListResponse"
188 },
189 "scopes": [
190 "https://www.googleapis.com/auth/glass.timeline"
191 ]
192 },
193 "patch": {
194 "description": "Updates a contact in place. This method supp orts patch semantics.",
195 "httpMethod": "PATCH",
196 "id": "mirror.contacts.patch",
197 "parameterOrder": [
198 "id"
199 ],
200 "parameters": {
201 "id": {
202 "description": "The ID of the contact.",
203 "location": "path",
204 "required": true,
205 "type": "string"
206 }
207 },
208 "path": "contacts/{id}",
209 "request": {
210 "$ref": "Contact"
211 },
212 "response": {
213 "$ref": "Contact"
214 },
215 "scopes": [
216 "https://www.googleapis.com/auth/glass.timeline"
217 ]
218 },
219 "update": {
220 "description": "Updates a contact in place.",
221 "httpMethod": "PUT",
222 "id": "mirror.contacts.update",
223 "parameterOrder": [
224 "id"
225 ],
226 "parameters": {
227 "id": {
228 "description": "The ID of the contact.",
229 "location": "path",
230 "required": true,
231 "type": "string"
232 }
233 },
234 "path": "contacts/{id}",
235 "request": {
236 "$ref": "Contact"
237 },
238 "response": {
239 "$ref": "Contact"
240 },
241 "scopes": [
242 "https://www.googleapis.com/auth/glass.timeline"
243 ]
244 }
245 }
246 },
247 "locations": {
248 "methods": {
249 "get": {
250 "description": "Gets a single location by ID.",
251 "httpMethod": "GET",
252 "id": "mirror.locations.get",
253 "parameterOrder": [
254 "id"
255 ],
256 "parameters": {
257 "id": {
258 "description": "The ID of the location or latest for the last known location.",
259 "location": "path",
260 "required": true,
261 "type": "string"
262 }
263 },
264 "path": "locations/{id}",
265 "response": {
266 "$ref": "Location"
267 },
268 "scopes": [
269 "https://www.googleapis.com/auth/glass.location",
270 "https://www.googleapis.com/auth/glass.timeline"
271 ]
272 },
273 "list": {
274 "description": "Retrieves a list of locations for the user." ,
275 "httpMethod": "GET",
276 "id": "mirror.locations.list",
277 "path": "locations",
278 "response": {
279 "$ref": "LocationsListResponse"
280 },
281 "scopes": [
282 "https://www.googleapis.com/auth/glass.location",
283 "https://www.googleapis.com/auth/glass.timeline"
284 ]
285 }
286 }
287 },
288 "settings": {
289 "methods": {
290 "get": {
291 "description": "Gets a single setting by ID.",
292 "httpMethod": "GET",
293 "id": "mirror.settings.get",
294 "parameterOrder": [
295 "id"
296 ],
297 "parameters": {
298 "id": {
299 "description": "The ID of the setting. The following IDs are valid: \n- locale - The key to the user’s language/locale (BCP 47 ident ifier) that Glassware should use to render localized content. \n- timezone - The key to the user’s current time zone region as defined in the tz database. Examp le: America/Los_Angeles.",
300 "location": "path",
301 "required": true,
302 "type": "string"
303 }
304 },
305 "path": "settings/{id}",
306 "response": {
307 "$ref": "Setting"
308 },
309 "scopes": [
310 "https://www.googleapis.com/auth/glass.timeline"
311 ]
312 }
313 }
314 },
315 "subscriptions": {
316 "methods": {
317 "delete": {
318 "description": "Deletes a subscription.",
319 "httpMethod": "DELETE",
320 "id": "mirror.subscriptions.delete",
321 "parameterOrder": [
322 "id"
323 ],
324 "parameters": {
325 "id": {
326 "description": "The ID of the subscription.",
327 "location": "path",
328 "required": true,
329 "type": "string"
330 }
331 },
332 "path": "subscriptions/{id}",
333 "scopes": [
334 "https://www.googleapis.com/auth/glass.timeline"
335 ]
336 },
337 "insert": {
338 "description": "Creates a new subscription.",
339 "httpMethod": "POST",
340 "id": "mirror.subscriptions.insert",
341 "path": "subscriptions",
342 "request": {
343 "$ref": "Subscription"
344 },
345 "response": {
346 "$ref": "Subscription"
347 },
348 "scopes": [
349 "https://www.googleapis.com/auth/glass.timeline"
350 ]
351 },
352 "list": {
353 "description": "Retrieves a list of subscriptions for the au thenticated user and service.",
354 "httpMethod": "GET",
355 "id": "mirror.subscriptions.list",
356 "path": "subscriptions",
357 "response": {
358 "$ref": "SubscriptionsListResponse"
359 },
360 "scopes": [
361 "https://www.googleapis.com/auth/glass.timeline"
362 ]
363 },
364 "update": {
365 "description": "Updates an existing subscription in place.",
366 "httpMethod": "PUT",
367 "id": "mirror.subscriptions.update",
368 "parameterOrder": [
369 "id"
370 ],
371 "parameters": {
372 "id": {
373 "description": "The ID of the subscription.",
374 "location": "path",
375 "required": true,
376 "type": "string"
377 }
378 },
379 "path": "subscriptions/{id}",
380 "request": {
381 "$ref": "Subscription"
382 },
383 "response": {
384 "$ref": "Subscription"
385 },
386 "scopes": [
387 "https://www.googleapis.com/auth/glass.timeline"
388 ]
389 }
390 }
391 },
392 "timeline": {
393 "methods": {
394 "delete": {
395 "description": "Deletes a timeline item.",
396 "httpMethod": "DELETE",
397 "id": "mirror.timeline.delete",
398 "parameterOrder": [
399 "id"
400 ],
401 "parameters": {
402 "id": {
403 "description": "The ID of the timeline item.",
404 "location": "path",
405 "required": true,
406 "type": "string"
407 }
408 },
409 "path": "timeline/{id}",
410 "scopes": [
411 "https://www.googleapis.com/auth/glass.location",
412 "https://www.googleapis.com/auth/glass.timeline"
413 ]
414 },
415 "get": {
416 "description": "Gets a single timeline item by ID.",
417 "httpMethod": "GET",
418 "id": "mirror.timeline.get",
419 "parameterOrder": [
420 "id"
421 ],
422 "parameters": {
423 "id": {
424 "description": "The ID of the timeline item.",
425 "location": "path",
426 "required": true,
427 "type": "string"
428 }
429 },
430 "path": "timeline/{id}",
431 "response": {
432 "$ref": "TimelineItem"
433 },
434 "scopes": [
435 "https://www.googleapis.com/auth/glass.location",
436 "https://www.googleapis.com/auth/glass.timeline"
437 ]
438 },
439 "insert": {
440 "description": "Inserts a new item into the timeline.",
441 "httpMethod": "POST",
442 "id": "mirror.timeline.insert",
443 "mediaUpload": {
444 "accept": [
445 "audio/*",
446 "image/*",
447 "video/*"
448 ],
449 "maxSize": "10MB",
450 "protocols": {
451 "resumable": {
452 "multipart": true,
453 "path": "/resumable/upload/mirror/v1/timeline"
454 },
455 "simple": {
456 "multipart": true,
457 "path": "/upload/mirror/v1/timeline"
458 }
459 }
460 },
461 "path": "timeline",
462 "request": {
463 "$ref": "TimelineItem"
464 },
465 "response": {
466 "$ref": "TimelineItem"
467 },
468 "scopes": [
469 "https://www.googleapis.com/auth/glass.location",
470 "https://www.googleapis.com/auth/glass.timeline"
471 ],
472 "supportsMediaUpload": true
473 },
474 "list": {
475 "description": "Retrieves a list of timeline items for the a uthenticated user.",
476 "httpMethod": "GET",
477 "id": "mirror.timeline.list",
478 "parameters": {
479 "bundleId": {
480 "description": "If provided, only items with the giv en bundleId will be returned.",
481 "location": "query",
482 "type": "string"
483 },
484 "includeDeleted": {
485 "description": "If true, tombstone records for delet ed items will be returned.",
486 "location": "query",
487 "type": "boolean"
488 },
489 "maxResults": {
490 "description": "The maximum number of items to inclu de in the response, used for paging.",
491 "format": "uint32",
492 "location": "query",
493 "type": "integer"
494 },
495 "orderBy": {
496 "description": "Controls the order in which timeline items are returned.",
497 "enum": [
498 "displayTime",
499 "writeTime"
500 ],
501 "enumDescriptions": [
502 "Results will be ordered by displayTime (default ). This is the same ordering as is used in the timeline on the device.",
503 "Results will be ordered by the time at which th ey were last written to the data store."
504 ],
505 "location": "query",
506 "type": "string"
507 },
508 "pageToken": {
509 "description": "Token for the page of results to ret urn.",
510 "location": "query",
511 "type": "string"
512 },
513 "pinnedOnly": {
514 "description": "If true, only pinned items will be r eturned.",
515 "location": "query",
516 "type": "boolean"
517 },
518 "sourceItemId": {
519 "description": "If provided, only items with the giv en sourceItemId will be returned.",
520 "location": "query",
521 "type": "string"
522 }
523 },
524 "path": "timeline",
525 "response": {
526 "$ref": "TimelineListResponse"
527 },
528 "scopes": [
529 "https://www.googleapis.com/auth/glass.location",
530 "https://www.googleapis.com/auth/glass.timeline"
531 ]
532 },
533 "patch": {
534 "description": "Updates a timeline item in place. This metho d supports patch semantics.",
535 "httpMethod": "PATCH",
536 "id": "mirror.timeline.patch",
537 "parameterOrder": [
538 "id"
539 ],
540 "parameters": {
541 "id": {
542 "description": "The ID of the timeline item.",
543 "location": "path",
544 "required": true,
545 "type": "string"
546 }
547 },
548 "path": "timeline/{id}",
549 "request": {
550 "$ref": "TimelineItem"
551 },
552 "response": {
553 "$ref": "TimelineItem"
554 },
555 "scopes": [
556 "https://www.googleapis.com/auth/glass.location",
557 "https://www.googleapis.com/auth/glass.timeline"
558 ]
559 },
560 "update": {
561 "description": "Updates a timeline item in place.",
562 "httpMethod": "PUT",
563 "id": "mirror.timeline.update",
564 "mediaUpload": {
565 "accept": [
566 "audio/*",
567 "image/*",
568 "video/*"
569 ],
570 "maxSize": "10MB",
571 "protocols": {
572 "resumable": {
573 "multipart": true,
574 "path": "/resumable/upload/mirror/v1/timeline/{i d}"
575 },
576 "simple": {
577 "multipart": true,
578 "path": "/upload/mirror/v1/timeline/{id}"
579 }
580 }
581 },
582 "parameterOrder": [
583 "id"
584 ],
585 "parameters": {
586 "id": {
587 "description": "The ID of the timeline item.",
588 "location": "path",
589 "required": true,
590 "type": "string"
591 }
592 },
593 "path": "timeline/{id}",
594 "request": {
595 "$ref": "TimelineItem"
596 },
597 "response": {
598 "$ref": "TimelineItem"
599 },
600 "scopes": [
601 "https://www.googleapis.com/auth/glass.location",
602 "https://www.googleapis.com/auth/glass.timeline"
603 ],
604 "supportsMediaUpload": true
605 }
606 },
607 "resources": {
608 "attachments": {
609 "methods": {
610 "delete": {
611 "description": "Deletes an attachment from a timelin e item.",
612 "httpMethod": "DELETE",
613 "id": "mirror.timeline.attachments.delete",
614 "parameterOrder": [
615 "itemId",
616 "attachmentId"
617 ],
618 "parameters": {
619 "attachmentId": {
620 "description": "The ID of the attachment.",
621 "location": "path",
622 "required": true,
623 "type": "string"
624 },
625 "itemId": {
626 "description": "The ID of the timeline item the attachment belongs to.",
627 "location": "path",
628 "required": true,
629 "type": "string"
630 }
631 },
632 "path": "timeline/{itemId}/attachments/{attachmentId }",
633 "scopes": [
634 "https://www.googleapis.com/auth/glass.timeline"
635 ]
636 },
637 "get": {
638 "description": "Retrieves an attachment on a timelin e item by item ID and attachment ID.",
639 "httpMethod": "GET",
640 "id": "mirror.timeline.attachments.get",
641 "parameterOrder": [
642 "itemId",
643 "attachmentId"
644 ],
645 "parameters": {
646 "attachmentId": {
647 "description": "The ID of the attachment.",
648 "location": "path",
649 "required": true,
650 "type": "string"
651 },
652 "itemId": {
653 "description": "The ID of the timeline item the attachment belongs to.",
654 "location": "path",
655 "required": true,
656 "type": "string"
657 }
658 },
659 "path": "timeline/{itemId}/attachments/{attachmentId }",
660 "response": {
661 "$ref": "Attachment"
662 },
663 "scopes": [
664 "https://www.googleapis.com/auth/glass.timeline"
665 ],
666 "supportsMediaDownload": true
667 },
668 "insert": {
669 "description": "Adds a new attachment to a timeline item.",
670 "httpMethod": "POST",
671 "id": "mirror.timeline.attachments.insert",
672 "mediaUpload": {
673 "accept": [
674 "audio/*",
675 "image/*",
676 "video/*"
677 ],
678 "maxSize": "10MB",
679 "protocols": {
680 "resumable": {
681 "multipart": true,
682 "path": "/resumable/upload/mirror/v1/tim eline/{itemId}/attachments"
683 },
684 "simple": {
685 "multipart": true,
686 "path": "/upload/mirror/v1/timeline/{ite mId}/attachments"
687 }
688 }
689 },
690 "parameterOrder": [
691 "itemId"
692 ],
693 "parameters": {
694 "itemId": {
695 "description": "The ID of the timeline item the attachment belongs to.",
696 "location": "path",
697 "required": true,
698 "type": "string"
699 }
700 },
701 "path": "timeline/{itemId}/attachments",
702 "response": {
703 "$ref": "Attachment"
704 },
705 "scopes": [
706 "https://www.googleapis.com/auth/glass.timeline"
707 ],
708 "supportsMediaUpload": true
709 },
710 "list": {
711 "description": "Returns a list of attachments for a timeline item.",
712 "httpMethod": "GET",
713 "id": "mirror.timeline.attachments.list",
714 "parameterOrder": [
715 "itemId"
716 ],
717 "parameters": {
718 "itemId": {
719 "description": "The ID of the timeline item whose attachments should be listed.",
720 "location": "path",
721 "required": true,
722 "type": "string"
723 }
724 },
725 "path": "timeline/{itemId}/attachments",
726 "response": {
727 "$ref": "AttachmentsListResponse"
728 },
729 "scopes": [
730 "https://www.googleapis.com/auth/glass.timeline"
731 ]
732 }
733 }
734 }
735 }
736 }
737 },
738 "revision": "20140908",
739 "rootUrl": "https://www.googleapis.com/",
740 "schemas": {
741 "Account": {
742 "description": "Represents an account passed into the Account Manage r on Glass.",
743 "id": "Account",
744 "properties": {
745 "authTokens": {
746 "items": {
747 "$ref": "AuthToken"
748 },
749 "type": "array"
750 },
751 "features": {
752 "items": {
753 "type": "string"
754 },
755 "type": "array"
756 },
757 "password": {
758 "type": "string"
759 },
760 "userData": {
761 "items": {
762 "$ref": "UserData"
763 },
764 "type": "array"
765 }
766 },
767 "type": "object"
768 },
769 "Attachment": {
770 "description": "Represents media content, such as a photo, that can be attached to a timeline item.",
771 "id": "Attachment",
772 "properties": {
773 "contentType": {
774 "description": "The MIME type of the attachment.",
775 "type": "string"
776 },
777 "contentUrl": {
778 "description": "The URL for the content.",
779 "type": "string"
780 },
781 "id": {
782 "description": "The ID of the attachment.",
783 "type": "string"
784 },
785 "isProcessingContent": {
786 "description": "Indicates that the contentUrl is not availab le because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later.",
787 "type": "boolean"
788 }
789 },
790 "type": "object"
791 },
792 "AttachmentsListResponse": {
793 "description": "A list of Attachments. This is the response from the server to GET requests on the attachments collection.",
794 "id": "AttachmentsListResponse",
795 "properties": {
796 "items": {
797 "description": "The list of attachments.",
798 "items": {
799 "$ref": "Attachment"
800 },
801 "type": "array"
802 },
803 "kind": {
804 "default": "mirror#attachmentsList",
805 "description": "The type of resource. This is always mirror# attachmentsList.",
806 "type": "string"
807 }
808 },
809 "type": "object"
810 },
811 "AuthToken": {
812 "id": "AuthToken",
813 "properties": {
814 "authToken": {
815 "type": "string"
816 },
817 "type": {
818 "type": "string"
819 }
820 },
821 "type": "object"
822 },
823 "Command": {
824 "description": "A single menu command that is part of a Contact.",
825 "id": "Command",
826 "properties": {
827 "type": {
828 "annotations": {
829 "required": [
830 "mirror.contacts.insert",
831 "mirror.contacts.update"
832 ]
833 },
834 "description": "The type of operation this command correspon ds to. Allowed values are: \n- TAKE_A_NOTE - Shares a timeline item with the tr anscription of user speech from the \"Take a note\" voice menu command. \n- POS T_AN_UPDATE - Shares a timeline item with the transcription of user speech from the \"Post an update\" voice menu command.",
835 "type": "string"
836 }
837 },
838 "type": "object"
839 },
840 "Contact": {
841 "description": "A person or group that can be used as a creator or a contact.",
842 "id": "Contact",
843 "properties": {
844 "acceptCommands": {
845 "description": "A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If th ere are more than that, the three contacts with the highest priority are shown f or that particular command.",
846 "items": {
847 "$ref": "Command"
848 },
849 "type": "array"
850 },
851 "acceptTypes": {
852 "description": "A list of MIME types that a contact supports . The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the cont act will be shown for all items.",
853 "items": {
854 "type": "string"
855 },
856 "type": "array"
857 },
858 "displayName": {
859 "annotations": {
860 "required": [
861 "mirror.contacts.insert",
862 "mirror.contacts.update"
863 ]
864 },
865 "description": "The name to display for this contact.",
866 "type": "string"
867 },
868 "id": {
869 "annotations": {
870 "required": [
871 "mirror.contacts.insert",
872 "mirror.contacts.update"
873 ]
874 },
875 "description": "An ID for this contact. This is generated by the application and is treated as an opaque token.",
876 "type": "string"
877 },
878 "imageUrls": {
879 "annotations": {
880 "required": [
881 "mirror.contacts.insert",
882 "mirror.contacts.update"
883 ]
884 },
885 "description": "Set of image URLs to display for a contact. Most contacts will have a single image, but a \"group\" contact may include up t o 8 image URLs and they will be resized and cropped into a mosaic on the client. ",
886 "items": {
887 "type": "string"
888 },
889 "type": "array"
890 },
891 "kind": {
892 "default": "mirror#contact",
893 "description": "The type of resource. This is always mirror# contact.",
894 "type": "string"
895 },
896 "phoneNumber": {
897 "description": "Primary phone number for the contact. This c an be a fully-qualified number, with country calling code and area code, or a lo cal number.",
898 "type": "string"
899 },
900 "priority": {
901 "description": "Priority for the contact to determine orderi ng in a list of contacts. Contacts with higher priorities will be shown before o nes with lower priorities.",
902 "format": "uint32",
903 "type": "integer"
904 },
905 "sharingFeatures": {
906 "description": "A list of sharing features that a contact ca n handle. Allowed values are: \n- ADD_CAPTION",
907 "items": {
908 "type": "string"
909 },
910 "type": "array"
911 },
912 "source": {
913 "description": "The ID of the application that created this contact. This is populated by the API",
914 "type": "string"
915 },
916 "speakableName": {
917 "description": "Name of this contact as it should be pronoun ced. If this contact's name must be spoken as part of a voice disambiguation men u, this name is used as the expected pronunciation. This is useful for contact n ames with unpronounceable characters or whose display spelling is otherwise not phonetic.",
918 "type": "string"
919 },
920 "type": {
921 "description": "The type for this contact. This is used for sorting in UIs. Allowed values are: \n- INDIVIDUAL - Represents a single person . This is the default. \n- GROUP - Represents more than a single person.",
922 "type": "string"
923 }
924 },
925 "type": "object"
926 },
927 "ContactsListResponse": {
928 "description": "A list of Contacts representing contacts. This is th e response from the server to GET requests on the contacts collection.",
929 "id": "ContactsListResponse",
930 "properties": {
931 "items": {
932 "description": "Contact list.",
933 "items": {
934 "$ref": "Contact"
935 },
936 "type": "array"
937 },
938 "kind": {
939 "default": "mirror#contacts",
940 "description": "The type of resource. This is always mirror# contacts.",
941 "type": "string"
942 }
943 },
944 "type": "object"
945 },
946 "Location": {
947 "description": "A geographic location that can be associated with a timeline item.",
948 "id": "Location",
949 "properties": {
950 "accuracy": {
951 "description": "The accuracy of the location fix in meters." ,
952 "format": "double",
953 "type": "number"
954 },
955 "address": {
956 "description": "The full address of the location.",
957 "type": "string"
958 },
959 "displayName": {
960 "description": "The name to be displayed. This may be a busi ness name or a user-defined place, such as \"Home\".",
961 "type": "string"
962 },
963 "id": {
964 "description": "The ID of the location.",
965 "type": "string"
966 },
967 "kind": {
968 "default": "mirror#location",
969 "description": "The type of resource. This is always mirror# location.",
970 "type": "string"
971 },
972 "latitude": {
973 "description": "The latitude, in degrees.",
974 "format": "double",
975 "type": "number"
976 },
977 "longitude": {
978 "description": "The longitude, in degrees.",
979 "format": "double",
980 "type": "number"
981 },
982 "timestamp": {
983 "description": "The time at which this location was captured , formatted according to RFC 3339.",
984 "format": "date-time",
985 "type": "string"
986 }
987 },
988 "type": "object"
989 },
990 "LocationsListResponse": {
991 "description": "A list of Locations. This is the response from the s erver to GET requests on the locations collection.",
992 "id": "LocationsListResponse",
993 "properties": {
994 "items": {
995 "description": "The list of locations.",
996 "items": {
997 "$ref": "Location"
998 },
999 "type": "array"
1000 },
1001 "kind": {
1002 "default": "mirror#locationsList",
1003 "description": "The type of resource. This is always mirror# locationsList.",
1004 "type": "string"
1005 }
1006 },
1007 "type": "object"
1008 },
1009 "MenuItem": {
1010 "description": "A custom menu item that can be presented to the user by a timeline item.",
1011 "id": "MenuItem",
1012 "properties": {
1013 "action": {
1014 "description": "Controls the behavior when the user picks th e menu option. Allowed values are: \n- CUSTOM - Custom action set by the servic e. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. \n- Built-in actions : \n- REPLY - Initiate a reply to the timeline item using the voice recording U I. The creator attribute must be set in the timeline item for this menu to be av ailable. \n- REPLY_ALL - Same behavior as REPLY. The original timeline item's re cipients will be added to the reply item. \n- DELETE - Delete the timeline item. \n- SHARE - Share the timeline item with the available contacts. \n- READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. \n- GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscrib e to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. \n- VOIC E_CALL - Initiate a phone call using the timeline item's creator.phoneNumber att ribute as recipient. \n- NAVIGATE - Navigate to the timeline item's location. \n - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. \n- OPEN_URI - Open the payload of the menu item in the browser. \n- PLAY_VIDEO - Open the pay load of the menu item in the Glass video player. \n- SEND_MESSAGE - Initiate sen ding a message to the timeline item's creator: \n- If the creator.phoneNumber i s set and Glass is connected to an Android phone, the message is an SMS. \n- Oth erwise, if the creator.email is set, the message is an email.",
1015 "type": "string"
1016 },
1017 "id": {
1018 "description": "The ID for this menu item. This is generated by the application and is treated as an opaque token.",
1019 "type": "string"
1020 },
1021 "payload": {
1022 "description": "A generic payload whose meaning changes depe nding on this MenuItem's action. \n- When the action is OPEN_URI, the payload i s the URL of the website to view. \n- When the action is PLAY_VIDEO, the payload is the streaming URL of the video \n- When the action is GET_MEDIA_INPUT, the p ayload is the text transcription of a user's speech input",
1023 "type": "string"
1024 },
1025 "removeWhenSelected": {
1026 "description": "If set to true on a CUSTOM menu item, that i tem will be removed from the menu after it is selected.",
1027 "type": "boolean"
1028 },
1029 "values": {
1030 "description": "For CUSTOM items, a list of values controlli ng the appearance of the menu item in each of its states. A value for the DEFAUL T state must be provided. If the PENDING or CONFIRMED states are missing, they w ill not be shown.",
1031 "items": {
1032 "$ref": "MenuValue"
1033 },
1034 "type": "array"
1035 }
1036 },
1037 "type": "object"
1038 },
1039 "MenuValue": {
1040 "description": "A single value that is part of a MenuItem.",
1041 "id": "MenuValue",
1042 "properties": {
1043 "displayName": {
1044 "description": "The name to display for the menu item. If yo u specify this property for a built-in menu item, the default contextual voice c ommand for that menu item is not shown.",
1045 "type": "string"
1046 },
1047 "iconUrl": {
1048 "description": "URL of an icon to display with the menu item .",
1049 "type": "string"
1050 },
1051 "state": {
1052 "description": "The state that this value applies to. Allowe d values are: \n- DEFAULT - Default value shown when displayed in the menuItems list. \n- PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. \n- CONFIRMED - Value shown when the menuItem has b een selected by the user and can no longer be cancelled.",
1053 "type": "string"
1054 }
1055 },
1056 "type": "object"
1057 },
1058 "Notification": {
1059 "description": "A notification delivered by the API.",
1060 "id": "Notification",
1061 "properties": {
1062 "collection": {
1063 "description": "The collection that generated the notificati on.",
1064 "type": "string"
1065 },
1066 "itemId": {
1067 "description": "The ID of the item that generated the notifi cation.",
1068 "type": "string"
1069 },
1070 "operation": {
1071 "description": "The type of operation that generated the not ification.",
1072 "type": "string"
1073 },
1074 "userActions": {
1075 "description": "A list of actions taken by the user that tri ggered the notification.",
1076 "items": {
1077 "$ref": "UserAction"
1078 },
1079 "type": "array"
1080 },
1081 "userToken": {
1082 "description": "The user token provided by the service when it subscribed for notifications.",
1083 "type": "string"
1084 },
1085 "verifyToken": {
1086 "description": "The secret verify token provided by the serv ice when it subscribed for notifications.",
1087 "type": "string"
1088 }
1089 },
1090 "type": "object"
1091 },
1092 "NotificationConfig": {
1093 "description": "Controls how notifications for a timeline item are p resented to the user.",
1094 "id": "NotificationConfig",
1095 "properties": {
1096 "deliveryTime": {
1097 "description": "The time at which the notification should be delivered.",
1098 "format": "date-time",
1099 "type": "string"
1100 },
1101 "level": {
1102 "description": "Describes how important the notification is. Allowed values are: \n- DEFAULT - Notifications of default importance. A chime will be played to alert users.",
1103 "type": "string"
1104 }
1105 },
1106 "type": "object"
1107 },
1108 "Setting": {
1109 "description": "A setting for Glass.",
1110 "id": "Setting",
1111 "properties": {
1112 "id": {
1113 "description": "The setting's ID. The following IDs are vali d: \n- locale - The key to the user’s language/locale (BCP 47 identifier) that Glassware should use to render localized content. \n- timezone - The key to the user’s current time zone region as defined in the tz database. Example: America /Los_Angeles.",
1114 "type": "string"
1115 },
1116 "kind": {
1117 "default": "mirror#setting",
1118 "description": "The type of resource. This is always mirror# setting.",
1119 "type": "string"
1120 },
1121 "value": {
1122 "description": "The setting value, as a string.",
1123 "type": "string"
1124 }
1125 },
1126 "type": "object"
1127 },
1128 "Subscription": {
1129 "description": "A subscription to events on a collection.",
1130 "id": "Subscription",
1131 "properties": {
1132 "callbackUrl": {
1133 "annotations": {
1134 "required": [
1135 "mirror.subscriptions.insert",
1136 "mirror.subscriptions.update"
1137 ]
1138 },
1139 "description": "The URL where notifications should be delive red (must start with https://).",
1140 "type": "string"
1141 },
1142 "collection": {
1143 "annotations": {
1144 "required": [
1145 "mirror.subscriptions.insert",
1146 "mirror.subscriptions.update"
1147 ]
1148 },
1149 "description": "The collection to subscribe to. Allowed valu es are: \n- timeline - Changes in the timeline including insertion, deletion, a nd updates. \n- locations - Location updates. \n- settings - Settings updates.",
1150 "type": "string"
1151 },
1152 "id": {
1153 "description": "The ID of the subscription.",
1154 "type": "string"
1155 },
1156 "kind": {
1157 "default": "mirror#subscription",
1158 "description": "The type of resource. This is always mirror# subscription.",
1159 "type": "string"
1160 },
1161 "notification": {
1162 "$ref": "Notification",
1163 "description": "Container object for notifications. This is not populated in the Subscription resource."
1164 },
1165 "operation": {
1166 "description": "A list of operations that should be subscrib ed to. An empty list indicates that all operations on the collection should be s ubscribed to. Allowed values are: \n- UPDATE - The item has been updated. \n- I NSERT - A new item has been inserted. \n- DELETE - The item has been deleted. \n - MENU_ACTION - A custom menu item has been triggered by the user.",
1167 "items": {
1168 "type": "string"
1169 },
1170 "type": "array"
1171 },
1172 "updated": {
1173 "description": "The time at which this subscription was last modified, formatted according to RFC 3339.",
1174 "format": "date-time",
1175 "type": "string"
1176 },
1177 "userToken": {
1178 "description": "An opaque token sent to the subscriber in no tifications so that it can determine the ID of the user.",
1179 "type": "string"
1180 },
1181 "verifyToken": {
1182 "description": "A secret token sent to the subscriber in not ifications so that it can verify that the notification was generated by Google." ,
1183 "type": "string"
1184 }
1185 },
1186 "type": "object"
1187 },
1188 "SubscriptionsListResponse": {
1189 "description": "A list of Subscriptions. This is the response from t he server to GET requests on the subscription collection.",
1190 "id": "SubscriptionsListResponse",
1191 "properties": {
1192 "items": {
1193 "description": "The list of subscriptions.",
1194 "items": {
1195 "$ref": "Subscription"
1196 },
1197 "type": "array"
1198 },
1199 "kind": {
1200 "default": "mirror#subscriptionsList",
1201 "description": "The type of resource. This is always mirror# subscriptionsList.",
1202 "type": "string"
1203 }
1204 },
1205 "type": "object"
1206 },
1207 "TimelineItem": {
1208 "description": "Each item in the user's timeline is represented as a TimelineItem JSON structure, described below.",
1209 "id": "TimelineItem",
1210 "properties": {
1211 "attachments": {
1212 "description": "A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example: \n- attachment: <img src=\"atta chment:attachment_index\"> where attachment_index is the 0-based index of this a rray. \n- cid: <img src=\"cid:attachment_id\"> where attachment_id is the ID of the attachment.",
1213 "items": {
1214 "$ref": "Attachment"
1215 },
1216 "type": "array"
1217 },
1218 "bundleId": {
1219 "description": "The bundle ID for this item. Services can sp ecify a bundleId to group many items together. They appear under a single top-le vel item on the device.",
1220 "type": "string"
1221 },
1222 "canonicalUrl": {
1223 "description": "A canonical URL pointing to the canonical/hi gh quality version of the data represented by the timeline item.",
1224 "type": "string"
1225 },
1226 "created": {
1227 "description": "The time at which this item was created, for matted according to RFC 3339.",
1228 "format": "date-time",
1229 "type": "string"
1230 },
1231 "creator": {
1232 "$ref": "Contact",
1233 "description": "The user or group that created this item."
1234 },
1235 "displayTime": {
1236 "description": "The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's tim eline is sorted chronologically on display time, so this will also determine whe re the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time.",
1237 "format": "date-time",
1238 "type": "string"
1239 },
1240 "etag": {
1241 "description": "ETag for this item.",
1242 "type": "string"
1243 },
1244 "html": {
1245 "description": "HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline.\nAllo wed HTML elements - You can use these elements in your timeline cards.\n \n- Hea ders: h1, h2, h3, h4, h5, h6 \n- Images: img \n- Lists: li, ol, ul \n- HTML5 sem antics: article, aside, details, figure, figcaption, footer, header, nav, sectio n, summary, time \n- Structural: blockquote, br, div, hr, p, span \n- Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup \n- Tables: tab le, tbody, td, tfoot, th, thead, tr \nBlocked HTML elements: These elements and their contents are removed from HTML payloads.\n \n- Document headers: head, ti tle \n- Embeds: audio, embed, object, source, video \n- Frames: frame, frameset \n- Scripting: applet, script \nOther elements: Any elements that aren't listed are removed, but their contents are preserved.",
1246 "type": "string"
1247 },
1248 "id": {
1249 "description": "The ID of the timeline item. This is unique within a user's timeline.",
1250 "type": "string"
1251 },
1252 "inReplyTo": {
1253 "description": "If this item was generated as a reply to ano ther item, this field will be set to the ID of the item being replied to. This c an be used to attach a reply to the appropriate conversation or post.",
1254 "type": "string"
1255 },
1256 "isBundleCover": {
1257 "description": "Whether this item is a bundle cover.\n\nIf a n item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the mai n timeline — not within the opened bundle.\n\nOn the main timeline, items that a re shown are: \n- Items that have isBundleCover set to true \n- Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: \n- It ems that have the bundleId in question AND isBundleCover set to false",
1258 "type": "boolean"
1259 },
1260 "isDeleted": {
1261 "description": "When true, indicates this item is deleted, a nd only the ID property is set.",
1262 "type": "boolean"
1263 },
1264 "isPinned": {
1265 "description": "When true, indicates this item is pinned, wh ich means it's grouped alongside \"active\" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline it ems. You can allow the user to toggle the value of this property with the TOGGLE _PINNED built-in menu item.",
1266 "type": "boolean"
1267 },
1268 "kind": {
1269 "default": "mirror#timelineItem",
1270 "description": "The type of resource. This is always mirror# timelineItem.",
1271 "type": "string"
1272 },
1273 "location": {
1274 "$ref": "Location",
1275 "description": "The geographic location associated with this item."
1276 },
1277 "menuItems": {
1278 "description": "A list of menu items that will be presented to the user when this item is selected in the timeline.",
1279 "items": {
1280 "$ref": "MenuItem"
1281 },
1282 "type": "array"
1283 },
1284 "notification": {
1285 "$ref": "NotificationConfig",
1286 "description": "Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated. "
1287 },
1288 "pinScore": {
1289 "description": "For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing cl oser to the clock. Note: setting this field is currently not supported.",
1290 "format": "int32",
1291 "type": "integer"
1292 },
1293 "recipients": {
1294 "description": "A list of users or groups that this item has been shared with.",
1295 "items": {
1296 "$ref": "Contact"
1297 },
1298 "type": "array"
1299 },
1300 "selfLink": {
1301 "description": "A URL that can be used to retrieve this item .",
1302 "type": "string"
1303 },
1304 "sourceItemId": {
1305 "description": "Opaque string you can use to map a timeline item to data in your own service.",
1306 "type": "string"
1307 },
1308 "speakableText": {
1309 "description": "The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass.\n\nGlassware should also specify the speakableType field, which will be spoken before this text in cases where the additional conte xt is useful, for example when the user requests that the item be read aloud fol lowing a notification.",
1310 "type": "string"
1311 },
1312 "speakableType": {
1313 "description": "A speakable description of the type of this item. This will be announced to the user prior to reading the content of the ite m in cases where the additional context is useful, for example when the user req uests that the item be read aloud following a notification.\n\nThis should be a short, simple noun phrase such as \"Email\", \"Text message\", or \"Daily Planet News Update\".\n\nGlassware are encouraged to populate this field for every tim eline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen.",
1314 "type": "string"
1315 },
1316 "text": {
1317 "description": "Text content of this item.",
1318 "type": "string"
1319 },
1320 "title": {
1321 "description": "The title of this item.",
1322 "type": "string"
1323 },
1324 "updated": {
1325 "description": "The time at which this item was last modifie d, formatted according to RFC 3339.",
1326 "format": "date-time",
1327 "type": "string"
1328 }
1329 },
1330 "type": "object"
1331 },
1332 "TimelineListResponse": {
1333 "description": "A list of timeline items. This is the response from the server to GET requests on the timeline collection.",
1334 "id": "TimelineListResponse",
1335 "properties": {
1336 "items": {
1337 "description": "Items in the timeline.",
1338 "items": {
1339 "$ref": "TimelineItem"
1340 },
1341 "type": "array"
1342 },
1343 "kind": {
1344 "default": "mirror#timeline",
1345 "description": "The type of resource. This is always mirror# timeline.",
1346 "type": "string"
1347 },
1348 "nextPageToken": {
1349 "description": "The next page token. Provide this as the pag eToken parameter in the request to retrieve the next page of results.",
1350 "type": "string"
1351 }
1352 },
1353 "type": "object"
1354 },
1355 "UserAction": {
1356 "description": "Represents an action taken by the user that triggere d a notification.",
1357 "id": "UserAction",
1358 "properties": {
1359 "payload": {
1360 "description": "An optional payload for the action.\n\nFor a ctions of type CUSTOM, this is the ID of the custom menu item that was selected. ",
1361 "type": "string"
1362 },
1363 "type": {
1364 "description": "The type of action. The value of this can be : \n- SHARE - the user shared an item. \n- REPLY - the user replied to an item. \n- REPLY_ALL - the user replied to all recipients of an item. \n- CUSTOM - the user selected a custom menu item on the timeline item. \n- DELETE - the user de leted the item. \n- PIN - the user pinned the item. \n- UNPIN - the user unpinne d the item. \n- LAUNCH - the user initiated a voice command. In the future, add itional types may be added. UserActions with unrecognized types should be ignore d.",
1365 "type": "string"
1366 }
1367 },
1368 "type": "object"
1369 },
1370 "UserData": {
1371 "id": "UserData",
1372 "properties": {
1373 "key": {
1374 "type": "string"
1375 },
1376 "value": {
1377 "type": "string"
1378 }
1379 },
1380 "type": "object"
1381 }
1382 },
1383 "servicePath": "mirror/v1/",
1384 "title": "Google Mirror API",
1385 "version": "v1"
1386 }
OLDNEW
« no previous file with comments | « discovery/googleapis/mapsengine__v1.json ('k') | discovery/googleapis/oauth2__v2.json » ('j') | pubspec.yaml » ('J')

Powered by Google App Engine
This is Rietveld 408576698