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

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

[diff] [blame]

91

<p class="firstline">Request downloaded content access for specified volumes on the My eBooks shelf.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

92

Bu Sun Kim

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

[diff] [blame]

93

<code><a href="#updateUserSettings">updateUserSettings(body=None, x__xgafv=None)</a></code></p>

Nathaniel Manista

4f877e5

2015-06-15 16:44:50 +0000

[diff] [blame]

94

<p class="firstline">Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.</p>

John Asmuth

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

[diff] [blame]

95

<h3>Method Details</h3>

96

Dmitry Frenkel

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

[diff] [blame]

97

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

98

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

102

<code class="details" id="getUserSettings">getUserSettings(country=None, x__xgafv=None)</code>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

103

<pre>Gets the current settings for the user.

104

105

Args:

Bu Sun Kim

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

[diff] [blame]

106

country: string, Unused. Added only to workaround TEX mandatory request template requirement

107

x__xgafv: string, V1 error format.

108

Allowed values

109

1 - v1 error format

110

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

111

112

Returns:

113

An object of the form:

114

115

{

Dmitry Frenkel

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

[diff] [blame]

116

"notesExport": { # User settings in sub-objects, each for different purposes.

Bu Sun Kim

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

[diff] [blame]

117

"folderName": "A String",

Yoshi Automation Bot

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

[diff] [blame^]

118

"isEnabled": True or False,

Dmitry Frenkel

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

[diff] [blame]

119

},

120

"notification": {

121

"matchMyInterests": {

122

"opted_state": "A String",

Bu Sun Kim

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

[diff] [blame]

123

},

Bu Sun Kim

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

[diff] [blame]

124

"priceDrop": {

Dmitry Frenkel

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

[diff] [blame]

125

"opted_state": "A String",

Bu Sun Kim

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

[diff] [blame]

126

},

Yoshi Automation Bot

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

[diff] [blame^]

127

"moreFromAuthors": {

128

"opted_state": "A String",

129

},

Dmitry Frenkel

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

[diff] [blame]

130

"moreFromSeries": {

131

"opted_state": "A String",

132

},

Bu Sun Kim

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

[diff] [blame]

133

"rewardExpirations": {

Dmitry Frenkel

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

[diff] [blame]

134

"opted_state": "A String",

135

},

Dmitry Frenkel

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

[diff] [blame]

136

},

137

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

138

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

142

<code class="details" id="releaseDownloadAccess">releaseDownloadAccess(cpksver, volumeIds, source=None, locale=None, x__xgafv=None)</code>

John Asmuth

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

[diff] [blame]

143

<pre>Release downloaded content access restriction.

144

145

Args:

Bu Sun Kim

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

[diff] [blame]

146

cpksver: string, The device/version ID from which to release the restriction. (required)

147

volumeIds: string, The volume(s) to release restrictions for. (required) (repeated)

Dmitry Frenkel

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

[diff] [blame]

148

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

Bu Sun Kim

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

[diff] [blame]

149

locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

Bu Sun Kim

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

[diff] [blame]

150

x__xgafv: string, V1 error format.

151

Allowed values

152

1 - v1 error format

153

2 - v2 error format

John Asmuth

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

[diff] [blame]

154

155

Returns:

156

An object of the form:

157

158

{

Yoshi Automation Bot

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

[diff] [blame^]

159

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

Bu Sun Kim

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

[diff] [blame]

160

"downloadAccessList": [ # A list of download access responses.

John Asmuth

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

[diff] [blame]

161

{

Bu Sun Kim

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

[diff] [blame]

162

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

163

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

Yoshi Automation Bot

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

[diff] [blame^]

164

"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

165

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

166

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

167

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

168

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

Bu Sun Kim

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

[diff] [blame]

169

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

Bu Sun Kim

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

[diff] [blame]

170

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

Yoshi Automation Bot

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

[diff] [blame^]

171

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

172

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

173

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

John Asmuth

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

[diff] [blame]

174

},

175

],

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]

180

<code class="details" id="requestAccess">requestAccess(cpksver, nonce, source, volumeId, locale=None, licenseTypes=None, x__xgafv=None)</code>

John Asmuth

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

[diff] [blame]

181

<pre>Request concurrent and download access restrictions.

182

183

Args:

Bu Sun Kim

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

[diff] [blame]

184

cpksver: string, The device/version ID from which to request the restrictions. (required)

185

nonce: string, The client nonce value. (required)

186

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

187

volumeId: string, The volume to request concurrent/download restrictions for. (required)

Bu Sun Kim

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

[diff] [blame]

188

locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

John Asmuth

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

[diff] [blame]

189

licenseTypes: string, The type of access license to request. If not specified, the default is BOTH.

190

Allowed values

Bu Sun Kim

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

[diff] [blame]

191

LICENSE_TYPES_UNDEFINED -

John Asmuth

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

[diff] [blame]

192

BOTH - Both concurrent and download licenses.

193

CONCURRENT - Concurrent access license.

194

DOWNLOAD - Offline download access license.

Bu Sun Kim

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

[diff] [blame]

195

x__xgafv: string, V1 error format.

196

Allowed values

197

1 - v1 error format

198

2 - v2 error format

John Asmuth

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

[diff] [blame]

199

200

Returns:

201

An object of the form:

202

203

{

Bu Sun Kim

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

[diff] [blame]

204

"downloadAccess": { # A download access response.

Bu Sun Kim

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

[diff] [blame]

205

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

206

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

Yoshi Automation Bot

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

[diff] [blame^]

207

"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

208

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

209

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

210

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

211

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

Bu Sun Kim

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

[diff] [blame]

212

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

Bu Sun Kim

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

[diff] [blame]

213

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

Yoshi Automation Bot

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

[diff] [blame^]

214

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

215

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

216

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

217

},

218

"concurrentAccess": { # A concurrent access response.

219

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

220

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

221

"maxConcurrentDevices": 42, # The maximum number of concurrent access licenses for this volume.

222

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

223

"reasonCode": "A String", # Error/warning reason code.

224

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

225

"timeWindowSeconds": 42, # Time in seconds for license auto-expiration.

226

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

227

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

228

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

229

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

John Asmuth

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

[diff] [blame]

230

},

Bu Sun Kim

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

[diff] [blame]

231

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

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

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

[diff] [blame^]

236

<code class="details" id="syncVolumeLicenses">syncVolumeLicenses(cpksver, nonce, source, volumeIds=None, showPreorders=None, features=None, includeNonComicsSeries=None, locale=None, x__xgafv=None)</code>

John Asmuth

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

[diff] [blame]

237

<pre>Request downloaded content access for specified volumes on the My eBooks shelf.

238

239

Args:

Bu Sun Kim

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

[diff] [blame]

240

cpksver: string, The device/version ID from which to release the restriction. (required)

241

nonce: string, The client nonce value. (required)

242

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

Yoshi Automation Bot

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

[diff] [blame^]

243

volumeIds: string, The volume(s) to request download restrictions for. (repeated)

Bu Sun Kim

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

[diff] [blame]

244

showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.

Bu Sun Kim

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

[diff] [blame]

245

features: string, List of features supported by the client, i.e., 'RENTALS' (repeated)

John Asmuth

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

[diff] [blame]

246

Allowed values

Bu Sun Kim

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

[diff] [blame]

247

FEATURES_UNDEFINED -

John Asmuth

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

[diff] [blame]

248

RENTALS - Client supports rentals.

Bu Sun Kim

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

[diff] [blame]

249

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

Yoshi Automation Bot

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

[diff] [blame^]

250

locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

Bu Sun Kim

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

[diff] [blame]

251

x__xgafv: string, V1 error format.

252

Allowed values

253

1 - v1 error format

254

2 - v2 error format

John Asmuth

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

[diff] [blame]

255

256

Returns:

257

An object of the form:

258

259

{

Bu Sun Kim

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

[diff] [blame]

260

"items": [ # A list of volumes.

John Asmuth

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

[diff] [blame]

261

{

Yoshi Automation Bot

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

[diff] [blame^]

262

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

263

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

264

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

265

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

266

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

267

"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

268

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

269

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

270

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

271

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

272

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

273

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

274

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

275

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

276

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

277

},

278

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

279

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

280

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

281

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

282

},

283

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

284

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

285

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

286

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

287

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

288

},

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

John Asmuth

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

[diff] [blame]

298

},

Bu Sun Kim

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

[diff] [blame]

299

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

300

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

301

},

