Blame - docs/dyn/books_v1.volumes.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

102

<p class="firstline">Gets volume information for a single volume.</p>

103

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

104

<code><a href="#list">list(q, langRestrict=None, orderBy=None, source=None, startIndex=None, showPreorders=None, maxResults=None, libraryRestrict=None, projection=None, download=None, filter=None, printType=None, maxAllowedMaturityRating=None, partner=None, x__xgafv=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

105

<p class="firstline">Performs a book search.</p>

106

<h3>Method Details</h3>

107

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

108

<code class="details" id="close">close()</code>

109

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

113

<code class="details" id="get">get(volumeId, country=None, user_library_consistent_read=None, partner=None, source=None, includeNonComicsSeries=None, projection=None, x__xgafv=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

114

<pre>Gets volume information for a single volume.

115

116

Args:

117

volumeId: string, ID of volume to retrieve. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

118

country: string, ISO-3166-1 code to override the IP-based location.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

119

user_library_consistent_read: boolean, A parameter

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

120

partner: string, Brand results for partner ID.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

121

source: string, string to identify the originator of this request.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

122

includeNonComicsSeries: boolean, Set to true to include non-comics series. Defaults to false.

John Asmuth

2014-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 Kim

2020-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 Kim

2020-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 Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

132

133

Returns:

134

An object of the form:

135

136

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

137

"layerInfo": { # What layers exist in this volume and high level information about them.

138

"layers": [ # A layer should appear here if and only if the layer exists for this book.

139

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

140

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

141

"layerId": "A String", # The layer id of this layer (e.g. "geo").

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

142

},

143

],

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

144

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

145

"recommendedInfo": { # Recommendation related information for this volume.

146

"explanation": "A String", # A text explaining why this volume is recommended.

147

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

148

"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).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

149

"offers": [ # Offers available for this volume (sales and rentals).

150

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

151

"listPrice": { # Offer list (=undiscounted) price in Micros.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

152

"currencyCode": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

153

"amountInMicros": 3.14,

154

},

155

"rentalDuration": { # The rental duration (for rental offers only).

156

"unit": "A String",

157

"count": 3.14,

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

158

},

159

"retailPrice": { # Offer retail (=discounted) price in Micros

160

"currencyCode": "A String",

161

"amountInMicros": 3.14,

162

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

163

"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)

164

"giftable": True or False, # Indicates whether the offer is giftable.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

165

},

166

],

167

"listPrice": { # Suggested retail price. (In LITE projection.)

168

"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)

169

"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)

170

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

171

"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.)

172

"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)

173

"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)

174

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

175

"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

176

"country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)

177

"onSaleDate": "A String", # The date on which this book is available for sale.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

178

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

179

"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

180

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

181

"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)

182

"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)

183

"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)

184

"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).

185

"gbTextPosition": "A String", # Position in a volume for text-based content.

186

"volumeId": "A String", # Volume id associated with this reading position.

187

"gbImagePosition": "A String", # Position in a volume for image-based content.

188

"pdfPosition": "A String", # Position in a PDF file.

189

"epubCfiPosition": "A String", # Position in an EPUB as a CFI.

190

"kind": "A String", # Resource type for a reading position.

191

},

192

"isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.

193

"isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.

194

"isUploaded": True or False, # Whether or not this volume was user uploaded.

195

"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)

196

"isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.

197

"entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.

198

"acquisitionType": 42, # How this volume was acquired.

199

"review": { # This user's review of this volume, if one exists.

200

"volumeId": "A String", # Volume that this review is for.

201

"date": "A String", # Date of this review.

202

"title": "A String", # Title for this review.

203

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.

204

"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.

205

"author": { # Author of this review.

206

"displayName": "A String", # Name of this person.

207

},

208

"source": { # Information regarding the source of this review, when the review is not from a Google Books user.

209

"url": "A String", # URL of the source of the review.

210

"extraDescription": "A String", # Extra text about the source of the review.

211

"description": "A String", # Name of the source.

212

},

213

"kind": "A String", # Resource type for a review.

214

"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.

215

"content": "A String", # Review text.

216

},

217

"copy": { # Copy/Paste accounting information.

218

"updated": "A String",

219

"allowedCharacterCount": 42,

220

"limitType": "A String",

221

"remainingCharacterCount": 42,

222

},

223

"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).

224

"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.

225

"rentalPeriod": { # Period during this book is/was a valid rental.

226

"startUtcSec": "A String",

227

"endUtcSec": "A String",

228

},

229

"userUploadedVolumeInfo": {

230

"processingState": "A String",

231

},

232

"rentalState": "A String", # Whether this book is an active or an expired rental.

233

"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."

234

"isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.

235

"familySharing": { # Information on the ability to share with the family.

236

"familyRole": "A String", # The role of the user in the family.

237

"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.

238

"isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.

239

},

240

"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)

241

},

242

"id": "A String", # Unique identifier for a volume. (In LITE projection.)

243

"volumeInfo": { # General volume information.

244

"maturityRating": "A String",

245

"samplePageCount": 42, # Total number of sample pages as per publisher metadata.

246

"previewLink": "A String", # URL to preview this volume on the Google Books site.

247

"dimensions": { # Physical dimensions of this volume.

248

"height": "A String", # Height or length of this volume (in cm).

249

"width": "A String", # Width of this volume (in cm).

250

"thickness": "A String", # Thickness of this volume (in cm).

251

},

252

"industryIdentifiers": [ # Industry standard identifiers for this volume.

253

{

254

"identifier": "A String", # Industry specific volume identifier.

255

"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.

256

},

257

],

258

"title": "A String", # Volume title. (In LITE projection.)

259

"comicsContent": True or False, # Whether the volume has comics content.

260

"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)

261

"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)

262

"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)

263

"A String",

264

],

265

"publishedDate": "A String", # Date of publication. (In LITE projection.)

266

"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.

267

"seriesInfo": {

268

"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.

269

"kind": "A String", # Resource type.

270

"shortSeriesBookTitle": "A String", # Short book title in the context of the series.

271

"volumeSeries": [

272

{

273

"issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.

274

{

275

"issueDisplayNumber": "A String",

276

"issueOrderNumber": 42,

277

},

278

],

279

"seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.

280

"seriesId": "A String", # The series id.

281

"orderNumber": 42, # The book order number in the series.

},

],

},

"ratingsCount": 42, # The number of review ratings for this volume.

286

"subtitle": "A String", # Volume subtitle. (In LITE projection.)

287

"pageCount": 42, # Total number of pages as per publisher metadata.

288

"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)

289

"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)

290

"extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)

291

"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)

292

"large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)

293

"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)

294

"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)

295

},

