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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

104

<code><a href="#list">list(q, showPreorders=None, projection=None, filter=None, libraryRestrict=None, source=None, printType=None, maxAllowedMaturityRating=None, partner=None, orderBy=None, maxResults=None, startIndex=None, langRestrict=None, download=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>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

113

<code class="details" id="get">get(volumeId, country=None, partner=None, source=None, user_library_consistent_read=None, projection=None, includeNonComicsSeries=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)

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

118

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

119

partner: string, Brand results for partner ID.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

120

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

121

user_library_consistent_read: boolean, A parameter

John Asmuth

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

[diff] [blame]

122

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

123

Allowed values

Bu Sun Kim

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

[diff] [blame]

124

PROJECTION_UNDEFINED -

125

FULL - Includes all volume data.

126

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

127

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

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

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

"updated": "A String",

147

"remainingCharacterCount": 42,

148

"limitType": "A String",

149

"allowedCharacterCount": 42,

150

},

151

"userUploadedVolumeInfo": {

152

"processingState": "A String",

153

},

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.

155

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

156

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

157

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

158

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

159

"endUtcSec": "A String",

160

"startUtcSec": "A String",

161

},

162

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

163

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

164

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

165

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

166

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

167

},

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

},

178

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

179

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

180

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

181

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

182

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

183

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

184

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

185

},

186

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

187

"author": { # Author of this review.

188

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

189

},

190

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

191

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

192

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

193

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

194

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

195

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

196

},

197

},

198

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

199

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

200

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

201

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

202

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

203

{

204

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

205

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

},

],

},

"volumeInfo": { # General volume information.

210

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

211

"seriesInfo": {

212

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

213

"volumeSeries": [

214

{

215

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

216

{

217

"issueDisplayNumber": "A String",

218

"issueOrderNumber": 42,

219

},

220

],

221

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

222

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

223

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

224

},

225

],

226

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

227

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

228

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

229

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

230

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

231

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

232

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

233

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

234

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

235

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

236

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

237

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

238

"A String",

239

],

240

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

241

"image": True or False,

242

"text": True or False,

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

243

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

244

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

245

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

246

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

247

"maturityRating": "A String",

248

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

249

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

250

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

251

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

252

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

253

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

254

"imageBubbleVersion": "A String",

255

"epubBubbleVersion": "A String",

256

"containsEpubBubbles": True or False,

257

"containsImageBubbles": True or False,

258

},

259

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

260

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

261

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

262

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

263

{

264

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

265

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

266

},

267

],

268

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

269

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

270

"A String",

271

],

272

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

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

},

282

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

John Asmuth

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

[diff] [blame]

283

},

Bu Sun Kim

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

[diff] [blame]

284

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

285

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

286

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

},

299

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

300

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

301

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

302

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

303

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

304

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

305

},

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

"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

316

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

317

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

318

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

319

},

320

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

321

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

322

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

323

},

Dmitry Frenkel

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

[diff] [blame]

324

"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

2020-11-25 07:50:41 -0800

[diff] [blame^]

325

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

326

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

327

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

328

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

329

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

330

},

331

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

332

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

333

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

Dmitry Frenkel

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

[diff] [blame]

334

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

335

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

336

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

337

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

338

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

339

"amountInMicros": 3.14,

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

340

"currencyCode": "A String",

341

},

342

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

343

"amountInMicros": 3.14,

344

"currencyCode": "A String",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

345

},

Bu Sun Kim

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

[diff] [blame]

346

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

347

"unit": "A String",

348

"count": 3.14,

Dmitry Frenkel

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

[diff] [blame]

349

},

Dmitry Frenkel

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

[diff] [blame]

350

},

351

],

352

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

Dmitry Frenkel

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

[diff] [blame]

353

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

354

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

Dmitry Frenkel

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

[diff] [blame]

355

},

Bu Sun Kim

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

[diff] [blame]

356

},

Bu Sun Kim

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

},

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

364

<code class="details" id="list">list(q, showPreorders=None, projection=None, filter=None, libraryRestrict=None, source=None, printType=None, maxAllowedMaturityRating=None, partner=None, orderBy=None, maxResults=None, startIndex=None, langRestrict=None, download=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)

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

369

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

Dmitry Frenkel

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

[diff] [blame]

370

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

371

Allowed values

372

PROJECTION_UNDEFINED -

373

FULL - Includes all volume data.

374

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

John Asmuth

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

[diff] [blame]

375

filter: string, Filter search results.

376

Allowed values

Bu Sun Kim

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

[diff] [blame]

377

FILTER_UNDEFINED -

John Asmuth

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

[diff] [blame]

378

ebooks - All Google eBooks.

379

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

380

full - Public can view entire volume text.

381

paid-ebooks - Google eBook with a price.

382

partial - Public able to see parts of text.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

383

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

384

Allowed values

385

