@datafire/google_books

Client library for Books API

Installation and Usage

npm install --save @datafire/google_books

let google_books = require('@datafire/google_books').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

The Google Books API allows clients to access the Google Books repository.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_books.oauthCallback({
  "code": ""
}, context)

Input

• input object
  • code required string

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_books.oauthRefresh(null, context)

Input

This action has no parameters

Output

• output object
  • access_token string
  • refresh_token string
  • token_type string
  • scope string
  • expiration string

books.cloudloading.addBook

Add a user-upload volume and triggers processing.

google_books.books.cloudloading.addBook({}, context)

Input

• input object
  • drive_document_id string: A drive document id. The upload_client_token must not be set.
  • mime_type string: The document MIME type. It can be set only if the drive_document_id is set.
  • name string: The document name. It can be set only if the drive_document_id is set.
  • upload_client_token string: Scotty upload token.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output BooksCloudloadingResource

books.cloudloading.deleteBook

Remove the book and its contents

google_books.books.cloudloading.deleteBook({
  "volumeId": ""
}, context)

Input

• input object
  • volumeId required string: The id of the book to be removed.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.cloudloading.updateBook

Updates a user-upload volume.

google_books.books.cloudloading.updateBook({}, context)

Input

• input object
  • body BooksCloudloadingResource
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output BooksCloudloadingResource

books.dictionary.listOfflineMetadata

Returns a list of offline dictionary metadata available

google_books.books.dictionary.listOfflineMetadata({
  "cpksver": ""
}, context)

Input

• input object
  • cpksver required string: The device/version ID from which to request the data.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Metadata

books.familysharing.getFamilyInfo

Gets information regarding the family that the user is part of.

google_books.books.familysharing.getFamilyInfo({}, context)

Input

• input object
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output FamilyInfo

books.familysharing.share

Initiates sharing of the content with the user's family. Empty response indicates success.

google_books.books.familysharing.share({}, context)

Input

• input object
  • docId string: The docid to share.
  • source string: String to identify the originator of this request.
  • volumeId string: The volume to share.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.familysharing.unshare

Initiates revoking content that has already been shared with the user's family. Empty response indicates success.

google_books.books.familysharing.unshare({}, context)

Input

• input object
  • docId string: The docid to unshare.
  • source string: String to identify the originator of this request.
  • volumeId string: The volume to unshare.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.myconfig.getUserSettings

Gets the current settings for the user.

google_books.books.myconfig.getUserSettings({}, context)

Input

• input object
  • country string: Unused. Added only to workaround TEX mandatory request template requirement
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Usersettings

books.myconfig.releaseDownloadAccess

Release downloaded content access restriction.

google_books.books.myconfig.releaseDownloadAccess({
  "cpksver": "",
  "volumeIds": []
}, context)

Input

• input object
  • cpksver required string: The device/version ID from which to release the restriction.
  • volumeIds required array: The volume(s) to release restrictions for.
  • locale string: ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output DownloadAccesses

books.myconfig.requestAccess

Request concurrent and download access restrictions.

google_books.books.myconfig.requestAccess({
  "cpksver": "",
  "nonce": "",
  "source": "",
  "volumeId": ""
}, context)

Input

• input object
  • cpksver required string: The device/version ID from which to request the restrictions.
  • nonce required string: The client nonce value.
  • source required string: String to identify the originator of this request.
  • volumeId required string: The volume to request concurrent/download restrictions for.
  • licenseTypes string (values: LICENSE_TYPES_UNDEFINED, BOTH, CONCURRENT, DOWNLOAD): The type of access license to request. If not specified, the default is BOTH.
  • locale string: ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output RequestAccessData

books.myconfig.syncVolumeLicenses

Request downloaded content access for specified volumes on the My eBooks shelf.

google_books.books.myconfig.syncVolumeLicenses({
  "cpksver": "",
  "nonce": "",
  "source": ""
}, context)

Input

• input object
  • cpksver required string: The device/version ID from which to release the restriction.
  • nonce required string: The client nonce value.
  • source required string: String to identify the originator of this request.
  • features array: List of features supported by the client, i.e., 'RENTALS'
  • includeNonComicsSeries boolean: Set to true to include non-comics series. Defaults to false.
  • locale string: ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
  • showPreorders boolean: Set to true to show pre-ordered books. Defaults to false.
  • volumeIds array: The volume(s) to request download restrictions for.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Volumes

books.myconfig.updateUserSettings

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.

google_books.books.myconfig.updateUserSettings({}, context)

