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

Dmitry Frenkel

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

[diff] [blame^]

104

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

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

Bu Sun Kim

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

[diff] [blame]

118

user_library_consistent_read: boolean, A parameter

Bu Sun Kim

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

[diff] [blame]

119

partner: string, Brand results for partner ID.

Dmitry Frenkel

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

[diff] [blame^]

120

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

Bu Sun Kim

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

[diff] [blame]

121

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

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.

127

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

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

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

Bu Sun Kim

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

[diff] [blame]

138

"userUploadedVolumeInfo": {

139

"processingState": "A String",

140

},

Dmitry Frenkel

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

[diff] [blame^]

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

Bu Sun Kim

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

[diff] [blame]

149

},

Bu Sun Kim

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

[diff] [blame]

150

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

151

"startUtcSec": "A String",

152

"endUtcSec": "A String",

153

},

Dmitry Frenkel

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

[diff] [blame^]

154

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

Bu Sun Kim

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

[diff] [blame]

155

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

Dmitry Frenkel

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

[diff] [blame^]

156

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

157

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

158

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

159

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

160

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

161

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

Bu Sun Kim

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

[diff] [blame]

162

},

Dmitry Frenkel

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

[diff] [blame^]

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

Bu Sun Kim

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

[diff] [blame]

173

},

Dmitry Frenkel

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

[diff] [blame^]

174

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

175

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

176

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

177

"author": { # Author of this review.

178

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

179

},

180

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

John Asmuth

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

[diff] [blame]

181

},

Dmitry Frenkel

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

[diff] [blame^]

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

"remainingCharacterCount": 42,

190

"limitType": "A String",

191

"allowedCharacterCount": 42,

192

"updated": "A String",

193

},

194

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

195

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

John Asmuth

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

[diff] [blame]

196

},

Bu Sun Kim

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

[diff] [blame]

197

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

Dmitry Frenkel

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

[diff] [blame^]

198

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

Bu Sun Kim

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

[diff] [blame]

199

"volumeInfo": { # General volume information.

Bu Sun Kim

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

[diff] [blame]

200

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

Dmitry Frenkel

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

[diff] [blame^]

201

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

202

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

203

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

204

"A String",

205

],

206

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

Bu Sun Kim

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

[diff] [blame]

207

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

208

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

Bu Sun Kim

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

[diff] [blame]

209

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

Bu Sun Kim

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

[diff] [blame]

210

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

Dmitry Frenkel

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

[diff] [blame^]

211

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

Bu Sun Kim

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

[diff] [blame]

212

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

Dmitry Frenkel

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

[diff] [blame^]

213

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

Bu Sun Kim

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

[diff] [blame]

214

},

Dmitry Frenkel

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

[diff] [blame^]

215

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

216

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

217

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

218

"epubBubbleVersion": "A String",

219

"containsImageBubbles": True or False,

220

"containsEpubBubbles": True or False,

221

"imageBubbleVersion": "A String",

222

},

223

"maturityRating": "A String",

Bu Sun Kim

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

[diff] [blame]

224

"seriesInfo": {

225

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

Bu Sun Kim

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

[diff] [blame]

226

"volumeSeries": [

227

{

Bu Sun Kim

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

[diff] [blame]

228

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

Dmitry Frenkel

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

[diff] [blame^]

229

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

Bu Sun Kim

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

[diff] [blame]

230

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

231

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

232

{

233

"issueOrderNumber": 42,

234

"issueDisplayNumber": "A String",

},

],

},

],

Dmitry Frenkel

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

[diff] [blame^]

239

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

Bu Sun Kim

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

[diff] [blame]

240

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

241

},

Bu Sun Kim

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

[diff] [blame]

242

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

Bu Sun Kim

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

[diff] [blame]

243

"text": True or False,

Dmitry Frenkel

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

[diff] [blame^]

244

"image": True or False,

Bu Sun Kim

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

[diff] [blame]

245

},

Bu Sun Kim

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

[diff] [blame]

246

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

247

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

248

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

249

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

250

},

Bu Sun Kim

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

[diff] [blame]

251

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

Bu Sun Kim

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

[diff] [blame]

252

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

Bu Sun Kim

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

[diff] [blame]

253

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

254

{

255

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

256

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

257

},

258

],

Bu Sun Kim

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

[diff] [blame]

259

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

Dmitry Frenkel

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

[diff] [blame^]

260

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

261

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

262

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

263

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

264

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

265

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

Bu Sun Kim

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

