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