Input

• input object
  • body Usersettings
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Usersettings

books.mylibrary.annotations.list

Retrieves a list of annotations, possibly filtered.

google_books.books.mylibrary.annotations.list({}, context)

Input

• input object
  • contentVersion string: The content version for the requested volume.
  • layerId string: The layer ID to limit annotation by.
  • layerIds array: The layer ID(s) to limit annotation by.
  • maxResults integer: Maximum number of results to return
  • pageToken string: The value of the nextToken from the previous page.
  • showDeleted boolean: Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
  • source string: String to identify the originator of this request.
  • updatedMax string: RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
  • updatedMin string: RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
  • volumeId string: The volume to restrict annotations to.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Annotations

books.mylibrary.annotations.insert

Inserts a new annotation.

google_books.books.mylibrary.annotations.insert({}, context)

Input

• input object
  • annotationId string: The ID for the annotation to insert.
  • country string: ISO-3166-1 code to override the IP-based location.
  • showOnlySummaryInResponse boolean: Requests that only the summary of the specified layer be provided in the response.
  • source string: String to identify the originator of this request.
  • body Annotation
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Annotation

books.mylibrary.annotations.summary

Gets the summary of specified layers.

google_books.books.mylibrary.annotations.summary({
  "layerIds": [],
  "volumeId": ""
}, context)

Input

• input object
  • layerIds required array: Array of layer IDs to get the summary for.
  • volumeId required string: Volume id to get the summary for.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output AnnotationsSummary

books.mylibrary.annotations.delete

Deletes an annotation.

google_books.books.mylibrary.annotations.delete({
  "annotationId": ""
}, context)

Input

• input object
  • annotationId required string: The ID for the annotation to delete.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.mylibrary.annotations.update

Updates an existing annotation.

google_books.books.mylibrary.annotations.update({
  "annotationId": ""
}, context)

Input

• input object
  • annotationId required string: The ID for the annotation to update.
  • source string: String to identify the originator of this request.
  • body Annotation
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Annotation

books.mylibrary.bookshelves.list

Retrieves a list of bookshelves belonging to the authenticated user.

google_books.books.mylibrary.bookshelves.list({}, context)

Input

• input object
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Bookshelves

books.mylibrary.bookshelves.get

Retrieves metadata for a specific bookshelf belonging to the authenticated user.

google_books.books.mylibrary.bookshelves.get({
  "shelf": ""
}, context)

Input

• input object
  • shelf required string: ID of bookshelf to retrieve.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Bookshelf

books.mylibrary.bookshelves.addVolume

Adds a volume to a bookshelf.

google_books.books.mylibrary.bookshelves.addVolume({
  "shelf": "",
  "volumeId": ""
}, context)

Input

• input object
  • shelf required string: ID of bookshelf to which to add a volume.
  • volumeId required string: ID of volume to add.
  • reason string (values: REASON_UNDEFINED, IOS_PREX, IOS_SEARCH, ONBOARDING): The reason for which the book is added to the library.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.mylibrary.bookshelves.clearVolumes

Clears all volumes from a bookshelf.

google_books.books.mylibrary.bookshelves.clearVolumes({
  "shelf": ""
}, context)

Input

• input object
  • shelf required string: ID of bookshelf from which to remove a volume.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.mylibrary.bookshelves.moveVolume

Moves a volume within a bookshelf.

google_books.books.mylibrary.bookshelves.moveVolume({
  "shelf": "",
  "volumeId": "",
  "volumePosition": 0
}, context)

Input

• input object
  • shelf required string: ID of bookshelf with the volume.
  • volumeId required string: ID of volume to move.
  • volumePosition required integer: 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.)
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.mylibrary.bookshelves.removeVolume

Removes a volume from a bookshelf.

google_books.books.mylibrary.bookshelves.removeVolume({
  "shelf": "",
  "volumeId": ""
}, context)

Input

• input object
  • shelf required string: ID of bookshelf from which to remove a volume.
  • volumeId required string: ID of volume to remove.
  • reason string (values: REASON_UNDEFINED, ONBOARDING): The reason for which the book is removed from the library.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.mylibrary.bookshelves.volumes.list

Gets volume information for volumes on a bookshelf.

google_books.books.mylibrary.bookshelves.volumes.list({
  "shelf": ""
}, context)

Input

