googleapis.books
Module googleapis.books
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_googleapis.books_1.4.0.png)
ballerinax/googleapis.books Ballerina library
Overview
This is a generated connector for Google Books API v1 OpenAPI specification. The Google Books API allows clients to access the Google Books repository.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Google account
- Obtain tokens - Follow this link
Quickstart
To use the Google Books connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
Import the ballerinax/googleapis.books module into the Ballerina project.
import ballerinax/googleapis.books as books;
Step 2: Create a new connector instance
You can now enter the credentials in the Google Books client configuration and create Google Books client by passing the configuration:
books:ClientConfig clientConfig = { auth: { clientId: <CLIENT_ID>, clientSecret: <CLIENT_SECRET>, refreshUrl: <REFRESH_URL>, refreshToken: <REFRESH_TOKEN> } }; books:Client baseClient = check new Client(clientConfig);
Step 3: Invoke connector operation
-
You can perform a book search as follows with
listVolumes
method by passing a search query string as a parameter.books:Volumes booksVolumesSearch = check baseClient->listVolumes("SriLanka");
-
Use
bal run
command to compile and run the Ballerina program.
Clients![](/images/permalink.svg)
googleapis.books: Client![](/images/permalink.svg)
This is a generated connector for Google Books API v1 OpenAPI specification. The Google Books API allows clients to access the Google Books repository.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a Google account and obtain tokens by following this guide.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://books.googleapis.com/" - URL of the target service
addbookCloudloading![](/images/permalink.svg)
function addbookCloudloading(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? driveDocumentId, string? mimeType, string? name, string? uploadClientToken) returns BooksCloudloadingResource|error
Add a user-upload volume and triggers processing.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- driveDocumentId string? (default ()) - A drive document id. The upload_client_token must not be set.
- mimeType string? (default ()) - The document MIME type. It can be set only if the drive_document_id is set.
- name string? (default ()) - The document name. It can be set only if the drive_document_id is set.
- uploadClientToken string? (default ()) - Scotty upload token.
Return Type
- BooksCloudloadingResource|error - Successful response
deletebookCloudloading![](/images/permalink.svg)
function deletebookCloudloading(string volumeId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error
Remove the book and its contents.
Parameters
- volumeId string - The id of the book to be removed.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
updatebookCloudloading![](/images/permalink.svg)
function updatebookCloudloading(BooksCloudloadingResource payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns BooksCloudloadingResource|error
Updates a user-upload volume.
Parameters
- payload BooksCloudloadingResource - Books cloudloading resource request
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- BooksCloudloadingResource|error - Successful response
listofflinemetadataDictionary![](/images/permalink.svg)
function listofflinemetadataDictionary(string cpksver, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Metadata|error
Returns a list of offline dictionary metadata available.
Parameters
- cpksver string - The device/version ID from which to request the data.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
getfamilyinfoFamilysharing![](/images/permalink.svg)
function getfamilyinfoFamilysharing(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? 'source) returns FamilyInfo|error
Gets information regarding the family that the user is part of.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- FamilyInfo|error - Successful response
shareFamilysharing![](/images/permalink.svg)
function shareFamilysharing(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? docId, string? 'source, string? volumeId) returns Response|error
Initiates sharing of the content with the user's family. Empty response indicates success.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- docId string? (default ()) - The docid to share.
- 'source string? (default ()) - String to identify the originator of this request.
- volumeId string? (default ()) - The volume to share.
unshareFamilysharing![](/images/permalink.svg)
function unshareFamilysharing(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? docId, string? 'source, string? volumeId) returns Response|error
Initiates revoking content that has already been shared with the user's family. Empty response indicates success.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- docId string? (default ()) - The docid to unshare.
- 'source string? (default ()) - String to identify the originator of this request.
- volumeId string? (default ()) - The volume to unshare.
getusersettingsMyconfig![](/images/permalink.svg)
function getusersettingsMyconfig(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? country) returns Usersettings|error
Gets the current settings for the user.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- country string? (default ()) - Unused. Added only to workaround TEX mandatory request template requirement
Return Type
- Usersettings|error - Successful response
releasedownloadaccessMyconfig![](/images/permalink.svg)
function releasedownloadaccessMyconfig(string cpksver, string[] volumeIds, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? locale, string? 'source) returns DownloadAccesses|error
Release downloaded content access restriction.
Parameters
- cpksver string - The device/version ID from which to release the restriction.
- volumeIds string[] - The volume(s) to release restrictions for.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- locale string? (default ()) - ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- DownloadAccesses|error - Successful response
requestaccessMyconfig![](/images/permalink.svg)
function requestaccessMyconfig(string cpksver, string nonce, string 'source, string volumeId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? licenseTypes, string? locale) returns RequestAccessData|error
Request concurrent and download access restrictions.
Parameters
- cpksver string - The device/version ID from which to request the restrictions.
- nonce string - The client nonce value.
- 'source string - String to identify the originator of this request.
- volumeId string - The volume to request concurrent/download restrictions for.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- licenseTypes string? (default ()) - The type of access license to request. If not specified, the default is BOTH.
- locale string? (default ()) - ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
Return Type
- RequestAccessData|error - Successful response
syncvolumelicensesMyconfig![](/images/permalink.svg)
function syncvolumelicensesMyconfig(string cpksver, string nonce, string 'source, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? features, boolean? includeNonComicsSeries, string? locale, boolean? showPreorders, string[]? volumeIds) returns Volumes|error
Request downloaded content access for specified volumes on the My eBooks shelf.
Parameters
- cpksver string - The device/version ID from which to release the restriction.
- nonce string - The client nonce value.
- 'source string - String to identify the originator of this request.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- features string[]? (default ()) - List of features supported by the client, i.e., 'RENTALS'
- includeNonComicsSeries boolean? (default ()) - Set to true to include non-comics series. Defaults to false.
- locale string? (default ()) - ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
- showPreorders boolean? (default ()) - Set to true to show pre-ordered books. Defaults to false.
- volumeIds string[]? (default ()) - The volume(s) to request download restrictions for.
updateusersettingsMyconfig![](/images/permalink.svg)
function updateusersettingsMyconfig(Usersettings payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Usersettings|error
Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.
Parameters
- payload Usersettings - A record of type
Usersettings
which contains the necessary data to set settings for user.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- Usersettings|error - Successful response
listMylibraryAnnotations![](/images/permalink.svg)
function listMylibraryAnnotations(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? contentVersion, string? layerId, string[]? layerIds, int? maxResults, string? pageToken, boolean? showDeleted, string? 'source, string? updatedMax, string? updatedMin, string? volumeId) returns Annotations|error
Retrieves a list of annotations, possibly filtered.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- contentVersion string? (default ()) - The content version for the requested volume.
- layerId string? (default ()) - The layer ID to limit annotation by.
- layerIds string[]? (default ()) - The layer ID(s) to limit annotation by.
- maxResults int? (default ()) - Maximum number of results to return
- pageToken string? (default ()) - The value of the nextToken from the previous page.
- showDeleted boolean? (default ()) - Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
- 'source string? (default ()) - String to identify the originator of this request.
- updatedMax string? (default ()) - RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
- updatedMin string? (default ()) - RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
- volumeId string? (default ()) - The volume to restrict annotations to.
Return Type
- Annotations|error - Successful response
insertMylibraryAnnotations![](/images/permalink.svg)
function insertMylibraryAnnotations(Annotation payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? annotationId, string? country, boolean? showOnlySummaryInResponse, string? 'source) returns Annotation|error
Inserts a new annotation.
Parameters
- payload Annotation - Annotation request
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- annotationId string? (default ()) - The ID for the annotation to insert.
- country string? (default ()) - ISO-3166-1 code to override the IP-based location.
- showOnlySummaryInResponse boolean? (default ()) - Requests that only the summary of the specified layer be provided in the response.
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- Annotation|error - Successful response
summaryMylibraryAnnotations![](/images/permalink.svg)
function summaryMylibraryAnnotations(string[] layerIds, string volumeId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns AnnotationsSummary|error
Gets the summary of specified layers.
Parameters
- layerIds string[] - Array of layer IDs to get the summary for.
- volumeId string - Volume id to get the summary for.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- AnnotationsSummary|error - Successful response
updateMylibraryAnnotations![](/images/permalink.svg)
function updateMylibraryAnnotations(string annotationId, Annotation payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? 'source) returns Annotation|error
Updates an existing annotation.
Parameters
- annotationId string - The ID for the annotation to update.
- payload Annotation - Annotation request
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- Annotation|error - Successful response
deleteMylibraryAnnotations![](/images/permalink.svg)
function deleteMylibraryAnnotations(string annotationId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? 'source) returns Response|error
Deletes an annotation.
Parameters
- annotationId string - The ID for the annotation to delete.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- 'source string? (default ()) - String to identify the originator of this request.
listMylibraryBookshelves![](/images/permalink.svg)
function listMylibraryBookshelves(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? 'source) returns Bookshelves|error
Retrieves a list of bookshelves belonging to the authenticated user.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- Bookshelves|error - Successful response
getMylibraryBookshelves![](/images/permalink.svg)
function getMylibraryBookshelves(string shelf, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? 'source) returns Bookshelf|error
Retrieves metadata for a specific bookshelf belonging to the authenticated user.
Parameters
- shelf string - ID of bookshelf to retrieve.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- 'source string? (default ()) - String to identify the originator of this request.
addvolumeMylibraryBookshelves![](/images/permalink.svg)
function addvolumeMylibraryBookshelves(string shelf, string volumeId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? reason, string? 'source) returns Response|error
Adds a volume to a bookshelf.
Parameters
- shelf string - ID of bookshelf to which to add a volume.
- volumeId string - ID of volume to add.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- reason string? (default ()) - The reason for which the book is added to the library.
- 'source string? (default ()) - String to identify the originator of this request.
clearvolumesMylibraryBookshelves![](/images/permalink.svg)
function clearvolumesMylibraryBookshelves(string shelf, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? 'source) returns Response|error
Clears all volumes from a bookshelf.
Parameters
- shelf string - ID of bookshelf from which to remove a volume.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- 'source string? (default ()) - String to identify the originator of this request.
movevolumeMylibraryBookshelves![](/images/permalink.svg)
function movevolumeMylibraryBookshelves(string shelf, string volumeId, int volumePosition, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? 'source) returns Response|error
Moves a volume within a bookshelf.
Parameters
- shelf string - ID of bookshelf with the volume.
- volumeId string - ID of volume to move.
- volumePosition int - 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.)
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- 'source string? (default ()) - String to identify the originator of this request.
removevolumeMylibraryBookshelves![](/images/permalink.svg)
function removevolumeMylibraryBookshelves(string shelf, string volumeId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? reason, string? 'source) returns Response|error
Removes a volume from a bookshelf.
Parameters
- shelf string - ID of bookshelf from which to remove a volume.
- volumeId string - ID of volume to remove.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- reason string? (default ()) - The reason for which the book is removed from the library.
- 'source string? (default ()) - String to identify the originator of this request.
listMylibraryBookshelvesVolumes![](/images/permalink.svg)
function listMylibraryBookshelvesVolumes(string shelf, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? country, int? maxResults, string? projection, string? q, boolean? showPreorders, string? 'source, int? startIndex) returns Volumes|error
Gets volume information for volumes on a bookshelf.
Parameters
- shelf string - The bookshelf ID or name retrieve volumes for.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- country string? (default ()) - ISO-3166-1 code to override the IP-based location.
- maxResults int? (default ()) - Maximum number of results to return
- projection string? (default ()) - Restrict information returned to a set of selected fields.
- q string? (default ()) - Full-text search query string in this bookshelf.
- showPreorders boolean? (default ()) - Set to true to show pre-ordered books. Defaults to false.
- 'source string? (default ()) - String to identify the originator of this request.
- startIndex int? (default ()) - Index of the first element to return (starts at 0)
getMylibraryReadingpositions![](/images/permalink.svg)
function getMylibraryReadingpositions(string volumeId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? contentVersion, string? 'source) returns ReadingPosition|error
Retrieves my reading position information for a volume.
Parameters
- volumeId string - ID of volume for which to retrieve a reading position.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- contentVersion string? (default ()) - Volume content version for which this reading position is requested.
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- ReadingPosition|error - Successful response
setpositionMylibraryReadingpositions![](/images/permalink.svg)
function setpositionMylibraryReadingpositions(string volumeId, string position, string timestamp, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? action, string? contentVersion, string? deviceCookie, string? 'source) returns Response|error
Sets my reading position information for a volume.
Parameters
- volumeId string - ID of volume for which to update the reading position.
- position string - Position string for the new volume reading position.
- timestamp string - RFC 3339 UTC format timestamp associated with this reading position.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- action string? (default ()) - Action that caused this reading position to be set.
- contentVersion string? (default ()) - Volume content version for which this reading position applies.
- deviceCookie string? (default ()) - Random persistent device cookie optional on set position.
- 'source string? (default ()) - String to identify the originator of this request.
getNotification![](/images/permalink.svg)
function getNotification(string notificationId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? locale, string? 'source) returns Notification|error
Returns notification details for a given notification id.
Parameters
- notificationId string - String to identify the notification.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- locale string? (default ()) - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- Notification|error - Successful response
listcategoriesOnboarding![](/images/permalink.svg)
function listcategoriesOnboarding(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? locale) returns Category|error
List categories for onboarding experience.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- locale string? (default ()) - ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
listcategoryvolumesOnboarding![](/images/permalink.svg)
function listcategoryvolumesOnboarding(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? categoryId, string? locale, string? maxAllowedMaturityRating, int? pageSize, string? pageToken) returns Volume2|error
List available volumes under categories for onboarding experience.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- categoryId string[]? (default ()) - List of category ids requested.
- locale string? (default ()) - ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
- maxAllowedMaturityRating string? (default ()) - The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.
- pageSize int? (default ()) - Number of maximum results per page to be included in the response.
- pageToken string? (default ()) - The value of the nextToken from the previous page.
getPersonalizedstream![](/images/permalink.svg)
function getPersonalizedstream(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? locale, string? maxAllowedMaturityRating, string? 'source) returns Discoveryclusters|error
Returns a stream of personalized book clusters.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- locale string? (default ()) - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- maxAllowedMaturityRating string? (default ()) - The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- Discoveryclusters|error - Successful response
acceptPromooffer![](/images/permalink.svg)
function acceptPromooffer(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? androidId, string? device, string? manufacturer, string? model, string? offerId, string? product, string? serial, string? volumeId) returns Response|error
Accepts the promo offer.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- androidId string? (default ()) - device android_id
- device string? (default ()) - device
- manufacturer string? (default ()) - device manufacturer
- model string? (default ()) - device model
- offerId string? (default ()) - offer id
- product string? (default ()) - device product
- serial string? (default ()) - device serial
- volumeId string? (default ()) - Volume id to exercise the offer
dismissPromooffer![](/images/permalink.svg)
function dismissPromooffer(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? androidId, string? device, string? manufacturer, string? model, string? offerId, string? product, string? serial) returns Response|error
Marks the promo offer as dismissed.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- androidId string? (default ()) - device android_id
- device string? (default ()) - device device
- manufacturer string? (default ()) - device manufacturer
- model string? (default ()) - device model
- offerId string? (default ()) - Offer to dimiss
- product string? (default ()) - device product
- serial string? (default ()) - device serial
getPromooffer![](/images/permalink.svg)
function getPromooffer(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? androidId, string? device, string? manufacturer, string? model, string? product, string? serial) returns Offers|error
Returns a list of promo offers available to the user.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- androidId string? (default ()) - device android_id
- device string? (default ()) - device device
- manufacturer string? (default ()) - device manufacturer
- model string? (default ()) - device model
- product string? (default ()) - device product
- serial string? (default ()) - device serial
getSeries![](/images/permalink.svg)
function getSeries(string[] seriesId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Series|error
Returns Series metadata for the given series ids.
Parameters
- seriesId string[] - String that identifies the series
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
getSeriesMembership![](/images/permalink.svg)
function getSeriesMembership(string seriesId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns Seriesmembership|error
Returns Series membership data given the series id.
Parameters
- seriesId string - String that identifies the series
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize int? (default ()) - Number of maximum results per page to be included in the response.
- pageToken string? (default ()) - The value of the nextToken from the previous page.
Return Type
- Seriesmembership|error - Successful response
listBookshelves![](/images/permalink.svg)
function listBookshelves(string userId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? 'source) returns Bookshelves|error
Retrieves a list of public bookshelves for the specified user.
Parameters
- userId string - ID of user for whom to retrieve bookshelves.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- Bookshelves|error - Successful response
getBookshelves![](/images/permalink.svg)
function getBookshelves(string userId, string shelf, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? 'source) returns Bookshelf|error
Retrieves metadata for a specific bookshelf for the specified user.
Parameters
- userId string - ID of user for whom to retrieve bookshelves.
- shelf string - ID of bookshelf to retrieve.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- 'source string? (default ()) - String to identify the originator of this request.
listBookshelvesVolumes![](/images/permalink.svg)
function listBookshelvesVolumes(string userId, string shelf, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? maxResults, boolean? showPreorders, string? 'source, int? startIndex) returns Volumes|error
Retrieves volumes in a specific bookshelf for the specified user.
Parameters
- userId string - ID of user for whom to retrieve bookshelf volumes.
- shelf string - ID of bookshelf to retrieve volumes.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- maxResults int? (default ()) - Maximum number of results to return
- showPreorders boolean? (default ()) - Set to true to show pre-ordered books. Defaults to false.
- 'source string? (default ()) - String to identify the originator of this request.
- startIndex int? (default ()) - Index of the first element to return (starts at 0)
listVolumes![](/images/permalink.svg)
function listVolumes(string q, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? download, string? filter, string? langRestrict, string? libraryRestrict, string? maxAllowedMaturityRating, int? maxResults, string? orderBy, string? partner, string? printType, string? projection, boolean? showPreorders, string? 'source, int? startIndex) returns Volumes|error
Performs a book search.
Parameters
- q string - Full-text search query string.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- download string? (default ()) - Restrict to volumes by download availability.
- filter string? (default ()) - Filter search results.
- langRestrict string? (default ()) - Restrict results to books with this language code.
- libraryRestrict string? (default ()) - Restrict search to this user's library.
- maxAllowedMaturityRating string? (default ()) - The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
- maxResults int? (default ()) - Maximum number of results to return.
- orderBy string? (default ()) - Sort search results.
- partner string? (default ()) - Restrict and brand results for partner ID.
- printType string? (default ()) - Restrict to books or magazines.
- projection string? (default ()) - Restrict information returned to a set of selected fields.
- showPreorders boolean? (default ()) - Set to true to show books available for preorder. Defaults to false.
- 'source string? (default ()) - String to identify the originator of this request.
- startIndex int? (default ()) - Index of the first result to return (starts at 0)
listVolumesMybooks![](/images/permalink.svg)
function listVolumesMybooks(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? acquireMethod, string? country, string? locale, int? maxResults, string[]? processingState, string? 'source, int? startIndex) returns Volumes|error
Return a list of books in My Library.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- acquireMethod string[]? (default ()) - How the book was acquired
- country string? (default ()) - ISO-3166-1 code to override the IP-based location.
- locale string? (default ()) - ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.
- maxResults int? (default ()) - Maximum number of results to return.
- processingState string[]? (default ()) - The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.
- 'source string? (default ()) - String to identify the originator of this request.
- startIndex int? (default ()) - Index of the first result to return (starts at 0)
listVolumesRecommended![](/images/permalink.svg)
function listVolumesRecommended(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? locale, string? maxAllowedMaturityRating, string? 'source) returns Volumes|error
Return a list of recommended books for the current user.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- locale string? (default ()) - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- maxAllowedMaturityRating string? (default ()) - The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
- 'source string? (default ()) - String to identify the originator of this request.
rateVolumesRecommended![](/images/permalink.svg)
function rateVolumesRecommended(string rating, string volumeId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? locale, string? 'source) returns BooksVolumesRecommendedRateResponse|error
Rate a recommended book for the current user.
Parameters
- rating string - Rating to be given to the volume.
- volumeId string - ID of the source volume.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- locale string? (default ()) - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- BooksVolumesRecommendedRateResponse|error - Successful response
listVolumesUseruploaded![](/images/permalink.svg)
function listVolumesUseruploaded(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? locale, int? maxResults, string[]? processingState, string? 'source, int? startIndex, string[]? volumeId) returns Volumes|error
Return a list of books uploaded by the current user.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- locale string? (default ()) - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- maxResults int? (default ()) - Maximum number of results to return.
- processingState string[]? (default ()) - The processing state of the user uploaded volumes to be returned.
- 'source string? (default ()) - String to identify the originator of this request.
- startIndex int? (default ()) - Index of the first result to return (starts at 0)
- volumeId string[]? (default ()) - The ids of the volumes to be returned. If not specified all that match the processingState are returned.
getVolumes![](/images/permalink.svg)
function getVolumes(string volumeId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? country, boolean? includeNonComicsSeries, string? partner, string? projection, string? 'source, boolean? userLibraryConsistentRead) returns Volume|error
Gets volume information for a single volume.
Parameters
- volumeId string - ID of volume to retrieve.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- country string? (default ()) - ISO-3166-1 code to override the IP-based location.
- includeNonComicsSeries boolean? (default ()) - Set to true to include non-comics series. Defaults to false.
- partner string? (default ()) - Brand results for partner ID.
- projection string? (default ()) - Restrict information returned to a set of selected fields.
- 'source string? (default ()) - string to identify the originator of this request.
- userLibraryConsistentRead boolean? (default ()) - user library consistent read status
listVolumesAssociated![](/images/permalink.svg)
function listVolumesAssociated(string volumeId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? association, string? locale, string? maxAllowedMaturityRating, string? 'source) returns Volumes|error
Return a list of associated books.
Parameters
- volumeId string - ID of the source volume.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- association string? (default ()) - Association type.
- locale string? (default ()) - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- maxAllowedMaturityRating string? (default ()) - The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
- 'source string? (default ()) - String to identify the originator of this request.
listLayersVolumeannotations![](/images/permalink.svg)
function listLayersVolumeannotations(string volumeId, string layerId, string contentVersion, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? endOffset, string? endPosition, string? locale, int? maxResults, string? pageToken, boolean? showDeleted, string? 'source, string? startOffset, string? startPosition, string? updatedMax, string? updatedMin, string? volumeAnnotationsVersion) returns Volumeannotations|error
Gets the volume annotations for a volume and layer.
Parameters
- volumeId string - The volume to retrieve annotations for.
- layerId string - The ID for the layer to get the annotations.
- contentVersion string - The content version for the requested volume.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- endOffset string? (default ()) - The end offset to end retrieving data from.
- endPosition string? (default ()) - The end position to end retrieving data from.
- locale string? (default ()) - The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
- maxResults int? (default ()) - Maximum number of results to return
- pageToken string? (default ()) - The value of the nextToken from the previous page.
- showDeleted boolean? (default ()) - Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
- 'source string? (default ()) - String to identify the originator of this request.
- startOffset string? (default ()) - The start offset to start retrieving data from.
- startPosition string? (default ()) - The start position to start retrieving data from.
- updatedMax string? (default ()) - RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
- updatedMin string? (default ()) - RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
- volumeAnnotationsVersion string? (default ()) - The version of the volume annotations that you are requesting.
Return Type
- Volumeannotations|error - Successful response
getLayersVolumeannotations![](/images/permalink.svg)
function getLayersVolumeannotations(string volumeId, string layerId, string annotationId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? locale, string? 'source) returns Volumeannotation|error
Gets the volume annotation.
Parameters
- volumeId string - The volume to retrieve annotations for.
- layerId string - The ID for the layer to get the annotations.
- annotationId string - The ID of the volume annotation to retrieve.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- locale string? (default ()) - The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- Volumeannotation|error - Successful response
listLayersAnnotationdata![](/images/permalink.svg)
function listLayersAnnotationdata(string volumeId, string layerId, string contentVersion, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? annotationDataId, int? h, string? locale, int? maxResults, string? pageToken, int? scale, string? 'source, string? updatedMax, string? updatedMin, int? w) returns Annotationsdata|error
Gets the annotation data for a volume and layer.
Parameters
- volumeId string - The volume to retrieve annotation data for.
- layerId string - The ID for the layer to get the annotation data.
- contentVersion string - The content version for the requested volume.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- annotationDataId string[]? (default ()) - The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.
- h int? (default ()) - The requested pixel height for any images. If height is provided width must also be provided.
- locale string? (default ()) - The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
- maxResults int? (default ()) - Maximum number of results to return
- pageToken string? (default ()) - The value of the nextToken from the previous page.
- scale int? (default ()) - The requested scale for the image.
- 'source string? (default ()) - String to identify the originator of this request.
- updatedMax string? (default ()) - RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
- updatedMin string? (default ()) - RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
- w int? (default ()) - The requested pixel width for any images. If width is provided height must also be provided.
Return Type
- Annotationsdata|error - Successful response
getLayersAnnotationdata![](/images/permalink.svg)
function getLayersAnnotationdata(string volumeId, string layerId, string annotationDataId, string contentVersion, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, boolean? allowWebDefinitions, int? h, string? locale, int? scale, string? 'source, int? w) returns DictionaryAnnotationdata|error
Gets the annotation data.
Parameters
- volumeId string - The volume to retrieve annotations for.
- layerId string - The ID for the layer to get the annotations.
- annotationDataId string - The ID of the annotation data to retrieve.
- contentVersion string - The content version for the volume you are trying to retrieve.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- allowWebDefinitions boolean? (default ()) - For the dictionary layer. Whether or not to allow web definitions.
- h int? (default ()) - The requested pixel height for any images. If height is provided width must also be provided.
- locale string? (default ()) - The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
- scale int? (default ()) - The requested scale for the image.
- 'source string? (default ()) - String to identify the originator of this request.
- w int? (default ()) - The requested pixel width for any images. If width is provided height must also be provided.
Return Type
- DictionaryAnnotationdata|error - Successful response
listLayers![](/images/permalink.svg)
function listLayers(string volumeId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? contentVersion, int? maxResults, string? pageToken, string? 'source) returns Layersummaries|error
List the layer summaries for a volume.
Parameters
- volumeId string - The volume to retrieve layers for.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- contentVersion string? (default ()) - The content version for the requested volume.
- maxResults int? (default ()) - Maximum number of results to return
- pageToken string? (default ()) - The value of the nextToken from the previous page.
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- Layersummaries|error - Successful response
getLayers![](/images/permalink.svg)
function getLayers(string volumeId, string summaryId, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? contentVersion, string? 'source) returns Layersummary|error
Gets the layer summary for a volume.
Parameters
- volumeId string - The volume to retrieve layers for.
- summaryId string - The ID for the layer to get the summary for.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - 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.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- contentVersion string? (default ()) - The content version for the requested volume.
- 'source string? (default ()) - String to identify the originator of this request.
Return Type
- Layersummary|error - Successful response
Records![](/images/permalink.svg)
googleapis.books: Annotation![](/images/permalink.svg)
Fields
- afterSelectedText string? - 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.
- beforeSelectedText string? - 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.
- clientVersionRanges AnnotationClientversionranges? - Selection ranges sent from the client.
- created string? - Timestamp for the created time of this annotation.
- currentVersionRanges AnnotationCurrentversionranges? - Selection ranges for the most recent content version.
- data string? - User-created data for this annotation.
- deleted boolean? - Indicates that this annotation is deleted.
- highlightStyle string? - The highlight style for this annotation.
- id string? - Id of this annotation, in the form of a GUID.
- kind string? - Resource type.
- layerId string? - The layer this annotation is for.
- layerSummary AnnotationLayersummary? -
- pageIds string[]? - Pages that this annotation spans.
- selectedText string? - Excerpt from the volume.
- selfLink string? - URL to this resource.
- updated string? - Timestamp for the last time this annotation was modified.
- volumeId string? - The volume that this annotation belongs to.
googleapis.books: AnnotationClientversionranges![](/images/permalink.svg)
Selection ranges sent from the client.
Fields
- cfiRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
- contentVersion string? - Content version the client sent in.
- gbImageRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
- gbTextRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
- imageCfiRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
googleapis.books: AnnotationCurrentversionranges![](/images/permalink.svg)
Selection ranges for the most recent content version.
Fields
- cfiRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
- contentVersion string? - Content version applicable to ranges below.
- gbImageRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
- gbTextRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
- imageCfiRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
googleapis.books: AnnotationLayersummary![](/images/permalink.svg)
Fields
- allowedCharacterCount int? - Maximum allowed characters on this layer, especially for the "copy" layer.
- limitType string? - Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
- remainingCharacterCount int? - Remaining allowed characters on this layer, especially for the "copy" layer.
googleapis.books: Annotations![](/images/permalink.svg)
Fields
- items Annotation[]? - A list of annotations.
- kind string? - Resource type.
- nextPageToken string? - Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
- totalItems int? - Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.
googleapis.books: Annotationsdata![](/images/permalink.svg)
Fields
- items GeoAnnotationdata[]? - A list of Annotation Data.
- kind string? - Resource type
- nextPageToken string? - Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
- totalItems int? - The total number of volume annotations found.
googleapis.books: AnnotationsSummary![](/images/permalink.svg)
Fields
- kind string? -
- layers AnnotationssummaryLayers[]? -
googleapis.books: AnnotationssummaryLayers![](/images/permalink.svg)
Fields
- allowedCharacterCount int? - Allowed character count.
- layerId string? - Layer id.
- limitType string? - Type of limitation on this layer.
- remainingCharacterCount int? - Remaining character count.
- updated string? - Updated annotation.
googleapis.books: BooksAnnotationsRange![](/images/permalink.svg)
Books annotation range sent by client in different standards.
Fields
- endOffset string? - The offset from the ending position.
- endPosition string? - The ending position for the range.
- startOffset string? - The offset from the starting position.
- startPosition string? - The starting position for the range.
googleapis.books: BooksCloudloadingResource![](/images/permalink.svg)
Fields
- author string? -
- processingState string? -
- title string? -
- volumeId string? -
googleapis.books: Bookshelf![](/images/permalink.svg)
Fields
- access string? - Whether this bookshelf is PUBLIC or PRIVATE.
- created string? - Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
- description string? - Description of this bookshelf.
- id int? - Id of this bookshelf, only unique by user.
- kind string? - Resource type for bookshelf metadata.
- selfLink string? - URL to this resource.
- title string? - Title of this bookshelf.
- updated string? - Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
- volumeCount int? - Number of volumes in this bookshelf.
- volumesLastUpdated string? - Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
googleapis.books: Bookshelves![](/images/permalink.svg)
Fields
- items Bookshelf[]? - A list of bookshelves.
- kind string? - Resource type.
googleapis.books: BooksVolumesRecommendedRateResponse![](/images/permalink.svg)
Fields
- consistency_token string? -
googleapis.books: Category![](/images/permalink.svg)
Fields
- items CategoryItems[]? - A list of onboarding categories.
- kind string? - Resource type.
googleapis.books: CategoryItems![](/images/permalink.svg)
Fields
- badgeUrl string? -
- categoryId string? -
- name string? -
googleapis.books: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
googleapis.books: ConcurrentAccessRestriction![](/images/permalink.svg)
Fields
- deviceAllowed boolean? - Whether access is granted for this (user, device, volume).
- kind string? - Resource type.
- maxConcurrentDevices int? - The maximum number of concurrent access licenses for this volume.
- message string? - Error/warning message.
- nonce string? - Client nonce for verification. Download access and client-validation only.
- reasonCode string? - Error/warning reason code.
- restricted boolean? - Whether this volume has any concurrent access restrictions.
- signature string? - Response signature.
- 'source string? - Client app identifier for verification. Download access and client-validation only.
- timeWindowSeconds int? - Time in seconds for license auto-expiration.
- volumeId string? - Identifies the volume for which this entry applies.
googleapis.books: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
googleapis.books: DictionaryAnnotationdata![](/images/permalink.svg)
Fields
- annotationType string? - The type of annotation this data is for.
- data Dictlayerdata? -
- encodedData string? - Base64 encoded data for this annotation data.
- id string? - Unique id for this annotation data.
- kind string? - Resource Type
- layerId string? - The Layer id for this data. *
- selfLink string? - URL for this resource. *
- updated string? - Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
- volumeId string? - The volume id for this data. *
googleapis.books: Dictlayerdata![](/images/permalink.svg)
Fields
- common DictlayerdataCommon? -
- dict DictlayerdataDict? -
- kind string? -
googleapis.books: DictlayerdataCommon![](/images/permalink.svg)
Fields
- title string? - The display title and localized canonical name to use when searching for this entity on Google search.
googleapis.books: DictlayerdataDict![](/images/permalink.svg)
Fields
- 'source DictlayerdataDictSource? - The source, url and attribution for this dictionary data.
- words DictlayerdataDictWords[]? -
googleapis.books: DictlayerdataDictConjugations![](/images/permalink.svg)
Fields
- 'type string? -
- value string? -
googleapis.books: DictlayerdataDictDefinitions![](/images/permalink.svg)
Fields
- definition string? -
- examples DictlayerdataDictExamples1[]? -
googleapis.books: DictlayerdataDictDerivatives![](/images/permalink.svg)
Fields
- 'source DictlayerdataDictSource1? -
- text string? -
googleapis.books: DictlayerdataDictExamples![](/images/permalink.svg)
Fields
- 'source DictlayerdataDictSource2? -
- text string? -
googleapis.books: DictlayerdataDictExamples1![](/images/permalink.svg)
Fields
- 'source DictlayerdataDictSource3? -
- text string? -
googleapis.books: DictlayerdataDictSenses![](/images/permalink.svg)
Fields
- conjugations DictlayerdataDictConjugations[]? -
- definitions DictlayerdataDictDefinitions[]? -
- partOfSpeech string? -
- pronunciation string? -
- pronunciationUrl string? -
- 'source DictlayerdataDictSource4? -
- syllabification string? -
- synonyms DictlayerdataDictExamples1[]? -
googleapis.books: DictlayerdataDictSource![](/images/permalink.svg)
The source, url and attribution for this dictionary data.
Fields
- attribution string? - The source attribution for this dictionary data.
- url string? - The source URL for this dictionary data.
googleapis.books: DictlayerdataDictSource1![](/images/permalink.svg)
Fields
- attribution string? - The derivatives attribution for this dictionary data.
- url string? - The derivatives URL for this dictionary data.
googleapis.books: DictlayerdataDictSource2![](/images/permalink.svg)
Fields
- attribution string? - The examples attribution for this dictionary data.
- url string? - The examples URL for this dictionary data.
googleapis.books: DictlayerdataDictSource3![](/images/permalink.svg)
Fields
- attribution string? -
- url string? -
googleapis.books: DictlayerdataDictSource4![](/images/permalink.svg)
Fields
- attribution string? - The senses source attribution for this dictionary data.
- url string? - The senses source URL for this dictionary data.
googleapis.books: DictlayerdataDictSource5![](/images/permalink.svg)
The words with different meanings but not related words, e.g. "go" (game) and "go" (verb).
Fields
- attribution string? - The source attribution for this dictionary data.
- url string? - The source URL for this dictionary data.
googleapis.books: DictlayerdataDictWords![](/images/permalink.svg)
Fields
- derivatives DictlayerdataDictDerivatives[]? -
- examples DictlayerdataDictExamples[]? -
- senses DictlayerdataDictSenses[]? -
- 'source DictlayerdataDictSource5? - The words with different meanings but not related words, e.g. "go" (game) and "go" (verb).
googleapis.books: Discoveryclusters![](/images/permalink.svg)
Fields
- clusters DiscoveryclustersClusters[]? -
- kind string? - Resorce type.
- totalClusters int? -
googleapis.books: DiscoveryclustersBannerWithContentContainer![](/images/permalink.svg)
Fields
- fillColorArgb string? -
- imageUrl string? -
- maskColorArgb string? -
- moreButtonText string? -
- moreButtonUrl string? -
- textColorArgb string? -
googleapis.books: DiscoveryclustersClusters![](/images/permalink.svg)
Fields
- banner_with_content_container DiscoveryclustersBannerWithContentContainer? -
- subTitle string? -
- title string? -
- totalVolumes int? -
- uid string? -
- volumes Volume[]? -
googleapis.books: DownloadAccesses![](/images/permalink.svg)
Fields
- downloadAccessList DownloadAccessRestriction[]? - A list of download access responses.
- kind string? - Resource type.
googleapis.books: DownloadAccessRestriction![](/images/permalink.svg)
The download access restriction.
Fields
- deviceAllowed boolean? - If restricted, whether access is granted for this (user, device, volume).
- downloadsAcquired int? - If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
- justAcquired boolean? - If deviceAllowed, whether access was just acquired with this request.
- kind string? - Resource type.
- maxDownloadDevices int? - If restricted, the maximum number of content download licenses for this volume.
- message string? - Error/warning message.
- nonce string? - Client nonce for verification. Download access and client-validation only.
- reasonCode string? - 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
- restricted boolean? - Whether this volume has any download access restrictions.
- signature string? - Response signature.
- 'source string? - Client app identifier for verification. Download access and client-validation only.
- volumeId string? - Identifies the volume for which this entry applies.
googleapis.books: Empty![](/images/permalink.svg)
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty
is empty JSON object {}
.
googleapis.books: FamilyInfo![](/images/permalink.svg)
Fields
- kind string? - Resource type.
- membership FamilyinfoMembership? - Family membership info of the user that made the request.
googleapis.books: FamilyinfoMembership![](/images/permalink.svg)
Family membership info of the user that made the request.
Fields
- acquirePermission string? - Restrictions on user buying and acquiring content.
- ageGroup string? - The age group of the user.
- allowedMaturityRating string? - The maximum allowed maturity rating for the user.
- isInFamily boolean? - Status of included in family
- role string? - The role of the user in the family.
googleapis.books: GeoAnnotationdata![](/images/permalink.svg)
Fields
- annotationType string? - The type of annotation this data is for.
- data Geolayerdata? -
- encodedData string? - Base64 encoded data for this annotation data.
- id string? - Unique id for this annotation data.
- kind string? - Resource Type
- layerId string? - The Layer id for this data. *
- selfLink string? - URL for this resource. *
- updated string? - Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
- volumeId string? - The volume id for this data. *
googleapis.books: Geolayerdata![](/images/permalink.svg)
Fields
- common GeolayerdataCommon? -
- geo GeolayerdataGeo? -
- kind string? -
googleapis.books: GeolayerdataCommon![](/images/permalink.svg)
Fields
- lang string? - The language of the information url and description.
- previewImageUrl string? - The URL for the preview image information.
- snippet string? - The description for this location.
- snippetUrl string? - The URL for information for this location. Ex: wikipedia link.
- title string? - The display title and localized canonical name to use when searching for this entity on Google search.
googleapis.books: GeolayerdataGeo![](/images/permalink.svg)
Fields
- boundary string[]? - The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.
- cachePolicy string? - The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER
- countryCode string? - The country code of the location.
- latitude decimal? - The latitude of the location.
- longitude decimal? - The longitude of the location.
- mapType string? - The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN
- viewport GeolayerdataGeoViewport? - The viewport for showing this location. This is a latitude, longitude rectangle.
- zoom int? - 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
googleapis.books: GeolayerdataGeoViewport![](/images/permalink.svg)
The viewport for showing this location. This is a latitude, longitude rectangle.
Fields
- hi GeolayerdataGeoViewportHi? - Highest viewport for showing this location.
- lo GeolayerdataGeoViewportLo? - Lowest viewport for showing this location.
googleapis.books: GeolayerdataGeoViewportHi![](/images/permalink.svg)
Highest viewport for showing this location.
Fields
- latitude decimal? - The latitude of the location.
- longitude decimal? - The longitude of the location.
googleapis.books: GeolayerdataGeoViewportLo![](/images/permalink.svg)
Lowest viewport for showing this location.
Fields
- latitude decimal? - The latitude of the location.
- longitude decimal? - The longitude of the location.
googleapis.books: Layersummaries![](/images/permalink.svg)
Fields
- items Layersummary[]? - A list of layer summary items.
- kind string? - Resource type.
- totalItems int? - The total number of layer summaries found.
googleapis.books: Layersummary![](/images/permalink.svg)
Fields
- annotationCount int? - The number of annotations for this layer.
- annotationTypes string[]? - The list of annotation types contained for this layer.
- annotationsDataLink string? - Link to get data for this annotation.
- annotationsLink string? - The link to get the annotations for this layer.
- contentVersion string? - The content version this resource is for.
- dataCount int? - The number of data items for this layer.
- id string? - Unique id of this layer summary.
- kind string? - Resource Type
- layerId string? - The layer id for this summary.
- selfLink string? - URL to this resource.
- updated string? - Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
- volumeAnnotationsVersion string? - 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.
- volumeId string? - The volume id this resource is for.
googleapis.books: Metadata![](/images/permalink.svg)
Fields
- items MetadataItems[]? - A list of offline dictionary metadata.
- kind string? - Resource type.
googleapis.books: MetadataItems![](/images/permalink.svg)
Fields
- download_url string? -
- encrypted_key string? -
- language string? -
- size string? -
- 'version string? -
googleapis.books: Notification![](/images/permalink.svg)
Fields
- body string? -
- crmExperimentIds string[]? - The list of crm experiment ids.
- doc_id string? -
- doc_type string? -
- dont_show_notification boolean? -
- iconUrl string? -
- is_document_mature boolean? -
- kind string? - Resource type.
- notificationGroup string? -
- notification_type string? -
- pcampaign_id string? -
- reason string? -
- show_notification_settings_action boolean? -
- targetUrl string? -
- timeToExpireMs string? -
- title string? -
googleapis.books: OAuth2RefreshTokenGrantConfig![](/images/permalink.svg)
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://accounts.google.com/o/oauth2/token") - Refresh URL
googleapis.books: Offers![](/images/permalink.svg)
Fields
- items OffersItems1[]? - A list of offers.
- kind string? - Resource type.
googleapis.books: OffersItems![](/images/permalink.svg)
Fields
- author string? -
- canonicalVolumeLink string? -
- coverUrl string? -
- description string? -
- title string? -
- volumeId string? -
googleapis.books: OffersItems1![](/images/permalink.svg)
Fields
- artUrl string? -
- gservicesKey string? -
- id string? -
- items OffersItems[]? -
googleapis.books: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
googleapis.books: ReadingPosition![](/images/permalink.svg)
Reading position
Fields
- epubCfiPosition string? - Position in an EPUB as a CFI.
- gbImagePosition string? - Position in a volume for image-based content.
- gbTextPosition string? - Position in a volume for text-based content.
- kind string? - Resource type for a reading position.
- pdfPosition string? - Position in a PDF file.
- updated string? - Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- volumeId string? - Volume id associated with this reading position.
googleapis.books: RequestAccessData![](/images/permalink.svg)
Fields
- concurrentAccess ConcurrentAccessRestriction? -
- downloadAccess DownloadAccessRestriction? - The download access restriction.
- kind string? - Resource type.
googleapis.books: Review![](/images/permalink.svg)
Review description.
Fields
- author ReviewAuthor? - Author of this review.
- content string? - Review text.
- date string? - Date of this review.
- fullTextUrl string? - URL for the full review text, for reviews gathered from the web.
- kind string? - Resource type for a review.
- rating string? - Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- 'source ReviewSource? - Information regarding the source of this review, when the review is not from a Google Books user.
- title string? - Title for this review.
- 'type string? - Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- volumeId string? - Volume that this review is for.
googleapis.books: ReviewAuthor![](/images/permalink.svg)
Author of this review.
Fields
- displayName string? - Name of this person.
googleapis.books: ReviewSource![](/images/permalink.svg)
Information regarding the source of this review, when the review is not from a Google Books user.
Fields
- description string? - Name of the source.
- extraDescription string? - Extra text about the source of the review.
- url string? - URL of the source of the review.
googleapis.books: Series![](/images/permalink.svg)
Fields
- kind string? - Resource type.
- series SeriesSeries[]? -
googleapis.books: Seriesmembership![](/images/permalink.svg)
Fields
- kind string? - Resorce type.
- member Volume[]? -
- nextPageToken string? -
googleapis.books: SeriesSeries![](/images/permalink.svg)
Fields
- bannerImageUrl string? -
- eligibleForSubscription boolean? -
- imageUrl string? -
- isComplete boolean? -
- seriesFormatType string? -
- seriesId string? -
- seriesSubscriptionReleaseInfo SeriesSeriessubscriptionreleaseinfo? -
- seriesType string? -
- subscriptionId string? -
- title string? -
googleapis.books: SeriesSeriessubscriptionreleaseinfo![](/images/permalink.svg)
Fields
- cancelTime string? -
- currentReleaseInfo SeriesSeriessubscriptionreleaseinfoCurrentreleaseinfo? -
- nextReleaseInfo SeriesSeriessubscriptionreleaseinfoCurrentreleaseinfo? -
- seriesSubscriptionType string? -
googleapis.books: SeriesSeriessubscriptionreleaseinfoCurrentreleaseinfo![](/images/permalink.svg)
Fields
- amountInMicros decimal? - Amount in micros
- currencyCode string? -
- releaseNumber string? -
- releaseTime string? -
googleapis.books: Usersettings![](/images/permalink.svg)
Fields
- kind string? - Resource type.
- notesExport UsersettingsNotesexport? - User settings in sub-objects, each for different purposes.
- notification UsersettingsNotification? -
googleapis.books: UsersettingsNotesexport![](/images/permalink.svg)
User settings in sub-objects, each for different purposes.
Fields
- folderName string? - Folder name
- isEnabled boolean? - Enabled or not
googleapis.books: UsersettingsNotification![](/images/permalink.svg)
Fields
- matchMyInterests UsersettingsNotificationMatchmyinterests? -
- moreFromAuthors UsersettingsNotificationMatchmyinterests? -
- moreFromSeries UsersettingsNotificationMatchmyinterests? -
- priceDrop UsersettingsNotificationMatchmyinterests? -
- rewardExpirations UsersettingsNotificationMatchmyinterests? -
googleapis.books: UsersettingsNotificationMatchmyinterests![](/images/permalink.svg)
Fields
- opted_state string? -
googleapis.books: Volume![](/images/permalink.svg)
Fields
- accessInfo VolumeAccessinfo? - 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.).
- etag string? - Opaque identifier for a specific version of a volume resource. (In LITE projection)
- id string? - Unique identifier for a volume. (In LITE projection.)
- kind string? - Resource type for a volume. (In LITE projection.)
- layerInfo VolumeLayerinfo? - What layers exist in this volume and high level information about them.
- recommendedInfo VolumeRecommendedinfo? - Recommendation related information for this volume.
- saleInfo VolumeSaleinfo? - 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).
- searchInfo VolumeSearchinfo? - Search result information related to this volume.
- selfLink string? - URL to this resource. (In LITE projection.)
- userInfo VolumeUserinfo? - User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
- volumeInfo VolumeVolumeinfo? - General volume information.
googleapis.books: Volume2![](/images/permalink.svg)
Fields
- items Volume[]? - A list of volumes.
- kind string? - Resource type.
- nextPageToken string? -
googleapis.books: VolumeAccessinfo![](/images/permalink.svg)
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.).
Fields
- accessViewStatus string? - 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.)
- country string? - The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
- downloadAccess DownloadAccessRestriction? - The download access restriction.
- driveImportedContentLink string? - URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
- embeddable boolean? - Whether this volume can be embedded in a viewport using the Embedded Viewer API.
- epub VolumeAccessinfoEpub? - Information about epub content. (In LITE projection.)
- explicitOfflineLicenseManagement boolean? - 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.
- pdf VolumeAccessinfoPdf? - Information about pdf content. (In LITE projection.)
- publicDomain boolean? - Whether or not this book is public domain in the country listed above.
- quoteSharingAllowed boolean? - Whether quote sharing is allowed for this volume.
- textToSpeechPermission string? - Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
- viewOrderUrl string? - For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
- viewability string? - 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.
- webReaderLink string? - URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
googleapis.books: VolumeAccessinfoEpub![](/images/permalink.svg)
Information about epub content. (In LITE projection.)
Fields
- acsTokenLink string? - URL to retrieve ACS token for epub download. (In LITE projection.)
- downloadLink string? - URL to download epub. (In LITE projection.)
- isAvailable boolean? - Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
googleapis.books: VolumeAccessinfoPdf![](/images/permalink.svg)
Information about pdf content. (In LITE projection.)
Fields
- acsTokenLink string? - URL to retrieve ACS token for pdf download. (In LITE projection.)
- downloadLink string? - URL to download pdf. (In LITE projection.)
- isAvailable boolean? - Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
googleapis.books: Volumeannotation![](/images/permalink.svg)
Fields
- annotationDataId string? - The annotation data id for this volume annotation.
- annotationDataLink string? - Link to get data for this annotation.
- annotationType string? - The type of annotation this is.
- contentRanges VolumeannotationContentranges? - The content ranges to identify the selected text.
- data string? - Data for this annotation.
- deleted boolean? - Indicates that this annotation is deleted.
- id string? - Unique id of this volume annotation.
- kind string? - Resource Type
- layerId string? - The Layer this annotation is for.
- pageIds string[]? - Pages the annotation spans.
- selectedText string? - Excerpt from the volume.
- selfLink string? - URL to this resource.
- updated string? - Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
- volumeId string? - The Volume this annotation is for.
googleapis.books: VolumeannotationContentranges![](/images/permalink.svg)
The content ranges to identify the selected text.
Fields
- cfiRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
- contentVersion string? - Content version applicable to ranges below.
- gbImageRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
- gbTextRange BooksAnnotationsRange? - Books annotation range sent by client in different standards.
googleapis.books: Volumeannotations![](/images/permalink.svg)
Fields
- items Volumeannotation[]? - A list of volume annotations.
- kind string? - Resource type
- nextPageToken string? - Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
- totalItems int? - The total number of volume annotations found.
- 'version string? - 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).
googleapis.books: VolumeLayerinfo![](/images/permalink.svg)
What layers exist in this volume and high level information about them.
Fields
- layers VolumeLayerinfoLayers[]? - A layer should appear here if and only if the layer exists for this book.
googleapis.books: VolumeLayerinfoLayers![](/images/permalink.svg)
Fields
- layerId string? - The layer id of this layer (e.g. "geo").
- volumeAnnotationsVersion string? - 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.
googleapis.books: VolumeRecommendedinfo![](/images/permalink.svg)
Recommendation related information for this volume.
Fields
- explanation string? - A text explaining why this volume is recommended.
googleapis.books: Volumes![](/images/permalink.svg)
Fields
- items Volume[]? - A list of volumes.
- kind string? - Resource type.
- totalItems int? - Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
googleapis.books: VolumeSaleinfo![](/images/permalink.svg)
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).
Fields
- buyLink string? - URL to purchase this volume on the Google Books site. (In LITE projection)
- country string? - The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
- isEbook boolean? - Whether or not this volume is an eBook (can be added to the My eBooks shelf).
- listPrice VolumeSaleinfoListprice? - Suggested retail price. (In LITE projection.)
- offers VolumeSaleinfoOffers[]? - Offers available for this volume (sales and rentals).
- onSaleDate string? - The date on which this book is available for sale.
- retailPrice VolumeSaleinfoRetailprice1? - 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.)
- saleability string? - 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.
googleapis.books: VolumeSaleinfoListprice![](/images/permalink.svg)
Suggested retail price. (In LITE projection.)
Fields
- amount decimal? - Amount in the currency listed below. (In LITE projection.)
- currencyCode string? - An ISO 4217, three-letter currency code. (In LITE projection.)
googleapis.books: VolumeSaleinfoListprice1![](/images/permalink.svg)
Offer list (=undiscounted) price in Micros.
Fields
- amountInMicros decimal? - Amount in micros
- currencyCode string? - An ISO 4217, three-letter currency code.
googleapis.books: VolumeSaleinfoOffers![](/images/permalink.svg)
Fields
- finskyOfferType int? - The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
- giftable boolean? - Indicates whether the offer is giftable.
- listPrice VolumeSaleinfoListprice1? - Offer list (=undiscounted) price in Micros.
- rentalDuration VolumeSaleinfoRentalduration? - The rental duration (for rental offers only).
- retailPrice VolumeSaleinfoRetailprice? - Offer retail (=discounted) price in Micros
googleapis.books: VolumeSaleinfoRentalduration![](/images/permalink.svg)
The rental duration (for rental offers only).
Fields
- count decimal? - Count of rental duration.
- unit string? - Unit of rental duration.
googleapis.books: VolumeSaleinfoRetailprice![](/images/permalink.svg)
Offer retail (=discounted) price in Micros
Fields
- amountInMicros decimal? - Amount in micros
- currencyCode string? - An ISO 4217, three-letter currency code.
googleapis.books: VolumeSaleinfoRetailprice1![](/images/permalink.svg)
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.)
Fields
- amount decimal? - Amount in the currency listed below. (In LITE projection.)
- currencyCode string? - An ISO 4217, three-letter currency code. (In LITE projection.)
googleapis.books: VolumeSearchinfo![](/images/permalink.svg)
Search result information related to this volume.
Fields
- textSnippet string? - A text snippet containing the search query.
googleapis.books: Volumeseriesinfo![](/images/permalink.svg)
The volume series information.
Fields
- bookDisplayNumber string? - The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
- kind string? - Resource type.
- shortSeriesBookTitle string? - Short book title in the context of the series.
- volumeSeries VolumeseriesinfoVolumeseries[]? - Volume series
googleapis.books: VolumeseriesinfoIssue![](/images/permalink.svg)
Fields
- issueDisplayNumber string? -
- issueOrderNumber int? -
googleapis.books: VolumeseriesinfoVolumeseries![](/images/permalink.svg)
Fields
- issue VolumeseriesinfoIssue[]? - List of issues. Applicable only for Collection Edition and Omnibus.
- orderNumber int? - The book order number in the series.
- seriesBookType string? - The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
- seriesId string? - The series id.
googleapis.books: VolumeUserinfo![](/images/permalink.svg)
User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
Fields
- acquiredTime string? - Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
- acquisitionType int? - How this volume was acquired.
- copy VolumeUserinfoCopy? - Copy/Paste accounting information.
- entitlementType int? - Whether this volume is purchased, sample, pd download etc.
- familySharing VolumeUserinfoFamilysharing? - Information on the ability to share with the family.
- isFamilySharedFromUser boolean? - Whether or not the user shared this volume with the family.
- isFamilySharedToUser boolean? - Whether or not the user received this volume through family sharing.
- isFamilySharingAllowed boolean? - Deprecated: Replaced by familySharing.
- isFamilySharingDisabledByFop boolean? - Deprecated: Replaced by familySharing.
- isInMyBooks boolean? - Whether or not this volume is currently in "my books."
- isPreordered boolean? - Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- isPurchased boolean? - Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- isUploaded boolean? - Whether or not this volume was user uploaded.
- readingPosition ReadingPosition? - Reading position
- rentalPeriod VolumeUserinfoRentalperiod? - Period during this book is/was a valid rental.
- rentalState string? - Whether this book is an active or an expired rental.
- review Review? - Review description.
- updated string? - 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).
- userUploadedVolumeInfo VolumeUserinfoUseruploadedvolumeinfo? - User uploaded volume info.
googleapis.books: VolumeUserinfoCopy![](/images/permalink.svg)
Copy/Paste accounting information.
Fields
- allowedCharacterCount int? - Allowed character count.
- limitType string? - Type of limitation on this layer.
- remainingCharacterCount int? - Remaining character count.
- updated string? - Updated user info.
googleapis.books: VolumeUserinfoFamilysharing![](/images/permalink.svg)
Information on the ability to share with the family.
Fields
- familyRole string? - The role of the user in the family.
- isSharingAllowed boolean? - Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
- isSharingDisabledByFop boolean? - Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
googleapis.books: VolumeUserinfoRentalperiod![](/images/permalink.svg)
Period during this book is/was a valid rental.
Fields
- endUtcSec string? - End rental period in UTC.
- startUtcSec string? - Start rental period in UTC.
googleapis.books: VolumeUserinfoUseruploadedvolumeinfo![](/images/permalink.svg)
User uploaded volume info.
Fields
- processingState string? - User uploaded volume processing state.
googleapis.books: VolumeVolumeinfo![](/images/permalink.svg)
General volume information.
Fields
- allowAnonLogging boolean? - Whether anonymous logging should be allowed.
- authors string[]? - The names of the authors and/or editors for this volume. (In LITE projection)
- averageRating decimal? - The mean review rating for this volume. (min = 1.0, max = 5.0)
- canonicalVolumeLink string? - Canonical URL for a volume. (In LITE projection.)
- categories string[]? - A list of subject categories, such as "Fiction", "Suspense", etc.
- comicsContent boolean? - Whether the volume has comics content.
- contentVersion string? - An identifier for the version of the volume content (text & images). (In LITE projection)
- description string? - 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.)
- dimensions VolumeVolumeinfoDimensions? - Physical dimensions of this volume.
- imageLinks VolumeVolumeinfoImagelinks? - A list of image links for all the sizes that are available. (In LITE projection.)
- industryIdentifiers VolumeVolumeinfoIndustryidentifiers[]? - Industry standard identifiers for this volume.
- infoLink string? - URL to view information about this volume on the Google Books site. (In LITE projection)
- language string? - Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
- mainCategory string? - The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
- maturityRating string? - The main rating to which this volume belongs.
- pageCount int? - Total number of pages as per publisher metadata.
- panelizationSummary VolumeVolumeinfoPanelizationsummary? - A top-level summary of the panelization info in this volume.
- previewLink string? - URL to preview this volume on the Google Books site.
- printType string? - Type of publication of this volume. Possible values are BOOK or MAGAZINE.
- printedPageCount int? - Total number of printed pages in generated pdf representation.
- publishedDate string? - Date of publication. (In LITE projection.)
- publisher string? - Publisher of this volume. (In LITE projection.)
- ratingsCount int? - The number of review ratings for this volume.
- readingModes VolumeVolumeinfoReadingmodes? - The reading modes available for this volume.
- samplePageCount int? - Total number of sample pages as per publisher metadata.
- seriesInfo Volumeseriesinfo? - The volume series information.
- subtitle string? - Volume subtitle. (In LITE projection.)
- title string? - Volume title. (In LITE projection.)
googleapis.books: VolumeVolumeinfoDimensions![](/images/permalink.svg)
Physical dimensions of this volume.
Fields
- height string? - Height or length of this volume (in cm).
- thickness string? - Thickness of this volume (in cm).
- width string? - Width of this volume (in cm).
googleapis.books: VolumeVolumeinfoImagelinks![](/images/permalink.svg)
A list of image links for all the sizes that are available. (In LITE projection.)
Fields
- extraLarge string? - Image link for extra large size (width of ~1280 pixels). (In LITE projection)
- large string? - Image link for large size (width of ~800 pixels). (In LITE projection)
- medium string? - Image link for medium size (width of ~575 pixels). (In LITE projection)
- small string? - Image link for small size (width of ~300 pixels). (In LITE projection)
- smallThumbnail string? - Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
- thumbnail string? - Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
googleapis.books: VolumeVolumeinfoIndustryidentifiers![](/images/permalink.svg)
Fields
- identifier string? - Industry specific volume identifier.
- 'type string? - Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
googleapis.books: VolumeVolumeinfoPanelizationsummary![](/images/permalink.svg)
A top-level summary of the panelization info in this volume.
Fields
- containsEpubBubbles boolean? - Contains epub bubbles
- containsImageBubbles boolean? - Contains image bubbles
- epubBubbleVersion string? - Epub bubble version
- imageBubbleVersion string? - Image bubble version
googleapis.books: VolumeVolumeinfoReadingmodes![](/images/permalink.svg)
The reading modes available for this volume.
Fields
- image boolean? - Reading mode image
- text boolean? - Reading mode text
Import
import ballerinax/googleapis.books;
Metadata
Released date: almost 2 years ago
Version: 1.4.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.2.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Lifestyle & Entertainment/Books
Cost/Freemium
Vendor/Google
Contributors
Dependencies