296

"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.)

297

"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.

298

"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.

299

"A String",

300

],

301

"publisher": "A String", # Publisher of this volume. (In LITE projection.)

302

"panelizationSummary": { # A top-level summary of the panelization info in this volume.

303

"epubBubbleVersion": "A String",

304

"imageBubbleVersion": "A String",

305

"containsEpubBubbles": True or False,

306

"containsImageBubbles": True or False,

307

},

308

"allowAnonLogging": True or False, # Whether anonymous logging should be allowed.

309

"printedPageCount": 42, # Total number of printed pages in generated pdf representation.

310

"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)

311

"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.

312

"readingModes": { # The reading modes available for this volume.

313

"image": True or False,

314

"text": True or False,

315

},

316

"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)

317

},

318

"selfLink": "A String", # URL to this resource. (In LITE projection.)

319

"searchInfo": { # Search result information related to this volume.

320

"textSnippet": "A String", # A text snippet containing the search query.

321

},

322

"kind": "A String", # Resource type for a volume. (In LITE projection.)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

323

"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.).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

324

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

325

"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.)

326

"embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.

327

"quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

328

"downloadAccess": { # Information about a volume's download license access restrictions.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

329

"nonce": "A String", # Client nonce for verification. Download access and client-validation only.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

330

"maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

331

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

332

"source": "A String", # Client app identifier for verification. Download access and client-validation only.

333

"message": "A String", # Error/warning message.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

334

"restricted": True or False, # Whether this volume has any download access restrictions.

335

"signature": "A String", # Response signature.

336

"downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

337

"kind": "A String", # Resource type.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

338

"deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

339

"justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

340

"volumeId": "A String", # Identifies the volume for which this entry applies.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

341

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

342

"epub": { # Information about epub content. (In LITE projection.)

343

"downloadLink": "A String", # URL to download epub. (In LITE projection.)

344

"acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)

345

"isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)

346

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

347

"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.

348

"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

349

"publicDomain": True or False, # Whether or not this book is public domain in the country listed above.

350

"pdf": { # Information about pdf content. (In LITE projection.)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

351

"acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

352

"downloadLink": "A String", # URL to download pdf. (In LITE projection.)

353

"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

354

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

355

"driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

356

"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.

357

"webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.

358

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

359

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

364

<code class="details" id="list">list(q, langRestrict=None, orderBy=None, source=None, startIndex=None, showPreorders=None, maxResults=None, libraryRestrict=None, projection=None, download=None, filter=None, printType=None, maxAllowedMaturityRating=None, partner=None, x__xgafv=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

365

<pre>Performs a book search.

366

367

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

368

q: string, Full-text search query string. (required)

369

langRestrict: string, Restrict results to books with this language code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

370

orderBy: string, Sort search results.

371

Allowed values

372

ORDER_BY_UNDEFINED -

373

newest - Most recently published.

374

relevance - Relevance to search terms.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

375

source: string, String to identify the originator of this request.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

376

startIndex: integer, Index of the first result to return (starts at 0)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

377

showPreorders: boolean, Set to true to show books available for preorder. Defaults to false.

378

maxResults: integer, Maximum number of results to return.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

379

libraryRestrict: string, Restrict search to this user's library.

380

Allowed values

381

LIBRARY_RESTRICT_UNDEFINED -

382

my-library - Restrict to the user's library, any shelf.

383

no-restrict - Do not restrict based on user's library.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

384

projection: string, Restrict information returned to a set of selected fields.

385

Allowed values

386

PROJECTION_UNDEFINED -

387

FULL - Includes all volume data.

388

LITE - Includes a subset of fields in volumeInfo and accessInfo.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

389

download: string, Restrict to volumes by download availability.

390

Allowed values

391

DOWNLOAD_UNDEFINED -

392

EPUB - All volumes with epub.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

393

filter: string, Filter search results.

394

Allowed values

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

395

FILTER_UNDEFINED -

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

396

ebooks - All Google eBooks.

397

free-ebooks - Google eBook with full volume text viewability.

398

full - Public can view entire volume text.

399

paid-ebooks - Google eBook with a price.

400

partial - Public able to see parts of text.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

401

printType: string, Restrict to books or magazines.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

402

Allowed values

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

403

PRINT_TYPE_UNDEFINED -

404

ALL - All volume content types.

405

BOOKS - Just books.

406

MAGAZINES - Just magazines.

407

maxAllowedMaturityRating: string, The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.

408

Allowed values

409

MAX_ALLOWED_MATURITY_RATING_UNDEFINED -

410

MATURE - Show books which are rated mature or lower.

411

not-mature - Show books which are rated not mature.

412

partner: string, Restrict and brand results for partner ID.

Bu Sun Kim

2020-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 Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

417

418

Returns:

419

An object of the form:

420

421

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

422

"totalItems": 42, # Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.

423

"kind": "A String", # Resource type.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

424

"items": [ # A list of volumes.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

425

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

426

"layerInfo": { # What layers exist in this volume and high level information about them.

427

"layers": [ # A layer should appear here if and only if the layer exists for this book.

428

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

429

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

430

"layerId": "A String", # The layer id of this layer (e.g. "geo").

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

431

},

432

],

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

433

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

434

"recommendedInfo": { # Recommendation related information for this volume.

435

"explanation": "A String", # A text explaining why this volume is recommended.

436

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

437

"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).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

438

"offers": [ # Offers available for this volume (sales and rentals).

439

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

440

"listPrice": { # Offer list (=undiscounted) price in Micros.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

441

"currencyCode": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

442

"amountInMicros": 3.14,

443

},

444

"rentalDuration": { # The rental duration (for rental offers only).

445

"unit": "A String",

446

"count": 3.14,

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

447

},

448

"retailPrice": { # Offer retail (=discounted) price in Micros

449

"currencyCode": "A String",

450

"amountInMicros": 3.14,

451

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

452

"finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)

453

"giftable": True or False, # Indicates whether the offer is giftable.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

454

},

455

],

456

"listPrice": { # Suggested retail price. (In LITE projection.)

457

"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)

458

"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)

459

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

460

"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.)

461

"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)

462

"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)

463

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

464

"buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

465

"country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)

466

"onSaleDate": "A String", # The date on which this book is available for sale.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

467

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

468

"isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

469

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

470

"etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)

471

"userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)

472

"readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)

473

"updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).

474

"gbTextPosition": "A String", # Position in a volume for text-based content.

475

"volumeId": "A String", # Volume id associated with this reading position.

476

"gbImagePosition": "A String", # Position in a volume for image-based content.

477

"pdfPosition": "A String", # Position in a PDF file.

478

"epubCfiPosition": "A String", # Position in an EPUB as a CFI.

479

"kind": "A String", # Resource type for a reading position.

480

},

481

"isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.

482

"isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.

483

"isUploaded": True or False, # Whether or not this volume was user uploaded.

484

"isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)

485

"isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.

486

"entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.

487

"acquisitionType": 42, # How this volume was acquired.

488

"review": { # This user's review of this volume, if one exists.

489

"volumeId": "A String", # Volume that this review is for.

490

"date": "A String", # Date of this review.

491

"title": "A String", # Title for this review.

492

"type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.

493

"fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.

494

"author": { # Author of this review.

495

"displayName": "A String", # Name of this person.

496

},

497

"source": { # Information regarding the source of this review, when the review is not from a Google Books user.

498

"url": "A String", # URL of the source of the review.

499

"extraDescription": "A String", # Extra text about the source of the review.

500

"description": "A String", # Name of the source.

501

},

502

"kind": "A String", # Resource type for a review.

503

"rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.

504

"content": "A String", # Review text.

505

},

506

"copy": { # Copy/Paste accounting information.

507

"updated": "A String",

508

"allowedCharacterCount": 42,

509

"limitType": "A String",

510

"remainingCharacterCount": 42,

511

},

512

"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).

513

"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.

514

"rentalPeriod": { # Period during this book is/was a valid rental.

515

"startUtcSec": "A String",

516

"endUtcSec": "A String",

517

},

518

"userUploadedVolumeInfo": {

519

"processingState": "A String",

520

},

521

"rentalState": "A String", # Whether this book is an active or an expired rental.

522

"isInMyBooks": True or False, # Whether or not this volume is currently in "my books."

523

"isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.

524

"familySharing": { # Information on the ability to share with the family.

525

"familyRole": "A String", # The role of the user in the family.

526

"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.

527

"isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.

528

},

529

"isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)

530

},

531

"id": "A String", # Unique identifier for a volume. (In LITE projection.)

532

"volumeInfo": { # General volume information.

533

"maturityRating": "A String",

534

"samplePageCount": 42, # Total number of sample pages as per publisher metadata.

535

"previewLink": "A String", # URL to preview this volume on the Google Books site.

536

"dimensions": { # Physical dimensions of this volume.

537

"height": "A String", # Height or length of this volume (in cm).

538

"width": "A String", # Width of this volume (in cm).

539

"thickness": "A String", # Thickness of this volume (in cm).

540

},

541

"industryIdentifiers": [ # Industry standard identifiers for this volume.

542

{

543

"identifier": "A String", # Industry specific volume identifier.

544

"type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.

545

},

546

],

547

"title": "A String", # Volume title. (In LITE projection.)

548

"comicsContent": True or False, # Whether the volume has comics content.

549

"canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)

550

"contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)

551

"authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)

552

"A String",

553

],

554

"publishedDate": "A String", # Date of publication. (In LITE projection.)

555

"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.

556

"seriesInfo": {

557

"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.

558

"kind": "A String", # Resource type.

559

"shortSeriesBookTitle": "A String", # Short book title in the context of the series.

560

"volumeSeries": [

561

{

562

"issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.

563

{

564

"issueDisplayNumber": "A String",

565

"issueOrderNumber": 42,

566

},

567

],

568

"seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.

569

"seriesId": "A String", # The series id.

570

"orderNumber": 42, # The book order number in the series.

},

],

},

"ratingsCount": 42, # The number of review ratings for this volume.

575

"subtitle": "A String", # Volume subtitle. (In LITE projection.)

576

"pageCount": 42, # Total number of pages as per publisher metadata.

577

"imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)

578

"medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)

579

"extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)

580

"small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)

581

"large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)

582

"thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)

583

"smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)

584

},

585

"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.)

586

"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.

587

"categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.

588

"A String",

589

],

590

"publisher": "A String", # Publisher of this volume. (In LITE projection.)

591

"panelizationSummary": { # A top-level summary of the panelization info in this volume.

592

"epubBubbleVersion": "A String",

593

"imageBubbleVersion": "A String",

594

"containsEpubBubbles": True or False,

595

"containsImageBubbles": True or False,

596

},

597

"allowAnonLogging": True or False, # Whether anonymous logging should be allowed.

598

"printedPageCount": 42, # Total number of printed pages in generated pdf representation.

599

"infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)

600

"printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.

601

"readingModes": { # The reading modes available for this volume.

602

"image": True or False,

603

"text": True or False,

604

},

605

"averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)

606

},

607

"selfLink": "A String", # URL to this resource. (In LITE projection.)

608

"searchInfo": { # Search result information related to this volume.

609

"textSnippet": "A String", # A text snippet containing the search query.

610

},

611

"kind": "A String", # Resource type for a volume. (In LITE projection.)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

612

"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.).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

613

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

614

"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.)

615

"embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.

616

"quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

617

"downloadAccess": { # Information about a volume's download license access restrictions.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

618

"nonce": "A String", # Client nonce for verification. Download access and client-validation only.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

619

"maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

620

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

621

"source": "A String", # Client app identifier for verification. Download access and client-validation only.

622

"message": "A String", # Error/warning message.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

623

"restricted": True or False, # Whether this volume has any download access restrictions.

624

"signature": "A String", # Response signature.

625

"downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

626

"kind": "A String", # Resource type.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

627

"deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

628

"justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

629

"volumeId": "A String", # Identifies the volume for which this entry applies.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

630

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

631

"epub": { # Information about epub content. (In LITE projection.)

632

"downloadLink": "A String", # URL to download epub. (In LITE projection.)

633

"acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)

634

"isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)

635

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

636

"textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.

637

"country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

638

"publicDomain": True or False, # Whether or not this book is public domain in the country listed above.

639

"pdf": { # Information about pdf content. (In LITE projection.)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

640

"acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

641

"downloadLink": "A String", # URL to download pdf. (In LITE projection.)

642

"isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

643

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

644

"driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

645

"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.

646

"webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.

647

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

648

},

John Asmuth