Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 7d5badbac4f925c1867e20b50cf0a1a70a5fb573 / . / docs / dyn / books_v1.volumes.html
blob: 718d57c196e7c7d9d32ee5d8a3e72245b3c1908a [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.volumes.html">volumes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="books_v1.volumes.associated.html">associated()</a></code>
79</p>
80<p class="firstline">Returns the associated Resource.</p>
81
82<p class="toc_element">
83 <code><a href="books_v1.volumes.mybooks.html">mybooks()</a></code>
84</p>
85<p class="firstline">Returns the mybooks Resource.</p>
86
87<p class="toc_element">
88 <code><a href="books_v1.volumes.recommended.html">recommended()</a></code>
89</p>
90<p class="firstline">Returns the recommended Resource.</p>
91
92<p class="toc_element">
93 <code><a href="books_v1.volumes.useruploaded.html">useruploaded()</a></code>
94</p>
95<p class="firstline">Returns the useruploaded Resource.</p>
96
97<p class="toc_element">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]98 <code><a href="#get">get(volumeId, user_library_consistent_read=None, projection=None, source=None, country=None, includeNonComicsSeries=None, partner=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]99<p class="firstline">Gets volume information for a single volume.</p>
100<p class="toc_element">
101 <code><a href="#list">list(q, orderBy=None, projection=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, printType=None, filter=None)</a></code></p>
102<p class="firstline">Performs a book search.</p>
103<h3>Method Details</h3>
104<div class="method">
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]105 <code class="details" id="get">get(volumeId, user_library_consistent_read=None, projection=None, source=None, country=None, includeNonComicsSeries=None, partner=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]106 <pre>Gets volume information for a single volume.
107
108Args:
109 volumeId: string, ID of volume to retrieve. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]110 user_library_consistent_read: boolean, A parameter
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111 projection: string, Restrict information returned to a set of selected fields.
112 Allowed values
113 full - Includes all volume data.
114 lite - Includes a subset of fields in volumeInfo and accessInfo.
115 source: string, String to identify the originator of this request.
116 country: string, ISO-3166-1 code to override the IP-based location.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]117 includeNonComicsSeries: boolean, Set to true to include non-comics series. Defaults to false.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]118 partner: string, Brand results for partner ID.
119
120Returns:
121 An object of the form:
122
123 {
124 "kind": "books#volume", # Resource type for a volume. (In LITE projection.)
125 "accessInfo": { # 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.).
126 "webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
127 "publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
128 "embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
129 "downloadAccess": { # Information about a volume's download license access restrictions.
130 "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
131 "kind": "books#downloadAccessRestriction", # Resource type.
132 "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
133 "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
134 "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
135 "signature": "A String", # Response signature.
136 "volumeId": "A String", # Identifies the volume for which this entry applies.
137 "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
138 "source": "A String", # Client app identifier for verification. Download access and client-validation only.
139 "restricted": True or False, # Whether this volume has any download access restrictions.
140 "reasonCode": "A String", # 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
141 "message": "A String", # Error/warning message.
142 },
143 "country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
144 "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
145 "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
146 "textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
147 "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
148 "pdf": { # Information about pdf content. (In LITE projection.)
149 "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
150 "downloadLink": "A String", # URL to download pdf. (In LITE projection.)
151 "acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
152 },
153 "explicitOfflineLicenseManagement": True or False, # 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.
154 "viewability": "A String", # 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.
155 "epub": { # Information about epub content. (In LITE projection.)
156 "isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
157 "downloadLink": "A String", # URL to download epub. (In LITE projection.)
158 "acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
159 },
160 "accessViewStatus": "A String", # 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.)
161 },
162 "searchInfo": { # Search result information related to this volume.
163 "textSnippet": "A String", # A text snippet containing the search query.
164 },
165 "saleInfo": { # 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).
166 "country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
167 "retailPrice": { # 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.)
168 "amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
169 "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
170 },
171 "isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
172 "offers": [ # Offers available for this volume (sales and rentals).
173 {
174 "rentalDuration": { # The rental duration (for rental offers only).
175 "count": 3.14,
176 "unit": "A String",
177 },
178 "retailPrice": { # Offer retail (=discounted) price in Micros
179 "currencyCode": "A String",
180 "amountInMicros": 3.14,
181 },
182 "listPrice": { # Offer list (=undiscounted) price in Micros.
183 "currencyCode": "A String",
184 "amountInMicros": 3.14,
185 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]186 "giftable": True or False, # Indicates whether the offer is giftable.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]187 "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
188 },
189 ],
190 "saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
191 "buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
192 "onSaleDate": "A String", # The date on which this book is available for sale.
193 "listPrice": { # Suggested retail price. (In LITE projection.)
194 "amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
195 "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
196 },
197 },
198 "etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
199 "selfLink": "A String", # URL to this resource. (In LITE projection.)
200 "volumeInfo": { # General volume information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]201 "subtitle": "A String", # Volume subtitle. (In LITE projection.)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]202 "pageCount": 42, # Total number of pages as per publisher metadata.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]203 "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]204 "seriesInfo": {
205 "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
206 "kind": "books#volume_series_info", # Resource type.
207 "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
208 "volumeSeries": [
209 {
210 "orderNumber": 42, # The book order number in the series.
211 "seriesId": "A String", # The series id.
212 "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
213 {
214 "issueOrderNumber": 42,
215 "issueDisplayNumber": "A String",
216 },
217 ],
218 "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
219 },
220 ],
221 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]222 "dimensions": { # Physical dimensions of this volume.
223 "width": "A String", # Width of this volume (in cm).
224 "thickness": "A String", # Thickness of this volume (in cm).
225 "height": "A String", # Height or length of this volume (in cm).
226 },
227 "previewLink": "A String", # URL to preview this volume on the Google Books site.
228 "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
229 "industryIdentifiers": [ # Industry standard identifiers for this volume.
230 {
231 "identifier": "A String", # Industry specific volume identifier.
232 "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
233 },
234 ],
235 "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
236 "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
237 "publishedDate": "A String", # Date of publication. (In LITE projection.)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]238 "imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
239 "medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
240 "smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
241 "large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
242 "extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
243 "small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
244 "thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
245 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]246 "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
247 "A String",
248 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]249 "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
250 "A String",
251 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]252 "panelizationSummary": { # A top-level summary of the panelization info in this volume.
253 "containsEpubBubbles": True or False,
254 "epubBubbleVersion": "A String",
255 "imageBubbleVersion": "A String",
256 "containsImageBubbles": True or False,
257 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]258 "publisher": "A String", # Publisher of this volume. (In LITE projection.)
259 "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]260 "maturityRating": "A String",
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]261 "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]262 "title": "A String", # Volume title. (In LITE projection.)
263 "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]264 "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]265 "readingModes": "", # The reading modes available for this volume.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]266 "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]267 "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]268 "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
269 "ratingsCount": 42, # The number of review ratings for this volume.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]270 },
271 "recommendedInfo": { # Recommendation related information for this volume.
272 "explanation": "A String", # A text explaining why this volume is recommended.
273 },
274 "id": "A String", # Unique identifier for a volume. (In LITE projection.)
275 "layerInfo": { # What layers exist in this volume and high level information about them.
276 "layers": [ # A layer should appear here if and only if the layer exists for this book.
277 {
278 "volumeAnnotationsVersion": "A String", # 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.
279 "layerId": "A String", # The layer id of this layer (e.g. "geo").
280 },
281 ],
282 },
283 "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]284 "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]285 "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]286 "acquisitionType": 42, # How this volume was acquired.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]287 "updated": "A String", # 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).
288 "userUploadedVolumeInfo": {
289 "processingState": "A String",
290 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]291 "rentalPeriod": { # Period during this book is/was a valid rental.
292 "startUtcSec": "A String",
293 "endUtcSec": "A String",
294 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]295 "familySharing": { # Information on the ability to share with the family.
296 "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
297 "familyRole": "A String", # The role of the user in the family.
298 "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
299 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]300 "rentalState": "A String", # Whether this book is an active or an expired rental.
301 "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
302 "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
303 "kind": "books#readingPosition", # Resource type for a reading position.
304 "gbImagePosition": "A String", # Position in a volume for image-based content.
305 "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
306 "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
307 "volumeId": "A String", # Volume id associated with this reading position.
308 "pdfPosition": "A String", # Position in a PDF file.
309 "gbTextPosition": "A String", # Position in a volume for text-based content.
310 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]311 "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
312 "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]313 "review": { # This user's review of this volume, if one exists.
314 "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
315 "kind": "books#review", # Resource type for a review.
316 "author": { # Author of this review.
317 "displayName": "A String", # Name of this person.
318 },
319 "title": "A String", # Title for this review.
320 "volumeId": "A String", # Volume that this review is for.
321 "content": "A String", # Review text.
322 "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
323 "extraDescription": "A String", # Extra text about the source of the review.
324 "url": "A String", # URL of the source of the review.
325 "description": "A String", # Name of the source.
326 },
327 "date": "A String", # Date of this review.
328 "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
329 "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
330 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]331 "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
332 "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]333 "copy": { # Copy/Paste accounting information.
334 "limitType": "A String",
335 "remainingCharacterCount": 42,
336 "updated": "A String",
337 "allowedCharacterCount": 42,
338 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]339 "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]340 "isUploaded": True or False, # Whether or not this volume was user uploaded.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]341 "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]342 },
343 }</pre>
344</div>
345
346<div class="method">
347 <code class="details" id="list">list(q, orderBy=None, projection=None, showPreorders=None, download=None, startIndex=None, partner=None, source=None, maxResults=None, libraryRestrict=None, langRestrict=None, printType=None, filter=None)</code>
348 <pre>Performs a book search.
349
350Args:
351 q: string, Full-text search query string. (required)
352 orderBy: string, Sort search results.
353 Allowed values
354 newest - Most recently published.
355 relevance - Relevance to search terms.
356 projection: string, Restrict information returned to a set of selected fields.
357 Allowed values
358 full - Includes all volume data.
359 lite - Includes a subset of fields in volumeInfo and accessInfo.
360 showPreorders: boolean, Set to true to show books available for preorder. Defaults to false.
361 download: string, Restrict to volumes by download availability.
362 Allowed values
363 epub - All volumes with epub.
364 startIndex: integer, Index of the first result to return (starts at 0)
365 partner: string, Restrict and brand results for partner ID.
366 source: string, String to identify the originator of this request.
367 maxResults: integer, Maximum number of results to return.
368 libraryRestrict: string, Restrict search to this user's library.
369 Allowed values
370 my-library - Restrict to the user's library, any shelf.
371 no-restrict - Do not restrict based on user's library.
372 langRestrict: string, Restrict results to books with this language code.
373 printType: string, Restrict to books or magazines.
374 Allowed values
375 all - All volume content types.
376 books - Just books.
377 magazines - Just magazines.
378 filter: string, Filter search results.
379 Allowed values
380 ebooks - All Google eBooks.
381 free-ebooks - Google eBook with full volume text viewability.
382 full - Public can view entire volume text.
383 paid-ebooks - Google eBook with a price.
384 partial - Public able to see parts of text.
385
386Returns:
387 An object of the form:
388
389 {
390 "totalItems": 42, # Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
391 "items": [ # A list of volumes.
392 {
393 "kind": "books#volume", # Resource type for a volume. (In LITE projection.)
394 "accessInfo": { # 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.).
395 "webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
396 "publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
397 "embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
398 "downloadAccess": { # Information about a volume's download license access restrictions.
399 "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
400 "kind": "books#downloadAccessRestriction", # Resource type.
401 "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
402 "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
403 "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
404 "signature": "A String", # Response signature.
405 "volumeId": "A String", # Identifies the volume for which this entry applies.
406 "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
407 "source": "A String", # Client app identifier for verification. Download access and client-validation only.
408 "restricted": True or False, # Whether this volume has any download access restrictions.
409 "reasonCode": "A String", # 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
410 "message": "A String", # Error/warning message.
411 },
412 "country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
413 "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
414 "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
415 "textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
416 "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
417 "pdf": { # Information about pdf content. (In LITE projection.)
418 "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
419 "downloadLink": "A String", # URL to download pdf. (In LITE projection.)
420 "acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
421 },
422 "explicitOfflineLicenseManagement": True or False, # 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.
423 "viewability": "A String", # 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.
424 "epub": { # Information about epub content. (In LITE projection.)
425 "isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
426 "downloadLink": "A String", # URL to download epub. (In LITE projection.)
427 "acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
428 },
429 "accessViewStatus": "A String", # 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.)
430 },
431 "searchInfo": { # Search result information related to this volume.
432 "textSnippet": "A String", # A text snippet containing the search query.
433 },
434 "saleInfo": { # 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).
435 "country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
436 "retailPrice": { # 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.)
437 "amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
438 "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
439 },
440 "isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
441 "offers": [ # Offers available for this volume (sales and rentals).
442 {
443 "rentalDuration": { # The rental duration (for rental offers only).
444 "count": 3.14,
445 "unit": "A String",
446 },
447 "retailPrice": { # Offer retail (=discounted) price in Micros
448 "currencyCode": "A String",
449 "amountInMicros": 3.14,
450 },
451 "listPrice": { # Offer list (=undiscounted) price in Micros.
452 "currencyCode": "A String",
453 "amountInMicros": 3.14,
454 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]455 "giftable": True or False, # Indicates whether the offer is giftable.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]456 "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
457 },
458 ],
459 "saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
460 "buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
461 "onSaleDate": "A String", # The date on which this book is available for sale.
462 "listPrice": { # Suggested retail price. (In LITE projection.)
463 "amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
464 "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
465 },
466 },
467 "etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
468 "selfLink": "A String", # URL to this resource. (In LITE projection.)
469 "volumeInfo": { # General volume information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]470 "subtitle": "A String", # Volume subtitle. (In LITE projection.)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]471 "pageCount": 42, # Total number of pages as per publisher metadata.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]472 "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]473 "seriesInfo": {
474 "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
475 "kind": "books#volume_series_info", # Resource type.
476 "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
477 "volumeSeries": [
478 {
479 "orderNumber": 42, # The book order number in the series.
480 "seriesId": "A String", # The series id.
481 "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
482 {
483 "issueOrderNumber": 42,
484 "issueDisplayNumber": "A String",
485 },
486 ],
487 "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
488 },
489 ],
490 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]491 "dimensions": { # Physical dimensions of this volume.
492 "width": "A String", # Width of this volume (in cm).
493 "thickness": "A String", # Thickness of this volume (in cm).
494 "height": "A String", # Height or length of this volume (in cm).
495 },
496 "previewLink": "A String", # URL to preview this volume on the Google Books site.
497 "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
498 "industryIdentifiers": [ # Industry standard identifiers for this volume.
499 {
500 "identifier": "A String", # Industry specific volume identifier.
501 "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
502 },
503 ],
504 "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
505 "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
506 "publishedDate": "A String", # Date of publication. (In LITE projection.)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]507 "imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
508 "medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
509 "smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
510 "large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
511 "extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
512 "small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
513 "thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
514 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]515 "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
516 "A String",
517 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]518 "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
519 "A String",
520 ],
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]521 "panelizationSummary": { # A top-level summary of the panelization info in this volume.
522 "containsEpubBubbles": True or False,
523 "epubBubbleVersion": "A String",
524 "imageBubbleVersion": "A String",
525 "containsImageBubbles": True or False,
526 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]527 "publisher": "A String", # Publisher of this volume. (In LITE projection.)
528 "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]529 "maturityRating": "A String",
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]530 "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]531 "title": "A String", # Volume title. (In LITE projection.)
532 "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]533 "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame^]534 "readingModes": "", # The reading modes available for this volume.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]535 "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]536 "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]537 "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
538 "ratingsCount": 42, # The number of review ratings for this volume.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]539 },
540 "recommendedInfo": { # Recommendation related information for this volume.
541 "explanation": "A String", # A text explaining why this volume is recommended.
542 },
543 "id": "A String", # Unique identifier for a volume. (In LITE projection.)
544 "layerInfo": { # What layers exist in this volume and high level information about them.
545 "layers": [ # A layer should appear here if and only if the layer exists for this book.
546 {
547 "volumeAnnotationsVersion": "A String", # 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.
548 "layerId": "A String", # The layer id of this layer (e.g. "geo").
549 },
550 ],
551 },
552 "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]553 "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]554 "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]555 "acquisitionType": 42, # How this volume was acquired.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]556 "updated": "A String", # 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).
557 "userUploadedVolumeInfo": {
558 "processingState": "A String",
559 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]560 "rentalPeriod": { # Period during this book is/was a valid rental.
561 "startUtcSec": "A String",
562 "endUtcSec": "A String",
563 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]564 "familySharing": { # Information on the ability to share with the family.
565 "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
566 "familyRole": "A String", # The role of the user in the family.
567 "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
568 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]569 "rentalState": "A String", # Whether this book is an active or an expired rental.
570 "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
571 "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
572 "kind": "books#readingPosition", # Resource type for a reading position.
573 "gbImagePosition": "A String", # Position in a volume for image-based content.
574 "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
575 "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
576 "volumeId": "A String", # Volume id associated with this reading position.
577 "pdfPosition": "A String", # Position in a PDF file.
578 "gbTextPosition": "A String", # Position in a volume for text-based content.
579 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]580 "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
581 "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]582 "review": { # This user's review of this volume, if one exists.
583 "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
584 "kind": "books#review", # Resource type for a review.
585 "author": { # Author of this review.
586 "displayName": "A String", # Name of this person.
587 },
588 "title": "A String", # Title for this review.
589 "volumeId": "A String", # Volume that this review is for.
590 "content": "A String", # Review text.
591 "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
592 "extraDescription": "A String", # Extra text about the source of the review.
593 "url": "A String", # URL of the source of the review.
594 "description": "A String", # Name of the source.
595 },
596 "date": "A String", # Date of this review.
597 "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
598 "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
599 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]600 "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
601 "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]602 "copy": { # Copy/Paste accounting information.
603 "limitType": "A String",
604 "remainingCharacterCount": 42,
605 "updated": "A String",
606 "allowedCharacterCount": 42,
607 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]608 "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]609 "isUploaded": True or False, # Whether or not this volume was user uploaded.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]610 "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]611 },
612 },
613 ],
614 "kind": "books#volumes", # Resource type.
615 }</pre>
616</div>
617
618</body></html>