• input object
  • shelf required string: The bookshelf ID or name retrieve volumes for.
  • country string: ISO-3166-1 code to override the IP-based location.
  • maxResults integer: Maximum number of results to return
  • projection string (values: PROJECTION_UNDEFINED, FULL, LITE): Restrict information returned to a set of selected fields.
  • q string: Full-text search query string in this bookshelf.
  • showPreorders boolean: Set to true to show pre-ordered books. Defaults to false.
  • source string: String to identify the originator of this request.
  • startIndex integer: Index of the first element to return (starts at 0)
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Volumes

books.mylibrary.readingpositions.get

Retrieves my reading position information for a volume.

google_books.books.mylibrary.readingpositions.get({
  "volumeId": ""
}, context)

Input

• input object
  • volumeId required string: ID of volume for which to retrieve a reading position.
  • contentVersion string: Volume content version for which this reading position is requested.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output ReadingPosition

books.mylibrary.readingpositions.setPosition

Sets my reading position information for a volume.

google_books.books.mylibrary.readingpositions.setPosition({
  "volumeId": "",
  "position": "",
  "timestamp": ""
}, context)

Input

• input object
  • volumeId required string: ID of volume for which to update the reading position.
  • position required string: Position string for the new volume reading position.
  • timestamp required string: RFC 3339 UTC format timestamp associated with this reading position.
  • action string (values: ACTION_UNDEFINED, bookmark, chapter, next-page, prev-page, scroll, search): Action that caused this reading position to be set.
  • contentVersion string: Volume content version for which this reading position applies.
  • deviceCookie string: Random persistent device cookie optional on set position.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.notification.get

Returns notification details for a given notification id.

google_books.books.notification.get({
  "notification_id": ""
}, context)

Input

• input object
  • notification_id required string: String to identify the notification.
  • locale string: ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Notification

books.onboarding.listCategories

List categories for onboarding experience.

google_books.books.onboarding.listCategories({}, context)

Input

• input object
  • locale string: ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Category

books.onboarding.listCategoryVolumes

List available volumes under categories for onboarding experience.

google_books.books.onboarding.listCategoryVolumes({}, context)

Input

• input object
  • categoryId array: List of category ids requested.
  • locale string: ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
  • maxAllowedMaturityRating string (values: MAX_ALLOWED_MATURITY_RATING_UNDEFINED, MATURE, not-mature): The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.
  • pageSize integer: Number of maximum results per page to be included in the response.
  • pageToken string: The value of the nextToken from the previous page.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Volume2

books.personalizedstream.get

Returns a stream of personalized book clusters

google_books.books.personalizedstream.get({}, context)

Input

• input object
  • locale string: ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
  • maxAllowedMaturityRating string (values: MAX_ALLOWED_MATURITY_RATING_UNDEFINED, MATURE, not-mature): The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Discoveryclusters

books.promooffer.accept

Accepts the promo offer.

google_books.books.promooffer.accept({}, context)

Input

• input object
  • androidId string: device android_id
  • device string: device device
  • manufacturer string: device manufacturer
  • model string: device model
  • offerId string
  • product string: device product
  • serial string: device serial
  • volumeId string: Volume id to exercise the offer
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.promooffer.dismiss

Marks the promo offer as dismissed.

google_books.books.promooffer.dismiss({}, context)

Input

• input object
  • androidId string: device android_id
  • device string: device device
  • manufacturer string: device manufacturer
  • model string: device model
  • offerId string: Offer to dimiss
  • product string: device product
  • serial string: device serial
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Empty

books.promooffer.get

Returns a list of promo offers available to the user

google_books.books.promooffer.get({}, context)

Input

• input object
  • androidId string: device android_id
  • device string: device device
  • manufacturer string: device manufacturer
  • model string: device model
  • product string: device product
  • serial string: device serial
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Offers

books.series.get

Returns Series metadata for the given series ids.

google_books.books.series.get({
  "series_id": []
}, context)

Input

• input object
  • series_id required array: String that identifies the series
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Series

books.series.membership.get

Returns Series membership data given the series id.

google_books.books.series.membership.get({
  "series_id": ""
}, context)

Input

• input object
  • series_id required string: String that identifies the series
  • page_size integer: Number of maximum results per page to be included in the response.
  • page_token string: The value of the nextToken from the previous page.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Seriesmembership

books.bookshelves.list

Retrieves a list of public bookshelves for the specified user.

google_books.books.bookshelves.list({
  "userId": ""
}, context)

Input

• input object
  • userId required string: ID of user for whom to retrieve bookshelves.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Bookshelves

books.bookshelves.get

Retrieves metadata for a specific bookshelf for the specified user.