[diff] [blame]

266

"A String",

267

],

Dmitry Frenkel

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

[diff] [blame^]

268

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

Bu Sun Kim

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

[diff] [blame]

269

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

Dmitry Frenkel

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

[diff] [blame^]

270

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

271

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

272

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

273

},

274

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

275

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

276

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

277

},

278

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

279

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

Bu Sun Kim

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

[diff] [blame]

280

},

281

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

282

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

283

{

Bu Sun Kim

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

[diff] [blame]

284

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

Dmitry Frenkel

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

[diff] [blame^]

285

"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-07-22 17:02:09 -0700

[diff] [blame]

286

},

287

],

John Asmuth

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

[diff] [blame]

288

},

Dmitry Frenkel

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

[diff] [blame^]

289

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

290

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

291

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

292

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

293

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

294

},

295

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

296

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

297

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

298

{

299

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

300

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

"count": 3.14,

"unit": "A String",

},

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

305

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

306

"amountInMicros": 3.14,

307

"currencyCode": "A String",

308

},

309

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

310

"currencyCode": "A String",

311

"amountInMicros": 3.14,

},

},

],

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

316

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

317

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

318

},

319

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

320

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

321

},

322

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

323

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

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.

325

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

326

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

327

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

328

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

329

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

330

"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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

},

340

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

341

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

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

},

347

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

348

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

349

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

350

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

351

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

352

},

353

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

354

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

355

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

356

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

357

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

358

},

359

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

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame^]

364

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

Dmitry Frenkel

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

[diff] [blame^]

368

orderBy: string, Sort search results.

369

Allowed values

370

ORDER_BY_UNDEFINED -

371

newest - Most recently published.

372

relevance - Relevance to search terms.

Bu Sun Kim

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

[diff] [blame]

373

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

Dmitry Frenkel

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

[diff] [blame^]

374

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

375

printType: string, Restrict to books or magazines.

376

Allowed values

377

PRINT_TYPE_UNDEFINED -

378

ALL - All volume content types.

379

BOOKS - Just books.

380

MAGAZINES - Just magazines.

381

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

382

Allowed values

383

LIBRARY_RESTRICT_UNDEFINED -

384

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

385

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

386

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

387

Allowed values

388

MAX_ALLOWED_MATURITY_RATING_UNDEFINED -

389

MATURE - Show books which are rated mature or lower.

390

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

391

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

392

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

393

Allowed values

394

PROJECTION_UNDEFINED -

395

FULL - Includes all volume data.

396

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

397

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

398

q: string, Full-text search query string.

Bu Sun Kim

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

[diff] [blame]

399

maxResults: integer, Maximum number of results to return.

John Asmuth

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

[diff] [blame]

400

filter: string, Filter search results.

401

Allowed values

Bu Sun Kim

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

[diff] [blame]

402

FILTER_UNDEFINED -

John Asmuth

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

[diff] [blame]

403

ebooks - All Google eBooks.

404

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

405

full - Public can view entire volume text.

406

paid-ebooks - Google eBook with a price.

407

partial - Public able to see parts of text.

Dmitry Frenkel

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

[diff] [blame^]

408

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

Bu Sun Kim

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

[diff] [blame]

409

download: string, Restrict to volumes by download availability.

410

Allowed values

411

DOWNLOAD_UNDEFINED -

412

EPUB - All volumes with epub.

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

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

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

Bu Sun Kim

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

[diff] [blame]

427

"userUploadedVolumeInfo": {

428

"processingState": "A String",

429

},

Dmitry Frenkel

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

[diff] [blame^]

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

Bu Sun Kim

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

[diff] [blame]

438

},

Bu Sun Kim

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

[diff] [blame]

439

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

440

"startUtcSec": "A String",

441

"endUtcSec": "A String",

442

},

Dmitry Frenkel

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

[diff] [blame^]

443

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

Bu Sun Kim

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

[diff] [blame]

444

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

Dmitry Frenkel

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

[diff] [blame^]

445

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

446

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

447

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

448

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

449

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

450

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

Bu Sun Kim

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

[diff] [blame]

451

},

Dmitry Frenkel

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

[diff] [blame^]

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

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

461

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

Bu Sun Kim

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

[diff] [blame]

462

},

Dmitry Frenkel

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

[diff] [blame^]

463

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

464

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

465

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

466

"author": { # Author of this review.

467

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

468

},

469

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

John Asmuth

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

[diff] [blame]

470

},

Dmitry Frenkel

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

[diff] [blame^]

471

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

472

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

473

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

474

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

475

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

476

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

477

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

478

"remainingCharacterCount": 42,

479

"limitType": "A String",

480

"allowedCharacterCount": 42,

481

"updated": "A String",

482

},

483

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

484

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

John Asmuth

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

[diff] [blame]

485

},

Bu Sun Kim

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

[diff] [blame]

486

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

Dmitry Frenkel

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

[diff] [blame^]

487

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

Bu Sun Kim

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

[diff] [blame]

488

"volumeInfo": { # General volume information.

Bu Sun Kim

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

[diff] [blame]

489

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

Dmitry Frenkel

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

[diff] [blame^]

490

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

491

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

492

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

493

"A String",

494

],

495

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

Bu Sun Kim

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

[diff] [blame]

496

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

497

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

Bu Sun Kim

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

[diff] [blame]

498

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

Bu Sun Kim

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

[diff] [blame]

499

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

Dmitry Frenkel

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

[diff] [blame^]

500

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

Bu Sun Kim

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

[diff] [blame]

501

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

Dmitry Frenkel

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

[diff] [blame^]

502

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

Bu Sun Kim

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

[diff] [blame]

503

},

Dmitry Frenkel

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

[diff] [blame^]

504

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

505

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

506

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

507

"epubBubbleVersion": "A String",

508

"containsImageBubbles": True or False,

509

"containsEpubBubbles": True or False,

510

"imageBubbleVersion": "A String",

511

},

512

"maturityRating": "A String",

Bu Sun Kim

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

[diff] [blame]

513

"seriesInfo": {

514

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

Bu Sun Kim

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

[diff] [blame]

515

"volumeSeries": [

516

{

Bu Sun Kim

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

[diff] [blame]

517

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

Dmitry Frenkel

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

[diff] [blame^]

518

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

Bu Sun Kim

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

[diff] [blame]

519

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

520

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

521

{

522

"issueOrderNumber": 42,

523

"issueDisplayNumber": "A String",

},

],

},

],

Dmitry Frenkel

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

[diff] [blame^]

528

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

Bu Sun Kim

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

[diff] [blame]

529

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

530

},

Bu Sun Kim

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

[diff] [blame]

531

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

Bu Sun Kim

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

[diff] [blame]

532

"text": True or False,

Dmitry Frenkel

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

[diff] [blame^]

533

"image": True or False,

Bu Sun Kim

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

[diff] [blame]

534

},

Bu Sun Kim

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

[diff] [blame]

535

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

536

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

537

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

538

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

539

},

Bu Sun Kim

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

[diff] [blame]

540

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

Bu Sun Kim

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

[diff] [blame]

541

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

Bu Sun Kim

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

[diff] [blame]

542

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

543

{

544

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

545

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

546

},

547

],

Bu Sun Kim

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

[diff] [blame]

548

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

Dmitry Frenkel

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

[diff] [blame^]

549

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

550

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

551

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

552

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

553

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

554

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

Bu Sun Kim

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

[diff] [blame]

555

"A String",

556

],

Dmitry Frenkel

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

[diff] [blame^]

557

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

Bu Sun Kim

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

[diff] [blame]

558

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

Dmitry Frenkel

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

[diff] [blame^]

559

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

560

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

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

},

563

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

564

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

565

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

566

},

567

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

568

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

Bu Sun Kim

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

[diff] [blame]

569

},

570

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

571

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

572

{

Bu Sun Kim

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

[diff] [blame]

573

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

Dmitry Frenkel

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

[diff] [blame^]

574

"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-07-22 17:02:09 -0700

[diff] [blame]

575

},

576

],

John Asmuth

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

[diff] [blame]

577

},

Dmitry Frenkel

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

[diff] [blame^]

578

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

579

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

580

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

581

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

582

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

583

},

584

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

585

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

586

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

587

{

588

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

589

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

"count": 3.14,

"unit": "A String",

},

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

594

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

595

"amountInMicros": 3.14,

596

"currencyCode": "A String",

597

},

598

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

599

"currencyCode": "A String",

600

"amountInMicros": 3.14,

},

},

],

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

605

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

606

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

607

},

608

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

609

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

610

},

611

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

612

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

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.

614

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

615

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

616

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

617

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

618

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

619

"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

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

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

628

},

629

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

630

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

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

},

636

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

637

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

638

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

639

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

640

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

641

},

642

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

643

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

644

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

645

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

646

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

647

},

648

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

John Asmuth