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