1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.onboarding.html">onboarding</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#listCategories">listCategories(locale=None, x__xgafv=None)</a></code></p>
<p class="firstline">List categories for onboarding experience.</p>
<p class="toc_element">
<code><a href="#listCategoryVolumes">listCategoryVolumes(categoryId=None, locale=None, maxAllowedMaturityRating=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List available volumes under categories for onboarding experience.</p>
<p class="toc_element">
<code><a href="#listCategoryVolumes_next">listCategoryVolumes_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="listCategories">listCategories(locale=None, x__xgafv=None)</code>
<pre>List categories for onboarding experience.
Args:
locale: string, ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"items": [ # A list of onboarding categories.
{
"badgeUrl": "A String",
"categoryId": "A String",
"name": "A String",
},
],
"kind": "A String", # Resource type.
}</pre>
</div>
<div class="method">
<code class="details" id="listCategoryVolumes">listCategoryVolumes(categoryId=None, locale=None, maxAllowedMaturityRating=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List available volumes under categories for onboarding experience.
Args:
categoryId: string, List of category ids requested. (repeated)
locale: string, ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.
Allowed values
MAX_ALLOWED_MATURITY_RATING_UNDEFINED -
MATURE - Show books which are rated mature or lower.
not-mature - Show books which are rated not mature.
pageSize: integer, Number of maximum results per page to be included in the response.
pageToken: string, The value of the nextToken from the previous page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"items": [ # A list of volumes.
{
"accessInfo": { # Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).
"accessViewStatus": "A String", # Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.)
"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
"downloadAccess": { # Information about a volume's download license access restrictions.
"deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
"downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
"justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
"kind": "A String", # Resource type.
"maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
"message": "A String", # Error/warning message.
"nonce": "A String", # Client nonce for verification. Download access and client-validation only.
"reasonCode": "A String", # Error/warning reason code. Additional codes may be added in the future. 0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS
"restricted": True or False, # Whether this volume has any download access restrictions.
"signature": "A String", # Response signature.
"source": "A String", # Client app identifier for verification. Download access and client-validation only.
"volumeId": "A String", # Identifies the volume for which this entry applies.
},
"driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
"embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
"epub": { # Information about epub content. (In LITE projection.)
"acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
"downloadLink": "A String", # URL to download epub. (In LITE projection.)
"isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
},
"explicitOfflineLicenseManagement": True or False, # Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it.
"pdf": { # Information about pdf content. (In LITE projection.)
"acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
"downloadLink": "A String", # URL to download pdf. (In LITE projection.)
"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
},
"publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
"quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
"viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
"viewability": "A String", # The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES.
"webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
},
"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
"id": "A String", # Unique identifier for a volume. (In LITE projection.)
"kind": "A String", # Resource type for a volume. (In LITE projection.)
"layerInfo": { # What layers exist in this volume and high level information about them.
"layers": [ # A layer should appear here if and only if the layer exists for this book.
{
"layerId": "A String", # The layer id of this layer (e.g. "geo").
"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
},
],
},
"recommendedInfo": { # Recommendation related information for this volume.
"explanation": "A String", # A text explaining why this volume is recommended.
},
"saleInfo": { # Any information about a volume related to the eBookstore and/or purchaseability. This information can depend on the country where the request originates from (i.e. books may not be for sale in certain countries).
"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
"country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
"listPrice": { # Suggested retail price. (In LITE projection.)
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
},
"offers": [ # Offers available for this volume (sales and rentals).
{
"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
"giftable": True or False, # Indicates whether the offer is giftable.
"listPrice": { # Offer list (=undiscounted) price in Micros.
"amountInMicros": 3.14,
"currencyCode": "A String",
},
"rentalDuration": { # The rental duration (for rental offers only).
"count": 3.14,
"unit": "A String",
},
"retailPrice": { # Offer retail (=discounted) price in Micros
"amountInMicros": 3.14,
"currencyCode": "A String",
},
},
],
"onSaleDate": "A String", # The date on which this book is available for sale.
"retailPrice": { # The actual selling price of the book. This is the same as the suggested retail or list price unless there are offers or discounts on this volume. (In LITE projection.)
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
},
"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
},
"searchInfo": { # Search result information related to this volume.
"textSnippet": "A String", # A text snippet containing the search query.
},
"selfLink": "A String", # URL to this resource. (In LITE projection.)
"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
"acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
"acquisitionType": 42, # How this volume was acquired.
"copy": { # Copy/Paste accounting information.
"allowedCharacterCount": 42,
"limitType": "A String",
"remainingCharacterCount": 42,
"updated": "A String",
},
"entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
"familySharing": { # Information on the ability to share with the family.
"familyRole": "A String", # The role of the user in the family.
"isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
"isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
},
"isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
"isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
"isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
"isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
"isUploaded": True or False, # Whether or not this volume was user uploaded.
"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
"epubCfiPosition": "A String", # Position in an EPUB as a CFI.
"gbImagePosition": "A String", # Position in a volume for image-based content.
"gbTextPosition": "A String", # Position in a volume for text-based content.
"kind": "A String", # Resource type for a reading position.
"pdfPosition": "A String", # Position in a PDF file.
"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
"volumeId": "A String", # Volume id associated with this reading position.
},
"rentalPeriod": { # Period during this book is/was a valid rental.
"endUtcSec": "A String",
"startUtcSec": "A String",
},
"rentalState": "A String", # Whether this book is an active or an expired rental.
"review": { # This user's review of this volume, if one exists.
"author": { # Author of this review.
"displayName": "A String", # Name of this person.
},
"content": "A String", # Review text.
"date": "A String", # Date of this review.
"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
"kind": "A String", # Resource type for a review.
"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
"source": { # Information regarding the source of this review, when the review is not from a Google Books user.
"description": "A String", # Name of the source.
"extraDescription": "A String", # Extra text about the source of the review.
"url": "A String", # URL of the source of the review.
},
"title": "A String", # Title for this review.
"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
"volumeId": "A String", # Volume that this review is for.
},
"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).
"userUploadedVolumeInfo": {
"processingState": "A String",
},
},
"volumeInfo": { # General volume information.
"allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
"A String",
],
"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
"A String",
],
"comicsContent": True or False, # Whether the volume has comics content.
"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
"description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
"dimensions": { # Physical dimensions of this volume.
"height": "A String", # Height or length of this volume (in cm).
"thickness": "A String", # Thickness of this volume (in cm).
"width": "A String", # Width of this volume (in cm).
},
"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
"extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
"large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
},
"industryIdentifiers": [ # Industry standard identifiers for this volume.
{
"identifier": "A String", # Industry specific volume identifier.
"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
},
],
"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
"maturityRating": "A String",
"pageCount": 42, # Total number of pages as per publisher metadata.
"panelizationSummary": { # A top-level summary of the panelization info in this volume.
"containsEpubBubbles": True or False,
"containsImageBubbles": True or False,
"epubBubbleVersion": "A String",
"imageBubbleVersion": "A String",
},
"previewLink": "A String", # URL to preview this volume on the Google Books site.
"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
"printedPageCount": 42, # Total number of printed pages in generated pdf representation.
"publishedDate": "A String", # Date of publication. (In LITE projection.)
"publisher": "A String", # Publisher of this volume. (In LITE projection.)
"ratingsCount": 42, # The number of review ratings for this volume.
"readingModes": { # The reading modes available for this volume.
"image": True or False,
"text": True or False,
},
"samplePageCount": 42, # Total number of sample pages as per publisher metadata.
"seriesInfo": {
"bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
"kind": "A String", # Resource type.
"shortSeriesBookTitle": "A String", # Short book title in the context of the series.
"volumeSeries": [
{
"issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
{
"issueDisplayNumber": "A String",
"issueOrderNumber": 42,
},
],
"orderNumber": 42, # The book order number in the series.
"seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
"seriesId": "A String", # The series id.
},
],
},
"subtitle": "A String", # Volume subtitle. (In LITE projection.)
"title": "A String", # Volume title. (In LITE projection.)
},
},
],
"kind": "A String", # Resource type.
"nextPageToken": "A String",
}</pre>
</div>
<div class="method">
<code class="details" id="listCategoryVolumes_next">listCategoryVolumes_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
