| Index: discovery/googleapis/books__v1.json
|
| diff --git a/discovery/googleapis/books__v1.json b/discovery/googleapis/books__v1.json
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..a70a45dfe5d05e8bbc3d912ab179756e51fd0653
|
| --- /dev/null
|
| +++ b/discovery/googleapis/books__v1.json
|
| @@ -0,0 +1,3824 @@
|
| +{
|
| + "auth": {
|
| + "oauth2": {
|
| + "scopes": {
|
| + "https://www.googleapis.com/auth/books": {
|
| + "description": "Manage your books"
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "basePath": "/books/v1/",
|
| + "baseUrl": "https://www.googleapis.com/books/v1/",
|
| + "batchPath": "batch",
|
| + "description": "Lets you search for books and manage your Google Books library.",
|
| + "discoveryVersion": "v1",
|
| + "documentationLink": "https://developers.google.com/books/docs/v1/getting_started",
|
| + "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/XYINYydMW1yxY9sZ7pYYpIG24qI\"",
|
| + "icons": {
|
| + "x16": "http://www.google.com/images/icons/product/ebooks-16.png",
|
| + "x32": "http://www.google.com/images/icons/product/ebooks-32.png"
|
| + },
|
| + "id": "books:v1",
|
| + "kind": "discovery#restDescription",
|
| + "name": "books",
|
| + "ownerDomain": "google.com",
|
| + "ownerName": "Google",
|
| + "parameters": {
|
| + "alt": {
|
| + "default": "json",
|
| + "description": "Data format for the response.",
|
| + "enum": [
|
| + "json"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Responses with Content-Type of application/json"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "fields": {
|
| + "description": "Selector specifying which fields to include in a partial response.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "key": {
|
| + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "oauth_token": {
|
| + "description": "OAuth 2.0 token for the current user.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "prettyPrint": {
|
| + "default": "true",
|
| + "description": "Returns response with indentations and line breaks.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "quotaUser": {
|
| + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "userIp": {
|
| + "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "protocol": "rest",
|
| + "resources": {
|
| + "bookshelves": {
|
| + "methods": {
|
| + "get": {
|
| + "description": "Retrieves metadata for a specific bookshelf for the specified user.",
|
| + "httpMethod": "GET",
|
| + "id": "books.bookshelves.get",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "shelf"
|
| + ],
|
| + "parameters": {
|
| + "shelf": {
|
| + "description": "ID of bookshelf to retrieve.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "description": "ID of user for whom to retrieve bookshelves.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "users/{userId}/bookshelves/{shelf}",
|
| + "response": {
|
| + "$ref": "Bookshelf"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Retrieves a list of public bookshelves for the specified user.",
|
| + "httpMethod": "GET",
|
| + "id": "books.bookshelves.list",
|
| + "parameterOrder": [
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "description": "ID of user for whom to retrieve bookshelves.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "users/{userId}/bookshelves",
|
| + "response": {
|
| + "$ref": "Bookshelves"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + },
|
| + "resources": {
|
| + "volumes": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Retrieves volumes in a specific bookshelf for the specified user.",
|
| + "httpMethod": "GET",
|
| + "id": "books.bookshelves.volumes.list",
|
| + "parameterOrder": [
|
| + "userId",
|
| + "shelf"
|
| + ],
|
| + "parameters": {
|
| + "maxResults": {
|
| + "description": "Maximum number of results to return",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "shelf": {
|
| + "description": "ID of bookshelf to retrieve volumes.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "showPreorders": {
|
| + "description": "Set to true to show pre-ordered books. Defaults to false.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "startIndex": {
|
| + "description": "Index of the first element to return (starts at 0)",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "userId": {
|
| + "description": "ID of user for whom to retrieve bookshelf volumes.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "users/{userId}/bookshelves/{shelf}/volumes",
|
| + "response": {
|
| + "$ref": "Volumes"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "cloudloading": {
|
| + "methods": {
|
| + "addBook": {
|
| + "description": "",
|
| + "httpMethod": "POST",
|
| + "id": "books.cloudloading.addBook",
|
| + "parameters": {
|
| + "drive_document_id": {
|
| + "description": "A drive document id. The upload_client_token must not be set.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "mime_type": {
|
| + "description": "The document MIME type. It can be set only if the drive_document_id is set.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "name": {
|
| + "description": "The document name. It can be set only if the drive_document_id is set.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "upload_client_token": {
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "cloudloading/addBook",
|
| + "response": {
|
| + "$ref": "BooksCloudloadingResource"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "deleteBook": {
|
| + "description": "Remove the book and its contents",
|
| + "httpMethod": "POST",
|
| + "id": "books.cloudloading.deleteBook",
|
| + "parameterOrder": [
|
| + "volumeId"
|
| + ],
|
| + "parameters": {
|
| + "volumeId": {
|
| + "description": "The id of the book to be removed.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "cloudloading/deleteBook",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "updateBook": {
|
| + "description": "",
|
| + "httpMethod": "POST",
|
| + "id": "books.cloudloading.updateBook",
|
| + "path": "cloudloading/updateBook",
|
| + "request": {
|
| + "$ref": "BooksCloudloadingResource"
|
| + },
|
| + "response": {
|
| + "$ref": "BooksCloudloadingResource"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "layers": {
|
| + "methods": {
|
| + "get": {
|
| + "description": "Gets the layer summary for a volume.",
|
| + "httpMethod": "GET",
|
| + "id": "books.layers.get",
|
| + "parameterOrder": [
|
| + "volumeId",
|
| + "summaryId"
|
| + ],
|
| + "parameters": {
|
| + "contentVersion": {
|
| + "description": "The content version for the requested volume.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "summaryId": {
|
| + "description": "The ID for the layer to get the summary for.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume to retrieve layers for.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "volumes/{volumeId}/layersummary/{summaryId}",
|
| + "response": {
|
| + "$ref": "Layersummary"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "List the layer summaries for a volume.",
|
| + "httpMethod": "GET",
|
| + "id": "books.layers.list",
|
| + "parameterOrder": [
|
| + "volumeId"
|
| + ],
|
| + "parameters": {
|
| + "contentVersion": {
|
| + "description": "The content version for the requested volume.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "maxResults": {
|
| + "description": "Maximum number of results to return",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "maximum": "200",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "pageToken": {
|
| + "description": "The value of the nextToken from the previous page.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume to retrieve layers for.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "volumes/{volumeId}/layersummary",
|
| + "response": {
|
| + "$ref": "Layersummaries"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + },
|
| + "resources": {
|
| + "annotationData": {
|
| + "methods": {
|
| + "get": {
|
| + "description": "Gets the annotation data.",
|
| + "httpMethod": "GET",
|
| + "id": "books.layers.annotationData.get",
|
| + "parameterOrder": [
|
| + "volumeId",
|
| + "layerId",
|
| + "annotationDataId",
|
| + "contentVersion"
|
| + ],
|
| + "parameters": {
|
| + "allowWebDefinitions": {
|
| + "description": "For the dictionary layer. Whether or not to allow web definitions.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "annotationDataId": {
|
| + "description": "The ID of the annotation data to retrieve.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "contentVersion": {
|
| + "description": "The content version for the volume you are trying to retrieve.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "h": {
|
| + "description": "The requested pixel height for any images. If height is provided width must also be provided.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "layerId": {
|
| + "description": "The ID for the layer to get the annotations.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "locale": {
|
| + "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "scale": {
|
| + "description": "The requested scale for the image.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume to retrieve annotations for.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "w": {
|
| + "description": "The requested pixel width for any images. If width is provided height must also be provided.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "path": "volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}",
|
| + "response": {
|
| + "$ref": "Annotationdata"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Gets the annotation data for a volume and layer.",
|
| + "httpMethod": "GET",
|
| + "id": "books.layers.annotationData.list",
|
| + "parameterOrder": [
|
| + "volumeId",
|
| + "layerId",
|
| + "contentVersion"
|
| + ],
|
| + "parameters": {
|
| + "annotationDataId": {
|
| + "description": "The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "contentVersion": {
|
| + "description": "The content version for the requested volume.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "h": {
|
| + "description": "The requested pixel height for any images. If height is provided width must also be provided.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "layerId": {
|
| + "description": "The ID for the layer to get the annotation data.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "locale": {
|
| + "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "maxResults": {
|
| + "description": "Maximum number of results to return",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "maximum": "200",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "pageToken": {
|
| + "description": "The value of the nextToken from the previous page.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "scale": {
|
| + "description": "The requested scale for the image.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "updatedMax": {
|
| + "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "updatedMin": {
|
| + "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume to retrieve annotation data for.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "w": {
|
| + "description": "The requested pixel width for any images. If width is provided height must also be provided.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "path": "volumes/{volumeId}/layers/{layerId}/data",
|
| + "response": {
|
| + "$ref": "Annotationsdata"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "volumeAnnotations": {
|
| + "methods": {
|
| + "get": {
|
| + "description": "Gets the volume annotation.",
|
| + "httpMethod": "GET",
|
| + "id": "books.layers.volumeAnnotations.get",
|
| + "parameterOrder": [
|
| + "volumeId",
|
| + "layerId",
|
| + "annotationId"
|
| + ],
|
| + "parameters": {
|
| + "annotationId": {
|
| + "description": "The ID of the volume annotation to retrieve.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "layerId": {
|
| + "description": "The ID for the layer to get the annotations.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "locale": {
|
| + "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume to retrieve annotations for.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}",
|
| + "response": {
|
| + "$ref": "Volumeannotation"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Gets the volume annotations for a volume and layer.",
|
| + "httpMethod": "GET",
|
| + "id": "books.layers.volumeAnnotations.list",
|
| + "parameterOrder": [
|
| + "volumeId",
|
| + "layerId",
|
| + "contentVersion"
|
| + ],
|
| + "parameters": {
|
| + "contentVersion": {
|
| + "description": "The content version for the requested volume.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "endOffset": {
|
| + "description": "The end offset to end retrieving data from.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "endPosition": {
|
| + "description": "The end position to end retrieving data from.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "layerId": {
|
| + "description": "The ID for the layer to get the annotations.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "locale": {
|
| + "description": "The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "maxResults": {
|
| + "description": "Maximum number of results to return",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "maximum": "200",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "pageToken": {
|
| + "description": "The value of the nextToken from the previous page.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "showDeleted": {
|
| + "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "startOffset": {
|
| + "description": "The start offset to start retrieving data from.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "startPosition": {
|
| + "description": "The start position to start retrieving data from.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "updatedMax": {
|
| + "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "updatedMin": {
|
| + "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeAnnotationsVersion": {
|
| + "description": "The version of the volume annotations that you are requesting.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume to retrieve annotations for.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "volumes/{volumeId}/layers/{layerId}",
|
| + "response": {
|
| + "$ref": "Volumeannotations"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "myconfig": {
|
| + "methods": {
|
| + "releaseDownloadAccess": {
|
| + "description": "Release downloaded content access restriction.",
|
| + "httpMethod": "POST",
|
| + "id": "books.myconfig.releaseDownloadAccess",
|
| + "parameterOrder": [
|
| + "volumeIds",
|
| + "cpksver"
|
| + ],
|
| + "parameters": {
|
| + "cpksver": {
|
| + "description": "The device/version ID from which to release the restriction.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "locale": {
|
| + "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeIds": {
|
| + "description": "The volume(s) to release restrictions for.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "myconfig/releaseDownloadAccess",
|
| + "response": {
|
| + "$ref": "DownloadAccesses"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "requestAccess": {
|
| + "description": "Request concurrent and download access restrictions.",
|
| + "httpMethod": "POST",
|
| + "id": "books.myconfig.requestAccess",
|
| + "parameterOrder": [
|
| + "source",
|
| + "volumeId",
|
| + "nonce",
|
| + "cpksver"
|
| + ],
|
| + "parameters": {
|
| + "cpksver": {
|
| + "description": "The device/version ID from which to request the restrictions.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "licenseTypes": {
|
| + "description": "The type of access license to request. If not specified, the default is BOTH.",
|
| + "enum": [
|
| + "BOTH",
|
| + "CONCURRENT",
|
| + "DOWNLOAD"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Both concurrent and download licenses.",
|
| + "Concurrent access license.",
|
| + "Offline download access license."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "locale": {
|
| + "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "nonce": {
|
| + "description": "The client nonce value.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume to request concurrent/download restrictions for.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "myconfig/requestAccess",
|
| + "response": {
|
| + "$ref": "RequestAccess"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "syncVolumeLicenses": {
|
| + "description": "Request downloaded content access for specified volumes on the My eBooks shelf.",
|
| + "httpMethod": "POST",
|
| + "id": "books.myconfig.syncVolumeLicenses",
|
| + "parameterOrder": [
|
| + "source",
|
| + "nonce",
|
| + "cpksver"
|
| + ],
|
| + "parameters": {
|
| + "cpksver": {
|
| + "description": "The device/version ID from which to release the restriction.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "features": {
|
| + "description": "List of features supported by the client, i.e., 'RENTALS'",
|
| + "enum": [
|
| + "RENTALS"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Client supports rentals."
|
| + ],
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "locale": {
|
| + "description": "ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "nonce": {
|
| + "description": "The client nonce value.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "showPreorders": {
|
| + "description": "Set to true to show pre-ordered books. Defaults to false.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "volumeIds": {
|
| + "description": "The volume(s) to request download restrictions for.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "myconfig/syncVolumeLicenses",
|
| + "response": {
|
| + "$ref": "Volumes"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "mylibrary": {
|
| + "resources": {
|
| + "annotations": {
|
| + "methods": {
|
| + "delete": {
|
| + "description": "Deletes an annotation.",
|
| + "httpMethod": "DELETE",
|
| + "id": "books.mylibrary.annotations.delete",
|
| + "parameterOrder": [
|
| + "annotationId"
|
| + ],
|
| + "parameters": {
|
| + "annotationId": {
|
| + "description": "The ID for the annotation to delete.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/annotations/{annotationId}",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Gets an annotation by its ID.",
|
| + "httpMethod": "GET",
|
| + "id": "books.mylibrary.annotations.get",
|
| + "parameterOrder": [
|
| + "annotationId"
|
| + ],
|
| + "parameters": {
|
| + "annotationId": {
|
| + "description": "The ID for the annotation to retrieve.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/annotations/{annotationId}",
|
| + "response": {
|
| + "$ref": "Annotation"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "insert": {
|
| + "description": "Inserts a new annotation.",
|
| + "httpMethod": "POST",
|
| + "id": "books.mylibrary.annotations.insert",
|
| + "parameters": {
|
| + "showOnlySummaryInResponse": {
|
| + "description": "Requests that only the summary of the specified layer be provided in the response.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/annotations",
|
| + "request": {
|
| + "$ref": "Annotation"
|
| + },
|
| + "response": {
|
| + "$ref": "Annotation"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Retrieves a list of annotations, possibly filtered.",
|
| + "httpMethod": "GET",
|
| + "id": "books.mylibrary.annotations.list",
|
| + "parameters": {
|
| + "contentVersion": {
|
| + "description": "The content version for the requested volume.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "layerId": {
|
| + "description": "The layer ID to limit annotation by.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "layerIds": {
|
| + "description": "The layer ID(s) to limit annotation by.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "maxResults": {
|
| + "description": "Maximum number of results to return",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "maximum": "40",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "pageIds": {
|
| + "description": "The page ID(s) for the volume that is being queried.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "pageToken": {
|
| + "description": "The value of the nextToken from the previous page.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "showDeleted": {
|
| + "description": "Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "updatedMax": {
|
| + "description": "RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "updatedMin": {
|
| + "description": "RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume to restrict annotations to.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/annotations",
|
| + "response": {
|
| + "$ref": "Annotations"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "summary": {
|
| + "description": "Gets the summary of specified layers.",
|
| + "httpMethod": "POST",
|
| + "id": "books.mylibrary.annotations.summary",
|
| + "parameterOrder": [
|
| + "layerIds",
|
| + "volumeId"
|
| + ],
|
| + "parameters": {
|
| + "layerIds": {
|
| + "description": "Array of layer IDs to get the summary for.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "Volume id to get the summary for.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/annotations/summary",
|
| + "response": {
|
| + "$ref": "AnnotationsSummary"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "update": {
|
| + "description": "Updates an existing annotation.",
|
| + "httpMethod": "PUT",
|
| + "id": "books.mylibrary.annotations.update",
|
| + "parameterOrder": [
|
| + "annotationId"
|
| + ],
|
| + "parameters": {
|
| + "annotationId": {
|
| + "description": "The ID for the annotation to update.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/annotations/{annotationId}",
|
| + "request": {
|
| + "$ref": "Annotation"
|
| + },
|
| + "response": {
|
| + "$ref": "Annotation"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "bookshelves": {
|
| + "methods": {
|
| + "addVolume": {
|
| + "description": "Adds a volume to a bookshelf.",
|
| + "httpMethod": "POST",
|
| + "id": "books.mylibrary.bookshelves.addVolume",
|
| + "parameterOrder": [
|
| + "shelf",
|
| + "volumeId"
|
| + ],
|
| + "parameters": {
|
| + "shelf": {
|
| + "description": "ID of bookshelf to which to add a volume.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "ID of volume to add.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/bookshelves/{shelf}/addVolume",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "clearVolumes": {
|
| + "description": "Clears all volumes from a bookshelf.",
|
| + "httpMethod": "POST",
|
| + "id": "books.mylibrary.bookshelves.clearVolumes",
|
| + "parameterOrder": [
|
| + "shelf"
|
| + ],
|
| + "parameters": {
|
| + "shelf": {
|
| + "description": "ID of bookshelf from which to remove a volume.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/bookshelves/{shelf}/clearVolumes",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Retrieves metadata for a specific bookshelf belonging to the authenticated user.",
|
| + "httpMethod": "GET",
|
| + "id": "books.mylibrary.bookshelves.get",
|
| + "parameterOrder": [
|
| + "shelf"
|
| + ],
|
| + "parameters": {
|
| + "shelf": {
|
| + "description": "ID of bookshelf to retrieve.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/bookshelves/{shelf}",
|
| + "response": {
|
| + "$ref": "Bookshelf"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Retrieves a list of bookshelves belonging to the authenticated user.",
|
| + "httpMethod": "GET",
|
| + "id": "books.mylibrary.bookshelves.list",
|
| + "parameters": {
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/bookshelves",
|
| + "response": {
|
| + "$ref": "Bookshelves"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "moveVolume": {
|
| + "description": "Moves a volume within a bookshelf.",
|
| + "httpMethod": "POST",
|
| + "id": "books.mylibrary.bookshelves.moveVolume",
|
| + "parameterOrder": [
|
| + "shelf",
|
| + "volumeId",
|
| + "volumePosition"
|
| + ],
|
| + "parameters": {
|
| + "shelf": {
|
| + "description": "ID of bookshelf with the volume.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "ID of volume to move.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "volumePosition": {
|
| + "description": "Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.)",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "path": "mylibrary/bookshelves/{shelf}/moveVolume",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "removeVolume": {
|
| + "description": "Removes a volume from a bookshelf.",
|
| + "httpMethod": "POST",
|
| + "id": "books.mylibrary.bookshelves.removeVolume",
|
| + "parameterOrder": [
|
| + "shelf",
|
| + "volumeId"
|
| + ],
|
| + "parameters": {
|
| + "shelf": {
|
| + "description": "ID of bookshelf from which to remove a volume.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "ID of volume to remove.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/bookshelves/{shelf}/removeVolume",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + },
|
| + "resources": {
|
| + "volumes": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Gets volume information for volumes on a bookshelf.",
|
| + "httpMethod": "GET",
|
| + "id": "books.mylibrary.bookshelves.volumes.list",
|
| + "parameterOrder": [
|
| + "shelf"
|
| + ],
|
| + "parameters": {
|
| + "country": {
|
| + "description": "ISO-3166-1 code to override the IP-based location.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "maxResults": {
|
| + "description": "Maximum number of results to return",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "projection": {
|
| + "description": "Restrict information returned to a set of selected fields.",
|
| + "enum": [
|
| + "full",
|
| + "lite"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Includes all volume data.",
|
| + "Includes a subset of fields in volumeInfo and accessInfo."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "q": {
|
| + "description": "Full-text search query string in this bookshelf.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "shelf": {
|
| + "description": "The bookshelf ID or name retrieve volumes for.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "showPreorders": {
|
| + "description": "Set to true to show pre-ordered books. Defaults to false.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "startIndex": {
|
| + "description": "Index of the first element to return (starts at 0)",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "path": "mylibrary/bookshelves/{shelf}/volumes",
|
| + "response": {
|
| + "$ref": "Volumes"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "readingpositions": {
|
| + "methods": {
|
| + "get": {
|
| + "description": "Retrieves my reading position information for a volume.",
|
| + "httpMethod": "GET",
|
| + "id": "books.mylibrary.readingpositions.get",
|
| + "parameterOrder": [
|
| + "volumeId"
|
| + ],
|
| + "parameters": {
|
| + "contentVersion": {
|
| + "description": "Volume content version for which this reading position is requested.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "ID of volume for which to retrieve a reading position.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/readingpositions/{volumeId}",
|
| + "response": {
|
| + "$ref": "ReadingPosition"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "setPosition": {
|
| + "description": "Sets my reading position information for a volume.",
|
| + "httpMethod": "POST",
|
| + "id": "books.mylibrary.readingpositions.setPosition",
|
| + "parameterOrder": [
|
| + "volumeId",
|
| + "timestamp",
|
| + "position"
|
| + ],
|
| + "parameters": {
|
| + "action": {
|
| + "description": "Action that caused this reading position to be set.",
|
| + "enum": [
|
| + "bookmark",
|
| + "chapter",
|
| + "next-page",
|
| + "prev-page",
|
| + "scroll",
|
| + "search"
|
| + ],
|
| + "enumDescriptions": [
|
| + "User chose bookmark within volume.",
|
| + "User selected chapter from list.",
|
| + "Next page event.",
|
| + "Previous page event.",
|
| + "User navigated to page.",
|
| + "User chose search results within volume."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "contentVersion": {
|
| + "description": "Volume content version for which this reading position applies.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "deviceCookie": {
|
| + "description": "Random persistent device cookie optional on set position.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "position": {
|
| + "description": "Position string for the new volume reading position.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "timestamp": {
|
| + "description": "RFC 3339 UTC format timestamp associated with this reading position.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "ID of volume for which to update the reading position.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "mylibrary/readingpositions/{volumeId}/setPosition",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "promooffer": {
|
| + "methods": {
|
| + "accept": {
|
| + "description": "",
|
| + "httpMethod": "POST",
|
| + "id": "books.promooffer.accept",
|
| + "parameters": {
|
| + "androidId": {
|
| + "description": "device android_id",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "device": {
|
| + "description": "device device",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "manufacturer": {
|
| + "description": "device manufacturer",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "model": {
|
| + "description": "device model",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "offerId": {
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "product": {
|
| + "description": "device product",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "serial": {
|
| + "description": "device serial",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "Volume id to exercise the offer",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "promooffer/accept",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "dismiss": {
|
| + "description": "",
|
| + "httpMethod": "POST",
|
| + "id": "books.promooffer.dismiss",
|
| + "parameters": {
|
| + "androidId": {
|
| + "description": "device android_id",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "device": {
|
| + "description": "device device",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "manufacturer": {
|
| + "description": "device manufacturer",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "model": {
|
| + "description": "device model",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "offerId": {
|
| + "description": "Offer to dimiss",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "product": {
|
| + "description": "device product",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "serial": {
|
| + "description": "device serial",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "promooffer/dismiss",
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Returns a list of promo offers available to the user",
|
| + "httpMethod": "GET",
|
| + "id": "books.promooffer.get",
|
| + "parameters": {
|
| + "androidId": {
|
| + "description": "device android_id",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "device": {
|
| + "description": "device device",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "manufacturer": {
|
| + "description": "device manufacturer",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "model": {
|
| + "description": "device model",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "product": {
|
| + "description": "device product",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "serial": {
|
| + "description": "device serial",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "promooffer/get",
|
| + "response": {
|
| + "$ref": "Offers"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "volumes": {
|
| + "methods": {
|
| + "get": {
|
| + "description": "Gets volume information for a single volume.",
|
| + "httpMethod": "GET",
|
| + "id": "books.volumes.get",
|
| + "parameterOrder": [
|
| + "volumeId"
|
| + ],
|
| + "parameters": {
|
| + "country": {
|
| + "description": "ISO-3166-1 code to override the IP-based location.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "partner": {
|
| + "description": "Brand results for partner ID.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "projection": {
|
| + "description": "Restrict information returned to a set of selected fields.",
|
| + "enum": [
|
| + "full",
|
| + "lite"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Includes all volume data.",
|
| + "Includes a subset of fields in volumeInfo and accessInfo."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "ID of volume to retrieve.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "volumes/{volumeId}",
|
| + "response": {
|
| + "$ref": "Volume"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Performs a book search.",
|
| + "httpMethod": "GET",
|
| + "id": "books.volumes.list",
|
| + "parameterOrder": [
|
| + "q"
|
| + ],
|
| + "parameters": {
|
| + "download": {
|
| + "description": "Restrict to volumes by download availability.",
|
| + "enum": [
|
| + "epub"
|
| + ],
|
| + "enumDescriptions": [
|
| + "All volumes with epub."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "filter": {
|
| + "description": "Filter search results.",
|
| + "enum": [
|
| + "ebooks",
|
| + "free-ebooks",
|
| + "full",
|
| + "paid-ebooks",
|
| + "partial"
|
| + ],
|
| + "enumDescriptions": [
|
| + "All Google eBooks.",
|
| + "Google eBook with full volume text viewability.",
|
| + "Public can view entire volume text.",
|
| + "Google eBook with a price.",
|
| + "Public able to see parts of text."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "langRestrict": {
|
| + "description": "Restrict results to books with this language code.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "libraryRestrict": {
|
| + "description": "Restrict search to this user's library.",
|
| + "enum": [
|
| + "my-library",
|
| + "no-restrict"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Restrict to the user's library, any shelf.",
|
| + "Do not restrict based on user's library."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "maxResults": {
|
| + "description": "Maximum number of results to return.",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "maximum": "40",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "orderBy": {
|
| + "description": "Sort search results.",
|
| + "enum": [
|
| + "newest",
|
| + "relevance"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Most recently published.",
|
| + "Relevance to search terms."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "partner": {
|
| + "description": "Restrict and brand results for partner ID.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "printType": {
|
| + "description": "Restrict to books or magazines.",
|
| + "enum": [
|
| + "all",
|
| + "books",
|
| + "magazines"
|
| + ],
|
| + "enumDescriptions": [
|
| + "All volume content types.",
|
| + "Just books.",
|
| + "Just magazines."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "projection": {
|
| + "description": "Restrict information returned to a set of selected fields.",
|
| + "enum": [
|
| + "full",
|
| + "lite"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Includes all volume data.",
|
| + "Includes a subset of fields in volumeInfo and accessInfo."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "q": {
|
| + "description": "Full-text search query string.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "showPreorders": {
|
| + "description": "Set to true to show books available for preorder. Defaults to false.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "startIndex": {
|
| + "description": "Index of the first result to return (starts at 0)",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "path": "volumes",
|
| + "response": {
|
| + "$ref": "Volumes"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + },
|
| + "resources": {
|
| + "associated": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Return a list of associated books.",
|
| + "httpMethod": "GET",
|
| + "id": "books.volumes.associated.list",
|
| + "parameterOrder": [
|
| + "volumeId"
|
| + ],
|
| + "parameters": {
|
| + "association": {
|
| + "description": "Association type.",
|
| + "enum": [
|
| + "end-of-sample",
|
| + "end-of-volume"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Recommendations for display end-of-sample.",
|
| + "Recommendations for display end-of-volume."
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "locale": {
|
| + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "ID of the source volume.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "volumes/{volumeId}/associated",
|
| + "response": {
|
| + "$ref": "Volumes"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "mybooks": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Return a list of books in My Library.",
|
| + "httpMethod": "GET",
|
| + "id": "books.volumes.mybooks.list",
|
| + "parameters": {
|
| + "acquireMethod": {
|
| + "description": "How the book was aquired",
|
| + "enum": [
|
| + "PREORDERED",
|
| + "PREVIOUSLY_RENTED",
|
| + "PUBLIC_DOMAIN",
|
| + "PURCHASED",
|
| + "RENTED",
|
| + "SAMPLE",
|
| + "UPLOADED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Preordered books (not yet available)",
|
| + "User-rented books past their expiration time",
|
| + "Public domain books",
|
| + "Purchased books",
|
| + "User-rented books",
|
| + "Sample books",
|
| + "User uploaded books"
|
| + ],
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "locale": {
|
| + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "maxResults": {
|
| + "description": "Maximum number of results to return.",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "maximum": "100",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "processingState": {
|
| + "description": "The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.",
|
| + "enum": [
|
| + "COMPLETED_FAILED",
|
| + "COMPLETED_SUCCESS",
|
| + "RUNNING"
|
| + ],
|
| + "enumDescriptions": [
|
| + "The volume processing hase failed.",
|
| + "The volume processing was completed.",
|
| + "The volume processing is not completed."
|
| + ],
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "startIndex": {
|
| + "description": "Index of the first result to return (starts at 0)",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "path": "volumes/mybooks",
|
| + "response": {
|
| + "$ref": "Volumes"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "recommended": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Return a list of recommended books for the current user.",
|
| + "httpMethod": "GET",
|
| + "id": "books.volumes.recommended.list",
|
| + "parameters": {
|
| + "locale": {
|
| + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "volumes/recommended",
|
| + "response": {
|
| + "$ref": "Volumes"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + },
|
| + "rate": {
|
| + "description": "Rate a recommended book for the current user.",
|
| + "httpMethod": "POST",
|
| + "id": "books.volumes.recommended.rate",
|
| + "parameterOrder": [
|
| + "rating",
|
| + "volumeId"
|
| + ],
|
| + "parameters": {
|
| + "locale": {
|
| + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "rating": {
|
| + "description": "Rating to be given to the volume.",
|
| + "enum": [
|
| + "HAVE_IT",
|
| + "NOT_INTERESTED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Rating indicating a dismissal due to ownership.",
|
| + "Rating indicating a negative dismissal of a volume."
|
| + ],
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "ID of the source volume.",
|
| + "location": "query",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "volumes/recommended/rate",
|
| + "response": {
|
| + "$ref": "BooksVolumesRecommendedRateResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "useruploaded": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Return a list of books uploaded by the current user.",
|
| + "httpMethod": "GET",
|
| + "id": "books.volumes.useruploaded.list",
|
| + "parameters": {
|
| + "locale": {
|
| + "description": "ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "maxResults": {
|
| + "description": "Maximum number of results to return.",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "maximum": "40",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "processingState": {
|
| + "description": "The processing state of the user uploaded volumes to be returned.",
|
| + "enum": [
|
| + "COMPLETED_FAILED",
|
| + "COMPLETED_SUCCESS",
|
| + "RUNNING"
|
| + ],
|
| + "enumDescriptions": [
|
| + "The volume processing hase failed.",
|
| + "The volume processing was completed.",
|
| + "The volume processing is not completed."
|
| + ],
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "String to identify the originator of this request.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "startIndex": {
|
| + "description": "Index of the first result to return (starts at 0)",
|
| + "format": "uint32",
|
| + "location": "query",
|
| + "minimum": "0",
|
| + "type": "integer"
|
| + },
|
| + "volumeId": {
|
| + "description": "The ids of the volumes to be returned. If not specified all that match the processingState are returned.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "volumes/useruploaded",
|
| + "response": {
|
| + "$ref": "Volumes"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/books"
|
| + ]
|
| + }
|
| + }
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "revision": "20140507",
|
| + "rootUrl": "https://www.googleapis.com/",
|
| + "schemas": {
|
| + "Annotation": {
|
| + "id": "Annotation",
|
| + "properties": {
|
| + "afterSelectedText": {
|
| + "description": "Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.",
|
| + "type": "string"
|
| + },
|
| + "beforeSelectedText": {
|
| + "description": "Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.",
|
| + "type": "string"
|
| + },
|
| + "clientVersionRanges": {
|
| + "description": "Selection ranges sent from the client.",
|
| + "properties": {
|
| + "cfiRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in CFI format for this annotation sent by client."
|
| + },
|
| + "contentVersion": {
|
| + "description": "Content version the client sent in.",
|
| + "type": "string"
|
| + },
|
| + "gbImageRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in GB image format for this annotation sent by client."
|
| + },
|
| + "gbTextRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in GB text format for this annotation sent by client."
|
| + },
|
| + "imageCfiRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in image CFI format for this annotation sent by client."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "created": {
|
| + "description": "Timestamp for the created time of this annotation.",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + },
|
| + "currentVersionRanges": {
|
| + "description": "Selection ranges for the most recent content version.",
|
| + "properties": {
|
| + "cfiRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in CFI format for this annotation for version above."
|
| + },
|
| + "contentVersion": {
|
| + "description": "Content version applicable to ranges below.",
|
| + "type": "string"
|
| + },
|
| + "gbImageRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in GB image format for this annotation for version above."
|
| + },
|
| + "gbTextRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in GB text format for this annotation for version above."
|
| + },
|
| + "imageCfiRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in image CFI format for this annotation for version above."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "data": {
|
| + "description": "User-created data for this annotation.",
|
| + "type": "string"
|
| + },
|
| + "deleted": {
|
| + "description": "Indicates that this annotation is deleted.",
|
| + "type": "boolean"
|
| + },
|
| + "highlightStyle": {
|
| + "description": "The highlight style for this annotation.",
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "Id of this annotation, in the form of a GUID.",
|
| + "type": "string"
|
| + },
|
| + "kind": {
|
| + "default": "books#annotation",
|
| + "description": "Resource type.",
|
| + "type": "string"
|
| + },
|
| + "layerId": {
|
| + "description": "The layer this annotation is for.",
|
| + "type": "string"
|
| + },
|
| + "layerSummary": {
|
| + "properties": {
|
| + "allowedCharacterCount": {
|
| + "description": "Maximum allowed characters on this layer, especially for the \"copy\" layer.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "limitType": {
|
| + "description": "Type of limitation on this layer. \"limited\" or \"unlimited\" for the \"copy\" layer.",
|
| + "type": "string"
|
| + },
|
| + "remainingCharacterCount": {
|
| + "description": "Remaining allowed characters on this layer, especially for the \"copy\" layer.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "pageIds": {
|
| + "description": "Pages that this annotation spans.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "selectedText": {
|
| + "description": "Excerpt from the volume.",
|
| + "type": "string"
|
| + },
|
| + "selfLink": {
|
| + "description": "URL to this resource.",
|
| + "type": "string"
|
| + },
|
| + "updated": {
|
| + "description": "Timestamp for the last time this annotation was modified.",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume that this annotation belongs to.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Annotationdata": {
|
| + "id": "Annotationdata",
|
| + "properties": {
|
| + "annotationType": {
|
| + "description": "The type of annotation this data is for.",
|
| + "type": "string"
|
| + },
|
| + "data": {
|
| + "type": "any"
|
| + },
|
| + "encoded_data": {
|
| + "description": "Base64 encoded data for this annotation data.",
|
| + "format": "byte",
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "Unique id for this annotation data.",
|
| + "type": "string"
|
| + },
|
| + "kind": {
|
| + "default": "books#annotationdata",
|
| + "description": "Resource Type",
|
| + "type": "string"
|
| + },
|
| + "layerId": {
|
| + "description": "The Layer id for this data. *",
|
| + "type": "string"
|
| + },
|
| + "selfLink": {
|
| + "description": "URL for this resource. *",
|
| + "type": "string"
|
| + },
|
| + "updated": {
|
| + "description": "Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume id for this data. *",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Annotations": {
|
| + "id": "Annotations",
|
| + "properties": {
|
| + "items": {
|
| + "description": "A list of annotations.",
|
| + "items": {
|
| + "$ref": "Annotation"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "kind": {
|
| + "default": "books#annotations",
|
| + "description": "Resource type.",
|
| + "type": "string"
|
| + },
|
| + "nextPageToken": {
|
| + "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.",
|
| + "type": "string"
|
| + },
|
| + "totalItems": {
|
| + "description": "Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "AnnotationsSummary": {
|
| + "id": "AnnotationsSummary",
|
| + "properties": {
|
| + "kind": {
|
| + "default": "books#annotationsSummary",
|
| + "type": "string"
|
| + },
|
| + "layers": {
|
| + "items": {
|
| + "properties": {
|
| + "allowedCharacterCount": {
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "layerId": {
|
| + "type": "string"
|
| + },
|
| + "limitType": {
|
| + "type": "string"
|
| + },
|
| + "remainingCharacterCount": {
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "updated": {
|
| + "format": "date-time",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Annotationsdata": {
|
| + "id": "Annotationsdata",
|
| + "properties": {
|
| + "items": {
|
| + "description": "A list of Annotation Data.",
|
| + "items": {
|
| + "$ref": "Annotationdata"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "kind": {
|
| + "default": "books#annotationsdata",
|
| + "description": "Resource type",
|
| + "type": "string"
|
| + },
|
| + "nextPageToken": {
|
| + "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.",
|
| + "type": "string"
|
| + },
|
| + "totalItems": {
|
| + "description": "The total number of volume annotations found.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "BooksAnnotationsRange": {
|
| + "id": "BooksAnnotationsRange",
|
| + "properties": {
|
| + "endOffset": {
|
| + "description": "The offset from the ending position.",
|
| + "type": "string"
|
| + },
|
| + "endPosition": {
|
| + "description": "The ending position for the range.",
|
| + "type": "string"
|
| + },
|
| + "startOffset": {
|
| + "description": "The offset from the starting position.",
|
| + "type": "string"
|
| + },
|
| + "startPosition": {
|
| + "description": "The starting position for the range.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "BooksCloudloadingResource": {
|
| + "id": "BooksCloudloadingResource",
|
| + "properties": {
|
| + "author": {
|
| + "type": "string"
|
| + },
|
| + "processingState": {
|
| + "type": "string"
|
| + },
|
| + "title": {
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "BooksVolumesRecommendedRateResponse": {
|
| + "id": "BooksVolumesRecommendedRateResponse",
|
| + "properties": {
|
| + "consistency_token": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Bookshelf": {
|
| + "id": "Bookshelf",
|
| + "properties": {
|
| + "access": {
|
| + "description": "Whether this bookshelf is PUBLIC or PRIVATE.",
|
| + "type": "string"
|
| + },
|
| + "created": {
|
| + "description": "Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + },
|
| + "description": {
|
| + "description": "Description of this bookshelf.",
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "Id of this bookshelf, only unique by user.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "kind": {
|
| + "default": "books#bookshelf",
|
| + "description": "Resource type for bookshelf metadata.",
|
| + "type": "string"
|
| + },
|
| + "selfLink": {
|
| + "description": "URL to this resource.",
|
| + "type": "string"
|
| + },
|
| + "title": {
|
| + "description": "Title of this bookshelf.",
|
| + "type": "string"
|
| + },
|
| + "updated": {
|
| + "description": "Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + },
|
| + "volumeCount": {
|
| + "description": "Number of volumes in this bookshelf.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "volumesLastUpdated": {
|
| + "description": "Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Bookshelves": {
|
| + "id": "Bookshelves",
|
| + "properties": {
|
| + "items": {
|
| + "description": "A list of bookshelves.",
|
| + "items": {
|
| + "$ref": "Bookshelf"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "kind": {
|
| + "default": "books#bookshelves",
|
| + "description": "Resource type.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ConcurrentAccessRestriction": {
|
| + "id": "ConcurrentAccessRestriction",
|
| + "properties": {
|
| + "deviceAllowed": {
|
| + "description": "Whether access is granted for this (user, device, volume).",
|
| + "type": "boolean"
|
| + },
|
| + "kind": {
|
| + "default": "books#concurrentAccessRestriction",
|
| + "description": "Resource type.",
|
| + "type": "string"
|
| + },
|
| + "maxConcurrentDevices": {
|
| + "description": "The maximum number of concurrent access licenses for this volume.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "message": {
|
| + "description": "Error/warning message.",
|
| + "type": "string"
|
| + },
|
| + "nonce": {
|
| + "description": "Client nonce for verification. Download access and client-validation only.",
|
| + "type": "string"
|
| + },
|
| + "reasonCode": {
|
| + "description": "Error/warning reason code.",
|
| + "type": "string"
|
| + },
|
| + "restricted": {
|
| + "description": "Whether this volume has any concurrent access restrictions.",
|
| + "type": "boolean"
|
| + },
|
| + "signature": {
|
| + "description": "Response signature.",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "Client app identifier for verification. Download access and client-validation only.",
|
| + "type": "string"
|
| + },
|
| + "timeWindowSeconds": {
|
| + "description": "Time in seconds for license auto-expiration.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "volumeId": {
|
| + "description": "Identifies the volume for which this entry applies.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Dictlayerdata": {
|
| + "id": "Dictlayerdata",
|
| + "properties": {
|
| + "common": {
|
| + "properties": {
|
| + "title": {
|
| + "description": "The display title and localized canonical name to use when searching for this entity on Google search.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "dict": {
|
| + "properties": {
|
| + "source": {
|
| + "description": "The source, url and attribution for this dictionary data.",
|
| + "properties": {
|
| + "attribution": {
|
| + "type": "string"
|
| + },
|
| + "url": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "words": {
|
| + "items": {
|
| + "properties": {
|
| + "derivatives": {
|
| + "items": {
|
| + "properties": {
|
| + "source": {
|
| + "properties": {
|
| + "attribution": {
|
| + "type": "string"
|
| + },
|
| + "url": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "text": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "examples": {
|
| + "items": {
|
| + "properties": {
|
| + "source": {
|
| + "properties": {
|
| + "attribution": {
|
| + "type": "string"
|
| + },
|
| + "url": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "text": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "senses": {
|
| + "items": {
|
| + "properties": {
|
| + "conjugations": {
|
| + "items": {
|
| + "properties": {
|
| + "type": {
|
| + "type": "string"
|
| + },
|
| + "value": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "definitions": {
|
| + "items": {
|
| + "properties": {
|
| + "definition": {
|
| + "type": "string"
|
| + },
|
| + "examples": {
|
| + "items": {
|
| + "properties": {
|
| + "source": {
|
| + "properties": {
|
| + "attribution": {
|
| + "type": "string"
|
| + },
|
| + "url": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "text": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "partOfSpeech": {
|
| + "type": "string"
|
| + },
|
| + "pronunciation": {
|
| + "type": "string"
|
| + },
|
| + "pronunciationUrl": {
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "properties": {
|
| + "attribution": {
|
| + "type": "string"
|
| + },
|
| + "url": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "syllabification": {
|
| + "type": "string"
|
| + },
|
| + "synonyms": {
|
| + "items": {
|
| + "properties": {
|
| + "source": {
|
| + "properties": {
|
| + "attribution": {
|
| + "type": "string"
|
| + },
|
| + "url": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "text": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "source": {
|
| + "description": "The words with different meanings but not related words, e.g. \"go\" (game) and \"go\" (verb).",
|
| + "properties": {
|
| + "attribution": {
|
| + "type": "string"
|
| + },
|
| + "url": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "kind": {
|
| + "default": "books#dictlayerdata",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "DownloadAccessRestriction": {
|
| + "id": "DownloadAccessRestriction",
|
| + "properties": {
|
| + "deviceAllowed": {
|
| + "description": "If restricted, whether access is granted for this (user, device, volume).",
|
| + "type": "boolean"
|
| + },
|
| + "downloadsAcquired": {
|
| + "description": "If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "justAcquired": {
|
| + "description": "If deviceAllowed, whether access was just acquired with this request.",
|
| + "type": "boolean"
|
| + },
|
| + "kind": {
|
| + "default": "books#downloadAccessRestriction",
|
| + "description": "Resource type.",
|
| + "type": "string"
|
| + },
|
| + "maxDownloadDevices": {
|
| + "description": "If restricted, the maximum number of content download licenses for this volume.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "message": {
|
| + "description": "Error/warning message.",
|
| + "type": "string"
|
| + },
|
| + "nonce": {
|
| + "description": "Client nonce for verification. Download access and client-validation only.",
|
| + "type": "string"
|
| + },
|
| + "reasonCode": {
|
| + "description": "Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS",
|
| + "type": "string"
|
| + },
|
| + "restricted": {
|
| + "description": "Whether this volume has any download access restrictions.",
|
| + "type": "boolean"
|
| + },
|
| + "signature": {
|
| + "description": "Response signature.",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "Client app identifier for verification. Download access and client-validation only.",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "Identifies the volume for which this entry applies.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "DownloadAccesses": {
|
| + "id": "DownloadAccesses",
|
| + "properties": {
|
| + "downloadAccessList": {
|
| + "description": "A list of download access responses.",
|
| + "items": {
|
| + "$ref": "DownloadAccessRestriction"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "kind": {
|
| + "default": "books#downloadAccesses",
|
| + "description": "Resource type.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Geolayerdata": {
|
| + "id": "Geolayerdata",
|
| + "properties": {
|
| + "common": {
|
| + "properties": {
|
| + "lang": {
|
| + "description": "The language of the information url and description.",
|
| + "type": "string"
|
| + },
|
| + "previewImageUrl": {
|
| + "description": "The URL for the preview image information.",
|
| + "type": "string"
|
| + },
|
| + "snippet": {
|
| + "description": "The description for this location.",
|
| + "type": "string"
|
| + },
|
| + "snippetUrl": {
|
| + "description": "The URL for information for this location. Ex: wikipedia link.",
|
| + "type": "string"
|
| + },
|
| + "title": {
|
| + "description": "The display title and localized canonical name to use when searching for this entity on Google search.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "geo": {
|
| + "properties": {
|
| + "boundary": {
|
| + "description": "The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.",
|
| + "items": {
|
| + "items": {
|
| + "properties": {
|
| + "latitude": {
|
| + "format": "uint32",
|
| + "type": "integer"
|
| + },
|
| + "longitude": {
|
| + "format": "uint32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "cachePolicy": {
|
| + "description": "The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER",
|
| + "type": "string"
|
| + },
|
| + "countryCode": {
|
| + "description": "The country code of the location.",
|
| + "type": "string"
|
| + },
|
| + "latitude": {
|
| + "description": "The latitude of the location.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "longitude": {
|
| + "description": "The longitude of the location.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "mapType": {
|
| + "description": "The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN",
|
| + "type": "string"
|
| + },
|
| + "viewport": {
|
| + "description": "The viewport for showing this location. This is a latitude, longitude rectangle.",
|
| + "properties": {
|
| + "hi": {
|
| + "properties": {
|
| + "latitude": {
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "longitude": {
|
| + "format": "double",
|
| + "type": "number"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "lo": {
|
| + "properties": {
|
| + "latitude": {
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "longitude": {
|
| + "format": "double",
|
| + "type": "number"
|
| + }
|
| + },
|
| + "type": "object"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "zoom": {
|
| + "description": "The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "kind": {
|
| + "default": "books#geolayerdata",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Layersummaries": {
|
| + "id": "Layersummaries",
|
| + "properties": {
|
| + "items": {
|
| + "description": "A list of layer summary items.",
|
| + "items": {
|
| + "$ref": "Layersummary"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "kind": {
|
| + "default": "books#layersummaries",
|
| + "description": "Resource type.",
|
| + "type": "string"
|
| + },
|
| + "totalItems": {
|
| + "description": "The total number of layer summaries found.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Layersummary": {
|
| + "id": "Layersummary",
|
| + "properties": {
|
| + "annotationCount": {
|
| + "description": "The number of annotations for this layer.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "annotationTypes": {
|
| + "description": "The list of annotation types contained for this layer.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "annotationsDataLink": {
|
| + "description": "Link to get data for this annotation.",
|
| + "type": "string"
|
| + },
|
| + "annotationsLink": {
|
| + "description": "The link to get the annotations for this layer.",
|
| + "type": "string"
|
| + },
|
| + "contentVersion": {
|
| + "description": "The content version this resource is for.",
|
| + "type": "string"
|
| + },
|
| + "dataCount": {
|
| + "description": "The number of data items for this layer.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "id": {
|
| + "description": "Unique id of this layer summary.",
|
| + "type": "string"
|
| + },
|
| + "kind": {
|
| + "default": "books#layersummary",
|
| + "description": "Resource Type",
|
| + "type": "string"
|
| + },
|
| + "layerId": {
|
| + "description": "The layer id for this summary.",
|
| + "type": "string"
|
| + },
|
| + "selfLink": {
|
| + "description": "URL to this resource.",
|
| + "type": "string"
|
| + },
|
| + "updated": {
|
| + "description": "Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + },
|
| + "volumeAnnotationsVersion": {
|
| + "description": "The current version of this 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.",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The volume id this resource is for.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Offers": {
|
| + "id": "Offers",
|
| + "properties": {
|
| + "items": {
|
| + "description": "A list of offers.",
|
| + "items": {
|
| + "properties": {
|
| + "artUrl": {
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "type": "string"
|
| + },
|
| + "items": {
|
| + "items": {
|
| + "properties": {
|
| + "author": {
|
| + "type": "string"
|
| + },
|
| + "canonicalVolumeLink": {
|
| + "type": "string"
|
| + },
|
| + "coverUrl": {
|
| + "type": "string"
|
| + },
|
| + "description": {
|
| + "type": "string"
|
| + },
|
| + "title": {
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "kind": {
|
| + "default": "promooffer#offers",
|
| + "description": "Resource type.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ReadingPosition": {
|
| + "id": "ReadingPosition",
|
| + "properties": {
|
| + "epubCfiPosition": {
|
| + "description": "Position in an EPUB as a CFI.",
|
| + "type": "string"
|
| + },
|
| + "gbImagePosition": {
|
| + "description": "Position in a volume for image-based content.",
|
| + "type": "string"
|
| + },
|
| + "gbTextPosition": {
|
| + "description": "Position in a volume for text-based content.",
|
| + "type": "string"
|
| + },
|
| + "kind": {
|
| + "default": "books#readingPosition",
|
| + "description": "Resource type for a reading position.",
|
| + "type": "string"
|
| + },
|
| + "pdfPosition": {
|
| + "description": "Position in a PDF file.",
|
| + "type": "string"
|
| + },
|
| + "updated": {
|
| + "description": "Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "Volume id associated with this reading position.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "RequestAccess": {
|
| + "id": "RequestAccess",
|
| + "properties": {
|
| + "concurrentAccess": {
|
| + "$ref": "ConcurrentAccessRestriction",
|
| + "description": "A concurrent access response."
|
| + },
|
| + "downloadAccess": {
|
| + "$ref": "DownloadAccessRestriction",
|
| + "description": "A download access response."
|
| + },
|
| + "kind": {
|
| + "default": "books#requestAccess",
|
| + "description": "Resource type.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Review": {
|
| + "id": "Review",
|
| + "properties": {
|
| + "author": {
|
| + "description": "Author of this review.",
|
| + "properties": {
|
| + "displayName": {
|
| + "description": "Name of this person.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "content": {
|
| + "description": "Review text.",
|
| + "type": "string"
|
| + },
|
| + "date": {
|
| + "description": "Date of this review.",
|
| + "type": "string"
|
| + },
|
| + "fullTextUrl": {
|
| + "description": "URL for the full review text, for reviews gathered from the web.",
|
| + "type": "string"
|
| + },
|
| + "kind": {
|
| + "default": "books#review",
|
| + "description": "Resource type for a review.",
|
| + "type": "string"
|
| + },
|
| + "rating": {
|
| + "description": "Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.",
|
| + "type": "string"
|
| + },
|
| + "source": {
|
| + "description": "Information regarding the source of this review, when the review is not from a Google Books user.",
|
| + "properties": {
|
| + "description": {
|
| + "description": "Name of the source.",
|
| + "type": "string"
|
| + },
|
| + "extraDescription": {
|
| + "description": "Extra text about the source of the review.",
|
| + "type": "string"
|
| + },
|
| + "url": {
|
| + "description": "URL of the source of the review.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "title": {
|
| + "description": "Title for this review.",
|
| + "type": "string"
|
| + },
|
| + "type": {
|
| + "description": "Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "Volume that this review is for.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Volume": {
|
| + "id": "Volume",
|
| + "properties": {
|
| + "accessInfo": {
|
| + "description": "Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).",
|
| + "properties": {
|
| + "accessViewStatus": {
|
| + "description": "Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "country": {
|
| + "description": "The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "downloadAccess": {
|
| + "$ref": "DownloadAccessRestriction",
|
| + "description": "Information about a volume's download license access restrictions."
|
| + },
|
| + "driveImportedContentLink": {
|
| + "description": "URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.",
|
| + "type": "string"
|
| + },
|
| + "embeddable": {
|
| + "description": "Whether this volume can be embedded in a viewport using the Embedded Viewer API.",
|
| + "type": "boolean"
|
| + },
|
| + "epub": {
|
| + "description": "Information about epub content. (In LITE projection.)",
|
| + "properties": {
|
| + "acsTokenLink": {
|
| + "description": "URL to retrieve ACS token for epub download. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "downloadLink": {
|
| + "description": "URL to download epub. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "isAvailable": {
|
| + "description": "Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "explicitOfflineLicenseManagement": {
|
| + "description": "Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.",
|
| + "type": "boolean"
|
| + },
|
| + "pdf": {
|
| + "description": "Information about pdf content. (In LITE projection.)",
|
| + "properties": {
|
| + "acsTokenLink": {
|
| + "description": "URL to retrieve ACS token for pdf download. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "downloadLink": {
|
| + "description": "URL to download pdf. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "isAvailable": {
|
| + "description": "Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "publicDomain": {
|
| + "description": "Whether or not this book is public domain in the country listed above.",
|
| + "type": "boolean"
|
| + },
|
| + "quoteSharingAllowed": {
|
| + "description": "Whether quote sharing is allowed for this volume.",
|
| + "type": "boolean"
|
| + },
|
| + "textToSpeechPermission": {
|
| + "description": "Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.",
|
| + "type": "string"
|
| + },
|
| + "viewOrderUrl": {
|
| + "description": "For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.",
|
| + "type": "string"
|
| + },
|
| + "viewability": {
|
| + "description": "The read access of a volume. Possible 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 some 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 of ALL_PAGES.",
|
| + "type": "string"
|
| + },
|
| + "webReaderLink": {
|
| + "description": "URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "etag": {
|
| + "description": "Opaque identifier for a specific version of a volume resource. (In LITE projection)",
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "Unique identifier for a volume. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "kind": {
|
| + "default": "books#volume",
|
| + "description": "Resource type for a volume. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "layerInfo": {
|
| + "description": "What layers exist in this volume and high level information about them.",
|
| + "properties": {
|
| + "layers": {
|
| + "description": "A layer should appear here if and only if the layer exists for this book.",
|
| + "items": {
|
| + "properties": {
|
| + "layerId": {
|
| + "description": "The layer id of this layer (e.g. \"geo\").",
|
| + "type": "string"
|
| + },
|
| + "volumeAnnotationsVersion": {
|
| + "description": "The current version of this 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.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "recommendedInfo": {
|
| + "description": "Recommendation related information for this volume.",
|
| + "properties": {
|
| + "explanation": {
|
| + "description": "A text explaining why this volume is recommended.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "saleInfo": {
|
| + "description": "Any information about a volume related to the 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 countries).",
|
| + "properties": {
|
| + "buyLink": {
|
| + "description": "URL to purchase this volume on the Google Books site. (In LITE projection)",
|
| + "type": "string"
|
| + },
|
| + "country": {
|
| + "description": "The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "isEbook": {
|
| + "description": "Whether or not this volume is an eBook (can be added to the My eBooks shelf).",
|
| + "type": "boolean"
|
| + },
|
| + "listPrice": {
|
| + "description": "Suggested retail price. (In LITE projection.)",
|
| + "properties": {
|
| + "amount": {
|
| + "description": "Amount in the currency listed below. (In LITE projection.)",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "currencyCode": {
|
| + "description": "An ISO 4217, three-letter currency code. (In LITE projection.)",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "offers": {
|
| + "description": "Offers available for this volume (sales and rentals).",
|
| + "items": {
|
| + "properties": {
|
| + "finskyOfferType": {
|
| + "description": "The finsky offer type (e.g., PURCHASE=0 RENTAL=3)",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "listPrice": {
|
| + "description": "Offer list (=undiscounted) price in Micros.",
|
| + "properties": {
|
| + "amountInMicros": {
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "currencyCode": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "rentalDuration": {
|
| + "description": "The rental duration (for rental offers only).",
|
| + "properties": {
|
| + "count": {
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "unit": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "retailPrice": {
|
| + "description": "Offer retail (=discounted) price in Micros",
|
| + "properties": {
|
| + "amountInMicros": {
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "currencyCode": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "onSaleDate": {
|
| + "description": "The date on which this book is available for sale.",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + },
|
| + "retailPrice": {
|
| + "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.)",
|
| + "properties": {
|
| + "amount": {
|
| + "description": "Amount in the currency listed below. (In LITE projection.)",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "currencyCode": {
|
| + "description": "An ISO 4217, three-letter currency code. (In LITE projection.)",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "saleability": {
|
| + "description": "Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "searchInfo": {
|
| + "description": "Search result information related to this volume.",
|
| + "properties": {
|
| + "textSnippet": {
|
| + "description": "A text snippet containing the search query.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "selfLink": {
|
| + "description": "URL to this resource. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "userInfo": {
|
| + "description": "User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)",
|
| + "properties": {
|
| + "copy": {
|
| + "description": "Copy/Paste accounting information.",
|
| + "properties": {
|
| + "allowedCharacterCount": {
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "limitType": {
|
| + "type": "string"
|
| + },
|
| + "remainingCharacterCount": {
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "updated": {
|
| + "format": "date-time",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "isInMyBooks": {
|
| + "description": "Whether or not this volume is currently in \"my books.\"",
|
| + "type": "boolean"
|
| + },
|
| + "isPreordered": {
|
| + "description": "Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)",
|
| + "type": "boolean"
|
| + },
|
| + "isPurchased": {
|
| + "description": "Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)",
|
| + "type": "boolean"
|
| + },
|
| + "isUploaded": {
|
| + "description": "Whether or not this volume was user uploaded.",
|
| + "type": "boolean"
|
| + },
|
| + "readingPosition": {
|
| + "$ref": "ReadingPosition",
|
| + "description": "The user's current reading position in the volume, if one is available. (In LITE projection.)"
|
| + },
|
| + "rentalPeriod": {
|
| + "description": "Period during this book is/was a valid rental.",
|
| + "properties": {
|
| + "endUtcSec": {
|
| + "format": "int64",
|
| + "type": "string"
|
| + },
|
| + "startUtcSec": {
|
| + "format": "int64",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "rentalState": {
|
| + "description": "Whether this book is an active or an expired rental.",
|
| + "type": "string"
|
| + },
|
| + "review": {
|
| + "$ref": "Review",
|
| + "description": "This user's review of this volume, if one exists."
|
| + },
|
| + "updated": {
|
| + "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).",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + },
|
| + "userUploadedVolumeInfo": {
|
| + "properties": {
|
| + "processingState": {
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "volumeInfo": {
|
| + "description": "General volume information.",
|
| + "properties": {
|
| + "authors": {
|
| + "description": "The names of the authors and/or editors for this volume. (In LITE projection)",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "averageRating": {
|
| + "description": "The mean review rating for this volume. (min = 1.0, max = 5.0)",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "canonicalVolumeLink": {
|
| + "description": "Canonical URL for a volume. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "categories": {
|
| + "description": "A list of subject categories, such as \"Fiction\", \"Suspense\", etc.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "contentVersion": {
|
| + "description": "An identifier for the version of the volume content (text & images). (In LITE projection)",
|
| + "type": "string"
|
| + },
|
| + "description": {
|
| + "description": "A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "dimensions": {
|
| + "description": "Physical dimensions of this volume.",
|
| + "properties": {
|
| + "height": {
|
| + "description": "Height or length of this volume (in cm).",
|
| + "type": "string"
|
| + },
|
| + "thickness": {
|
| + "description": "Thickness of this volume (in cm).",
|
| + "type": "string"
|
| + },
|
| + "width": {
|
| + "description": "Width of this volume (in cm).",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "imageLinks": {
|
| + "description": "A list of image links for all the sizes that are available. (In LITE projection.)",
|
| + "properties": {
|
| + "extraLarge": {
|
| + "description": "Image link for extra large size (width of ~1280 pixels). (In LITE projection)",
|
| + "type": "string"
|
| + },
|
| + "large": {
|
| + "description": "Image link for large size (width of ~800 pixels). (In LITE projection)",
|
| + "type": "string"
|
| + },
|
| + "medium": {
|
| + "description": "Image link for medium size (width of ~575 pixels). (In LITE projection)",
|
| + "type": "string"
|
| + },
|
| + "small": {
|
| + "description": "Image link for small size (width of ~300 pixels). (In LITE projection)",
|
| + "type": "string"
|
| + },
|
| + "smallThumbnail": {
|
| + "description": "Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)",
|
| + "type": "string"
|
| + },
|
| + "thumbnail": {
|
| + "description": "Image link for thumbnail size (width of ~128 pixels). (In LITE projection)",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "industryIdentifiers": {
|
| + "description": "Industry standard identifiers for this volume.",
|
| + "items": {
|
| + "properties": {
|
| + "identifier": {
|
| + "description": "Industry specific volume identifier.",
|
| + "type": "string"
|
| + },
|
| + "type": {
|
| + "description": "Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "infoLink": {
|
| + "description": "URL to view information about this volume on the Google Books site. (In LITE projection)",
|
| + "type": "string"
|
| + },
|
| + "language": {
|
| + "description": "Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.",
|
| + "type": "string"
|
| + },
|
| + "mainCategory": {
|
| + "description": "The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.",
|
| + "type": "string"
|
| + },
|
| + "pageCount": {
|
| + "description": "Total number of pages as per publisher metadata.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "previewLink": {
|
| + "description": "URL to preview this volume on the Google Books site.",
|
| + "type": "string"
|
| + },
|
| + "printType": {
|
| + "description": "Type of publication of this volume. Possible values are BOOK or MAGAZINE.",
|
| + "type": "string"
|
| + },
|
| + "printedPageCount": {
|
| + "description": "Total number of printed pages in generated pdf representation.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "publishedDate": {
|
| + "description": "Date of publication. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "publisher": {
|
| + "description": "Publisher of this volume. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "ratingsCount": {
|
| + "description": "The number of review ratings for this volume.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "readingModes": {
|
| + "description": "The reading modes available for this volume.",
|
| + "type": "any"
|
| + },
|
| + "subtitle": {
|
| + "description": "Volume subtitle. (In LITE projection.)",
|
| + "type": "string"
|
| + },
|
| + "title": {
|
| + "description": "Volume title. (In LITE projection.)",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Volumeannotation": {
|
| + "id": "Volumeannotation",
|
| + "properties": {
|
| + "annotationDataId": {
|
| + "description": "The annotation data id for this volume annotation.",
|
| + "type": "string"
|
| + },
|
| + "annotationDataLink": {
|
| + "description": "Link to get data for this annotation.",
|
| + "type": "string"
|
| + },
|
| + "annotationType": {
|
| + "description": "The type of annotation this is.",
|
| + "type": "string"
|
| + },
|
| + "contentRanges": {
|
| + "description": "The content ranges to identify the selected text.",
|
| + "properties": {
|
| + "cfiRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in CFI format for this annotation for version above."
|
| + },
|
| + "contentVersion": {
|
| + "description": "Content version applicable to ranges below.",
|
| + "type": "string"
|
| + },
|
| + "gbImageRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in GB image format for this annotation for version above."
|
| + },
|
| + "gbTextRange": {
|
| + "$ref": "BooksAnnotationsRange",
|
| + "description": "Range in GB text format for this annotation for version above."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "data": {
|
| + "description": "Data for this annotation.",
|
| + "type": "string"
|
| + },
|
| + "deleted": {
|
| + "description": "Indicates that this annotation is deleted.",
|
| + "type": "boolean"
|
| + },
|
| + "id": {
|
| + "description": "Unique id of this volume annotation.",
|
| + "type": "string"
|
| + },
|
| + "kind": {
|
| + "default": "books#volumeannotation",
|
| + "description": "Resource Type",
|
| + "type": "string"
|
| + },
|
| + "layerId": {
|
| + "description": "The Layer this annotation is for.",
|
| + "type": "string"
|
| + },
|
| + "pageIds": {
|
| + "description": "Pages the annotation spans.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "selectedText": {
|
| + "description": "Excerpt from the volume.",
|
| + "type": "string"
|
| + },
|
| + "selfLink": {
|
| + "description": "URL to this resource.",
|
| + "type": "string"
|
| + },
|
| + "updated": {
|
| + "description": "Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).",
|
| + "format": "date-time",
|
| + "type": "string"
|
| + },
|
| + "volumeId": {
|
| + "description": "The Volume this annotation is for.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Volumeannotations": {
|
| + "id": "Volumeannotations",
|
| + "properties": {
|
| + "items": {
|
| + "description": "A list of volume annotations.",
|
| + "items": {
|
| + "$ref": "Volumeannotation"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "kind": {
|
| + "default": "books#volumeannotations",
|
| + "description": "Resource type",
|
| + "type": "string"
|
| + },
|
| + "nextPageToken": {
|
| + "description": "Token to pass in for pagination for the next page. This will not be present if this request does not have more results.",
|
| + "type": "string"
|
| + },
|
| + "totalItems": {
|
| + "description": "The total number of volume annotations found.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "version": {
|
| + "description": "The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book).",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Volumes": {
|
| + "id": "Volumes",
|
| + "properties": {
|
| + "items": {
|
| + "description": "A list of volumes.",
|
| + "items": {
|
| + "$ref": "Volume"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "kind": {
|
| + "default": "books#volumes",
|
| + "description": "Resource type.",
|
| + "type": "string"
|
| + },
|
| + "totalItems": {
|
| + "description": "Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + }
|
| + },
|
| + "type": "object"
|
| + }
|
| + },
|
| + "servicePath": "books/v1/",
|
| + "title": "Books API",
|
| + "version": "v1"
|
| +}
|
|
|