Dmitry Frenkel

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

[diff] [blame]

302

"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-24 15:48:03 -0800

[diff] [blame^]

303

"saleability": "A String", # Whether or not this book is available for sale or offered for free in the Google eBookstore for the country listed above. Possible values are FOR_SALE, FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.

Dmitry Frenkel

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

[diff] [blame]

304

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

305

{

Dmitry Frenkel

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

[diff] [blame]

306

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

Dmitry Frenkel

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

[diff] [blame]

307

"currencyCode": "A String",

Bu Sun Kim

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

[diff] [blame]

308

"amountInMicros": 3.14,

309

},

Yoshi Automation Bot

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

[diff] [blame^]

310

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

311

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

312

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

313

"currencyCode": "A String",

314

"amountInMicros": 3.14,

315

},

Bu Sun Kim

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

[diff] [blame]

316

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

317

"unit": "A String",

318

"count": 3.14,

Dmitry Frenkel

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

[diff] [blame]

319

},

Dmitry Frenkel

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

[diff] [blame]

320

},

321

],

Yoshi Automation Bot

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

[diff] [blame^]

322

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

323

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

Dmitry Frenkel

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

[diff] [blame]

324

"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^]

325

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

Dmitry Frenkel

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

[diff] [blame]

326

},

Yoshi Automation Bot

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

