google_api_books v0.4.0 API Reference
Modules
API calls for all endpoints tagged Bookshelves
.
API calls for all endpoints tagged Cloudloading
.
API calls for all endpoints tagged Dictionary
.
API calls for all endpoints tagged Familysharing
.
API calls for all endpoints tagged Layers
.
API calls for all endpoints tagged Myconfig
.
API calls for all endpoints tagged Mylibrary
.
API calls for all endpoints tagged Notification
.
API calls for all endpoints tagged Onboarding
.
API calls for all endpoints tagged Personalizedstream
.
API calls for all endpoints tagged Promooffer
.
API calls for all endpoints tagged Series
.
API calls for all endpoints tagged Volumes
.
Handle Tesla connections for GoogleApi.Books.V1.
Helper functions for deserializing responses into models.
Attributes
- afterSelectedText (String.t): 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. Defaults to:
null
. - beforeSelectedText (String.t): 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. Defaults to:
null
. - clientVersionRanges (AnnotationClientVersionRanges): Defaults to:
null
. - created (DateTime.t): Timestamp for the created time of this annotation. Defaults to:
null
. - currentVersionRanges (AnnotationCurrentVersionRanges): Defaults to:
null
. - data (String.t): User-created data for this annotation. Defaults to:
null
. - deleted (boolean()): Indicates that this annotation is deleted. Defaults to:
null
. - highlightStyle (String.t): The highlight style for this annotation. Defaults to:
null
. - id (String.t): Id of this annotation, in the form of a GUID. Defaults to:
null
. - kind (String.t): Resource type. Defaults to:
null
. - layerId (String.t): The layer this annotation is for. Defaults to:
null
. - layerSummary (AnnotationLayerSummary): Defaults to:
null
. - pageIds ([String.t]): Pages that this annotation spans. Defaults to:
null
. - selectedText (String.t): Excerpt from the volume. Defaults to:
null
. - selfLink (String.t): URL to this resource. Defaults to:
null
. - updated (DateTime.t): Timestamp for the last time this annotation was modified. Defaults to:
null
. - volumeId (String.t): The volume that this annotation belongs to. Defaults to:
null
.
Selection ranges sent from the client.
Selection ranges for the most recent content version.
Attributes
- allowedCharacterCount (integer()): Maximum allowed characters on this layer, especially for the "copy" layer. Defaults to:
null
. - limitType (String.t): Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer. Defaults to:
null
. - remainingCharacterCount (integer()): Remaining allowed characters on this layer, especially for the "copy" layer. Defaults to:
null
.
Attributes
- annotationType (String.t): The type of annotation this data is for. Defaults to:
null
. - data (String.t): Defaults to:
null
. - encoded_data (binary()): Base64 encoded data for this annotation data. Defaults to:
null
. - id (String.t): Unique id for this annotation data. Defaults to:
null
. - kind (String.t): Resource Type Defaults to:
null
. - layerId (String.t): The Layer id for this data. * Defaults to:
null
. - selfLink (String.t): URL for this resource. * Defaults to:
null
. - updated (DateTime.t): Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). Defaults to:
null
. - volumeId (String.t): The volume id for this data. * Defaults to:
null
.
Attributes
- items ([Annotation]): A list of annotations. Defaults to:
null
. - kind (String.t): Resource type. Defaults to:
null
. - nextPageToken (String.t): Token to pass in for pagination for the next page. This will not be present if this request does not have more results. Defaults to:
null
. - totalItems (integer()): Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated. Defaults to:
null
.
Attributes
- items ([Annotationdata]): A list of Annotation Data. Defaults to:
null
. - kind (String.t): Resource type Defaults to:
null
. - nextPageToken (String.t): Token to pass in for pagination for the next page. This will not be present if this request does not have more results. Defaults to:
null
. - totalItems (integer()): The total number of volume annotations found. Defaults to:
null
.
Attributes
- endOffset (String.t): The offset from the ending position. Defaults to:
null
. - endPosition (String.t): The ending position for the range. Defaults to:
null
. - startOffset (String.t): The offset from the starting position. Defaults to:
null
. - startPosition (String.t): The starting position for the range. Defaults to:
null
.
Attributes
- access (String.t): Whether this bookshelf is PUBLIC or PRIVATE. Defaults to:
null
. - created (DateTime.t): Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). Defaults to:
null
. - description (String.t): Description of this bookshelf. Defaults to:
null
. - id (integer()): Id of this bookshelf, only unique by user. Defaults to:
null
. - kind (String.t): Resource type for bookshelf metadata. Defaults to:
null
. - selfLink (String.t): URL to this resource. Defaults to:
null
. - title (String.t): Title of this bookshelf. Defaults to:
null
. - updated (DateTime.t): Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). Defaults to:
null
. - volumeCount (integer()): Number of volumes in this bookshelf. Defaults to:
null
. - volumesLastUpdated (DateTime.t): Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). Defaults to:
null
.
Attributes
- deviceAllowed (boolean()): Whether access is granted for this (user, device, volume). Defaults to:
null
. - kind (String.t): Resource type. Defaults to:
null
. - maxConcurrentDevices (integer()): The maximum number of concurrent access licenses for this volume. Defaults to:
null
. - message (String.t): Error/warning message. Defaults to:
null
. - nonce (String.t): Client nonce for verification. Download access and client-validation only. Defaults to:
null
. - reasonCode (String.t): Error/warning reason code. Defaults to:
null
. - restricted (boolean()): Whether this volume has any concurrent access restrictions. Defaults to:
null
. - signature (String.t): Response signature. Defaults to:
null
. - source (String.t): Client app identifier for verification. Download access and client-validation only. Defaults to:
null
. - timeWindowSeconds (integer()): Time in seconds for license auto-expiration. Defaults to:
null
. - volumeId (String.t): Identifies the volume for which this entry applies. Defaults to:
null
.
Attributes
- definitions ([DictlayerdataDictDefinitions]): Defaults to:
null
. - conjugations ([DictlayerdataDictConjugations]): Defaults to:
null
. - partOfSpeech (String.t): Defaults to:
null
. - pronunciation (String.t): Defaults to:
null
. - pronunciationUrl (String.t): Defaults to:
null
. - source (DictlayerdataDictSource1): Defaults to:
null
. - syllabification (String.t): Defaults to:
null
. - synonyms ([DictlayerdataDictDerivatives]): Defaults to:
null
.
The source, url and attribution for this dictionary data.
The words with different meanings but not related words, e.g. "go" (game) and "go" (verb).
Attributes
- banner_with_content_container (DiscoveryclustersBannerWithContentContainer): Defaults to:
null
. - subTitle (String.t): Defaults to:
null
. - title (String.t): Defaults to:
null
. - totalVolumes (integer()): Defaults to:
null
. - uid (String.t): Defaults to:
null
. - volumes ([Volume]): Defaults to:
null
.
Attributes
- deviceAllowed (boolean()): If restricted, whether access is granted for this (user, device, volume). Defaults to:
null
. - downloadsAcquired (integer()): If restricted, the number of content download licenses already acquired (including the requesting client, if licensed). Defaults to:
null
. - justAcquired (boolean()): If deviceAllowed, whether access was just acquired with this request. Defaults to:
null
. - kind (String.t): Resource type. Defaults to:
null
. - maxDownloadDevices (integer()): If restricted, the maximum number of content download licenses for this volume. Defaults to:
null
. - message (String.t): Error/warning message. Defaults to:
null
. - nonce (String.t): Client nonce for verification. Download access and client-validation only. Defaults to:
null
. - reasonCode (String.t): 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 Defaults to:
null
. - restricted (boolean()): Whether this volume has any download access restrictions. Defaults to:
null
. - signature (String.t): Response signature. Defaults to:
null
. - source (String.t): Client app identifier for verification. Download access and client-validation only. Defaults to:
null
. - volumeId (String.t): Identifies the volume for which this entry applies. Defaults to:
null
.
Family membership info of the user that made the request.
Attributes
- lang (String.t): The language of the information url and description. Defaults to:
null
. - previewImageUrl (String.t): The URL for the preview image information. Defaults to:
null
. - snippet (String.t): The description for this location. Defaults to:
null
. - snippetUrl (String.t): The URL for information for this location. Ex: wikipedia link. Defaults to:
null
. - title (String.t): The display title and localized canonical name to use when searching for this entity on Google search. Defaults to:
null
.
Attributes
- boundary ([[Object]]): The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates. Defaults to:
null
. - cachePolicy (String.t): The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER Defaults to:
null
. - countryCode (String.t): The country code of the location. Defaults to:
null
. - latitude (float()): The latitude of the location. Defaults to:
null
. - longitude (float()): The longitude of the location. Defaults to:
null
. - mapType (String.t): The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN Defaults to:
null
. - viewport (GeolayerdataGeoViewport): Defaults to:
null
. - zoom (integer()): 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 Defaults to:
null
.
The viewport for showing this location. This is a latitude, longitude rectangle.
Attributes
- annotationCount (integer()): The number of annotations for this layer. Defaults to:
null
. - annotationTypes ([String.t]): The list of annotation types contained for this layer. Defaults to:
null
. - annotationsDataLink (String.t): Link to get data for this annotation. Defaults to:
null
. - annotationsLink (String.t): The link to get the annotations for this layer. Defaults to:
null
. - contentVersion (String.t): The content version this resource is for. Defaults to:
null
. - dataCount (integer()): The number of data items for this layer. Defaults to:
null
. - id (String.t): Unique id of this layer summary. Defaults to:
null
. - kind (String.t): Resource Type Defaults to:
null
. - layerId (String.t): The layer id for this summary. Defaults to:
null
. - selfLink (String.t): URL to this resource. Defaults to:
null
. - updated (DateTime.t): Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format). Defaults to:
null
. - volumeAnnotationsVersion (String.t): 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. Defaults to:
null
. - volumeId (String.t): The volume id this resource is for. Defaults to:
null
.
Attributes
- body (String.t): Defaults to:
null
. - crmExperimentIds ([String.t]): The list of crm experiment ids. Defaults to:
null
. - doc_id (String.t): Defaults to:
null
. - doc_type (String.t): Defaults to:
null
. - dont_show_notification (boolean()): Defaults to:
null
. - iconUrl (String.t): Defaults to:
null
. - is_document_mature (boolean()): Defaults to:
null
. - kind (String.t): Resource type. Defaults to:
null
. - notificationGroup (String.t): Defaults to:
null
. - notification_type (String.t): Defaults to:
null
. - pcampaign_id (String.t): Defaults to:
null
. - reason (String.t): Defaults to:
null
. - show_notification_settings_action (boolean()): Defaults to:
null
. - targetUrl (String.t): Defaults to:
null
. - timeToExpireMs (String.t): Defaults to:
null
. - title (String.t): Defaults to:
null
.
Attributes
- epubCfiPosition (String.t): Position in an EPUB as a CFI. Defaults to:
null
. - gbImagePosition (String.t): Position in a volume for image-based content. Defaults to:
null
. - gbTextPosition (String.t): Position in a volume for text-based content. Defaults to:
null
. - kind (String.t): Resource type for a reading position. Defaults to:
null
. - pdfPosition (String.t): Position in a PDF file. Defaults to:
null
. - updated (DateTime.t): Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution). Defaults to:
null
. - volumeId (String.t): Volume id associated with this reading position. Defaults to:
null
.
Attributes
- author (ReviewAuthor): Defaults to:
null
. - content (String.t): Review text. Defaults to:
null
. - date (String.t): Date of this review. Defaults to:
null
. - fullTextUrl (String.t): URL for the full review text, for reviews gathered from the web. Defaults to:
null
. - kind (String.t): Resource type for a review. Defaults to:
null
. - rating (String.t): Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. Defaults to:
null
. - source (ReviewSource): Defaults to:
null
. - title (String.t): Title for this review. Defaults to:
null
. - type (String.t): Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. Defaults to:
null
. - volumeId (String.t): Volume that this review is for. Defaults to:
null
.
Author of this review.
Information regarding the source of this review, when the review is not from a Google Books user.
User settings in sub-objects, each for different purposes.
Attributes
- matchMyInterests (UsersettingsNotificationMatchMyInterests): Defaults to:
null
. - moreFromAuthors (UsersettingsNotificationMatchMyInterests): Defaults to:
null
. - moreFromSeries (UsersettingsNotificationMatchMyInterests): Defaults to:
null
. - priceDrop (UsersettingsNotificationMatchMyInterests): Defaults to:
null
. - rewardExpirations (UsersettingsNotificationMatchMyInterests): Defaults to:
null
.
Attributes
- accessInfo (VolumeAccessInfo): Defaults to:
null
. - etag (String.t): Opaque identifier for a specific version of a volume resource. (In LITE projection) Defaults to:
null
. - id (String.t): Unique identifier for a volume. (In LITE projection.) Defaults to:
null
. - kind (String.t): Resource type for a volume. (In LITE projection.) Defaults to:
null
. - layerInfo (VolumeLayerInfo): Defaults to:
null
. - recommendedInfo (VolumeRecommendedInfo): Defaults to:
null
. - saleInfo (VolumeSaleInfo): Defaults to:
null
. - searchInfo (VolumeSearchInfo): Defaults to:
null
. - selfLink (String.t): URL to this resource. (In LITE projection.) Defaults to:
null
. - userInfo (VolumeUserInfo): Defaults to:
null
. - volumeInfo (VolumeVolumeInfo): Defaults to:
null
.
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.).
Information about epub content. (In LITE projection.)
Information about pdf content. (In LITE projection.)
What layers exist in this volume and high level information about them.
Attributes
- layerId (String.t): The layer id of this layer (e.g. "geo"). Defaults to:
null
. - volumeAnnotationsVersion (String.t): 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. Defaults to:
null
.
Recommendation related information for this volume.
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).
Suggested retail price. (In LITE projection.)
Offer list (=undiscounted) price in Micros.
Attributes
- finskyOfferType (integer()): The finsky offer type (e.g., PURCHASE=0 RENTAL=3) Defaults to:
null
. - giftable (boolean()): Indicates whether the offer is giftable. Defaults to:
null
. - listPrice (VolumeSaleInfoListPrice1): Defaults to:
null
. - rentalDuration (VolumeSaleInfoRentalDuration): Defaults to:
null
. - retailPrice (VolumeSaleInfoRetailPrice): Defaults to:
null
.
The rental duration (for rental offers only).
Offer retail (=discounted) price in Micros
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.)
Search result information related to this volume.
User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
Copy/Paste accounting information.
Information on the ability to share with the family.
Period during this book is/was a valid rental.
General volume information.
Physical dimensions of this volume.
A list of image links for all the sizes that are available. (In LITE projection.)
A top-level summary of the panelization info in this volume.
Attributes
- annotationDataId (String.t): The annotation data id for this volume annotation. Defaults to:
null
. - annotationDataLink (String.t): Link to get data for this annotation. Defaults to:
null
. - annotationType (String.t): The type of annotation this is. Defaults to:
null
. - contentRanges (VolumeannotationContentRanges): Defaults to:
null
. - data (String.t): Data for this annotation. Defaults to:
null
. - deleted (boolean()): Indicates that this annotation is deleted. Defaults to:
null
. - id (String.t): Unique id of this volume annotation. Defaults to:
null
. - kind (String.t): Resource Type Defaults to:
null
. - layerId (String.t): The Layer this annotation is for. Defaults to:
null
. - pageIds ([String.t]): Pages the annotation spans. Defaults to:
null
. - selectedText (String.t): Excerpt from the volume. Defaults to:
null
. - selfLink (String.t): URL to this resource. Defaults to:
null
. - updated (DateTime.t): Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). Defaults to:
null
. - volumeId (String.t): The Volume this annotation is for. Defaults to:
null
.
The content ranges to identify the selected text.
Attributes
- items ([Volumeannotation]): A list of volume annotations. Defaults to:
null
. - kind (String.t): Resource type Defaults to:
null
. - nextPageToken (String.t): Token to pass in for pagination for the next page. This will not be present if this request does not have more results. Defaults to:
null
. - totalItems (integer()): The total number of volume annotations found. Defaults to:
null
. - version (String.t): 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). Defaults to:
null
.
Attributes
- bookDisplayNumber (String.t): The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. Defaults to:
null
. - kind (String.t): Resource type. Defaults to:
null
. - shortSeriesBookTitle (String.t): Short book title in the context of the series. Defaults to:
null
. - volumeSeries ([VolumeseriesinfoVolumeSeries]): Defaults to:
null
.
Attributes
- issue ([VolumeseriesinfoIssue]): List of issues. Applicable only for Collection Edition and Omnibus. Defaults to:
null
. - orderNumber (integer()): The book order number in the series. Defaults to:
null
. - seriesBookType (String.t): The book type in the context of series. Examples - Single Issue, Collection Edition, etc. Defaults to:
null
. - seriesId (String.t): The series id. Defaults to:
null
.
Helper functions for building Tesla requests.