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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/books__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/blogger__v3.json ('k') | discovery/googleapis/calendar__v3.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/books": {
6 "description": "Manage your books"
7 }
8 }
9 }
10 },
11 "basePath": "/books/v1/",
12 "baseUrl": "https://www.googleapis.com/books/v1/",
13 "batchPath": "batch",
14 "description": "Lets you search for books and manage your Google Books libra ry.",
15 "discoveryVersion": "v1",
16 "documentationLink": "https://developers.google.com/books/docs/v1/getting_st arted",
17 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/XYINYydMW1yxY9sZ7pYYpIG24qI\"",
18 "icons": {
19 "x16": "http://www.google.com/images/icons/product/ebooks-16.png",
20 "x32": "http://www.google.com/images/icons/product/ebooks-32.png"
21 },
22 "id": "books:v1",
23 "kind": "discovery#restDescription",
24 "name": "books",
25 "ownerDomain": "google.com",
26 "ownerName": "Google",
27 "parameters": {
28 "alt": {
29 "default": "json",
30 "description": "Data format for the response.",
31 "enum": [
32 "json"
33 ],
34 "enumDescriptions": [
35 "Responses with Content-Type of application/json"
36 ],
37 "location": "query",
38 "type": "string"
39 },
40 "fields": {
41 "description": "Selector specifying which fields to include in a par tial response.",
42 "location": "query",
43 "type": "string"
44 },
45 "key": {
46 "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.",
47 "location": "query",
48 "type": "string"
49 },
50 "oauth_token": {
51 "description": "OAuth 2.0 token for the current user.",
52 "location": "query",
53 "type": "string"
54 },
55 "prettyPrint": {
56 "default": "true",
57 "description": "Returns response with indentations and line breaks." ,
58 "location": "query",
59 "type": "boolean"
60 },
61 "quotaUser": {
62 "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.",
63 "location": "query",
64 "type": "string"
65 },
66 "userIp": {
67 "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
68 "location": "query",
69 "type": "string"
70 }
71 },
72 "protocol": "rest",
73 "resources": {
74 "bookshelves": {
75 "methods": {
76 "get": {
77 "description": "Retrieves metadata for a specific bookshelf for the specified user.",
78 "httpMethod": "GET",
79 "id": "books.bookshelves.get",
80 "parameterOrder": [
81 "userId",
82 "shelf"
83 ],
84 "parameters": {
85 "shelf": {
86 "description": "ID of bookshelf to retrieve.",
87 "location": "path",
88 "required": true,
89 "type": "string"
90 },
91 "source": {
92 "description": "String to identify the originator of this request.",
93 "location": "query",
94 "type": "string"
95 },
96 "userId": {
97 "description": "ID of user for whom to retrieve book shelves.",
98 "location": "path",
99 "required": true,
100 "type": "string"
101 }
102 },
103 "path": "users/{userId}/bookshelves/{shelf}",
104 "response": {
105 "$ref": "Bookshelf"
106 },
107 "scopes": [
108 "https://www.googleapis.com/auth/books"
109 ]
110 },
111 "list": {
112 "description": "Retrieves a list of public bookshelves for t he specified user.",
113 "httpMethod": "GET",
114 "id": "books.bookshelves.list",
115 "parameterOrder": [
116 "userId"
117 ],
118 "parameters": {
119 "source": {
120 "description": "String to identify the originator of this request.",
121 "location": "query",
122 "type": "string"
123 },
124 "userId": {
125 "description": "ID of user for whom to retrieve book shelves.",
126 "location": "path",
127 "required": true,
128 "type": "string"
129 }
130 },
131 "path": "users/{userId}/bookshelves",
132 "response": {
133 "$ref": "Bookshelves"
134 },
135 "scopes": [
136 "https://www.googleapis.com/auth/books"
137 ]
138 }
139 },
140 "resources": {
141 "volumes": {
142 "methods": {
143 "list": {
144 "description": "Retrieves volumes in a specific book shelf for the specified user.",
145 "httpMethod": "GET",
146 "id": "books.bookshelves.volumes.list",
147 "parameterOrder": [
148 "userId",
149 "shelf"
150 ],
151 "parameters": {
152 "maxResults": {
153 "description": "Maximum number of results to return",
154 "format": "uint32",
155 "location": "query",
156 "minimum": "0",
157 "type": "integer"
158 },
159 "shelf": {
160 "description": "ID of bookshelf to retrieve volumes.",
161 "location": "path",
162 "required": true,
163 "type": "string"
164 },
165 "showPreorders": {
166 "description": "Set to true to show pre-orde red books. Defaults to false.",
167 "location": "query",
168 "type": "boolean"
169 },
170 "source": {
171 "description": "String to identify the origi nator of this request.",
172 "location": "query",
173 "type": "string"
174 },
175 "startIndex": {
176 "description": "Index of the first element t o return (starts at 0)",
177 "format": "uint32",
178 "location": "query",
179 "minimum": "0",
180 "type": "integer"
181 },
182 "userId": {
183 "description": "ID of user for whom to retri eve bookshelf volumes.",
184 "location": "path",
185 "required": true,
186 "type": "string"
187 }
188 },
189 "path": "users/{userId}/bookshelves/{shelf}/volumes" ,
190 "response": {
191 "$ref": "Volumes"
192 },
193 "scopes": [
194 "https://www.googleapis.com/auth/books"
195 ]
196 }
197 }
198 }
199 }
200 },
201 "cloudloading": {
202 "methods": {
203 "addBook": {
204 "description": "",
205 "httpMethod": "POST",
206 "id": "books.cloudloading.addBook",
207 "parameters": {
208 "drive_document_id": {
209 "description": "A drive document id. The upload_clie nt_token must not be set.",
210 "location": "query",
211 "type": "string"
212 },
213 "mime_type": {
214 "description": "The document MIME type. It can be se t only if the drive_document_id is set.",
215 "location": "query",
216 "type": "string"
217 },
218 "name": {
219 "description": "The document name. It can be set onl y if the drive_document_id is set.",
220 "location": "query",
221 "type": "string"
222 },
223 "upload_client_token": {
224 "location": "query",
225 "type": "string"
226 }
227 },
228 "path": "cloudloading/addBook",
229 "response": {
230 "$ref": "BooksCloudloadingResource"
231 },
232 "scopes": [
233 "https://www.googleapis.com/auth/books"
234 ]
235 },
236 "deleteBook": {
237 "description": "Remove the book and its contents",
238 "httpMethod": "POST",
239 "id": "books.cloudloading.deleteBook",
240 "parameterOrder": [
241 "volumeId"
242 ],
243 "parameters": {
244 "volumeId": {
245 "description": "The id of the book to be removed.",
246 "location": "query",
247 "required": true,
248 "type": "string"
249 }
250 },
251 "path": "cloudloading/deleteBook",
252 "scopes": [
253 "https://www.googleapis.com/auth/books"
254 ]
255 },
256 "updateBook": {
257 "description": "",
258 "httpMethod": "POST",
259 "id": "books.cloudloading.updateBook",
260 "path": "cloudloading/updateBook",
261 "request": {
262 "$ref": "BooksCloudloadingResource"
263 },
264 "response": {
265 "$ref": "BooksCloudloadingResource"
266 },
267 "scopes": [
268 "https://www.googleapis.com/auth/books"
269 ]
270 }
271 }
272 },
273 "layers": {
274 "methods": {
275 "get": {
276 "description": "Gets the layer summary for a volume.",
277 "httpMethod": "GET",
278 "id": "books.layers.get",
279 "parameterOrder": [
280 "volumeId",
281 "summaryId"
282 ],
283 "parameters": {
284 "contentVersion": {
285 "description": "The content version for the requeste d volume.",
286 "location": "query",
287 "type": "string"
288 },
289 "source": {
290 "description": "String to identify the originator of this request.",
291 "location": "query",
292 "type": "string"
293 },
294 "summaryId": {
295 "description": "The ID for the layer to get the summ ary for.",
296 "location": "path",
297 "required": true,
298 "type": "string"
299 },
300 "volumeId": {
301 "description": "The volume to retrieve layers for.",
302 "location": "path",
303 "required": true,
304 "type": "string"
305 }
306 },
307 "path": "volumes/{volumeId}/layersummary/{summaryId}",
308 "response": {
309 "$ref": "Layersummary"
310 },
311 "scopes": [
312 "https://www.googleapis.com/auth/books"
313 ]
314 },
315 "list": {
316 "description": "List the layer summaries for a volume.",
317 "httpMethod": "GET",
318 "id": "books.layers.list",
319 "parameterOrder": [
320 "volumeId"
321 ],
322 "parameters": {
323 "contentVersion": {
324 "description": "The content version for the requeste d volume.",
325 "location": "query",
326 "type": "string"
327 },
328 "maxResults": {
329 "description": "Maximum number of results to return" ,
330 "format": "uint32",
331 "location": "query",
332 "maximum": "200",
333 "minimum": "0",
334 "type": "integer"
335 },
336 "pageToken": {
337 "description": "The value of the nextToken from the previous page.",
338 "location": "query",
339 "type": "string"
340 },
341 "source": {
342 "description": "String to identify the originator of this request.",
343 "location": "query",
344 "type": "string"
345 },
346 "volumeId": {
347 "description": "The volume to retrieve layers for.",
348 "location": "path",
349 "required": true,
350 "type": "string"
351 }
352 },
353 "path": "volumes/{volumeId}/layersummary",
354 "response": {
355 "$ref": "Layersummaries"
356 },
357 "scopes": [
358 "https://www.googleapis.com/auth/books"
359 ]
360 }
361 },
362 "resources": {
363 "annotationData": {
364 "methods": {
365 "get": {
366 "description": "Gets the annotation data.",
367 "httpMethod": "GET",
368 "id": "books.layers.annotationData.get",
369 "parameterOrder": [
370 "volumeId",
371 "layerId",
372 "annotationDataId",
373 "contentVersion"
374 ],
375 "parameters": {
376 "allowWebDefinitions": {
377 "description": "For the dictionary layer. Wh ether or not to allow web definitions.",
378 "location": "query",
379 "type": "boolean"
380 },
381 "annotationDataId": {
382 "description": "The ID of the annotation dat a to retrieve.",
383 "location": "path",
384 "required": true,
385 "type": "string"
386 },
387 "contentVersion": {
388 "description": "The content version for the volume you are trying to retrieve.",
389 "location": "query",
390 "required": true,
391 "type": "string"
392 },
393 "h": {
394 "description": "The requested pixel height f or any images. If height is provided width must also be provided.",
395 "format": "int32",
396 "location": "query",
397 "type": "integer"
398 },
399 "layerId": {
400 "description": "The ID for the layer to get the annotations.",
401 "location": "path",
402 "required": true,
403 "type": "string"
404 },
405 "locale": {
406 "description": "The locale information for t he data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
407 "location": "query",
408 "type": "string"
409 },
410 "scale": {
411 "description": "The requested scale for the image.",
412 "format": "int32",
413 "location": "query",
414 "minimum": "0",
415 "type": "integer"
416 },
417 "source": {
418 "description": "String to identify the origi nator of this request.",
419 "location": "query",
420 "type": "string"
421 },
422 "volumeId": {
423 "description": "The volume to retrieve annot ations for.",
424 "location": "path",
425 "required": true,
426 "type": "string"
427 },
428 "w": {
429 "description": "The requested pixel width fo r any images. If width is provided height must also be provided.",
430 "format": "int32",
431 "location": "query",
432 "type": "integer"
433 }
434 },
435 "path": "volumes/{volumeId}/layers/{layerId}/data/{a nnotationDataId}",
436 "response": {
437 "$ref": "Annotationdata"
438 },
439 "scopes": [
440 "https://www.googleapis.com/auth/books"
441 ]
442 },
443 "list": {
444 "description": "Gets the annotation data for a volum e and layer.",
445 "httpMethod": "GET",
446 "id": "books.layers.annotationData.list",
447 "parameterOrder": [
448 "volumeId",
449 "layerId",
450 "contentVersion"
451 ],
452 "parameters": {
453 "annotationDataId": {
454 "description": "The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.",
455 "location": "query",
456 "repeated": true,
457 "type": "string"
458 },
459 "contentVersion": {
460 "description": "The content version for the requested volume.",
461 "location": "query",
462 "required": true,
463 "type": "string"
464 },
465 "h": {
466 "description": "The requested pixel height f or any images. If height is provided width must also be provided.",
467 "format": "int32",
468 "location": "query",
469 "type": "integer"
470 },
471 "layerId": {
472 "description": "The ID for the layer to get the annotation data.",
473 "location": "path",
474 "required": true,
475 "type": "string"
476 },
477 "locale": {
478 "description": "The locale information for t he data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
479 "location": "query",
480 "type": "string"
481 },
482 "maxResults": {
483 "description": "Maximum number of results to return",
484 "format": "uint32",
485 "location": "query",
486 "maximum": "200",
487 "minimum": "0",
488 "type": "integer"
489 },
490 "pageToken": {
491 "description": "The value of the nextToken f rom the previous page.",
492 "location": "query",
493 "type": "string"
494 },
495 "scale": {
496 "description": "The requested scale for the image.",
497 "format": "int32",
498 "location": "query",
499 "minimum": "0",
500 "type": "integer"
501 },
502 "source": {
503 "description": "String to identify the origi nator of this request.",
504 "location": "query",
505 "type": "string"
506 },
507 "updatedMax": {
508 "description": "RFC 3339 timestamp to restri ct to items updated prior to this timestamp (exclusive).",
509 "location": "query",
510 "type": "string"
511 },
512 "updatedMin": {
513 "description": "RFC 3339 timestamp to restri ct to items updated since this timestamp (inclusive).",
514 "location": "query",
515 "type": "string"
516 },
517 "volumeId": {
518 "description": "The volume to retrieve annot ation data for.",
519 "location": "path",
520 "required": true,
521 "type": "string"
522 },
523 "w": {
524 "description": "The requested pixel width fo r any images. If width is provided height must also be provided.",
525 "format": "int32",
526 "location": "query",
527 "type": "integer"
528 }
529 },
530 "path": "volumes/{volumeId}/layers/{layerId}/data",
531 "response": {
532 "$ref": "Annotationsdata"
533 },
534 "scopes": [
535 "https://www.googleapis.com/auth/books"
536 ]
537 }
538 }
539 },
540 "volumeAnnotations": {
541 "methods": {
542 "get": {
543 "description": "Gets the volume annotation.",
544 "httpMethod": "GET",
545 "id": "books.layers.volumeAnnotations.get",
546 "parameterOrder": [
547 "volumeId",
548 "layerId",
549 "annotationId"
550 ],
551 "parameters": {
552 "annotationId": {
553 "description": "The ID of the volume annotat ion to retrieve.",
554 "location": "path",
555 "required": true,
556 "type": "string"
557 },
558 "layerId": {
559 "description": "The ID for the layer to get the annotations.",
560 "location": "path",
561 "required": true,
562 "type": "string"
563 },
564 "locale": {
565 "description": "The locale information for t he data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
566 "location": "query",
567 "type": "string"
568 },
569 "source": {
570 "description": "String to identify the origi nator of this request.",
571 "location": "query",
572 "type": "string"
573 },
574 "volumeId": {
575 "description": "The volume to retrieve annot ations for.",
576 "location": "path",
577 "required": true,
578 "type": "string"
579 }
580 },
581 "path": "volumes/{volumeId}/layers/{layerId}/annotat ions/{annotationId}",
582 "response": {
583 "$ref": "Volumeannotation"
584 },
585 "scopes": [
586 "https://www.googleapis.com/auth/books"
587 ]
588 },
589 "list": {
590 "description": "Gets the volume annotations for a vo lume and layer.",
591 "httpMethod": "GET",
592 "id": "books.layers.volumeAnnotations.list",
593 "parameterOrder": [
594 "volumeId",
595 "layerId",
596 "contentVersion"
597 ],
598 "parameters": {
599 "contentVersion": {
600 "description": "The content version for the requested volume.",
601 "location": "query",
602 "required": true,
603 "type": "string"
604 },
605 "endOffset": {
606 "description": "The end offset to end retrie ving data from.",
607 "location": "query",
608 "type": "string"
609 },
610 "endPosition": {
611 "description": "The end position to end retr ieving data from.",
612 "location": "query",
613 "type": "string"
614 },
615 "layerId": {
616 "description": "The ID for the layer to get the annotations.",
617 "location": "path",
618 "required": true,
619 "type": "string"
620 },
621 "locale": {
622 "description": "The locale information for t he data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
623 "location": "query",
624 "type": "string"
625 },
626 "maxResults": {
627 "description": "Maximum number of results to return",
628 "format": "uint32",
629 "location": "query",
630 "maximum": "200",
631 "minimum": "0",
632 "type": "integer"
633 },
634 "pageToken": {
635 "description": "The value of the nextToken f rom the previous page.",
636 "location": "query",
637 "type": "string"
638 },
639 "showDeleted": {
640 "description": "Set to true to return delete d annotations. updatedMin must be in the request to use this. Defaults to false. ",
641 "location": "query",
642 "type": "boolean"
643 },
644 "source": {
645 "description": "String to identify the origi nator of this request.",
646 "location": "query",
647 "type": "string"
648 },
649 "startOffset": {
650 "description": "The start offset to start re trieving data from.",
651 "location": "query",
652 "type": "string"
653 },
654 "startPosition": {
655 "description": "The start position to start retrieving data from.",
656 "location": "query",
657 "type": "string"
658 },
659 "updatedMax": {
660 "description": "RFC 3339 timestamp to restri ct to items updated prior to this timestamp (exclusive).",
661 "location": "query",
662 "type": "string"
663 },
664 "updatedMin": {
665 "description": "RFC 3339 timestamp to restri ct to items updated since this timestamp (inclusive).",
666 "location": "query",
667 "type": "string"
668 },
669 "volumeAnnotationsVersion": {
670 "description": "The version of the volume an notations that you are requesting.",
671 "location": "query",
672 "type": "string"
673 },
674 "volumeId": {
675 "description": "The volume to retrieve annot ations for.",
676 "location": "path",
677 "required": true,
678 "type": "string"
679 }
680 },
681 "path": "volumes/{volumeId}/layers/{layerId}",
682 "response": {
683 "$ref": "Volumeannotations"
684 },
685 "scopes": [
686 "https://www.googleapis.com/auth/books"
687 ]
688 }
689 }
690 }
691 }
692 },
693 "myconfig": {
694 "methods": {
695 "releaseDownloadAccess": {
696 "description": "Release downloaded content access restrictio n.",
697 "httpMethod": "POST",
698 "id": "books.myconfig.releaseDownloadAccess",
699 "parameterOrder": [
700 "volumeIds",
701 "cpksver"
702 ],
703 "parameters": {
704 "cpksver": {
705 "description": "The device/version ID from which to release the restriction.",
706 "location": "query",
707 "required": true,
708 "type": "string"
709 },
710 "locale": {
711 "description": "ISO-639-1, ISO-3166-1 codes for mess age localization, i.e. en_US.",
712 "location": "query",
713 "type": "string"
714 },
715 "source": {
716 "description": "String to identify the originator of this request.",
717 "location": "query",
718 "type": "string"
719 },
720 "volumeIds": {
721 "description": "The volume(s) to release restriction s for.",
722 "location": "query",
723 "repeated": true,
724 "required": true,
725 "type": "string"
726 }
727 },
728 "path": "myconfig/releaseDownloadAccess",
729 "response": {
730 "$ref": "DownloadAccesses"
731 },
732 "scopes": [
733 "https://www.googleapis.com/auth/books"
734 ]
735 },
736 "requestAccess": {
737 "description": "Request concurrent and download access restr ictions.",
738 "httpMethod": "POST",
739 "id": "books.myconfig.requestAccess",
740 "parameterOrder": [
741 "source",
742 "volumeId",
743 "nonce",
744 "cpksver"
745 ],
746 "parameters": {
747 "cpksver": {
748 "description": "The device/version ID from which to request the restrictions.",
749 "location": "query",
750 "required": true,
751 "type": "string"
752 },
753 "licenseTypes": {
754 "description": "The type of access license to reques t. If not specified, the default is BOTH.",
755 "enum": [
756 "BOTH",
757 "CONCURRENT",
758 "DOWNLOAD"
759 ],
760 "enumDescriptions": [
761 "Both concurrent and download licenses.",
762 "Concurrent access license.",
763 "Offline download access license."
764 ],
765 "location": "query",
766 "type": "string"
767 },
768 "locale": {
769 "description": "ISO-639-1, ISO-3166-1 codes for mess age localization, i.e. en_US.",
770 "location": "query",
771 "type": "string"
772 },
773 "nonce": {
774 "description": "The client nonce value.",
775 "location": "query",
776 "required": true,
777 "type": "string"
778 },
779 "source": {
780 "description": "String to identify the originator of this request.",
781 "location": "query",
782 "required": true,
783 "type": "string"
784 },
785 "volumeId": {
786 "description": "The volume to request concurrent/dow nload restrictions for.",
787 "location": "query",
788 "required": true,
789 "type": "string"
790 }
791 },
792 "path": "myconfig/requestAccess",
793 "response": {
794 "$ref": "RequestAccess"
795 },
796 "scopes": [
797 "https://www.googleapis.com/auth/books"
798 ]
799 },
800 "syncVolumeLicenses": {
801 "description": "Request downloaded content access for specif ied volumes on the My eBooks shelf.",
802 "httpMethod": "POST",
803 "id": "books.myconfig.syncVolumeLicenses",
804 "parameterOrder": [
805 "source",
806 "nonce",
807 "cpksver"
808 ],
809 "parameters": {
810 "cpksver": {
811 "description": "The device/version ID from which to release the restriction.",
812 "location": "query",
813 "required": true,
814 "type": "string"
815 },
816 "features": {
817 "description": "List of features supported by the cl ient, i.e., 'RENTALS'",
818 "enum": [
819 "RENTALS"
820 ],
821 "enumDescriptions": [
822 "Client supports rentals."
823 ],
824 "location": "query",
825 "repeated": true,
826 "type": "string"
827 },
828 "locale": {
829 "description": "ISO-639-1, ISO-3166-1 codes for mess age localization, i.e. en_US.",
830 "location": "query",
831 "type": "string"
832 },
833 "nonce": {
834 "description": "The client nonce value.",
835 "location": "query",
836 "required": true,
837 "type": "string"
838 },
839 "showPreorders": {
840 "description": "Set to true to show pre-ordered book s. Defaults to false.",
841 "location": "query",
842 "type": "boolean"
843 },
844 "source": {
845 "description": "String to identify the originator of this request.",
846 "location": "query",
847 "required": true,
848 "type": "string"
849 },
850 "volumeIds": {
851 "description": "The volume(s) to request download re strictions for.",
852 "location": "query",
853 "repeated": true,
854 "type": "string"
855 }
856 },
857 "path": "myconfig/syncVolumeLicenses",
858 "response": {
859 "$ref": "Volumes"
860 },
861 "scopes": [
862 "https://www.googleapis.com/auth/books"
863 ]
864 }
865 }
866 },
867 "mylibrary": {
868 "resources": {
869 "annotations": {
870 "methods": {
871 "delete": {
872 "description": "Deletes an annotation.",
873 "httpMethod": "DELETE",
874 "id": "books.mylibrary.annotations.delete",
875 "parameterOrder": [
876 "annotationId"
877 ],
878 "parameters": {
879 "annotationId": {
880 "description": "The ID for the annotation to delete.",
881 "location": "path",
882 "required": true,
883 "type": "string"
884 },
885 "source": {
886 "description": "String to identify the origi nator of this request.",
887 "location": "query",
888 "type": "string"
889 }
890 },
891 "path": "mylibrary/annotations/{annotationId}",
892 "scopes": [
893 "https://www.googleapis.com/auth/books"
894 ]
895 },
896 "get": {
897 "description": "Gets an annotation by its ID.",
898 "httpMethod": "GET",
899 "id": "books.mylibrary.annotations.get",
900 "parameterOrder": [
901 "annotationId"
902 ],
903 "parameters": {
904 "annotationId": {
905 "description": "The ID for the annotation to retrieve.",
906 "location": "path",
907 "required": true,
908 "type": "string"
909 },
910 "source": {
911 "description": "String to identify the origi nator of this request.",
912 "location": "query",
913 "type": "string"
914 }
915 },
916 "path": "mylibrary/annotations/{annotationId}",
917 "response": {
918 "$ref": "Annotation"
919 },
920 "scopes": [
921 "https://www.googleapis.com/auth/books"
922 ]
923 },
924 "insert": {
925 "description": "Inserts a new annotation.",
926 "httpMethod": "POST",
927 "id": "books.mylibrary.annotations.insert",
928 "parameters": {
929 "showOnlySummaryInResponse": {
930 "description": "Requests that only the summa ry of the specified layer be provided in the response.",
931 "location": "query",
932 "type": "boolean"
933 },
934 "source": {
935 "description": "String to identify the origi nator of this request.",
936 "location": "query",
937 "type": "string"
938 }
939 },
940 "path": "mylibrary/annotations",
941 "request": {
942 "$ref": "Annotation"
943 },
944 "response": {
945 "$ref": "Annotation"
946 },
947 "scopes": [
948 "https://www.googleapis.com/auth/books"
949 ]
950 },
951 "list": {
952 "description": "Retrieves a list of annotations, pos sibly filtered.",
953 "httpMethod": "GET",
954 "id": "books.mylibrary.annotations.list",
955 "parameters": {
956 "contentVersion": {
957 "description": "The content version for the requested volume.",
958 "location": "query",
959 "type": "string"
960 },
961 "layerId": {
962 "description": "The layer ID to limit annota tion by.",
963 "location": "query",
964 "type": "string"
965 },
966 "layerIds": {
967 "description": "The layer ID(s) to limit ann otation by.",
968 "location": "query",
969 "repeated": true,
970 "type": "string"
971 },
972 "maxResults": {
973 "description": "Maximum number of results to return",
974 "format": "uint32",
975 "location": "query",
976 "maximum": "40",
977 "minimum": "0",
978 "type": "integer"
979 },
980 "pageIds": {
981 "description": "The page ID(s) for the volum e that is being queried.",
982 "location": "query",
983 "repeated": true,
984 "type": "string"
985 },
986 "pageToken": {
987 "description": "The value of the nextToken f rom the previous page.",
988 "location": "query",
989 "type": "string"
990 },
991 "showDeleted": {
992 "description": "Set to true to return delete d annotations. updatedMin must be in the request to use this. Defaults to false. ",
993 "location": "query",
994 "type": "boolean"
995 },
996 "source": {
997 "description": "String to identify the origi nator of this request.",
998 "location": "query",
999 "type": "string"
1000 },
1001 "updatedMax": {
1002 "description": "RFC 3339 timestamp to restri ct to items updated prior to this timestamp (exclusive).",
1003 "location": "query",
1004 "type": "string"
1005 },
1006 "updatedMin": {
1007 "description": "RFC 3339 timestamp to restri ct to items updated since this timestamp (inclusive).",
1008 "location": "query",
1009 "type": "string"
1010 },
1011 "volumeId": {
1012 "description": "The volume to restrict annot ations to.",
1013 "location": "query",
1014 "type": "string"
1015 }
1016 },
1017 "path": "mylibrary/annotations",
1018 "response": {
1019 "$ref": "Annotations"
1020 },
1021 "scopes": [
1022 "https://www.googleapis.com/auth/books"
1023 ]
1024 },
1025 "summary": {
1026 "description": "Gets the summary of specified layers .",
1027 "httpMethod": "POST",
1028 "id": "books.mylibrary.annotations.summary",
1029 "parameterOrder": [
1030 "layerIds",
1031 "volumeId"
1032 ],
1033 "parameters": {
1034 "layerIds": {
1035 "description": "Array of layer IDs to get th e summary for.",
1036 "location": "query",
1037 "repeated": true,
1038 "required": true,
1039 "type": "string"
1040 },
1041 "volumeId": {
1042 "description": "Volume id to get the summary for.",
1043 "location": "query",
1044 "required": true,
1045 "type": "string"
1046 }
1047 },
1048 "path": "mylibrary/annotations/summary",
1049 "response": {
1050 "$ref": "AnnotationsSummary"
1051 },
1052 "scopes": [
1053 "https://www.googleapis.com/auth/books"
1054 ]
1055 },
1056 "update": {
1057 "description": "Updates an existing annotation.",
1058 "httpMethod": "PUT",
1059 "id": "books.mylibrary.annotations.update",
1060 "parameterOrder": [
1061 "annotationId"
1062 ],
1063 "parameters": {
1064 "annotationId": {
1065 "description": "The ID for the annotation to update.",
1066 "location": "path",
1067 "required": true,
1068 "type": "string"
1069 },
1070 "source": {
1071 "description": "String to identify the origi nator of this request.",
1072 "location": "query",
1073 "type": "string"
1074 }
1075 },
1076 "path": "mylibrary/annotations/{annotationId}",
1077 "request": {
1078 "$ref": "Annotation"
1079 },
1080 "response": {
1081 "$ref": "Annotation"
1082 },
1083 "scopes": [
1084 "https://www.googleapis.com/auth/books"
1085 ]
1086 }
1087 }
1088 },
1089 "bookshelves": {
1090 "methods": {
1091 "addVolume": {
1092 "description": "Adds a volume to a bookshelf.",
1093 "httpMethod": "POST",
1094 "id": "books.mylibrary.bookshelves.addVolume",
1095 "parameterOrder": [
1096 "shelf",
1097 "volumeId"
1098 ],
1099 "parameters": {
1100 "shelf": {
1101 "description": "ID of bookshelf to which to add a volume.",
1102 "location": "path",
1103 "required": true,
1104 "type": "string"
1105 },
1106 "source": {
1107 "description": "String to identify the origi nator of this request.",
1108 "location": "query",
1109 "type": "string"
1110 },
1111 "volumeId": {
1112 "description": "ID of volume to add.",
1113 "location": "query",
1114 "required": true,
1115 "type": "string"
1116 }
1117 },
1118 "path": "mylibrary/bookshelves/{shelf}/addVolume",
1119 "scopes": [
1120 "https://www.googleapis.com/auth/books"
1121 ]
1122 },
1123 "clearVolumes": {
1124 "description": "Clears all volumes from a bookshelf. ",
1125 "httpMethod": "POST",
1126 "id": "books.mylibrary.bookshelves.clearVolumes",
1127 "parameterOrder": [
1128 "shelf"
1129 ],
1130 "parameters": {
1131 "shelf": {
1132 "description": "ID of bookshelf from which t o remove a volume.",
1133 "location": "path",
1134 "required": true,
1135 "type": "string"
1136 },
1137 "source": {
1138 "description": "String to identify the origi nator of this request.",
1139 "location": "query",
1140 "type": "string"
1141 }
1142 },
1143 "path": "mylibrary/bookshelves/{shelf}/clearVolumes" ,
1144 "scopes": [
1145 "https://www.googleapis.com/auth/books"
1146 ]
1147 },
1148 "get": {
1149 "description": "Retrieves metadata for a specific bo okshelf belonging to the authenticated user.",
1150 "httpMethod": "GET",
1151 "id": "books.mylibrary.bookshelves.get",
1152 "parameterOrder": [
1153 "shelf"
1154 ],
1155 "parameters": {
1156 "shelf": {
1157 "description": "ID of bookshelf to retrieve. ",
1158 "location": "path",
1159 "required": true,
1160 "type": "string"
1161 },
1162 "source": {
1163 "description": "String to identify the origi nator of this request.",
1164 "location": "query",
1165 "type": "string"
1166 }
1167 },
1168 "path": "mylibrary/bookshelves/{shelf}",
1169 "response": {
1170 "$ref": "Bookshelf"
1171 },
1172 "scopes": [
1173 "https://www.googleapis.com/auth/books"
1174 ]
1175 },
1176 "list": {
1177 "description": "Retrieves a list of bookshelves belo nging to the authenticated user.",
1178 "httpMethod": "GET",
1179 "id": "books.mylibrary.bookshelves.list",
1180 "parameters": {
1181 "source": {
1182 "description": "String to identify the origi nator of this request.",
1183 "location": "query",
1184 "type": "string"
1185 }
1186 },
1187 "path": "mylibrary/bookshelves",
1188 "response": {
1189 "$ref": "Bookshelves"
1190 },
1191 "scopes": [
1192 "https://www.googleapis.com/auth/books"
1193 ]
1194 },
1195 "moveVolume": {
1196 "description": "Moves a volume within a bookshelf.",
1197 "httpMethod": "POST",
1198 "id": "books.mylibrary.bookshelves.moveVolume",
1199 "parameterOrder": [
1200 "shelf",
1201 "volumeId",
1202 "volumePosition"
1203 ],
1204 "parameters": {
1205 "shelf": {
1206 "description": "ID of bookshelf with the vol ume.",
1207 "location": "path",
1208 "required": true,
1209 "type": "string"
1210 },
1211 "source": {
1212 "description": "String to identify the origi nator of this request.",
1213 "location": "query",
1214 "type": "string"
1215 },
1216 "volumeId": {
1217 "description": "ID of volume to move.",
1218 "location": "query",
1219 "required": true,
1220 "type": "string"
1221 },
1222 "volumePosition": {
1223 "description": "Position on shelf to move th e item (0 puts the item before the current first item, 1 puts it between the fir st and the second and so on.)",
1224 "format": "int32",
1225 "location": "query",
1226 "required": true,
1227 "type": "integer"
1228 }
1229 },
1230 "path": "mylibrary/bookshelves/{shelf}/moveVolume",
1231 "scopes": [
1232 "https://www.googleapis.com/auth/books"
1233 ]
1234 },
1235 "removeVolume": {
1236 "description": "Removes a volume from a bookshelf.",
1237 "httpMethod": "POST",
1238 "id": "books.mylibrary.bookshelves.removeVolume",
1239 "parameterOrder": [
1240 "shelf",
1241 "volumeId"
1242 ],
1243 "parameters": {
1244 "shelf": {
1245 "description": "ID of bookshelf from which t o remove a volume.",
1246 "location": "path",
1247 "required": true,
1248 "type": "string"
1249 },
1250 "source": {
1251 "description": "String to identify the origi nator of this request.",
1252 "location": "query",
1253 "type": "string"
1254 },
1255 "volumeId": {
1256 "description": "ID of volume to remove.",
1257 "location": "query",
1258 "required": true,
1259 "type": "string"
1260 }
1261 },
1262 "path": "mylibrary/bookshelves/{shelf}/removeVolume" ,
1263 "scopes": [
1264 "https://www.googleapis.com/auth/books"
1265 ]
1266 }
1267 },
1268 "resources": {
1269 "volumes": {
1270 "methods": {
1271 "list": {
1272 "description": "Gets volume information for volumes on a bookshelf.",
1273 "httpMethod": "GET",
1274 "id": "books.mylibrary.bookshelves.volumes.l ist",
1275 "parameterOrder": [
1276 "shelf"
1277 ],
1278 "parameters": {
1279 "country": {
1280 "description": "ISO-3166-1 code to o verride the IP-based location.",
1281 "location": "query",
1282 "type": "string"
1283 },
1284 "maxResults": {
1285 "description": "Maximum number of re sults to return",
1286 "format": "uint32",
1287 "location": "query",
1288 "minimum": "0",
1289 "type": "integer"
1290 },
1291 "projection": {
1292 "description": "Restrict information returned to a set of selected fields.",
1293 "enum": [
1294 "full",
1295 "lite"
1296 ],
1297 "enumDescriptions": [
1298 "Includes all volume data.",
1299 "Includes a subset of fields in volumeInfo and accessInfo."
1300 ],
1301 "location": "query",
1302 "type": "string"
1303 },
1304 "q": {
1305 "description": "Full-text search que ry string in this bookshelf.",
1306 "location": "query",
1307 "type": "string"
1308 },
1309 "shelf": {
1310 "description": "The bookshelf ID or name retrieve volumes for.",
1311 "location": "path",
1312 "required": true,
1313 "type": "string"
1314 },
1315 "showPreorders": {
1316 "description": "Set to true to show pre-ordered books. Defaults to false.",
1317 "location": "query",
1318 "type": "boolean"
1319 },
1320 "source": {
1321 "description": "String to identify t he originator of this request.",
1322 "location": "query",
1323 "type": "string"
1324 },
1325 "startIndex": {
1326 "description": "Index of the first e lement to return (starts at 0)",
1327 "format": "uint32",
1328 "location": "query",
1329 "minimum": "0",
1330 "type": "integer"
1331 }
1332 },
1333 "path": "mylibrary/bookshelves/{shelf}/volum es",
1334 "response": {
1335 "$ref": "Volumes"
1336 },
1337 "scopes": [
1338 "https://www.googleapis.com/auth/books"
1339 ]
1340 }
1341 }
1342 }
1343 }
1344 },
1345 "readingpositions": {
1346 "methods": {
1347 "get": {
1348 "description": "Retrieves my reading position inform ation for a volume.",
1349 "httpMethod": "GET",
1350 "id": "books.mylibrary.readingpositions.get",
1351 "parameterOrder": [
1352 "volumeId"
1353 ],
1354 "parameters": {
1355 "contentVersion": {
1356 "description": "Volume content version for w hich this reading position is requested.",
1357 "location": "query",
1358 "type": "string"
1359 },
1360 "source": {
1361 "description": "String to identify the origi nator of this request.",
1362 "location": "query",
1363 "type": "string"
1364 },
1365 "volumeId": {
1366 "description": "ID of volume for which to re trieve a reading position.",
1367 "location": "path",
1368 "required": true,
1369 "type": "string"
1370 }
1371 },
1372 "path": "mylibrary/readingpositions/{volumeId}",
1373 "response": {
1374 "$ref": "ReadingPosition"
1375 },
1376 "scopes": [
1377 "https://www.googleapis.com/auth/books"
1378 ]
1379 },
1380 "setPosition": {
1381 "description": "Sets my reading position information for a volume.",
1382 "httpMethod": "POST",
1383 "id": "books.mylibrary.readingpositions.setPosition" ,
1384 "parameterOrder": [
1385 "volumeId",
1386 "timestamp",
1387 "position"
1388 ],
1389 "parameters": {
1390 "action": {
1391 "description": "Action that caused this read ing position to be set.",
1392 "enum": [
1393 "bookmark",
1394 "chapter",
1395 "next-page",
1396 "prev-page",
1397 "scroll",
1398 "search"
1399 ],
1400 "enumDescriptions": [
1401 "User chose bookmark within volume.",
1402 "User selected chapter from list.",
1403 "Next page event.",
1404 "Previous page event.",
1405 "User navigated to page.",
1406 "User chose search results within volume ."
1407 ],
1408 "location": "query",
1409 "type": "string"
1410 },
1411 "contentVersion": {
1412 "description": "Volume content version for w hich this reading position applies.",
1413 "location": "query",
1414 "type": "string"
1415 },
1416 "deviceCookie": {
1417 "description": "Random persistent device coo kie optional on set position.",
1418 "location": "query",
1419 "type": "string"
1420 },
1421 "position": {
1422 "description": "Position string for the new volume reading position.",
1423 "location": "query",
1424 "required": true,
1425 "type": "string"
1426 },
1427 "source": {
1428 "description": "String to identify the origi nator of this request.",
1429 "location": "query",
1430 "type": "string"
1431 },
1432 "timestamp": {
1433 "description": "RFC 3339 UTC format timestam p associated with this reading position.",
1434 "location": "query",
1435 "required": true,
1436 "type": "string"
1437 },
1438 "volumeId": {
1439 "description": "ID of volume for which to up date the reading position.",
1440 "location": "path",
1441 "required": true,
1442 "type": "string"
1443 }
1444 },
1445 "path": "mylibrary/readingpositions/{volumeId}/setPo sition",
1446 "scopes": [
1447 "https://www.googleapis.com/auth/books"
1448 ]
1449 }
1450 }
1451 }
1452 }
1453 },
1454 "promooffer": {
1455 "methods": {
1456 "accept": {
1457 "description": "",
1458 "httpMethod": "POST",
1459 "id": "books.promooffer.accept",
1460 "parameters": {
1461 "androidId": {
1462 "description": "device android_id",
1463 "location": "query",
1464 "type": "string"
1465 },
1466 "device": {
1467 "description": "device device",
1468 "location": "query",
1469 "type": "string"
1470 },
1471 "manufacturer": {
1472 "description": "device manufacturer",
1473 "location": "query",
1474 "type": "string"
1475 },
1476 "model": {
1477 "description": "device model",
1478 "location": "query",
1479 "type": "string"
1480 },
1481 "offerId": {
1482 "location": "query",
1483 "type": "string"
1484 },
1485 "product": {
1486 "description": "device product",
1487 "location": "query",
1488 "type": "string"
1489 },
1490 "serial": {
1491 "description": "device serial",
1492 "location": "query",
1493 "type": "string"
1494 },
1495 "volumeId": {
1496 "description": "Volume id to exercise the offer",
1497 "location": "query",
1498 "type": "string"
1499 }
1500 },
1501 "path": "promooffer/accept",
1502 "scopes": [
1503 "https://www.googleapis.com/auth/books"
1504 ]
1505 },
1506 "dismiss": {
1507 "description": "",
1508 "httpMethod": "POST",
1509 "id": "books.promooffer.dismiss",
1510 "parameters": {
1511 "androidId": {
1512 "description": "device android_id",
1513 "location": "query",
1514 "type": "string"
1515 },
1516 "device": {
1517 "description": "device device",
1518 "location": "query",
1519 "type": "string"
1520 },
1521 "manufacturer": {
1522 "description": "device manufacturer",
1523 "location": "query",
1524 "type": "string"
1525 },
1526 "model": {
1527 "description": "device model",
1528 "location": "query",
1529 "type": "string"
1530 },
1531 "offerId": {
1532 "description": "Offer to dimiss",
1533 "location": "query",
1534 "type": "string"
1535 },
1536 "product": {
1537 "description": "device product",
1538 "location": "query",
1539 "type": "string"
1540 },
1541 "serial": {
1542 "description": "device serial",
1543 "location": "query",
1544 "type": "string"
1545 }
1546 },
1547 "path": "promooffer/dismiss",
1548 "scopes": [
1549 "https://www.googleapis.com/auth/books"
1550 ]
1551 },
1552 "get": {
1553 "description": "Returns a list of promo offers available to the user",
1554 "httpMethod": "GET",
1555 "id": "books.promooffer.get",
1556 "parameters": {
1557 "androidId": {
1558 "description": "device android_id",
1559 "location": "query",
1560 "type": "string"
1561 },
1562 "device": {
1563 "description": "device device",
1564 "location": "query",
1565 "type": "string"
1566 },
1567 "manufacturer": {
1568 "description": "device manufacturer",
1569 "location": "query",
1570 "type": "string"
1571 },
1572 "model": {
1573 "description": "device model",
1574 "location": "query",
1575 "type": "string"
1576 },
1577 "product": {
1578 "description": "device product",
1579 "location": "query",
1580 "type": "string"
1581 },
1582 "serial": {
1583 "description": "device serial",
1584 "location": "query",
1585 "type": "string"
1586 }
1587 },
1588 "path": "promooffer/get",
1589 "response": {
1590 "$ref": "Offers"
1591 },
1592 "scopes": [
1593 "https://www.googleapis.com/auth/books"
1594 ]
1595 }
1596 }
1597 },
1598 "volumes": {
1599 "methods": {
1600 "get": {
1601 "description": "Gets volume information for a single volume. ",
1602 "httpMethod": "GET",
1603 "id": "books.volumes.get",
1604 "parameterOrder": [
1605 "volumeId"
1606 ],
1607 "parameters": {
1608 "country": {
1609 "description": "ISO-3166-1 code to override the IP-b ased location.",
1610 "location": "query",
1611 "type": "string"
1612 },
1613 "partner": {
1614 "description": "Brand results for partner ID.",
1615 "location": "query",
1616 "type": "string"
1617 },
1618 "projection": {
1619 "description": "Restrict information returned to a s et of selected fields.",
1620 "enum": [
1621 "full",
1622 "lite"
1623 ],
1624 "enumDescriptions": [
1625 "Includes all volume data.",
1626 "Includes a subset of fields in volumeInfo and a ccessInfo."
1627 ],
1628 "location": "query",
1629 "type": "string"
1630 },
1631 "source": {
1632 "description": "String to identify the originator of this request.",
1633 "location": "query",
1634 "type": "string"
1635 },
1636 "volumeId": {
1637 "description": "ID of volume to retrieve.",
1638 "location": "path",
1639 "required": true,
1640 "type": "string"
1641 }
1642 },
1643 "path": "volumes/{volumeId}",
1644 "response": {
1645 "$ref": "Volume"
1646 },
1647 "scopes": [
1648 "https://www.googleapis.com/auth/books"
1649 ]
1650 },
1651 "list": {
1652 "description": "Performs a book search.",
1653 "httpMethod": "GET",
1654 "id": "books.volumes.list",
1655 "parameterOrder": [
1656 "q"
1657 ],
1658 "parameters": {
1659 "download": {
1660 "description": "Restrict to volumes by download avai lability.",
1661 "enum": [
1662 "epub"
1663 ],
1664 "enumDescriptions": [
1665 "All volumes with epub."
1666 ],
1667 "location": "query",
1668 "type": "string"
1669 },
1670 "filter": {
1671 "description": "Filter search results.",
1672 "enum": [
1673 "ebooks",
1674 "free-ebooks",
1675 "full",
1676 "paid-ebooks",
1677 "partial"
1678 ],
1679 "enumDescriptions": [
1680 "All Google eBooks.",
1681 "Google eBook with full volume text viewability. ",
1682 "Public can view entire volume text.",
1683 "Google eBook with a price.",
1684 "Public able to see parts of text."
1685 ],
1686 "location": "query",
1687 "type": "string"
1688 },
1689 "langRestrict": {
1690 "description": "Restrict results to books with this language code.",
1691 "location": "query",
1692 "type": "string"
1693 },
1694 "libraryRestrict": {
1695 "description": "Restrict search to this user's libra ry.",
1696 "enum": [
1697 "my-library",
1698 "no-restrict"
1699 ],
1700 "enumDescriptions": [
1701 "Restrict to the user's library, any shelf.",
1702 "Do not restrict based on user's library."
1703 ],
1704 "location": "query",
1705 "type": "string"
1706 },
1707 "maxResults": {
1708 "description": "Maximum number of results to return. ",
1709 "format": "uint32",
1710 "location": "query",
1711 "maximum": "40",
1712 "minimum": "0",
1713 "type": "integer"
1714 },
1715 "orderBy": {
1716 "description": "Sort search results.",
1717 "enum": [
1718 "newest",
1719 "relevance"
1720 ],
1721 "enumDescriptions": [
1722 "Most recently published.",
1723 "Relevance to search terms."
1724 ],
1725 "location": "query",
1726 "type": "string"
1727 },
1728 "partner": {
1729 "description": "Restrict and brand results for partn er ID.",
1730 "location": "query",
1731 "type": "string"
1732 },
1733 "printType": {
1734 "description": "Restrict to books or magazines.",
1735 "enum": [
1736 "all",
1737 "books",
1738 "magazines"
1739 ],
1740 "enumDescriptions": [
1741 "All volume content types.",
1742 "Just books.",
1743 "Just magazines."
1744 ],
1745 "location": "query",
1746 "type": "string"
1747 },
1748 "projection": {
1749 "description": "Restrict information returned to a s et of selected fields.",
1750 "enum": [
1751 "full",
1752 "lite"
1753 ],
1754 "enumDescriptions": [
1755 "Includes all volume data.",
1756 "Includes a subset of fields in volumeInfo and a ccessInfo."
1757 ],
1758 "location": "query",
1759 "type": "string"
1760 },
1761 "q": {
1762 "description": "Full-text search query string.",
1763 "location": "query",
1764 "required": true,
1765 "type": "string"
1766 },
1767 "showPreorders": {
1768 "description": "Set to true to show books available for preorder. Defaults to false.",
1769 "location": "query",
1770 "type": "boolean"
1771 },
1772 "source": {
1773 "description": "String to identify the originator of this request.",
1774 "location": "query",
1775 "type": "string"
1776 },
1777 "startIndex": {
1778 "description": "Index of the first result to return (starts at 0)",
1779 "format": "uint32",
1780 "location": "query",
1781 "minimum": "0",
1782 "type": "integer"
1783 }
1784 },
1785 "path": "volumes",
1786 "response": {
1787 "$ref": "Volumes"
1788 },
1789 "scopes": [
1790 "https://www.googleapis.com/auth/books"
1791 ]
1792 }
1793 },
1794 "resources": {
1795 "associated": {
1796 "methods": {
1797 "list": {
1798 "description": "Return a list of associated books.",
1799 "httpMethod": "GET",
1800 "id": "books.volumes.associated.list",
1801 "parameterOrder": [
1802 "volumeId"
1803 ],
1804 "parameters": {
1805 "association": {
1806 "description": "Association type.",
1807 "enum": [
1808 "end-of-sample",
1809 "end-of-volume"
1810 ],
1811 "enumDescriptions": [
1812 "Recommendations for display end-of-samp le.",
1813 "Recommendations for display end-of-volu me."
1814 ],
1815 "location": "query",
1816 "type": "string"
1817 },
1818 "locale": {
1819 "description": "ISO-639-1 language and ISO-3 166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
1820 "location": "query",
1821 "type": "string"
1822 },
1823 "source": {
1824 "description": "String to identify the origi nator of this request.",
1825 "location": "query",
1826 "type": "string"
1827 },
1828 "volumeId": {
1829 "description": "ID of the source volume.",
1830 "location": "path",
1831 "required": true,
1832 "type": "string"
1833 }
1834 },
1835 "path": "volumes/{volumeId}/associated",
1836 "response": {
1837 "$ref": "Volumes"
1838 },
1839 "scopes": [
1840 "https://www.googleapis.com/auth/books"
1841 ]
1842 }
1843 }
1844 },
1845 "mybooks": {
1846 "methods": {
1847 "list": {
1848 "description": "Return a list of books in My Library .",
1849 "httpMethod": "GET",
1850 "id": "books.volumes.mybooks.list",
1851 "parameters": {
1852 "acquireMethod": {
1853 "description": "How the book was aquired",
1854 "enum": [
1855 "PREORDERED",
1856 "PREVIOUSLY_RENTED",
1857 "PUBLIC_DOMAIN",
1858 "PURCHASED",
1859 "RENTED",
1860 "SAMPLE",
1861 "UPLOADED"
1862 ],
1863 "enumDescriptions": [
1864 "Preordered books (not yet available)",
1865 "User-rented books past their expiration time",
1866 "Public domain books",
1867 "Purchased books",
1868 "User-rented books",
1869 "Sample books",
1870 "User uploaded books"
1871 ],
1872 "location": "query",
1873 "repeated": true,
1874 "type": "string"
1875 },
1876 "locale": {
1877 "description": "ISO-639-1 language and ISO-3 166-1 country code. Ex:'en_US'. Used for generating recommendations.",
1878 "location": "query",
1879 "type": "string"
1880 },
1881 "maxResults": {
1882 "description": "Maximum number of results to return.",
1883 "format": "uint32",
1884 "location": "query",
1885 "maximum": "100",
1886 "minimum": "0",
1887 "type": "integer"
1888 },
1889 "processingState": {
1890 "description": "The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specifi ed in the acquireMethod.",
1891 "enum": [
1892 "COMPLETED_FAILED",
1893 "COMPLETED_SUCCESS",
1894 "RUNNING"
1895 ],
1896 "enumDescriptions": [
1897 "The volume processing hase failed.",
1898 "The volume processing was completed.",
1899 "The volume processing is not completed. "
1900 ],
1901 "location": "query",
1902 "repeated": true,
1903 "type": "string"
1904 },
1905 "source": {
1906 "description": "String to identify the origi nator of this request.",
1907 "location": "query",
1908 "type": "string"
1909 },
1910 "startIndex": {
1911 "description": "Index of the first result to return (starts at 0)",
1912 "format": "uint32",
1913 "location": "query",
1914 "minimum": "0",
1915 "type": "integer"
1916 }
1917 },
1918 "path": "volumes/mybooks",
1919 "response": {
1920 "$ref": "Volumes"
1921 },
1922 "scopes": [
1923 "https://www.googleapis.com/auth/books"
1924 ]
1925 }
1926 }
1927 },
1928 "recommended": {
1929 "methods": {
1930 "list": {
1931 "description": "Return a list of recommended books f or the current user.",
1932 "httpMethod": "GET",
1933 "id": "books.volumes.recommended.list",
1934 "parameters": {
1935 "locale": {
1936 "description": "ISO-639-1 language and ISO-3 166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
1937 "location": "query",
1938 "type": "string"
1939 },
1940 "source": {
1941 "description": "String to identify the origi nator of this request.",
1942 "location": "query",
1943 "type": "string"
1944 }
1945 },
1946 "path": "volumes/recommended",
1947 "response": {
1948 "$ref": "Volumes"
1949 },
1950 "scopes": [
1951 "https://www.googleapis.com/auth/books"
1952 ]
1953 },
1954 "rate": {
1955 "description": "Rate a recommended book for the curr ent user.",
1956 "httpMethod": "POST",
1957 "id": "books.volumes.recommended.rate",
1958 "parameterOrder": [
1959 "rating",
1960 "volumeId"
1961 ],
1962 "parameters": {
1963 "locale": {
1964 "description": "ISO-639-1 language and ISO-3 166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
1965 "location": "query",
1966 "type": "string"
1967 },
1968 "rating": {
1969 "description": "Rating to be given to the vo lume.",
1970 "enum": [
1971 "HAVE_IT",
1972 "NOT_INTERESTED"
1973 ],
1974 "enumDescriptions": [
1975 "Rating indicating a dismissal due to ow nership.",
1976 "Rating indicating a negative dismissal of a volume."
1977 ],
1978 "location": "query",
1979 "required": true,
1980 "type": "string"
1981 },
1982 "source": {
1983 "description": "String to identify the origi nator of this request.",
1984 "location": "query",
1985 "type": "string"
1986 },
1987 "volumeId": {
1988 "description": "ID of the source volume.",
1989 "location": "query",
1990 "required": true,
1991 "type": "string"
1992 }
1993 },
1994 "path": "volumes/recommended/rate",
1995 "response": {
1996 "$ref": "BooksVolumesRecommendedRateResponse"
1997 },
1998 "scopes": [
1999 "https://www.googleapis.com/auth/books"
2000 ]
2001 }
2002 }
2003 },
2004 "useruploaded": {
2005 "methods": {
2006 "list": {
2007 "description": "Return a list of books uploaded by t he current user.",
2008 "httpMethod": "GET",
2009 "id": "books.volumes.useruploaded.list",
2010 "parameters": {
2011 "locale": {
2012 "description": "ISO-639-1 language and ISO-3 166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
2013 "location": "query",
2014 "type": "string"
2015 },
2016 "maxResults": {
2017 "description": "Maximum number of results to return.",
2018 "format": "uint32",
2019 "location": "query",
2020 "maximum": "40",
2021 "minimum": "0",
2022 "type": "integer"
2023 },
2024 "processingState": {
2025 "description": "The processing state of the user uploaded volumes to be returned.",
2026 "enum": [
2027 "COMPLETED_FAILED",
2028 "COMPLETED_SUCCESS",
2029 "RUNNING"
2030 ],
2031 "enumDescriptions": [
2032 "The volume processing hase failed.",
2033 "The volume processing was completed.",
2034 "The volume processing is not completed. "
2035 ],
2036 "location": "query",
2037 "repeated": true,
2038 "type": "string"
2039 },
2040 "source": {
2041 "description": "String to identify the origi nator of this request.",
2042 "location": "query",
2043 "type": "string"
2044 },
2045 "startIndex": {
2046 "description": "Index of the first result to return (starts at 0)",
2047 "format": "uint32",
2048 "location": "query",
2049 "minimum": "0",
2050 "type": "integer"
2051 },
2052 "volumeId": {
2053 "description": "The ids of the volumes to be returned. If not specified all that match the processingState are returned.",
2054 "location": "query",
2055 "repeated": true,
2056 "type": "string"
2057 }
2058 },
2059 "path": "volumes/useruploaded",
2060 "response": {
2061 "$ref": "Volumes"
2062 },
2063 "scopes": [
2064 "https://www.googleapis.com/auth/books"
2065 ]
2066 }
2067 }
2068 }
2069 }
2070 }
2071 },
2072 "revision": "20140507",
2073 "rootUrl": "https://www.googleapis.com/",
2074 "schemas": {
2075 "Annotation": {
2076 "id": "Annotation",
2077 "properties": {
2078 "afterSelectedText": {
2079 "description": "Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field sho uld be empty.",
2080 "type": "string"
2081 },
2082 "beforeSelectedText": {
2083 "description": "Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field sh ould be empty.",
2084 "type": "string"
2085 },
2086 "clientVersionRanges": {
2087 "description": "Selection ranges sent from the client.",
2088 "properties": {
2089 "cfiRange": {
2090 "$ref": "BooksAnnotationsRange",
2091 "description": "Range in CFI format for this annotat ion sent by client."
2092 },
2093 "contentVersion": {
2094 "description": "Content version the client sent in." ,
2095 "type": "string"
2096 },
2097 "gbImageRange": {
2098 "$ref": "BooksAnnotationsRange",
2099 "description": "Range in GB image format for this an notation sent by client."
2100 },
2101 "gbTextRange": {
2102 "$ref": "BooksAnnotationsRange",
2103 "description": "Range in GB text format for this ann otation sent by client."
2104 },
2105 "imageCfiRange": {
2106 "$ref": "BooksAnnotationsRange",
2107 "description": "Range in image CFI format for this a nnotation sent by client."
2108 }
2109 },
2110 "type": "object"
2111 },
2112 "created": {
2113 "description": "Timestamp for the created time of this annot ation.",
2114 "format": "date-time",
2115 "type": "string"
2116 },
2117 "currentVersionRanges": {
2118 "description": "Selection ranges for the most recent content version.",
2119 "properties": {
2120 "cfiRange": {
2121 "$ref": "BooksAnnotationsRange",
2122 "description": "Range in CFI format for this annotat ion for version above."
2123 },
2124 "contentVersion": {
2125 "description": "Content version applicable to ranges below.",
2126 "type": "string"
2127 },
2128 "gbImageRange": {
2129 "$ref": "BooksAnnotationsRange",
2130 "description": "Range in GB image format for this an notation for version above."
2131 },
2132 "gbTextRange": {
2133 "$ref": "BooksAnnotationsRange",
2134 "description": "Range in GB text format for this ann otation for version above."
2135 },
2136 "imageCfiRange": {
2137 "$ref": "BooksAnnotationsRange",
2138 "description": "Range in image CFI format for this a nnotation for version above."
2139 }
2140 },
2141 "type": "object"
2142 },
2143 "data": {
2144 "description": "User-created data for this annotation.",
2145 "type": "string"
2146 },
2147 "deleted": {
2148 "description": "Indicates that this annotation is deleted.",
2149 "type": "boolean"
2150 },
2151 "highlightStyle": {
2152 "description": "The highlight style for this annotation.",
2153 "type": "string"
2154 },
2155 "id": {
2156 "description": "Id of this annotation, in the form of a GUID .",
2157 "type": "string"
2158 },
2159 "kind": {
2160 "default": "books#annotation",
2161 "description": "Resource type.",
2162 "type": "string"
2163 },
2164 "layerId": {
2165 "description": "The layer this annotation is for.",
2166 "type": "string"
2167 },
2168 "layerSummary": {
2169 "properties": {
2170 "allowedCharacterCount": {
2171 "description": "Maximum allowed characters on this l ayer, especially for the \"copy\" layer.",
2172 "format": "int32",
2173 "type": "integer"
2174 },
2175 "limitType": {
2176 "description": "Type of limitation on this layer. \" limited\" or \"unlimited\" for the \"copy\" layer.",
2177 "type": "string"
2178 },
2179 "remainingCharacterCount": {
2180 "description": "Remaining allowed characters on this layer, especially for the \"copy\" layer.",
2181 "format": "int32",
2182 "type": "integer"
2183 }
2184 },
2185 "type": "object"
2186 },
2187 "pageIds": {
2188 "description": "Pages that this annotation spans.",
2189 "items": {
2190 "type": "string"
2191 },
2192 "type": "array"
2193 },
2194 "selectedText": {
2195 "description": "Excerpt from the volume.",
2196 "type": "string"
2197 },
2198 "selfLink": {
2199 "description": "URL to this resource.",
2200 "type": "string"
2201 },
2202 "updated": {
2203 "description": "Timestamp for the last time this annotation was modified.",
2204 "format": "date-time",
2205 "type": "string"
2206 },
2207 "volumeId": {
2208 "description": "The volume that this annotation belongs to." ,
2209 "type": "string"
2210 }
2211 },
2212 "type": "object"
2213 },
2214 "Annotationdata": {
2215 "id": "Annotationdata",
2216 "properties": {
2217 "annotationType": {
2218 "description": "The type of annotation this data is for.",
2219 "type": "string"
2220 },
2221 "data": {
2222 "type": "any"
2223 },
2224 "encoded_data": {
2225 "description": "Base64 encoded data for this annotation data .",
2226 "format": "byte",
2227 "type": "string"
2228 },
2229 "id": {
2230 "description": "Unique id for this annotation data.",
2231 "type": "string"
2232 },
2233 "kind": {
2234 "default": "books#annotationdata",
2235 "description": "Resource Type",
2236 "type": "string"
2237 },
2238 "layerId": {
2239 "description": "The Layer id for this data. *",
2240 "type": "string"
2241 },
2242 "selfLink": {
2243 "description": "URL for this resource. *",
2244 "type": "string"
2245 },
2246 "updated": {
2247 "description": "Timestamp for the last time this data was up dated. (RFC 3339 UTC date-time format).",
2248 "format": "date-time",
2249 "type": "string"
2250 },
2251 "volumeId": {
2252 "description": "The volume id for this data. *",
2253 "type": "string"
2254 }
2255 },
2256 "type": "object"
2257 },
2258 "Annotations": {
2259 "id": "Annotations",
2260 "properties": {
2261 "items": {
2262 "description": "A list of annotations.",
2263 "items": {
2264 "$ref": "Annotation"
2265 },
2266 "type": "array"
2267 },
2268 "kind": {
2269 "default": "books#annotations",
2270 "description": "Resource type.",
2271 "type": "string"
2272 },
2273 "nextPageToken": {
2274 "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.",
2275 "type": "string"
2276 },
2277 "totalItems": {
2278 "description": "Total number of annotations found. This may be greater than the number of notes returned in this response if results have be en paginated.",
2279 "format": "int32",
2280 "type": "integer"
2281 }
2282 },
2283 "type": "object"
2284 },
2285 "AnnotationsSummary": {
2286 "id": "AnnotationsSummary",
2287 "properties": {
2288 "kind": {
2289 "default": "books#annotationsSummary",
2290 "type": "string"
2291 },
2292 "layers": {
2293 "items": {
2294 "properties": {
2295 "allowedCharacterCount": {
2296 "format": "int32",
2297 "type": "integer"
2298 },
2299 "layerId": {
2300 "type": "string"
2301 },
2302 "limitType": {
2303 "type": "string"
2304 },
2305 "remainingCharacterCount": {
2306 "format": "int32",
2307 "type": "integer"
2308 },
2309 "updated": {
2310 "format": "date-time",
2311 "type": "string"
2312 }
2313 },
2314 "type": "object"
2315 },
2316 "type": "array"
2317 }
2318 },
2319 "type": "object"
2320 },
2321 "Annotationsdata": {
2322 "id": "Annotationsdata",
2323 "properties": {
2324 "items": {
2325 "description": "A list of Annotation Data.",
2326 "items": {
2327 "$ref": "Annotationdata"
2328 },
2329 "type": "array"
2330 },
2331 "kind": {
2332 "default": "books#annotationsdata",
2333 "description": "Resource type",
2334 "type": "string"
2335 },
2336 "nextPageToken": {
2337 "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.",
2338 "type": "string"
2339 },
2340 "totalItems": {
2341 "description": "The total number of volume annotations found .",
2342 "format": "int32",
2343 "type": "integer"
2344 }
2345 },
2346 "type": "object"
2347 },
2348 "BooksAnnotationsRange": {
2349 "id": "BooksAnnotationsRange",
2350 "properties": {
2351 "endOffset": {
2352 "description": "The offset from the ending position.",
2353 "type": "string"
2354 },
2355 "endPosition": {
2356 "description": "The ending position for the range.",
2357 "type": "string"
2358 },
2359 "startOffset": {
2360 "description": "The offset from the starting position.",
2361 "type": "string"
2362 },
2363 "startPosition": {
2364 "description": "The starting position for the range.",
2365 "type": "string"
2366 }
2367 },
2368 "type": "object"
2369 },
2370 "BooksCloudloadingResource": {
2371 "id": "BooksCloudloadingResource",
2372 "properties": {
2373 "author": {
2374 "type": "string"
2375 },
2376 "processingState": {
2377 "type": "string"
2378 },
2379 "title": {
2380 "type": "string"
2381 },
2382 "volumeId": {
2383 "type": "string"
2384 }
2385 },
2386 "type": "object"
2387 },
2388 "BooksVolumesRecommendedRateResponse": {
2389 "id": "BooksVolumesRecommendedRateResponse",
2390 "properties": {
2391 "consistency_token": {
2392 "type": "string"
2393 }
2394 },
2395 "type": "object"
2396 },
2397 "Bookshelf": {
2398 "id": "Bookshelf",
2399 "properties": {
2400 "access": {
2401 "description": "Whether this bookshelf is PUBLIC or PRIVATE. ",
2402 "type": "string"
2403 },
2404 "created": {
2405 "description": "Created time for this bookshelf (formatted U TC timestamp with millisecond resolution).",
2406 "format": "date-time",
2407 "type": "string"
2408 },
2409 "description": {
2410 "description": "Description of this bookshelf.",
2411 "type": "string"
2412 },
2413 "id": {
2414 "description": "Id of this bookshelf, only unique by user.",
2415 "format": "int32",
2416 "type": "integer"
2417 },
2418 "kind": {
2419 "default": "books#bookshelf",
2420 "description": "Resource type for bookshelf metadata.",
2421 "type": "string"
2422 },
2423 "selfLink": {
2424 "description": "URL to this resource.",
2425 "type": "string"
2426 },
2427 "title": {
2428 "description": "Title of this bookshelf.",
2429 "type": "string"
2430 },
2431 "updated": {
2432 "description": "Last modified time of this bookshelf (format ted UTC timestamp with millisecond resolution).",
2433 "format": "date-time",
2434 "type": "string"
2435 },
2436 "volumeCount": {
2437 "description": "Number of volumes in this bookshelf.",
2438 "format": "int32",
2439 "type": "integer"
2440 },
2441 "volumesLastUpdated": {
2442 "description": "Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).",
2443 "format": "date-time",
2444 "type": "string"
2445 }
2446 },
2447 "type": "object"
2448 },
2449 "Bookshelves": {
2450 "id": "Bookshelves",
2451 "properties": {
2452 "items": {
2453 "description": "A list of bookshelves.",
2454 "items": {
2455 "$ref": "Bookshelf"
2456 },
2457 "type": "array"
2458 },
2459 "kind": {
2460 "default": "books#bookshelves",
2461 "description": "Resource type.",
2462 "type": "string"
2463 }
2464 },
2465 "type": "object"
2466 },
2467 "ConcurrentAccessRestriction": {
2468 "id": "ConcurrentAccessRestriction",
2469 "properties": {
2470 "deviceAllowed": {
2471 "description": "Whether access is granted for this (user, de vice, volume).",
2472 "type": "boolean"
2473 },
2474 "kind": {
2475 "default": "books#concurrentAccessRestriction",
2476 "description": "Resource type.",
2477 "type": "string"
2478 },
2479 "maxConcurrentDevices": {
2480 "description": "The maximum number of concurrent access lice nses for this volume.",
2481 "format": "int32",
2482 "type": "integer"
2483 },
2484 "message": {
2485 "description": "Error/warning message.",
2486 "type": "string"
2487 },
2488 "nonce": {
2489 "description": "Client nonce for verification. Download acce ss and client-validation only.",
2490 "type": "string"
2491 },
2492 "reasonCode": {
2493 "description": "Error/warning reason code.",
2494 "type": "string"
2495 },
2496 "restricted": {
2497 "description": "Whether this volume has any concurrent acces s restrictions.",
2498 "type": "boolean"
2499 },
2500 "signature": {
2501 "description": "Response signature.",
2502 "type": "string"
2503 },
2504 "source": {
2505 "description": "Client app identifier for verification. Down load access and client-validation only.",
2506 "type": "string"
2507 },
2508 "timeWindowSeconds": {
2509 "description": "Time in seconds for license auto-expiration. ",
2510 "format": "int32",
2511 "type": "integer"
2512 },
2513 "volumeId": {
2514 "description": "Identifies the volume for which this entry a pplies.",
2515 "type": "string"
2516 }
2517 },
2518 "type": "object"
2519 },
2520 "Dictlayerdata": {
2521 "id": "Dictlayerdata",
2522 "properties": {
2523 "common": {
2524 "properties": {
2525 "title": {
2526 "description": "The display title and localized cano nical name to use when searching for this entity on Google search.",
2527 "type": "string"
2528 }
2529 },
2530 "type": "object"
2531 },
2532 "dict": {
2533 "properties": {
2534 "source": {
2535 "description": "The source, url and attribution for this dictionary data.",
2536 "properties": {
2537 "attribution": {
2538 "type": "string"
2539 },
2540 "url": {
2541 "type": "string"
2542 }
2543 },
2544 "type": "object"
2545 },
2546 "words": {
2547 "items": {
2548 "properties": {
2549 "derivatives": {
2550 "items": {
2551 "properties": {
2552 "source": {
2553 "properties": {
2554 "attribution": {
2555 "type": "string"
2556 },
2557 "url": {
2558 "type": "string"
2559 }
2560 },
2561 "type": "object"
2562 },
2563 "text": {
2564 "type": "string"
2565 }
2566 },
2567 "type": "object"
2568 },
2569 "type": "array"
2570 },
2571 "examples": {
2572 "items": {
2573 "properties": {
2574 "source": {
2575 "properties": {
2576 "attribution": {
2577 "type": "string"
2578 },
2579 "url": {
2580 "type": "string"
2581 }
2582 },
2583 "type": "object"
2584 },
2585 "text": {
2586 "type": "string"
2587 }
2588 },
2589 "type": "object"
2590 },
2591 "type": "array"
2592 },
2593 "senses": {
2594 "items": {
2595 "properties": {
2596 "conjugations": {
2597 "items": {
2598 "properties": {
2599 "type": {
2600 "type": "string"
2601 },
2602 "value": {
2603 "type": "string"
2604 }
2605 },
2606 "type": "object"
2607 },
2608 "type": "array"
2609 },
2610 "definitions": {
2611 "items": {
2612 "properties": {
2613 "definition": {
2614 "type": "string"
2615 },
2616 "examples": {
2617 "items": {
2618 "properties" : {
2619 "source" : {
2620 "pro perties": {
2621 "attribution": {
2622 "type": "string"
2623 },
2624 "url": {
2625 "type": "string"
2626 }
2627 },
2628 "typ e": "object"
2629 },
2630 "text": {
2631 "typ e": "string"
2632 }
2633 },
2634 "type": "obj ect"
2635 },
2636 "type": "array"
2637 }
2638 },
2639 "type": "object"
2640 },
2641 "type": "array"
2642 },
2643 "partOfSpeech": {
2644 "type": "string"
2645 },
2646 "pronunciation": {
2647 "type": "string"
2648 },
2649 "pronunciationUrl": {
2650 "type": "string"
2651 },
2652 "source": {
2653 "properties": {
2654 "attribution": {
2655 "type": "string"
2656 },
2657 "url": {
2658 "type": "string"
2659 }
2660 },
2661 "type": "object"
2662 },
2663 "syllabification": {
2664 "type": "string"
2665 },
2666 "synonyms": {
2667 "items": {
2668 "properties": {
2669 "source": {
2670 "properties": {
2671 "attribution ": {
2672 "type": "string"
2673 },
2674 "url": {
2675 "type": "string"
2676 }
2677 },
2678 "type": "object"
2679 },
2680 "text": {
2681 "type": "string"
2682 }
2683 },
2684 "type": "object"
2685 },
2686 "type": "array"
2687 }
2688 },
2689 "type": "object"
2690 },
2691 "type": "array"
2692 },
2693 "source": {
2694 "description": "The words with different meanings but not related words, e.g. \"go\" (game) and \"go\" (verb).",
2695 "properties": {
2696 "attribution": {
2697 "type": "string"
2698 },
2699 "url": {
2700 "type": "string"
2701 }
2702 },
2703 "type": "object"
2704 }
2705 },
2706 "type": "object"
2707 },
2708 "type": "array"
2709 }
2710 },
2711 "type": "object"
2712 },
2713 "kind": {
2714 "default": "books#dictlayerdata",
2715 "type": "string"
2716 }
2717 },
2718 "type": "object"
2719 },
2720 "DownloadAccessRestriction": {
2721 "id": "DownloadAccessRestriction",
2722 "properties": {
2723 "deviceAllowed": {
2724 "description": "If restricted, whether access is granted for this (user, device, volume).",
2725 "type": "boolean"
2726 },
2727 "downloadsAcquired": {
2728 "description": "If restricted, the number of content downloa d licenses already acquired (including the requesting client, if licensed).",
2729 "format": "int32",
2730 "type": "integer"
2731 },
2732 "justAcquired": {
2733 "description": "If deviceAllowed, whether access was just ac quired with this request.",
2734 "type": "boolean"
2735 },
2736 "kind": {
2737 "default": "books#downloadAccessRestriction",
2738 "description": "Resource type.",
2739 "type": "string"
2740 },
2741 "maxDownloadDevices": {
2742 "description": "If restricted, the maximum number of content download licenses for this volume.",
2743 "format": "int32",
2744 "type": "integer"
2745 },
2746 "message": {
2747 "description": "Error/warning message.",
2748 "type": "string"
2749 },
2750 "nonce": {
2751 "description": "Client nonce for verification. Download acce ss and client-validation only.",
2752 "type": "string"
2753 },
2754 "reasonCode": {
2755 "description": "Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DE NIED_LIMIT 200 WARNING_USED_LAST_ACCESS",
2756 "type": "string"
2757 },
2758 "restricted": {
2759 "description": "Whether this volume has any download access restrictions.",
2760 "type": "boolean"
2761 },
2762 "signature": {
2763 "description": "Response signature.",
2764 "type": "string"
2765 },
2766 "source": {
2767 "description": "Client app identifier for verification. Down load access and client-validation only.",
2768 "type": "string"
2769 },
2770 "volumeId": {
2771 "description": "Identifies the volume for which this entry a pplies.",
2772 "type": "string"
2773 }
2774 },
2775 "type": "object"
2776 },
2777 "DownloadAccesses": {
2778 "id": "DownloadAccesses",
2779 "properties": {
2780 "downloadAccessList": {
2781 "description": "A list of download access responses.",
2782 "items": {
2783 "$ref": "DownloadAccessRestriction"
2784 },
2785 "type": "array"
2786 },
2787 "kind": {
2788 "default": "books#downloadAccesses",
2789 "description": "Resource type.",
2790 "type": "string"
2791 }
2792 },
2793 "type": "object"
2794 },
2795 "Geolayerdata": {
2796 "id": "Geolayerdata",
2797 "properties": {
2798 "common": {
2799 "properties": {
2800 "lang": {
2801 "description": "The language of the information url and description.",
2802 "type": "string"
2803 },
2804 "previewImageUrl": {
2805 "description": "The URL for the preview image inform ation.",
2806 "type": "string"
2807 },
2808 "snippet": {
2809 "description": "The description for this location.",
2810 "type": "string"
2811 },
2812 "snippetUrl": {
2813 "description": "The URL for information for this loc ation. Ex: wikipedia link.",
2814 "type": "string"
2815 },
2816 "title": {
2817 "description": "The display title and localized cano nical name to use when searching for this entity on Google search.",
2818 "type": "string"
2819 }
2820 },
2821 "type": "object"
2822 },
2823 "geo": {
2824 "properties": {
2825 "boundary": {
2826 "description": "The boundary of the location as a se t of loops containing pairs of latitude, longitude coordinates.",
2827 "items": {
2828 "items": {
2829 "properties": {
2830 "latitude": {
2831 "format": "uint32",
2832 "type": "integer"
2833 },
2834 "longitude": {
2835 "format": "uint32",
2836 "type": "integer"
2837 }
2838 },
2839 "type": "object"
2840 },
2841 "type": "array"
2842 },
2843 "type": "array"
2844 },
2845 "cachePolicy": {
2846 "description": "The cache policy active for this dat a. EX: UNRESTRICTED, RESTRICTED, NEVER",
2847 "type": "string"
2848 },
2849 "countryCode": {
2850 "description": "The country code of the location.",
2851 "type": "string"
2852 },
2853 "latitude": {
2854 "description": "The latitude of the location.",
2855 "format": "double",
2856 "type": "number"
2857 },
2858 "longitude": {
2859 "description": "The longitude of the location.",
2860 "format": "double",
2861 "type": "number"
2862 },
2863 "mapType": {
2864 "description": "The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN",
2865 "type": "string"
2866 },
2867 "viewport": {
2868 "description": "The viewport for showing this locati on. This is a latitude, longitude rectangle.",
2869 "properties": {
2870 "hi": {
2871 "properties": {
2872 "latitude": {
2873 "format": "double",
2874 "type": "number"
2875 },
2876 "longitude": {
2877 "format": "double",
2878 "type": "number"
2879 }
2880 },
2881 "type": "object"
2882 },
2883 "lo": {
2884 "properties": {
2885 "latitude": {
2886 "format": "double",
2887 "type": "number"
2888 },
2889 "longitude": {
2890 "format": "double",
2891 "type": "number"
2892 }
2893 },
2894 "type": "object"
2895 }
2896 },
2897 "type": "object"
2898 },
2899 "zoom": {
2900 "description": "The Zoom level to use for the map. Z oom levels between 0 (the lowest zoom level, in which the entire world can be se en on one map) to 21+ (down to individual buildings). See: https://developers.go ogle.com/maps/documentation/staticmaps/#Zoomlevels",
2901 "format": "int32",
2902 "type": "integer"
2903 }
2904 },
2905 "type": "object"
2906 },
2907 "kind": {
2908 "default": "books#geolayerdata",
2909 "type": "string"
2910 }
2911 },
2912 "type": "object"
2913 },
2914 "Layersummaries": {
2915 "id": "Layersummaries",
2916 "properties": {
2917 "items": {
2918 "description": "A list of layer summary items.",
2919 "items": {
2920 "$ref": "Layersummary"
2921 },
2922 "type": "array"
2923 },
2924 "kind": {
2925 "default": "books#layersummaries",
2926 "description": "Resource type.",
2927 "type": "string"
2928 },
2929 "totalItems": {
2930 "description": "The total number of layer summaries found.",
2931 "format": "int32",
2932 "type": "integer"
2933 }
2934 },
2935 "type": "object"
2936 },
2937 "Layersummary": {
2938 "id": "Layersummary",
2939 "properties": {
2940 "annotationCount": {
2941 "description": "The number of annotations for this layer.",
2942 "format": "int32",
2943 "type": "integer"
2944 },
2945 "annotationTypes": {
2946 "description": "The list of annotation types contained for t his layer.",
2947 "items": {
2948 "type": "string"
2949 },
2950 "type": "array"
2951 },
2952 "annotationsDataLink": {
2953 "description": "Link to get data for this annotation.",
2954 "type": "string"
2955 },
2956 "annotationsLink": {
2957 "description": "The link to get the annotations for this lay er.",
2958 "type": "string"
2959 },
2960 "contentVersion": {
2961 "description": "The content version this resource is for.",
2962 "type": "string"
2963 },
2964 "dataCount": {
2965 "description": "The number of data items for this layer.",
2966 "format": "int32",
2967 "type": "integer"
2968 },
2969 "id": {
2970 "description": "Unique id of this layer summary.",
2971 "type": "string"
2972 },
2973 "kind": {
2974 "default": "books#layersummary",
2975 "description": "Resource Type",
2976 "type": "string"
2977 },
2978 "layerId": {
2979 "description": "The layer id for this summary.",
2980 "type": "string"
2981 },
2982 "selfLink": {
2983 "description": "URL to this resource.",
2984 "type": "string"
2985 },
2986 "updated": {
2987 "description": "Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).",
2988 "format": "date-time",
2989 "type": "string"
2990 },
2991 "volumeAnnotationsVersion": {
2992 "description": "The current version of this layer's volume a nnotations. Note that this version applies only to the data in the books.layers. volumeAnnotations.* responses. The actual annotation data is versioned separatel y.",
2993 "type": "string"
2994 },
2995 "volumeId": {
2996 "description": "The volume id this resource is for.",
2997 "type": "string"
2998 }
2999 },
3000 "type": "object"
3001 },
3002 "Offers": {
3003 "id": "Offers",
3004 "properties": {
3005 "items": {
3006 "description": "A list of offers.",
3007 "items": {
3008 "properties": {
3009 "artUrl": {
3010 "type": "string"
3011 },
3012 "id": {
3013 "type": "string"
3014 },
3015 "items": {
3016 "items": {
3017 "properties": {
3018 "author": {
3019 "type": "string"
3020 },
3021 "canonicalVolumeLink": {
3022 "type": "string"
3023 },
3024 "coverUrl": {
3025 "type": "string"
3026 },
3027 "description": {
3028 "type": "string"
3029 },
3030 "title": {
3031 "type": "string"
3032 },
3033 "volumeId": {
3034 "type": "string"
3035 }
3036 },
3037 "type": "object"
3038 },
3039 "type": "array"
3040 }
3041 },
3042 "type": "object"
3043 },
3044 "type": "array"
3045 },
3046 "kind": {
3047 "default": "promooffer#offers",
3048 "description": "Resource type.",
3049 "type": "string"
3050 }
3051 },
3052 "type": "object"
3053 },
3054 "ReadingPosition": {
3055 "id": "ReadingPosition",
3056 "properties": {
3057 "epubCfiPosition": {
3058 "description": "Position in an EPUB as a CFI.",
3059 "type": "string"
3060 },
3061 "gbImagePosition": {
3062 "description": "Position in a volume for image-based content .",
3063 "type": "string"
3064 },
3065 "gbTextPosition": {
3066 "description": "Position in a volume for text-based content. ",
3067 "type": "string"
3068 },
3069 "kind": {
3070 "default": "books#readingPosition",
3071 "description": "Resource type for a reading position.",
3072 "type": "string"
3073 },
3074 "pdfPosition": {
3075 "description": "Position in a PDF file.",
3076 "type": "string"
3077 },
3078 "updated": {
3079 "description": "Timestamp when this reading position was las t updated (formatted UTC timestamp with millisecond resolution).",
3080 "format": "date-time",
3081 "type": "string"
3082 },
3083 "volumeId": {
3084 "description": "Volume id associated with this reading posit ion.",
3085 "type": "string"
3086 }
3087 },
3088 "type": "object"
3089 },
3090 "RequestAccess": {
3091 "id": "RequestAccess",
3092 "properties": {
3093 "concurrentAccess": {
3094 "$ref": "ConcurrentAccessRestriction",
3095 "description": "A concurrent access response."
3096 },
3097 "downloadAccess": {
3098 "$ref": "DownloadAccessRestriction",
3099 "description": "A download access response."
3100 },
3101 "kind": {
3102 "default": "books#requestAccess",
3103 "description": "Resource type.",
3104 "type": "string"
3105 }
3106 },
3107 "type": "object"
3108 },
3109 "Review": {
3110 "id": "Review",
3111 "properties": {
3112 "author": {
3113 "description": "Author of this review.",
3114 "properties": {
3115 "displayName": {
3116 "description": "Name of this person.",
3117 "type": "string"
3118 }
3119 },
3120 "type": "object"
3121 },
3122 "content": {
3123 "description": "Review text.",
3124 "type": "string"
3125 },
3126 "date": {
3127 "description": "Date of this review.",
3128 "type": "string"
3129 },
3130 "fullTextUrl": {
3131 "description": "URL for the full review text, for reviews ga thered from the web.",
3132 "type": "string"
3133 },
3134 "kind": {
3135 "default": "books#review",
3136 "description": "Resource type for a review.",
3137 "type": "string"
3138 },
3139 "rating": {
3140 "description": "Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.",
3141 "type": "string"
3142 },
3143 "source": {
3144 "description": "Information regarding the source of this rev iew, when the review is not from a Google Books user.",
3145 "properties": {
3146 "description": {
3147 "description": "Name of the source.",
3148 "type": "string"
3149 },
3150 "extraDescription": {
3151 "description": "Extra text about the source of the r eview.",
3152 "type": "string"
3153 },
3154 "url": {
3155 "description": "URL of the source of the review.",
3156 "type": "string"
3157 }
3158 },
3159 "type": "object"
3160 },
3161 "title": {
3162 "description": "Title for this review.",
3163 "type": "string"
3164 },
3165 "type": {
3166 "description": "Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.",
3167 "type": "string"
3168 },
3169 "volumeId": {
3170 "description": "Volume that this review is for.",
3171 "type": "string"
3172 }
3173 },
3174 "type": "object"
3175 },
3176 "Volume": {
3177 "id": "Volume",
3178 "properties": {
3179 "accessInfo": {
3180 "description": "Any information about a volume related to re ading or obtaining that volume text. This information can depend on country (boo ks may be public domain in one country but not in another, e.g.).",
3181 "properties": {
3182 "accessViewStatus": {
3183 "description": "Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURC HASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)",
3184 "type": "string"
3185 },
3186 "country": {
3187 "description": "The two-letter ISO_3166-1 country co de for which this access information is valid. (In LITE projection.)",
3188 "type": "string"
3189 },
3190 "downloadAccess": {
3191 "$ref": "DownloadAccessRestriction",
3192 "description": "Information about a volume's downloa d license access restrictions."
3193 },
3194 "driveImportedContentLink": {
3195 "description": "URL to the Google Drive viewer if th is volume is uploaded by the user by selecting the file from Google Drive.",
3196 "type": "string"
3197 },
3198 "embeddable": {
3199 "description": "Whether this volume can be embedded in a viewport using the Embedded Viewer API.",
3200 "type": "boolean"
3201 },
3202 "epub": {
3203 "description": "Information about epub content. (In LITE projection.)",
3204 "properties": {
3205 "acsTokenLink": {
3206 "description": "URL to retrieve ACS token fo r epub download. (In LITE projection.)",
3207 "type": "string"
3208 },
3209 "downloadLink": {
3210 "description": "URL to download epub. (In LI TE projection.)",
3211 "type": "string"
3212 },
3213 "isAvailable": {
3214 "description": "Is a flowing text epub avail able either as public domain or for purchase. (In LITE projection.)",
3215 "type": "boolean"
3216 }
3217 },
3218 "type": "object"
3219 },
3220 "explicitOfflineLicenseManagement": {
3221 "description": "Whether this volume requires that th e client explicitly request offline download license rather than have it done au tomatically when loading the content, if the client supports it.",
3222 "type": "boolean"
3223 },
3224 "pdf": {
3225 "description": "Information about pdf content. (In L ITE projection.)",
3226 "properties": {
3227 "acsTokenLink": {
3228 "description": "URL to retrieve ACS token fo r pdf download. (In LITE projection.)",
3229 "type": "string"
3230 },
3231 "downloadLink": {
3232 "description": "URL to download pdf. (In LIT E projection.)",
3233 "type": "string"
3234 },
3235 "isAvailable": {
3236 "description": "Is a scanned image pdf avail able either as public domain or for purchase. (In LITE projection.)",
3237 "type": "boolean"
3238 }
3239 },
3240 "type": "object"
3241 },
3242 "publicDomain": {
3243 "description": "Whether or not this book is public d omain in the country listed above.",
3244 "type": "boolean"
3245 },
3246 "quoteSharingAllowed": {
3247 "description": "Whether quote sharing is allowed for this volume.",
3248 "type": "boolean"
3249 },
3250 "textToSpeechPermission": {
3251 "description": "Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWE D.",
3252 "type": "string"
3253 },
3254 "viewOrderUrl": {
3255 "description": "For ordered but not yet processed or ders, we give a URL that can be used to go to the appropriate Google Wallet page .",
3256 "type": "string"
3257 },
3258 "viewability": {
3259 "description": "The read access of a volume. Possibl e values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed so me portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value o f ALL_PAGES.",
3260 "type": "string"
3261 },
3262 "webReaderLink": {
3263 "description": "URL to read this volume on the Googl e Books site. Link will not allow users to read non-viewable volumes.",
3264 "type": "string"
3265 }
3266 },
3267 "type": "object"
3268 },
3269 "etag": {
3270 "description": "Opaque identifier for a specific version of a volume resource. (In LITE projection)",
3271 "type": "string"
3272 },
3273 "id": {
3274 "description": "Unique identifier for a volume. (In LITE pro jection.)",
3275 "type": "string"
3276 },
3277 "kind": {
3278 "default": "books#volume",
3279 "description": "Resource type for a volume. (In LITE project ion.)",
3280 "type": "string"
3281 },
3282 "layerInfo": {
3283 "description": "What layers exist in this volume and high le vel information about them.",
3284 "properties": {
3285 "layers": {
3286 "description": "A layer should appear here if and on ly if the layer exists for this book.",
3287 "items": {
3288 "properties": {
3289 "layerId": {
3290 "description": "The layer id of this lay er (e.g. \"geo\").",
3291 "type": "string"
3292 },
3293 "volumeAnnotationsVersion": {
3294 "description": "The current version of t his layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.",
3295 "type": "string"
3296 }
3297 },
3298 "type": "object"
3299 },
3300 "type": "array"
3301 }
3302 },
3303 "type": "object"
3304 },
3305 "recommendedInfo": {
3306 "description": "Recommendation related information for this volume.",
3307 "properties": {
3308 "explanation": {
3309 "description": "A text explaining why this volume is recommended.",
3310 "type": "string"
3311 }
3312 },
3313 "type": "object"
3314 },
3315 "saleInfo": {
3316 "description": "Any information about a volume related to th e eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain cou ntries).",
3317 "properties": {
3318 "buyLink": {
3319 "description": "URL to purchase this volume on the G oogle Books site. (In LITE projection)",
3320 "type": "string"
3321 },
3322 "country": {
3323 "description": "The two-letter ISO_3166-1 country co de for which this sale information is valid. (In LITE projection.)",
3324 "type": "string"
3325 },
3326 "isEbook": {
3327 "description": "Whether or not this volume is an eBo ok (can be added to the My eBooks shelf).",
3328 "type": "boolean"
3329 },
3330 "listPrice": {
3331 "description": "Suggested retail price. (In LITE pro jection.)",
3332 "properties": {
3333 "amount": {
3334 "description": "Amount in the currency liste d below. (In LITE projection.)",
3335 "format": "double",
3336 "type": "number"
3337 },
3338 "currencyCode": {
3339 "description": "An ISO 4217, three-letter cu rrency code. (In LITE projection.)",
3340 "type": "string"
3341 }
3342 },
3343 "type": "object"
3344 },
3345 "offers": {
3346 "description": "Offers available for this volume (sa les and rentals).",
3347 "items": {
3348 "properties": {
3349 "finskyOfferType": {
3350 "description": "The finsky offer type (e .g., PURCHASE=0 RENTAL=3)",
3351 "format": "int32",
3352 "type": "integer"
3353 },
3354 "listPrice": {
3355 "description": "Offer list (=undiscounte d) price in Micros.",
3356 "properties": {
3357 "amountInMicros": {
3358 "format": "double",
3359 "type": "number"
3360 },
3361 "currencyCode": {
3362 "type": "string"
3363 }
3364 },
3365 "type": "object"
3366 },
3367 "rentalDuration": {
3368 "description": "The rental duration (for rental offers only).",
3369 "properties": {
3370 "count": {
3371 "format": "double",
3372 "type": "number"
3373 },
3374 "unit": {
3375 "type": "string"
3376 }
3377 },
3378 "type": "object"
3379 },
3380 "retailPrice": {
3381 "description": "Offer retail (=discounte d) price in Micros",
3382 "properties": {
3383 "amountInMicros": {
3384 "format": "double",
3385 "type": "number"
3386 },
3387 "currencyCode": {
3388 "type": "string"
3389 }
3390 },
3391 "type": "object"
3392 }
3393 },
3394 "type": "object"
3395 },
3396 "type": "array"
3397 },
3398 "onSaleDate": {
3399 "description": "The date on which this book is avail able for sale.",
3400 "format": "date-time",
3401 "type": "string"
3402 },
3403 "retailPrice": {
3404 "description": "The actual selling price of the book . This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)",
3405 "properties": {
3406 "amount": {
3407 "description": "Amount in the currency liste d below. (In LITE projection.)",
3408 "format": "double",
3409 "type": "number"
3410 },
3411 "currencyCode": {
3412 "description": "An ISO 4217, three-letter cu rrency code. (In LITE projection.)",
3413 "type": "string"
3414 }
3415 },
3416 "type": "object"
3417 },
3418 "saleability": {
3419 "description": "Whether or not this book is availabl e for sale or offered for free in the Google eBookstore for the country listed a bove. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.",
3420 "type": "string"
3421 }
3422 },
3423 "type": "object"
3424 },
3425 "searchInfo": {
3426 "description": "Search result information related to this vo lume.",
3427 "properties": {
3428 "textSnippet": {
3429 "description": "A text snippet containing the search query.",
3430 "type": "string"
3431 }
3432 },
3433 "type": "object"
3434 },
3435 "selfLink": {
3436 "description": "URL to this resource. (In LITE projection.)" ,
3437 "type": "string"
3438 },
3439 "userInfo": {
3440 "description": "User specific information related to this vo lume. (e.g. page this user last read or whether they purchased this book)",
3441 "properties": {
3442 "copy": {
3443 "description": "Copy/Paste accounting information.",
3444 "properties": {
3445 "allowedCharacterCount": {
3446 "format": "int32",
3447 "type": "integer"
3448 },
3449 "limitType": {
3450 "type": "string"
3451 },
3452 "remainingCharacterCount": {
3453 "format": "int32",
3454 "type": "integer"
3455 },
3456 "updated": {
3457 "format": "date-time",
3458 "type": "string"
3459 }
3460 },
3461 "type": "object"
3462 },
3463 "isInMyBooks": {
3464 "description": "Whether or not this volume is curren tly in \"my books.\"",
3465 "type": "boolean"
3466 },
3467 "isPreordered": {
3468 "description": "Whether or not this volume was pre-o rdered by the authenticated user making the request. (In LITE projection.)",
3469 "type": "boolean"
3470 },
3471 "isPurchased": {
3472 "description": "Whether or not this volume was purch ased by the authenticated user making the request. (In LITE projection.)",
3473 "type": "boolean"
3474 },
3475 "isUploaded": {
3476 "description": "Whether or not this volume was user uploaded.",
3477 "type": "boolean"
3478 },
3479 "readingPosition": {
3480 "$ref": "ReadingPosition",
3481 "description": "The user's current reading position in the volume, if one is available. (In LITE projection.)"
3482 },
3483 "rentalPeriod": {
3484 "description": "Period during this book is/was a val id rental.",
3485 "properties": {
3486 "endUtcSec": {
3487 "format": "int64",
3488 "type": "string"
3489 },
3490 "startUtcSec": {
3491 "format": "int64",
3492 "type": "string"
3493 }
3494 },
3495 "type": "object"
3496 },
3497 "rentalState": {
3498 "description": "Whether this book is an active or an expired rental.",
3499 "type": "string"
3500 },
3501 "review": {
3502 "$ref": "Review",
3503 "description": "This user's review of this volume, i f one exists."
3504 },
3505 "updated": {
3506 "description": "Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).",
3507 "format": "date-time",
3508 "type": "string"
3509 },
3510 "userUploadedVolumeInfo": {
3511 "properties": {
3512 "processingState": {
3513 "type": "string"
3514 }
3515 },
3516 "type": "object"
3517 }
3518 },
3519 "type": "object"
3520 },
3521 "volumeInfo": {
3522 "description": "General volume information.",
3523 "properties": {
3524 "authors": {
3525 "description": "The names of the authors and/or edit ors for this volume. (In LITE projection)",
3526 "items": {
3527 "type": "string"
3528 },
3529 "type": "array"
3530 },
3531 "averageRating": {
3532 "description": "The mean review rating for this volu me. (min = 1.0, max = 5.0)",
3533 "format": "double",
3534 "type": "number"
3535 },
3536 "canonicalVolumeLink": {
3537 "description": "Canonical URL for a volume. (In LITE projection.)",
3538 "type": "string"
3539 },
3540 "categories": {
3541 "description": "A list of subject categories, such a s \"Fiction\", \"Suspense\", etc.",
3542 "items": {
3543 "type": "string"
3544 },
3545 "type": "array"
3546 },
3547 "contentVersion": {
3548 "description": "An identifier for the version of the volume content (text & images). (In LITE projection)",
3549 "type": "string"
3550 },
3551 "description": {
3552 "description": "A synopsis of the volume. The text o f the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)",
3553 "type": "string"
3554 },
3555 "dimensions": {
3556 "description": "Physical dimensions of this volume." ,
3557 "properties": {
3558 "height": {
3559 "description": "Height or length of this vol ume (in cm).",
3560 "type": "string"
3561 },
3562 "thickness": {
3563 "description": "Thickness of this volume (in cm).",
3564 "type": "string"
3565 },
3566 "width": {
3567 "description": "Width of this volume (in cm) .",
3568 "type": "string"
3569 }
3570 },
3571 "type": "object"
3572 },
3573 "imageLinks": {
3574 "description": "A list of image links for all the si zes that are available. (In LITE projection.)",
3575 "properties": {
3576 "extraLarge": {
3577 "description": "Image link for extra large s ize (width of ~1280 pixels). (In LITE projection)",
3578 "type": "string"
3579 },
3580 "large": {
3581 "description": "Image link for large size (w idth of ~800 pixels). (In LITE projection)",
3582 "type": "string"
3583 },
3584 "medium": {
3585 "description": "Image link for medium size ( width of ~575 pixels). (In LITE projection)",
3586 "type": "string"
3587 },
3588 "small": {
3589 "description": "Image link for small size (w idth of ~300 pixels). (In LITE projection)",
3590 "type": "string"
3591 },
3592 "smallThumbnail": {
3593 "description": "Image link for small thumbna il size (width of ~80 pixels). (In LITE projection)",
3594 "type": "string"
3595 },
3596 "thumbnail": {
3597 "description": "Image link for thumbnail siz e (width of ~128 pixels). (In LITE projection)",
3598 "type": "string"
3599 }
3600 },
3601 "type": "object"
3602 },
3603 "industryIdentifiers": {
3604 "description": "Industry standard identifiers for th is volume.",
3605 "items": {
3606 "properties": {
3607 "identifier": {
3608 "description": "Industry specific volume identifier.",
3609 "type": "string"
3610 },
3611 "type": {
3612 "description": "Identifier type. Possibl e values are ISBN_10, ISBN_13, ISSN and OTHER.",
3613 "type": "string"
3614 }
3615 },
3616 "type": "object"
3617 },
3618 "type": "array"
3619 },
3620 "infoLink": {
3621 "description": "URL to view information about this v olume on the Google Books site. (In LITE projection)",
3622 "type": "string"
3623 },
3624 "language": {
3625 "description": "Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.",
3626 "type": "string"
3627 },
3628 "mainCategory": {
3629 "description": "The main category to which this volu me belongs. It will be the category from the categories list returned below that has the highest weight.",
3630 "type": "string"
3631 },
3632 "pageCount": {
3633 "description": "Total number of pages as per publish er metadata.",
3634 "format": "int32",
3635 "type": "integer"
3636 },
3637 "previewLink": {
3638 "description": "URL to preview this volume on the Go ogle Books site.",
3639 "type": "string"
3640 },
3641 "printType": {
3642 "description": "Type of publication of this volume. Possible values are BOOK or MAGAZINE.",
3643 "type": "string"
3644 },
3645 "printedPageCount": {
3646 "description": "Total number of printed pages in gen erated pdf representation.",
3647 "format": "int32",
3648 "type": "integer"
3649 },
3650 "publishedDate": {
3651 "description": "Date of publication. (In LITE projec tion.)",
3652 "type": "string"
3653 },
3654 "publisher": {
3655 "description": "Publisher of this volume. (In LITE p rojection.)",
3656 "type": "string"
3657 },
3658 "ratingsCount": {
3659 "description": "The number of review ratings for thi s volume.",
3660 "format": "int32",
3661 "type": "integer"
3662 },
3663 "readingModes": {
3664 "description": "The reading modes available for this volume.",
3665 "type": "any"
3666 },
3667 "subtitle": {
3668 "description": "Volume subtitle. (In LITE projection .)",
3669 "type": "string"
3670 },
3671 "title": {
3672 "description": "Volume title. (In LITE projection.)" ,
3673 "type": "string"
3674 }
3675 },
3676 "type": "object"
3677 }
3678 },
3679 "type": "object"
3680 },
3681 "Volumeannotation": {
3682 "id": "Volumeannotation",
3683 "properties": {
3684 "annotationDataId": {
3685 "description": "The annotation data id for this volume annot ation.",
3686 "type": "string"
3687 },
3688 "annotationDataLink": {
3689 "description": "Link to get data for this annotation.",
3690 "type": "string"
3691 },
3692 "annotationType": {
3693 "description": "The type of annotation this is.",
3694 "type": "string"
3695 },
3696 "contentRanges": {
3697 "description": "The content ranges to identify the selected text.",
3698 "properties": {
3699 "cfiRange": {
3700 "$ref": "BooksAnnotationsRange",
3701 "description": "Range in CFI format for this annotat ion for version above."
3702 },
3703 "contentVersion": {
3704 "description": "Content version applicable to ranges below.",
3705 "type": "string"
3706 },
3707 "gbImageRange": {
3708 "$ref": "BooksAnnotationsRange",
3709 "description": "Range in GB image format for this an notation for version above."
3710 },
3711 "gbTextRange": {
3712 "$ref": "BooksAnnotationsRange",
3713 "description": "Range in GB text format for this ann otation for version above."
3714 }
3715 },
3716 "type": "object"
3717 },
3718 "data": {
3719 "description": "Data for this annotation.",
3720 "type": "string"
3721 },
3722 "deleted": {
3723 "description": "Indicates that this annotation is deleted.",
3724 "type": "boolean"
3725 },
3726 "id": {
3727 "description": "Unique id of this volume annotation.",
3728 "type": "string"
3729 },
3730 "kind": {
3731 "default": "books#volumeannotation",
3732 "description": "Resource Type",
3733 "type": "string"
3734 },
3735 "layerId": {
3736 "description": "The Layer this annotation is for.",
3737 "type": "string"
3738 },
3739 "pageIds": {
3740 "description": "Pages the annotation spans.",
3741 "items": {
3742 "type": "string"
3743 },
3744 "type": "array"
3745 },
3746 "selectedText": {
3747 "description": "Excerpt from the volume.",
3748 "type": "string"
3749 },
3750 "selfLink": {
3751 "description": "URL to this resource.",
3752 "type": "string"
3753 },
3754 "updated": {
3755 "description": "Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).",
3756 "format": "date-time",
3757 "type": "string"
3758 },
3759 "volumeId": {
3760 "description": "The Volume this annotation is for.",
3761 "type": "string"
3762 }
3763 },
3764 "type": "object"
3765 },
3766 "Volumeannotations": {
3767 "id": "Volumeannotations",
3768 "properties": {
3769 "items": {
3770 "description": "A list of volume annotations.",
3771 "items": {
3772 "$ref": "Volumeannotation"
3773 },
3774 "type": "array"
3775 },
3776 "kind": {
3777 "default": "books#volumeannotations",
3778 "description": "Resource type",
3779 "type": "string"
3780 },
3781 "nextPageToken": {
3782 "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.",
3783 "type": "string"
3784 },
3785 "totalItems": {
3786 "description": "The total number of volume annotations found .",
3787 "format": "int32",
3788 "type": "integer"
3789 },
3790 "version": {
3791 "description": "The version string for all of the volume ann otations in this layer (not just the ones in this response). Note: the version s tring doesn't apply to the annotation data, just the information in this respons e (e.g. the location of annotations in the book).",
3792 "type": "string"
3793 }
3794 },
3795 "type": "object"
3796 },
3797 "Volumes": {
3798 "id": "Volumes",
3799 "properties": {
3800 "items": {
3801 "description": "A list of volumes.",
3802 "items": {
3803 "$ref": "Volume"
3804 },
3805 "type": "array"
3806 },
3807 "kind": {
3808 "default": "books#volumes",
3809 "description": "Resource type.",
3810 "type": "string"
3811 },
3812 "totalItems": {
3813 "description": "Total number of volumes found. This might be greater than the number of volumes returned in this response if results have be en paginated.",
3814 "format": "int32",
3815 "type": "integer"
3816 }
3817 },
3818 "type": "object"
3819 }
3820 },
3821 "servicePath": "books/v1/",
3822 "title": "Books API",
3823 "version": "v1"
3824 }
OLDNEW
« no previous file with comments | « discovery/googleapis/blogger__v3.json ('k') | discovery/googleapis/calendar__v3.json » ('j') | pubspec.yaml » ('J')

Powered by Google App Engine
This is Rietveld 408576698