Default request referring to version v1 of the Books API. This contains the host and root path used as a starting point for constructing service requests.

Manage your books

Creates a value of UserSettings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• usNotification
• usKind
• usNotesExport

Resource type.

User settings in sub-objects, each for different purposes.

Creates a value of Annotations with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aTotalItems
• aNextPageToken
• aKind
• aItems

Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.

Token to pass in for pagination for the next page. This will not be present if this request does not have more results.

Resource type.

A list of annotations.

Restrict information returned to a set of selected fields.

Restrict information returned to a set of selected fields.

Sort search results.

Creates a value of AnnotationsData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• adTotalItems
• adNextPageToken
• adKind
• adItems

The total number of volume annotations found.

Token to pass in for pagination for the next page. This will not be present if this request does not have more results.

Resource type

A list of Annotation Data.

Creates a value of UserSettingsNotificationMoreFromAuthors with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• usnmfaOptedState

Creates a value of Volumeannotations with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vTotalItems
• vNextPageToken
• vKind
• vItems
• vVersion

The total number of volume annotations found.

Token to pass in for pagination for the next page. This will not be present if this request does not have more results.

Resource type

A list of volume annotations.

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).

Information regarding the source of this review, when the review is not from a Google Books user.

See: reviewSource smart constructor.

Creates a value of ReviewSource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rsExtraDescription
• rsURL
• rsDescription

Extra text about the source of the review.

URL of the source of the review.

Name of the source.

Creates a value of AnnotationData with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• annEncodedData
• annKind
• annData
• annSelfLink
• annAnnotationType
• annVolumeId
• annId
• annUpdated
• annLayerId

Base64 encoded data for this annotation data.

Resource Type

URL for this resource. *

The type of annotation this data is for.

The volume id for this data. *

Unique id for this annotation data.

Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).

The Layer id for this data. *

Creates a value of Volumeannotation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• volSelectedText
• volAnnotationDataLink
• volPageIds
• volKind
• volData
• volSelfLink
• volAnnotationType
• volAnnotationDataId
• volContentRanges
• volVolumeId
• volId
• volDeleted
• volUpdated
• volLayerId

Excerpt from the volume.

Link to get data for this annotation.

Pages the annotation spans.

Resource Type

Data for this annotation.

URL to this resource.

The type of annotation this is.

The annotation data id for this volume annotation.

The content ranges to identify the selected text.

The Volume this annotation is for.

Unique id of this volume annotation.

Indicates that this annotation is deleted.

Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).

The Layer this annotation is for.

Creates a value of BooksCloudLoadingResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• bclrProcessingState
• bclrVolumeId
• bclrAuthor
• bclrTitle

Creates a value of Annotation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aaSelectedText
• aaLayerSummary
• aaHighlightStyle
• aaClientVersionRanges
• aaPageIds
• aaKind
• aaData
• aaCreated
• aaAfterSelectedText
• aaSelfLink
• aaCurrentVersionRanges
• aaVolumeId
• aaBeforeSelectedText
• aaId
• aaDeleted
• aaUpdated
• aaLayerId

Excerpt from the volume.

The highlight style for this annotation.

Selection ranges sent from the client.

Pages that this annotation spans.

Resource type.

User-created data for this annotation.

Timestamp for the created time of this annotation.

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.

URL to this resource.

Selection ranges for the most recent content version.

The volume that this annotation belongs to.

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.

Id of this annotation, in the form of a GUID.

Indicates that this annotation is deleted.

Timestamp for the last time this annotation was modified.

The layer this annotation is for.

Author of this review.

See: reviewAuthor smart constructor.

Creates a value of ReviewAuthor with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• raDisplayName

Name of this person.

The viewport for showing this location. This is a latitude, longitude rectangle.

See: geolayerDataGeoViewport smart constructor.

Creates a value of GeolayerDataGeoViewport with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdgvHi
• gdgvLo

User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)

See: volumeUserInfo smart constructor.

Creates a value of VolumeUserInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vuiCopy
• vuiUserUploadedVolumeInfo
• vuiIsPurchased
• vuiEntitlementType
• vuiAcquisitionType
• vuiRentalState
• vuiIsPreOrdered
• vuiReview
• vuiRentalPeriod
• vuiUpdated
• vuiIsUploaded
• vuiIsInMyBooks
• vuiReadingPosition

Copy/Paste accounting information.

Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)

Whether this volume is purchased, sample, pd download etc.

How this volume was acquired.

Whether this book is an active or an expired rental.

Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)

This user's review of this volume, if one exists.