google_books.books.bookshelves.get({
  "userId": "",
  "shelf": ""
}, context)

Input

• input object
  • userId required string: ID of user for whom to retrieve bookshelves.
  • shelf required string: ID of bookshelf to retrieve.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Bookshelf

books.bookshelves.volumes.list

Retrieves volumes in a specific bookshelf for the specified user.

google_books.books.bookshelves.volumes.list({
  "userId": "",
  "shelf": ""
}, context)

Input

• input object
  • userId required string: ID of user for whom to retrieve bookshelf volumes.
  • shelf required string: ID of bookshelf to retrieve volumes.
  • maxResults integer: Maximum number of results to return
  • showPreorders boolean: Set to true to show pre-ordered books. Defaults to false.
  • source string: String to identify the originator of this request.
  • startIndex integer: Index of the first element to return (starts at 0)
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Volumes

books.volumes.list

Performs a book search.

google_books.books.volumes.list({
  "q": ""
}, context)

Input

• input object
  • q required string: Full-text search query string.
  • download string (values: DOWNLOAD_UNDEFINED, EPUB): Restrict to volumes by download availability.
  • filter string (values: FILTER_UNDEFINED, ebooks, free-ebooks, full, paid-ebooks, partial): Filter search results.
  • langRestrict string: Restrict results to books with this language code.
  • libraryRestrict string (values: LIBRARY_RESTRICT_UNDEFINED, my-library, no-restrict): Restrict search to this user's library.
  • maxAllowedMaturityRating string (values: MAX_ALLOWED_MATURITY_RATING_UNDEFINED, MATURE, not-mature): The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
  • maxResults integer: Maximum number of results to return.
  • orderBy string (values: ORDER_BY_UNDEFINED, newest, relevance): Sort search results.
  • partner string: Restrict and brand results for partner ID.
  • printType string (values: PRINT_TYPE_UNDEFINED, ALL, BOOKS, MAGAZINES): Restrict to books or magazines.
  • projection string (values: PROJECTION_UNDEFINED, FULL, LITE): Restrict information returned to a set of selected fields.
  • showPreorders boolean: Set to true to show books available for preorder. Defaults to false.
  • source string: String to identify the originator of this request.
  • startIndex integer: Index of the first result to return (starts at 0)
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Volumes

books.volumes.mybooks.list

Return a list of books in My Library.

google_books.books.volumes.mybooks.list({}, context)

Input

• input object
  • acquireMethod array: How the book was acquired
  • country string: ISO-3166-1 code to override the IP-based location.
  • locale string: ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.
  • maxResults integer: Maximum number of results to return.
  • processingState array: The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.
  • source string: String to identify the originator of this request.
  • startIndex integer: Index of the first result to return (starts at 0)
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Volumes

books.volumes.recommended.list

Return a list of recommended books for the current user.

google_books.books.volumes.recommended.list({}, context)

Input

• input object
  • locale string: ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
  • maxAllowedMaturityRating string (values: MAX_ALLOWED_MATURITY_RATING_UNDEFINED, MATURE, not-mature): The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output Volumes

books.volumes.recommended.rate

Rate a recommended book for the current user.

google_books.books.volumes.recommended.rate({
  "rating": "",
  "volumeId": ""
}, context)

Input

• input object
  • rating required string (values: RATING_UNDEFINED, HAVE_IT, NOT_INTERESTED): Rating to be given to the volume.
  • volumeId required string: ID of the source volume.
  • locale string: ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
  • source string: String to identify the originator of this request.
  • $.xgafv string (values: 1, 2): V1 error format.
  • access_token string: OAuth access token.
  • alt string (values: json, media, proto): Data format for response.
  • callback string: JSONP
  • fields string: Selector specifying which fields to include in a partial response.
  • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • oauth_token string: OAuth 2.0 token for the current user.
  • prettyPrint boolean: Returns response with indentations and line breaks.
  • quotaUser string: 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.
  • upload_protocol string: Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string: Legacy upload protocol for media (e.g. "media", "multipart").

Output

• output BooksVolumesRecommendedRateResponse

books.volumes.useruploaded.list

Return a list of books uploaded by the current user.

google_books.books.volumes.useruploaded.list({}, context)

Input

• input object
  • locale string: ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
  • maxResults integer: Maximum number of results to return.
  • processingState array: The processing state of the user uploaded volumes to be returned.
  • source string: String to identify the originator of this request.
  • startIndex integer: Index of the first result to return (starts at 0)
  • volumeId array: T