LIBRARY_RESTRICT_UNDEFINED -

386

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

387

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

388

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

Bu Sun Kim

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

[diff] [blame]

389

printType: string, Restrict to books or magazines.

Bu Sun Kim

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

[diff] [blame]

390

Allowed values

Bu Sun Kim

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

[diff] [blame]

391

PRINT_TYPE_UNDEFINED -

392

ALL - All volume content types.

393

BOOKS - Just books.

394

MAGAZINES - Just magazines.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

395

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

396

Allowed values

397

MAX_ALLOWED_MATURITY_RATING_UNDEFINED -

398

MATURE - Show books which are rated mature or lower.

399

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

400

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

401

orderBy: string, Sort search results.

Bu Sun Kim

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

[diff] [blame]

402

Allowed values

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

403

ORDER_BY_UNDEFINED -

404

newest - Most recently published.

405

relevance - Relevance to search terms.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

406

maxResults: integer, Maximum number of results to return.

407

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

408

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

409

download: string, Restrict to volumes by download availability.

410

Allowed values

411

DOWNLOAD_UNDEFINED -

412

EPUB - All volumes with epub.

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

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

422

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

Bu Sun Kim

6502091

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

[diff] [blame]

423

"items": [ # A list of volumes.

John Asmuth

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

[diff] [blame]

424

{

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

"updated": "A String",

435

"remainingCharacterCount": 42,

436

"limitType": "A String",

437

"allowedCharacterCount": 42,

438

},

439

"userUploadedVolumeInfo": {

440

"processingState": "A String",

441

},

442

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

443

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

444

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

445

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

446

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

447

"endUtcSec": "A String",

448

"startUtcSec": "A String",

449

},

450

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

451

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

452

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

453

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

454

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

455

},

456

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

457

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

458

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

459

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

460

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

461

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

462

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

463

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

464

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

465

},

466

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

467

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

468

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

469

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

470

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

471

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

472

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

473

},

474

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

475

"author": { # Author of this review.

476

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

477

},

478

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

479

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

480

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

481

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

482

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

483

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

484

},

485

},

486

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

487

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

488

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

489

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

490

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

491

{

492

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

493

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

},

],

},

"volumeInfo": { # General volume information.

498

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

499

"seriesInfo": {

500

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

501

"volumeSeries": [

502

{

503

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

504

{

505

"issueDisplayNumber": "A String",

506

"issueOrderNumber": 42,

507

},

508

],

509

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

510

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

511

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

512

},

513

],

514

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

515

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

516

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

517

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

518

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

519

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

520

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

521

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

522

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

523

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

524

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

525

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

526

"A String",

527

],

528

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

529

"image": True or False,

530

"text": True or False,

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

531

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

532

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

533

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

534

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

535

"maturityRating": "A String",

536

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

537

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

538

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

539

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

540

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

541

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

542

"imageBubbleVersion": "A String",

543

"epubBubbleVersion": "A String",

544

"containsEpubBubbles": True or False,

545

"containsImageBubbles": True or False,

546

},

547

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

548

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

549

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

550

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

551

{

552

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

553

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

554

},

555

],

556

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

557

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

558

"A String",

559

],

560

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

561

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

562

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

563

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

564

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

565

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

566

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

567

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

568

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

569

},

570

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

John Asmuth

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

[diff] [blame]

571

},

Bu Sun Kim

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

[diff] [blame]

572

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

573

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

574

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

575

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

576

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

577

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

578

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

579

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

580

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

581

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

582

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

583

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

584

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

585

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

586

},

587

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

588

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

589

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

590

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

591

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

592

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

593

},

594

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

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

"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

604

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

605

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

606

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

607

},

608

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

609

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

610

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

611

},

Dmitry Frenkel

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

[diff] [blame]

612

"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

2020-11-25 07:50:41 -0800

[diff] [blame^]

613

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

614

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

615

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

616

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

617

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

618

},

619

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

620

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

621

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

Dmitry Frenkel

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

[diff] [blame]

622

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

623

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

624

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

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

625

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

626

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

627

"amountInMicros": 3.14,

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

628

"currencyCode": "A String",

629

},

630

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

631

"amountInMicros": 3.14,

632

"currencyCode": "A String",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

633

},

Bu Sun Kim

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

[diff] [blame]

634

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

635

"unit": "A String",

636

"count": 3.14,

Dmitry Frenkel

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

[diff] [blame]

637

},

Dmitry Frenkel

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

[diff] [blame]

638

},

639

],

640

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

Dmitry Frenkel

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

[diff] [blame]

641

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

642

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

Dmitry Frenkel

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

[diff] [blame]

643

},

Bu Sun Kim

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

[diff] [blame]

644

},

Bu Sun Kim

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

[diff] [blame]

645

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

646

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

647

},

John Asmuth

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

[diff] [blame]

648

},

649

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

650

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

John Asmuth