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