[diff] [blame^]

327

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

328

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

329

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

330

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

331

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

332

},

Bu Sun Kim

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

[diff] [blame]

333

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

Dmitry Frenkel

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

[diff] [blame]

334

},

Bu Sun Kim

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

[diff] [blame]

335

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

336

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

Yoshi Automation Bot

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

[diff] [blame^]

337

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

Bu Sun Kim

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

[diff] [blame]

338

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

Yoshi Automation Bot

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

[diff] [blame^]

339

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

340

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

341

"remainingCharacterCount": 42,

342

"updated": "A String",

343

"limitType": "A String",

344

"allowedCharacterCount": 42,

345

},

346

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

Bu Sun Kim

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

[diff] [blame]

347

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

348

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

Yoshi Automation Bot

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

[diff] [blame^]

349

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

Bu Sun Kim

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

[diff] [blame]

350

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

351

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

352

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

Yoshi Automation Bot

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

[diff] [blame^]

353

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

354

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

355

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

356

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

357

},

358

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

359

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

360

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

Bu Sun Kim

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

[diff] [blame]

361

"author": { # Author of this review.

362

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

363

},

Bu Sun Kim

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

[diff] [blame]

364

},

Yoshi Automation Bot

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

[diff] [blame^]

365

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

366

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

367

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

368

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

369

"isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.

Bu Sun Kim

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

[diff] [blame]

370

},

Yoshi Automation Bot

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

[diff] [blame^]

371

"userUploadedVolumeInfo": {

372

"processingState": "A String",

373

},

374

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

Bu Sun Kim

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

[diff] [blame]

375

"updated": "A String", # Timestamp when this volume was last modified by a user action, such as a reading position update, volume purchase or writing a review. (RFC 3339 UTC date-time format).

Yoshi Automation Bot

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

[diff] [blame^]

376

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

377

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

378

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

Bu Sun Kim

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

[diff] [blame]

379

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

380

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

381

"startUtcSec": "A String",

382

"endUtcSec": "A String",

383

},

Yoshi Automation Bot

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

[diff] [blame^]

384

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

Bu Sun Kim

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

[diff] [blame]

385

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

Yoshi Automation Bot

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

[diff] [blame^]

386

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

387

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

388

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

389

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

390

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

391

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

392

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

393

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

Bu Sun Kim

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

[diff] [blame]

394

},

Bu Sun Kim

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

[diff] [blame]

395

},

Yoshi Automation Bot

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

[diff] [blame^]

396

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

Bu Sun Kim

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

[diff] [blame]

397

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

398

"volumeInfo": { # General volume information.

Bu Sun Kim

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

[diff] [blame]

399

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

Yoshi Automation Bot

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

[diff] [blame^]

400

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

401

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

402

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

403

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

404

"containsEpubBubbles": True or False,

405

"epubBubbleVersion": "A String",

406

"imageBubbleVersion": "A String",

407

"containsImageBubbles": True or False,

408

},

409

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

410

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

411

"A String",

412

],

413

"mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.

Bu Sun Kim

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

[diff] [blame]

414

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

Bu Sun Kim

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

[diff] [blame]

415

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

416

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

Yoshi Automation Bot

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

[diff] [blame^]

417

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

Bu Sun Kim

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

[diff] [blame]

418

},

419

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

420

{

421

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

422

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

423

},

424

],

Yoshi Automation Bot

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

[diff] [blame^]

425

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

426

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

Bu Sun Kim

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

[diff] [blame]

427

"A String",

428

],

Yoshi Automation Bot

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

[diff] [blame^]

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

},

Bu Sun Kim

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

[diff] [blame]

438

"seriesInfo": {

Bu Sun Kim

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

[diff] [blame]

439

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

Bu Sun Kim

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

[diff] [blame]

440

"volumeSeries": [

441

{

442

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

443

{

Bu Sun Kim

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

[diff] [blame]

444

"issueOrderNumber": 42,

Yoshi Automation Bot

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

[diff] [blame^]

445

"issueDisplayNumber": "A String",

Bu Sun Kim

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

[diff] [blame]

446

},

447

],

448

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

449

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

450

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

451

},

452

],