Period during this book is/was a valid rental.

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).

Whether or not this volume was user uploaded.

Whether or not this volume is currently in "my books."

The user's current reading position in the volume, if one is available. (In LITE projection.)

Creates a value of Layersummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• lAnnotationsDataLink
• lAnnotationsLink
• lKind
• lDataCount
• lContentVersion
• lVolumeAnnotationsVersion
• lAnnotationCount
• lAnnotationTypes
• lSelfLink
• lVolumeId
• lId
• lUpdated
• lLayerId

Link to get data for this annotation.

The link to get the annotations for this layer.

Resource Type

The number of data items for this layer.

The content version this resource is for.

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.

The number of annotations for this layer.

The list of annotation types contained for this layer.

URL to this resource.

The volume id this resource is for.

Unique id of this layer summary.

Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).

The layer id for this summary.

Restrict search to this user's library.

The content ranges to identify the selected text.

See: volumeannotationContentRanges smart constructor.

Creates a value of VolumeannotationContentRanges with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vcrGbImageRange
• vcrContentVersion
• vcrGbTextRange
• vcrCfiRange

Range in GB image format for this annotation for version above.

Content version applicable to ranges below.

Range in GB text format for this annotation for version above.

Range in CFI format for this annotation for version above.

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.).

See: volumeAccessInfo smart constructor.

Creates a value of VolumeAccessInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vaiWebReaderLink
• vaiCountry
• vaiDriveImportedContentLink
• vaiExplicitOfflineLicenseManagement
• vaiViewability
• vaiQuoteSharingAllowed
• vaiEpub
• vaiPdf
• vaiTextToSpeechPermission
• vaiEmbeddable
• vaiAccessViewStatus
• vaiDownloadAccess
• vaiViewOrderURL
• vaiPublicDomain

URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.

The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)

URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.

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.

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.

Whether quote sharing is allowed for this volume.

Information about epub content. (In LITE projection.)

Information about pdf content. (In LITE projection.)

Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.

Whether this volume can be embedded in a viewport using the Embedded Viewer API.

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.)

Information about a volume's download license access restrictions.

For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.

Whether or not this book is public domain in the country listed above.

The reason for which the book is removed from the library.

A list of image links for all the sizes that are available. (In LITE projection.)

See: volumeVolumeInfoImageLinks smart constructor.

Creates a value of VolumeVolumeInfoImageLinks with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vviilThumbnail
• vviilSmall
• vviilExtraLarge
• vviilLarge
• vviilMedium
• vviilSmallThumbnail

Image link for thumbnail size (width of ~128 pixels). (In LITE projection)

Image link for small size (width of ~300 pixels). (In LITE projection)

Image link for extra large size (width of ~1280 pixels). (In LITE projection)

Image link for large size (width of ~800 pixels). (In LITE projection)

Image link for medium size (width of ~575 pixels). (In LITE projection)

Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)

The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.

Creates a value of VolumeUserInfoUserUploadedVolumeInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vuiuuviProcessingState

Copy/Paste accounting information.

See: volumeUserInfoCopy smart constructor.

Creates a value of VolumeUserInfoCopy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vuicLimitType
• vuicAllowedCharacterCount
• vuicUpdated
• vuicRemainingCharacterCount

Creates a value of BooksVolumesRecommendedRateResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• bvrrrConsistencyToken

Creates a value of Bookshelf with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• bAccess
• bVolumesLastUpdated
• bKind
• bCreated
• bVolumeCount
• bSelfLink
• bId
• bUpdated
• bTitle
• bDescription

Whether this bookshelf is PUBLIC or PRIVATE.

Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).

Resource type for bookshelf metadata.

Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).

Number of volumes in this bookshelf.

URL to this resource.

Id of this bookshelf, only unique by user.

Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).

Title of this bookshelf.

Description of this bookshelf.

Creates a value of Notification with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• nKind
• nBody
• nLinkURL
• nIconURL
• nTitle

Resource type.

Restrict to volumes by download availability.

Creates a value of AnnotationsSummaryLayersItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• asliLimitType
• asliAllowedCharacterCount
• asliUpdated
• asliLayerId
• asliRemainingCharacterCount

The rental duration (for rental offers only).

See: volumeSaleInfoOffersItemRentalDuration smart constructor.

Creates a value of VolumeSaleInfoOffersItemRentalDuration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• vsioirdCount
• vsioirdUnit

Creates a value of DictlayerDataDictWordsItemExamplesItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dddwieiText
• dddwieiSource

Creates a value of OffersItemsItem with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired: