View Source API Reference google_api_books v0.21.0
Modules
API client metadata for GoogleApi.Books.V1.
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
(type:String.t
, default:nil
) - Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty. -
beforeSelectedText
(type:String.t
, default:nil
) - Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty. -
clientVersionRanges
(type:GoogleApi.Books.V1.Model.AnnotationClientVersionRanges.t
, default:nil
) - Selection ranges sent from the client. -
created
(type:String.t
, default:nil
) - Timestamp for the created time of this annotation. -
currentVersionRanges
(type:GoogleApi.Books.V1.Model.AnnotationCurrentVersionRanges.t
, default:nil
) - Selection ranges for the most recent content version. -
data
(type:String.t
, default:nil
) - User-created data for this annotation. -
deleted
(type:boolean()
, default:nil
) - Indicates that this annotation is deleted. -
highlightStyle
(type:String.t
, default:nil
) - The highlight style for this annotation. -
id
(type:String.t
, default:nil
) - Id of this annotation, in the form of a GUID. -
kind
(type:String.t
, default:nil
) - Resource type. -
layerId
(type:String.t
, default:nil
) - The layer this annotation is for. -
layerSummary
(type:GoogleApi.Books.V1.Model.AnnotationLayerSummary.t
, default:nil
) - -
pageIds
(type:list(String.t)
, default:nil
) - Pages that this annotation spans. -
selectedText
(type:String.t
, default:nil
) - Excerpt from the volume. -
selfLink
(type:String.t
, default:nil
) - URL to this resource. -
updated
(type:String.t
, default:nil
) - Timestamp for the last time this annotation was modified. -
volumeId
(type:String.t
, default:nil
) - The volume that this annotation belongs to.
Selection ranges sent from the client.
Selection ranges for the most recent content version.
Attributes
-
allowedCharacterCount
(type:integer()
, default:nil
) - Maximum allowed characters on this layer, especially for the "copy" layer. -
limitType
(type:String.t
, default:nil
) - Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer. -
remainingCharacterCount
(type:integer()
, default:nil
) - Remaining allowed characters on this layer, especially for the "copy" layer.
Attributes
-
items
(type:list(GoogleApi.Books.V1.Model.Annotation.t)
, default:nil
) - A list of annotations. -
kind
(type:String.t
, default:nil
) - Resource type. -
nextPageToken
(type:String.t
, default:nil
) - Token to pass in for pagination for the next page. This will not be present if this request does not have more results. -
totalItems
(type:integer()
, default:nil
) - Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.
Attributes
-
items
(type:list(GoogleApi.Books.V1.Model.GeoAnnotationdata.t)
, default:nil
) - A list of Annotation Data. -
kind
(type:String.t
, default:nil
) - Resource type -
nextPageToken
(type:String.t
, default:nil
) - Token to pass in for pagination for the next page. This will not be present if this request does not have more results. -
totalItems
(type:integer()
, default:nil
) - The total number of volume annotations found.
Attributes
-
endOffset
(type:String.t
, default:nil
) - The offset from the ending position. -
endPosition
(type:String.t
, default:nil
) - The ending position for the range. -
startOffset
(type:String.t
, default:nil
) - The offset from the starting position. -
startPosition
(type:String.t
, default:nil
) - The starting position for the range.
Attributes
-
access
(type:String.t
, default:nil
) - Whether this bookshelf is PUBLIC or PRIVATE. -
created
(type:String.t
, default:nil
) - Created time for this bookshelf (formatted UTC timestamp with millisecond resolution). -
description
(type:String.t
, default:nil
) - Description of this bookshelf. -
id
(type:integer()
, default:nil
) - Id of this bookshelf, only unique by user. -
kind
(type:String.t
, default:nil
) - Resource type for bookshelf metadata. -
selfLink
(type:String.t
, default:nil
) - URL to this resource. -
title
(type:String.t
, default:nil
) - Title of this bookshelf. -
updated
(type:String.t
, default:nil
) - Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution). -
volumeCount
(type:integer()
, default:nil
) - Number of volumes in this bookshelf. -
volumesLastUpdated
(type:String.t
, default:nil
) - Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
Attributes
-
deviceAllowed
(type:boolean()
, default:nil
) - Whether access is granted for this (user, device, volume). -
kind
(type:String.t
, default:nil
) - Resource type. -
maxConcurrentDevices
(type:integer()
, default:nil
) - The maximum number of concurrent access licenses for this volume. -
message
(type:String.t
, default:nil
) - Error/warning message. -
nonce
(type:String.t
, default:nil
) - Client nonce for verification. Download access and client-validation only. -
reasonCode
(type:String.t
, default:nil
) - Error/warning reason code. -
restricted
(type:boolean()
, default:nil
) - Whether this volume has any concurrent access restrictions. -
signature
(type:String.t
, default:nil
) - Response signature. -
source
(type:String.t
, default:nil
) - Client app identifier for verification. Download access and client-validation only. -
timeWindowSeconds
(type:integer()
, default:nil
) - Time in seconds for license auto-expiration. -
volumeId
(type:String.t
, default:nil
) - Identifies the volume for which this entry applies.
Attributes
-
annotationType
(type:String.t
, default:nil
) - The type of annotation this data is for. -
data
(type:GoogleApi.Books.V1.Model.Dictlayerdata.t
, default:nil
) - JSON encoded data for this dictionary annotation data. Emitted with name 'data' in JSON output. Either this or geo_data will be populated. -
encodedData
(type:String.t
, default:nil
) - Base64 encoded data for this annotation data. -
id
(type:String.t
, default:nil
) - Unique id for this annotation data. -
kind
(type:String.t
, default:nil
) - Resource Type -
layerId
(type:String.t
, default:nil
) - The Layer id for this data. * -
selfLink
(type:String.t
, default:nil
) - URL for this resource. * -
updated
(type:String.t
, default:nil
) - Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). -
volumeId
(type:String.t
, default:nil
) - The volume id for this data. *
The source, url and attribution for this dictionary data.
Attributes
-
derivatives
(type:list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsDerivatives.t)
, default:nil
) - -
examples
(type:list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsExamples.t)
, default:nil
) - -
senses
(type:list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsSenses.t)
, default:nil
) - -
source
(type:GoogleApi.Books.V1.Model.DictlayerdataDictWordsSource.t
, default:nil
) - The words with different meanings but not related words, e.g. "go" (game) and "go" (verb).
Attributes
-
conjugations
(type:list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsSensesConjugations.t)
, default:nil
) - -
definitions
(type:list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsSensesDefinitions.t)
, default:nil
) - -
partOfSpeech
(type:String.t
, default:nil
) - -
pronunciation
(type:String.t
, default:nil
) - -
pronunciationUrl
(type:String.t
, default:nil
) - -
source
(type:GoogleApi.Books.V1.Model.DictlayerdataDictWordsSensesSource.t
, default:nil
) - -
syllabification
(type:String.t
, default:nil
) - -
synonyms
(type:list(GoogleApi.Books.V1.Model.DictlayerdataDictWordsSensesSynonyms.t)
, default:nil
) -
The words with different meanings but not related words, e.g. "go" (game) and "go" (verb).
Attributes
-
banner_with_content_container
(type:GoogleApi.Books.V1.Model.DiscoveryclustersClustersBannerWithContentContainer.t
, default:nil
) - -
subTitle
(type:String.t
, default:nil
) - -
title
(type:String.t
, default:nil
) - -
totalVolumes
(type:integer()
, default:nil
) - -
uid
(type:String.t
, default:nil
) - -
volumes
(type:list(GoogleApi.Books.V1.Model.Volume.t)
, default:nil
) -
Attributes
-
deviceAllowed
(type:boolean()
, default:nil
) - If restricted, whether access is granted for this (user, device, volume). -
downloadsAcquired
(type:integer()
, default:nil
) - If restricted, the number of content download licenses already acquired (including the requesting client, if licensed). -
justAcquired
(type:boolean()
, default:nil
) - If deviceAllowed, whether access was just acquired with this request. -
kind
(type:String.t
, default:nil
) - Resource type. -
maxDownloadDevices
(type:integer()
, default:nil
) - If restricted, the maximum number of content download licenses for this volume. -
message
(type:String.t
, default:nil
) - Error/warning message. -
nonce
(type:String.t
, default:nil
) - Client nonce for verification. Download access and client-validation only. -
reasonCode
(type:String.t
, default:nil
) - Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS -
restricted
(type:boolean()
, default:nil
) - Whether this volume has any download access restrictions. -
signature
(type:String.t
, default:nil
) - Response signature. -
source
(type:String.t
, default:nil
) - Client app identifier for verification. Download access and client-validation only. -
volumeId
(type:String.t
, default:nil
) - Identifies the volume for which this entry applies.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Family membership info of the user that made the request.
Attributes
-
annotationType
(type:String.t
, default:nil
) - The type of annotation this data is for. -
data
(type:GoogleApi.Books.V1.Model.Geolayerdata.t
, default:nil
) - JSON encoded data for this geo annotation data. Emitted with name 'data' in JSON output. Either this or dict_data will be populated. -
encodedData
(type:String.t
, default:nil
) - Base64 encoded data for this annotation data. -
id
(type:String.t
, default:nil
) - Unique id for this annotation data. -
kind
(type:String.t
, default:nil
) - Resource Type -
layerId
(type:String.t
, default:nil
) - The Layer id for this data. * -
selfLink
(type:String.t
, default:nil
) - URL for this resource. * -
updated
(type:String.t
, default:nil
) - Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). -
volumeId
(type:String.t
, default:nil
) - The volume id for this data. *
Attributes
-
lang
(type:String.t
, default:nil
) - The language of the information url and description. -
previewImageUrl
(type:String.t
, default:nil
) - The URL for the preview image information. -
snippet
(type:String.t
, default:nil
) - The description for this location. -
snippetUrl
(type:String.t
, default:nil
) - The URL for information for this location. Ex: wikipedia link. -
title
(type:String.t
, default:nil
) - The display title and localized canonical name to use when searching for this entity on Google search.
Attributes
-
boundary
(type:list(String.t)
, default:nil
) - The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates. -
cachePolicy
(type:String.t
, default:nil
) - The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER -
countryCode
(type:String.t
, default:nil
) - The country code of the location. -
latitude
(type:float()
, default:nil
) - The latitude of the location. -
longitude
(type:float()
, default:nil
) - The longitude of the location. -
mapType
(type:String.t
, default:nil
) - The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN -
viewport
(type:GoogleApi.Books.V1.Model.GeolayerdataGeoViewport.t
, default:nil
) - The viewport for showing this location. This is a latitude, longitude rectangle. -
zoom
(type:integer()
, default:nil
) - 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
The viewport for showing this location. This is a latitude, longitude rectangle.
Attributes
-
annotationCount
(type:integer()
, default:nil
) - The number of annotations for this layer. -
annotationTypes
(type:list(String.t)
, default:nil
) - The list of annotation types contained for this layer. -
annotationsDataLink
(type:String.t
, default:nil
) - Link to get data for this annotation. -
annotationsLink
(type:String.t
, default:nil
) - The link to get the annotations for this layer. -
contentVersion
(type:String.t
, default:nil
) - The content version this resource is for. -
dataCount
(type:integer()
, default:nil
) - The number of data items for this layer. -
id
(type:String.t
, default:nil
) - Unique id of this layer summary. -
kind
(type:String.t
, default:nil
) - Resource Type -
layerId
(type:String.t
, default:nil
) - The layer id for this summary. -
selfLink
(type:String.t
, default:nil
) - URL to this resource. -
updated
(type:String.t
, default:nil
) - Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format). -
volumeAnnotationsVersion
(type:String.t
, default:nil
) - The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately. -
volumeId
(type:String.t
, default:nil
) - The volume id this resource is for.
Attributes
-
body
(type:String.t
, default:nil
) - -
crmExperimentIds
(type:list(String.t)
, default:nil
) - The list of crm experiment ids. -
doc_id
(type:String.t
, default:nil
) - -
doc_type
(type:String.t
, default:nil
) - -
dont_show_notification
(type:boolean()
, default:nil
) - -
iconUrl
(type:String.t
, default:nil
) - -
is_document_mature
(type:boolean()
, default:nil
) - -
kind
(type:String.t
, default:nil
) - Resource type. -
notificationGroup
(type:String.t
, default:nil
) - -
notification_type
(type:String.t
, default:nil
) - -
pcampaign_id
(type:String.t
, default:nil
) - -
reason
(type:String.t
, default:nil
) - -
show_notification_settings_action
(type:boolean()
, default:nil
) - -
targetUrl
(type:String.t
, default:nil
) - -
timeToExpireMs
(type:String.t
, default:nil
) - -
title
(type:String.t
, default:nil
) -
Attributes
-
epubCfiPosition
(type:String.t
, default:nil
) - Position in an EPUB as a CFI. -
gbImagePosition
(type:String.t
, default:nil
) - Position in a volume for image-based content. -
gbTextPosition
(type:String.t
, default:nil
) - Position in a volume for text-based content. -
kind
(type:String.t
, default:nil
) - Resource type for a reading position. -
pdfPosition
(type:String.t
, default:nil
) - Position in a PDF file. -
updated
(type:String.t
, default:nil
) - Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution). -
volumeId
(type:String.t
, default:nil
) - Volume id associated with this reading position.
Attributes
-
concurrentAccess
(type:GoogleApi.Books.V1.Model.ConcurrentAccessRestriction.t
, default:nil
) - A concurrent access response. -
downloadAccess
(type:GoogleApi.Books.V1.Model.DownloadAccessRestriction.t
, default:nil
) - A download access response. -
kind
(type:String.t
, default:nil
) - Resource type.
Attributes
-
author
(type:GoogleApi.Books.V1.Model.ReviewAuthor.t
, default:nil
) - Author of this review. -
content
(type:String.t
, default:nil
) - Review text. -
date
(type:String.t
, default:nil
) - Date of this review. -
fullTextUrl
(type:String.t
, default:nil
) - URL for the full review text, for reviews gathered from the web. -
kind
(type:String.t
, default:nil
) - Resource type for a review. -
rating
(type:String.t
, default:nil
) - Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED. -
source
(type:GoogleApi.Books.V1.Model.ReviewSource.t
, default:nil
) - Information regarding the source of this review, when the review is not from a Google Books user. -
title
(type:String.t
, default:nil
) - Title for this review. -
type
(type:String.t
, default:nil
) - Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER. -
volumeId
(type:String.t
, default:nil
) - Volume that this review is for.
Author of this review.
Information regarding the source of this review, when the review is not from a Google Books user.
Attributes
-
bannerImageUrl
(type:String.t
, default:nil
) - -
eligibleForSubscription
(type:boolean()
, default:nil
) - -
imageUrl
(type:String.t
, default:nil
) - -
isComplete
(type:boolean()
, default:nil
) - -
seriesFormatType
(type:String.t
, default:nil
) - -
seriesId
(type:String.t
, default:nil
) - -
seriesSubscriptionReleaseInfo
(type:GoogleApi.Books.V1.Model.SeriesSeriesSeriesSubscriptionReleaseInfo.t
, default:nil
) - -
seriesType
(type:String.t
, default:nil
) - -
subscriptionId
(type:String.t
, default:nil
) - -
title
(type:String.t
, default:nil
) -
Attributes
-
cancelTime
(type:String.t
, default:nil
) - -
currentReleaseInfo
(type:GoogleApi.Books.V1.Model.SeriesSeriesSeriesSubscriptionReleaseInfoCurrentReleaseInfo.t
, default:nil
) - -
nextReleaseInfo
(type:GoogleApi.Books.V1.Model.SeriesSeriesSeriesSubscriptionReleaseInfoNextReleaseInfo.t
, default:nil
) - -
seriesSubscriptionType
(type:String.t
, default:nil
) -
User settings in sub-objects, each for different purposes.
Attributes
-
matchMyInterests
(type:GoogleApi.Books.V1.Model.UsersettingsNotificationMatchMyInterests.t
, default:nil
) - -
moreFromAuthors
(type:GoogleApi.Books.V1.Model.UsersettingsNotificationMoreFromAuthors.t
, default:nil
) - -
moreFromSeries
(type:GoogleApi.Books.V1.Model.UsersettingsNotificationMoreFromSeries.t
, default:nil
) - -
priceDrop
(type:GoogleApi.Books.V1.Model.UsersettingsNotificationPriceDrop.t
, default:nil
) - -
rewardExpirations
(type:GoogleApi.Books.V1.Model.UsersettingsNotificationRewardExpirations.t
, default:nil
) -
Attributes
-
accessInfo
(type:GoogleApi.Books.V1.Model.VolumeAccessInfo.t
, default: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.). -
etag
(type:String.t
, default:nil
) - Opaque identifier for a specific version of a volume resource. (In LITE projection) -
id
(type:String.t
, default:nil
) - Unique identifier for a volume. (In LITE projection.) -
kind
(type:String.t
, default:nil
) - Resource type for a volume. (In LITE projection.) -
layerInfo
(type:GoogleApi.Books.V1.Model.VolumeLayerInfo.t
, default:nil
) - What layers exist in this volume and high level information about them. -
recommendedInfo
(type:GoogleApi.Books.V1.Model.VolumeRecommendedInfo.t
, default:nil
) - Recommendation related information for this volume. -
saleInfo
(type:GoogleApi.Books.V1.Model.VolumeSaleInfo.t
, default:nil
) - Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries). -
searchInfo
(type:GoogleApi.Books.V1.Model.VolumeSearchInfo.t
, default:nil
) - Search result information related to this volume. -
selfLink
(type:String.t
, default:nil
) - URL to this resource. (In LITE projection.) -
userInfo
(type:GoogleApi.Books.V1.Model.VolumeUserInfo.t
, default:nil
) - User specific information related to this volume. (e.g. page this user last read or whether they purchased this book) -
volumeInfo
(type:GoogleApi.Books.V1.Model.VolumeVolumeInfo.t
, default:nil
) - General volume information.
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
(type:String.t
, default:nil
) - The layer id of this layer (e.g. "geo"). -
volumeAnnotationsVersion
(type:String.t
, default:nil
) - 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.
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
(type:integer()
, default:nil
) - The finsky offer type (e.g., PURCHASE=0 RENTAL=3) -
giftable
(type:boolean()
, default:nil
) - Indicates whether the offer is giftable. -
listPrice
(type:GoogleApi.Books.V1.Model.VolumeSaleInfoOffersListPrice.t
, default:nil
) - Offer list (=undiscounted) price in Micros. -
rentalDuration
(type:GoogleApi.Books.V1.Model.VolumeSaleInfoOffersRentalDuration.t
, default:nil
) - The rental duration (for rental offers only). -
retailPrice
(type:GoogleApi.Books.V1.Model.VolumeSaleInfoOffersRetailPrice.t
, default:nil
) - Offer retail (=discounted) price in Micros
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.
The reading modes available for this volume.
Attributes
-
annotationDataId
(type:String.t
, default:nil
) - The annotation data id for this volume annotation. -
annotationDataLink
(type:String.t
, default:nil
) - Link to get data for this annotation. -
annotationType
(type:String.t
, default:nil
) - The type of annotation this is. -
contentRanges
(type:GoogleApi.Books.V1.Model.VolumeannotationContentRanges.t
, default:nil
) - The content ranges to identify the selected text. -
data
(type:String.t
, default:nil
) - Data for this annotation. -
deleted
(type:boolean()
, default:nil
) - Indicates that this annotation is deleted. -
id
(type:String.t
, default:nil
) - Unique id of this volume annotation. -
kind
(type:String.t
, default:nil
) - Resource Type -
layerId
(type:String.t
, default:nil
) - The Layer this annotation is for. -
pageIds
(type:list(String.t)
, default:nil
) - Pages the annotation spans. -
selectedText
(type:String.t
, default:nil
) - Excerpt from the volume. -
selfLink
(type:String.t
, default:nil
) - URL to this resource. -
updated
(type:String.t
, default:nil
) - Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). -
volumeId
(type:String.t
, default:nil
) - The Volume this annotation is for.
The content ranges to identify the selected text.
Attributes
-
items
(type:list(GoogleApi.Books.V1.Model.Volumeannotation.t)
, default:nil
) - A list of volume annotations. -
kind
(type:String.t
, default:nil
) - Resource type -
nextPageToken
(type:String.t
, default:nil
) - Token to pass in for pagination for the next page. This will not be present if this request does not have more results. -
totalItems
(type:integer()
, default:nil
) - The total number of volume annotations found. -
version
(type:String.t
, default:nil
) - 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).
Attributes
-
items
(type:list(GoogleApi.Books.V1.Model.Volume.t)
, default:nil
) - A list of volumes. -
kind
(type:String.t
, default:nil
) - Resource type. -
totalItems
(type:integer()
, default:nil
) - Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
Attributes
-
bookDisplayNumber
(type:String.t
, default:nil
) - The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber. -
kind
(type:String.t
, default:nil
) - Resource type. -
shortSeriesBookTitle
(type:String.t
, default:nil
) - Short book title in the context of the series. -
volumeSeries
(type:list(GoogleApi.Books.V1.Model.VolumeseriesinfoVolumeSeries.t)
, default:nil
) -
Attributes
-
issue
(type:list(GoogleApi.Books.V1.Model.VolumeseriesinfoVolumeSeriesIssue.t)
, default:nil
) - List of issues. Applicable only for Collection Edition and Omnibus. -
orderNumber
(type:integer()
, default:nil
) - The book order number in the series. -
seriesBookType
(type:String.t
, default:nil
) - The book type in the context of series. Examples - Single Issue, Collection Edition, etc. -
seriesId
(type:String.t
, default:nil
) - The series id.