Yoshi Automation Bot

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

[diff] [blame^]

453

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

454

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

Bu Sun Kim

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

[diff] [blame]

455

},

Yoshi Automation Bot

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

[diff] [blame^]

456

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

Bu Sun Kim

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

[diff] [blame]

457

"language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.

Yoshi Automation Bot

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

[diff] [blame^]

458

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

Bu Sun Kim

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

[diff] [blame]

459

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

Yoshi Automation Bot

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

[diff] [blame^]

460

"maturityRating": "A String",

461

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

462

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

Bu Sun Kim

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

[diff] [blame]

463

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

Bu Sun Kim

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

[diff] [blame]

464

"text": True or False,

Yoshi Automation Bot

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

[diff] [blame^]

465

"image": True or False,

Bu Sun Kim

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

[diff] [blame]

466

},

Yoshi Automation Bot

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

[diff] [blame^]

467

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

Bu Sun Kim

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

[diff] [blame]

468

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

Yoshi Automation Bot

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

[diff] [blame^]

469

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

470

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

471

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

Bu Sun Kim

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

[diff] [blame]

472

},

Bu Sun Kim

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

[diff] [blame]

473

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

474

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

475

},

476

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

Yoshi Automation Bot

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

[diff] [blame^]

477

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

478

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

479

{

480

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

481

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

482

},

483

],

Dmitry Frenkel

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

[diff] [blame]

484

},

John Asmuth

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

[diff] [blame]

485

},

486

],

Yoshi Automation Bot

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

[diff] [blame^]

487

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

488

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

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

492

Bu Sun Kim

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

[diff] [blame]

493

<code class="details" id="updateUserSettings">updateUserSettings(body=None, x__xgafv=None)</code>

Nathaniel Manista

4f877e5

2015-06-15 16:44:50 +0000

[diff] [blame]

494

<pre>Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub-objects will retain the existing value.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

495

496

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

497

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

498

The object takes the form of:

499

500

{

Dmitry Frenkel

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

[diff] [blame]

501

"notesExport": { # User settings in sub-objects, each for different purposes.

Bu Sun Kim

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

[diff] [blame]

502

"folderName": "A String",

Yoshi Automation Bot

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

[diff] [blame^]

503

"isEnabled": True or False,

Dmitry Frenkel

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

[diff] [blame]

504

},

505

"notification": {

506

"matchMyInterests": {

507

"opted_state": "A String",

Jon Wayne Parrott

36e41bc

2016-02-19 16:02:29 -0800

[diff] [blame]

508

},

Bu Sun Kim

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

[diff] [blame]

509

"priceDrop": {

Dmitry Frenkel

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

[diff] [blame]

510

"opted_state": "A String",

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

511

},

Yoshi Automation Bot

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

[diff] [blame^]

512

"moreFromAuthors": {

513

"opted_state": "A String",

514

},

Dmitry Frenkel

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

[diff] [blame]

515

"moreFromSeries": {

516

"opted_state": "A String",

517

},

Bu Sun Kim

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

[diff] [blame]

518

"rewardExpirations": {

Dmitry Frenkel

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

[diff] [blame]

519

"opted_state": "A String",

520

},

Dmitry Frenkel

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

[diff] [blame]

521

},

522

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

523

}

Bu Sun Kim

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

[diff] [blame]

524

525

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

532

533

{

Dmitry Frenkel

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

[diff] [blame]

534

"notesExport": { # User settings in sub-objects, each for different purposes.

Bu Sun Kim

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

[diff] [blame]

535

"folderName": "A String",

Yoshi Automation Bot

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

[diff] [blame^]

536

"isEnabled": True or False,

Dmitry Frenkel

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

[diff] [blame]

537

},

538

"notification": {

539

"matchMyInterests": {

540

"opted_state": "A String",

Bu Sun Kim

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

[diff] [blame]

541

},

Bu Sun Kim

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

[diff] [blame]

542

"priceDrop": {

Dmitry Frenkel

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

[diff] [blame]

543

"opted_state": "A String",

Bu Sun Kim

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

[diff] [blame]

544

},

Yoshi Automation Bot

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

[diff] [blame^]

545

"moreFromAuthors": {

546

"opted_state": "A String",

547

},

Dmitry Frenkel

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

[diff] [blame]

548

"moreFromSeries": {

549

"opted_state": "A String",

550

},

Bu Sun Kim

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

[diff] [blame]

551

"rewardExpirations": {

Dmitry Frenkel

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

[diff] [blame]

552

"opted_state": "A String",

553

},

Dmitry Frenkel

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

[diff] [blame]

554

},

555

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

556

}</pre>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

557

</div>

558

John Asmuth