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