google_api_books v0.5.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.
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
nil
. - 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
nil
. - clientVersionRanges (GoogleApi.Books.V1.Model.AnnotationClientVersionRanges.t): Selection ranges sent from the client. Defaults to
nil
. - created (DateTime.t): Timestamp for the created time of this annotation. Defaults to
nil
. - currentVersionRanges (GoogleApi.Books.V1.Model.AnnotationCurrentVersionRanges.t): Selection ranges for the most recent content version. Defaults to
nil
. - data (String.t): User-created data for this annotation. Defaults to
nil
. - deleted (boolean()): Indicates that this annotation is deleted. Defaults to
nil
. - highlightStyle (String.t): The highlight style for this annotation. Defaults to
nil
. - id (String.t): Id of this annotation, in the form of a GUID. Defaults to
nil
. - kind (String.t): Resource type. Defaults to
books#annotation
. - layerId (String.t): The layer this annotation is for. Defaults to
nil
. - layerSummary (GoogleApi.Books.V1.Model.AnnotationLayerSummary.t): Defaults to
nil
. - pageIds (list(String.t)): Pages that this annotation spans. Defaults to
nil
. - selectedText (String.t): Excerpt from the volume. Defaults to
nil
. - selfLink (String.t): URL to this resource. Defaults to
nil
. - updated (DateTime.t): Timestamp for the last time this annotation was modified. Defaults to
nil
. - volumeId (String.t): The volume that this annotation belongs to. Defaults to
nil
.
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
nil
. - limitType (String.t): Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer. Defaults to
nil
. - remainingCharacterCount (integer()): Remaining allowed characters on this layer, especially for the "copy" layer. Defaults to
nil
.
Attributes
- annotationType (String.t): The type of annotation this data is for. Defaults to
nil
. - data (any()): Defaults to
nil
. - encoded_data (String.t): Base64 encoded data for this annotation data. Defaults to
nil
. - id (String.t): Unique id for this annotation data. Defaults to
nil
. - kind (String.t): Resource Type Defaults to
books#annotationdata
. - layerId (String.t): The Layer id for this data. * Defaults to
nil
. - selfLink (String.t): URL for this resource. * Defaults to
nil
. - updated (DateTime.t): Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). Defaults to
nil
. - volumeId (String.t): The volume id for this data. * Defaults to
nil
.
Attributes
- items (list(GoogleApi.Books.V1.Model.Annotation.t)): A list of annotations. Defaults to
nil
. - kind (String.t): Resource type. Defaults to
books#annotations
. - 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
nil
. - 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
nil
.
Attributes
- items (list(GoogleApi.Books.V1.Model.Annotationdata.t)): A list of Annotation Data. Defaults to
nil
. - kind (String.t): Resource type Defaults to
books#annotationsdata
. - 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
nil
. - totalItems (integer()): The total number of volume annotations found. Defaults to
nil
.
Attributes
- endOffset (String.t): The offset from the ending position. Defaults to
nil
. - endPosition (String.t): The ending position for the range. Defaults to
nil
. - startOffset (String.t): The offset from the starting position. Defaults to
nil
. - startPosition (String.t): The starting position for the range. Defaults to
nil
.
Attributes
- access (String.t): Whether this bookshelf is PUBLIC or PRIVATE. Defaults to
nil
. - created (DateTime.t): Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). Defaults to
nil
. - description (String.t): Description of this bookshelf. Defaults to
nil
. - id (integer()): Id of this bookshelf, only unique by user. Defaults to
nil
. - kind (String.t): Resource type for bookshelf metadata. Defaults to
books#bookshelf
. - selfLink (String.t): URL to this resource. Defaults to
nil
. - title (String.t): Title of this bookshelf. Defaults to
nil
. - updated (DateTime.t): Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). Defaults to
nil
. - volumeCount (integer()): Number of volumes in this bookshelf. Defaults to
nil
. - volumesLastUpdated (DateTime.t): Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution). Defaults to
nil
.
Attributes
- deviceAllowed (boolean()): Whether access is granted for this (user, device, volume). Defaults to
nil
. - kind (String.t): Resource type. Defaults to
books#concurrentAccessRestriction
. - maxConcurrentDevices (integer()): The maximum number of concurrent access licenses for this volume. Defaults to
nil
. - message (String.t): Error/warning message. Defaults to
nil
. - nonce (String.t): Client nonce for verification. Download access and client-validation only. Defaults to
nil
. - reasonCode (String.t): Error/warning reason code. Defaults to
nil
. - restricted (boolean()): Whether this volume has any concurrent access restrictions. Defaults to
nil
. - signature (String.t): Response signature. Defaults to
nil
. - source (String.t): Client app identifier for verification. Download access and client-validation only. Defaults to
nil
. - timeWindowSeconds (integer()): Time in seconds for license auto-expiration. Defaults to
nil
. - volumeId (String.t): Identifies the volume for which this entry applies. Defaults to
nil
.
The source, url and attribution for this dictionary data.
Attributes
- derivatives (list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsDerivatives.t)): Defaults to
nil
. - examples (list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsExamples.t)): Defaults to
nil
. - senses (list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsSenses.t)): Defaults to
nil
. - source (GoogleApi.Books.V1.Model.DictlayerdataDictWordsSource.t): The words with different meanings but not related words, e.g. "go" (game) and "go" (verb). Defaults to
nil
.
Attributes
- conjugations (list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsSensesConjugations.t)): Defaults to
nil
. - definitions (list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsSensesDefinitions.t)): Defaults to
nil
. - partOfSpeech (String.t): Defaults to
nil
. - pronunciation (String.t): Defaults to
nil
. - pronunciationUrl (String.t): Defaults to
nil
. - source (GoogleApi.Books.V1.Model.DictlayerdataDictWordsSensesSource.t): Defaults to
nil
. - syllabification (String.t): Defaults to
nil
. - synonyms (list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsSensesSynonyms.t)): Defaults to
nil
.
The words with different meanings but not related words, e.g. "go" (game) and "go" (verb).
Attributes
- banner_with_content_container (GoogleApi.Books.V1.Model.DiscoveryclustersClustersBannerWithContentContainer.t): Defaults to
nil
. - subTitle (String.t): Defaults to
nil
. - title (String.t): Defaults to
nil
. - totalVolumes (integer()): Defaults to
nil
. - uid (String.t): Defaults to
nil
. - volumes (list(GoogleApi.Books.V1.Model.Volume.t)): Defaults to
nil
.
Attributes
- deviceAllowed (boolean()): If restricted, whether access is granted for this (user, device, volume). Defaults to
nil
. - downloadsAcquired (integer()): If restricted, the number of content download licenses already acquired (including the requesting client, if licensed). Defaults to
nil
. - justAcquired (boolean()): If deviceAllowed, whether access was just acquired with this request. Defaults to
nil
. - kind (String.t): Resource type. Defaults to
books#downloadAccessRestriction
. - maxDownloadDevices (integer()): If restricted, the maximum number of content download licenses for this volume. Defaults to
nil
. - message (String.t): Error/warning message. Defaults to
nil
. - nonce (String.t): Client nonce for verification. Download access and client-validation only. Defaults to
nil
. - 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
nil
. - restricted (boolean()): Whether this volume has any download access restrictions. Defaults to
nil
. - signature (String.t): Response signature. Defaults to
nil
. - source (String.t): Client app identifier for verification. Download access and client-validation only. Defaults to
nil
. - volumeId (String.t): Identifies the volume for which this entry applies. Defaults to
nil
.
Family membership info of the user that made the request.
Attributes
- lang (String.t): The language of the information url and description. Defaults to
nil
. - previewImageUrl (String.t): The URL for the preview image information. Defaults to
nil
. - snippet (String.t): The description for this location. Defaults to
nil
. - snippetUrl (String.t): The URL for information for this location. Ex: wikipedia link. Defaults to
nil
. - title (String.t): The display title and localized canonical name to use when searching for this entity on Google search. Defaults to
nil
.
Attributes
- boundary (list(list(GoogleApi.Books.V1.Model.GeolayerdataGeoBoundary.t))): The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates. Defaults to
nil
. - cachePolicy (String.t): The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER Defaults to
nil
. - countryCode (String.t): The country code of the location. Defaults to
nil
. - latitude (float()): The latitude of the location. Defaults to
nil
. - longitude (float()): The longitude of the location. Defaults to
nil
. - mapType (String.t): The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN Defaults to
nil
. - viewport (GoogleApi.Books.V1.Model.GeolayerdataGeoViewport.t): The viewport for showing this location. This is a latitude, longitude rectangle. Defaults to
nil
. - 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
nil
.
The viewport for showing this location. This is a latitude, longitude rectangle.
Attributes
- annotationCount (integer()): The number of annotations for this layer. Defaults to
nil
. - annotationTypes (list(String.t)): The list of annotation types contained for this layer. Defaults to
nil
. - annotationsDataLink (String.t): Link to get data for this annotation. Defaults to
nil
. - annotationsLink (String.t): The link to get the annotations for this layer. Defaults to
nil
. - contentVersion (String.t): The content version this resource is for. Defaults to
nil
. - dataCount (integer()): The number of data items for this layer. Defaults to
nil
. - id (String.t): Unique id of this layer summary. Defaults to
nil
. - kind (String.t): Resource Type Defaults to
books#layersummary
. - layerId (String.t): The layer id for this summary. Defaults to
nil
. - selfLink (String.t): URL to this resource. Defaults to
nil
. - updated (DateTime.t): Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format). Defaults to
nil
. - 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
nil
. - volumeId (String.t): The volume id this resource is for. Defaults to
nil
.
Attributes
- body (String.t): Defaults to
nil
. - crmExperimentIds (list(String.t)): The list of crm experiment ids. Defaults to
nil
. - doc_id (String.t): Defaults to
nil
. - doc_type (String.t): Defaults to
nil
. - dont_show_notification (boolean()): Defaults to
nil
. - iconUrl (String.t): Defaults to
nil
. - is_document_mature (boolean()): Defaults to
nil
. - kind (String.t): Resource type. Defaults to
books#notification
. - notificationGroup (String.t): Defaults to
nil
. - notification_type (String.t): Defaults to
nil
. - pcampaign_id (String.t): Defaults to
nil
. - reason (String.t): Defaults to
nil
. - show_notification_settings_action (boolean()): Defaults to
nil
. - targetUrl (String.t): Defaults to
nil
. - timeToExpireMs (String.t): Defaults to
nil
. - title (String.t): Defaults to
nil
.
Attributes
- epubCfiPosition (String.t): Position in an EPUB as a CFI. Defaults to
nil
. - gbImagePosition (String.t): Position in a volume for image-based content. Defaults to
nil
. - gbTextPosition (String.t): Position in a volume for text-based content. Defaults to
nil
. - kind (String.t): Resource type for a reading position. Defaults to
books#readingPosition
. - pdfPosition (String.t): Position in a PDF file. Defaults to
nil
. - updated (DateTime.t): Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution). Defaults to
nil
. - volumeId (String.t): Volume id associated with this reading position. Defaults to
nil
.
Attributes
- concurrentAccess (GoogleApi.Books.V1.Model.ConcurrentAccessRestriction.t): A concurrent access response. Defaults to
nil
. - downloadAccess (GoogleApi.Books.V1.Model.DownloadAccessRestriction.t): A download access response. Defaults to
nil
. - kind (String.t): Resource type. Defaults to
books#requestAccess
.
Attributes
- author (GoogleApi.Books.V1.Model.ReviewAuthor.t): Author of this review. Defaults to
nil
. - content (String.t): Review text. Defaults to
nil
. - date (String.t): Date of this review. Defaults to
nil
. - fullTextUrl (String.t): URL for the full review text, for reviews gathered from the web. Defaults to
nil
. - kind (String.t): Resource type for a review. Defaults to
books#review
. - rating (String.t): Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. Defaults to
nil
. - source (GoogleApi.Books.V1.Model.ReviewSource.t): Information regarding the source of this review, when the review is not from a Google Books user. Defaults to
nil
. - title (String.t): Title for this review. Defaults to
nil
. - type (String.t): Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. Defaults to
nil
. - volumeId (String.t): Volume that this review is for. Defaults to
nil
.
Author of this review.
Information regarding the source of this review, when the review is not from a Google Books user.
Attributes
- kind (String.t): Resource type. Defaults to
books#usersettings
. - notesExport (GoogleApi.Books.V1.Model.UsersettingsNotesExport.t): User settings in sub-objects, each for different purposes. Defaults to
nil
. - notification (GoogleApi.Books.V1.Model.UsersettingsNotification.t): Defaults to
nil
.
User settings in sub-objects, each for different purposes.
Attributes
- matchMyInterests (GoogleApi.Books.V1.Model.UsersettingsNotificationMatchMyInterests.t): Defaults to
nil
. - moreFromAuthors (GoogleApi.Books.V1.Model.UsersettingsNotificationMoreFromAuthors.t): Defaults to
nil
. - moreFromSeries (GoogleApi.Books.V1.Model.UsersettingsNotificationMoreFromSeries.t): Defaults to
nil
. - priceDrop (GoogleApi.Books.V1.Model.UsersettingsNotificationPriceDrop.t): Defaults to
nil
. - rewardExpirations (GoogleApi.Books.V1.Model.UsersettingsNotificationRewardExpirations.t): Defaults to
nil
.
Attributes
- accessInfo (GoogleApi.Books.V1.Model.VolumeAccessInfo.t): 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.). Defaults to
nil
. - etag (String.t): Opaque identifier for a specific version of a volume resource. (In LITE projection) Defaults to
nil
. - id (String.t): Unique identifier for a volume. (In LITE projection.) Defaults to
nil
. - kind (String.t): Resource type for a volume. (In LITE projection.) Defaults to
books#volume
. - layerInfo (GoogleApi.Books.V1.Model.VolumeLayerInfo.t): What layers exist in this volume and high level information about them. Defaults to
nil
. - recommendedInfo (GoogleApi.Books.V1.Model.VolumeRecommendedInfo.t): Recommendation related information for this volume. Defaults to
nil
. - saleInfo (GoogleApi.Books.V1.Model.VolumeSaleInfo.t): 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). Defaults to
nil
. - searchInfo (GoogleApi.Books.V1.Model.VolumeSearchInfo.t): Search result information related to this volume. Defaults to
nil
. - selfLink (String.t): URL to this resource. (In LITE projection.) Defaults to
nil
. - userInfo (GoogleApi.Books.V1.Model.VolumeUserInfo.t): User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) Defaults to
nil
. - volumeInfo (GoogleApi.Books.V1.Model.VolumeVolumeInfo.t): General volume information. Defaults to
nil
.
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
nil
. - 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
nil
.
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.)
Attributes
- finskyOfferType (integer()): The finsky offer type (e.g., PURCHASE=0 RENTAL=3) Defaults to
nil
. - giftable (boolean()): Indicates whether the offer is giftable. Defaults to
nil
. - listPrice (GoogleApi.Books.V1.Model.VolumeSaleInfoOffersListPrice.t): Offer list (=undiscounted) price in Micros. Defaults to
nil
. - rentalDuration (GoogleApi.Books.V1.Model.VolumeSaleInfoOffersRentalDuration.t): The rental duration (for rental offers only). Defaults to
nil
. - retailPrice (GoogleApi.Books.V1.Model.VolumeSaleInfoOffersRetailPrice.t): Offer retail (=discounted) price in Micros Defaults to
nil
.
Offer list (=undiscounted) price in Micros.
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
nil
. - annotationDataLink (String.t): Link to get data for this annotation. Defaults to
nil
. - annotationType (String.t): The type of annotation this is. Defaults to
nil
. - contentRanges (GoogleApi.Books.V1.Model.VolumeannotationContentRanges.t): The content ranges to identify the selected text. Defaults to
nil
. - data (String.t): Data for this annotation. Defaults to
nil
. - deleted (boolean()): Indicates that this annotation is deleted. Defaults to
nil
. - id (String.t): Unique id of this volume annotation. Defaults to
nil
. - kind (String.t): Resource Type Defaults to
books#volumeannotation
. - layerId (String.t): The Layer this annotation is for. Defaults to
nil
. - pageIds (list(String.t)): Pages the annotation spans. Defaults to
nil
. - selectedText (String.t): Excerpt from the volume. Defaults to
nil
. - selfLink (String.t): URL to this resource. Defaults to
nil
. - updated (DateTime.t): Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). Defaults to
nil
. - volumeId (String.t): The Volume this annotation is for. Defaults to
nil
.
The content ranges to identify the selected text.
Attributes
- items (list(GoogleApi.Books.V1.Model.Volumeannotation.t)): A list of volume annotations. Defaults to
nil
. - kind (String.t): Resource type Defaults to
books#volumeannotations
. - 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
nil
. - totalItems (integer()): The total number of volume annotations found. Defaults to
nil
. - 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
nil
.
Attributes
- items (list(GoogleApi.Books.V1.Model.Volume.t)): A list of volumes. Defaults to
nil
. - kind (String.t): Resource type. Defaults to
books#volumes
. - totalItems (integer()): Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated. Defaults to
nil
.
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
nil
. - kind (String.t): Resource type. Defaults to
books#volume_series_info
. - shortSeriesBookTitle (String.t): Short book title in the context of the series. Defaults to
nil
. - volumeSeries (list(GoogleApi.Books.V1.Model.VolumeseriesinfoVolumeSeries.t)): Defaults to
nil
.
Attributes
- issue (list(GoogleApi.Books.V1.Model.VolumeseriesinfoVolumeSeriesIssue.t)): List of issues. Applicable only for Collection Edition and Omnibus. Defaults to
nil
. - orderNumber (integer()): The book order number in the series. Defaults to
nil
. - seriesBookType (String.t): The book type in the context of series. Examples - Single Issue, Collection Edition, etc. Defaults to
nil
. - seriesId (String.t): The series id. Defaults to
nil
.