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

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

[diff] [blame]

78

<code><a href="#delete">delete(annotationId, source=None, x__xgafv=None)</a></code></p>

John Asmuth

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

[diff] [blame]

79

<p class="firstline">Deletes an annotation.</p>

80

Bu Sun Kim

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

[diff] [blame]

81

<code><a href="#insert">insert(body=None, country=None, source=None, annotationId=None, showOnlySummaryInResponse=None, x__xgafv=None)</a></code></p>

John Asmuth

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

[diff] [blame]

82

<p class="firstline">Inserts a new annotation.</p>

83

Bu Sun Kim

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

[diff] [blame]

84

<code><a href="#list">list(showDeleted=None, source=None, contentVersion=None, volumeId=None, layerIds=None, updatedMax=None, layerId=None, maxResults=None, updatedMin=None, pageToken=None, x__xgafv=None)</a></code></p>

John Asmuth

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

[diff] [blame]

85

<p class="firstline">Retrieves a list of annotations, possibly filtered.</p>

86

87

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

88

<p class="firstline">Retrieves the next page of results.</p>

89

Bu Sun Kim

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

[diff] [blame]

90

<code><a href="#summary">summary(volumeId=None, layerIds=None, x__xgafv=None)</a></code></p>

John Asmuth

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

[diff] [blame]

91

<p class="firstline">Gets the summary of specified layers.</p>

92

Bu Sun Kim

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

[diff] [blame]

93

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

John Asmuth

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

[diff] [blame]

94

<p class="firstline">Updates an existing annotation.</p>

95

<h3>Method Details</h3>

96

Bu Sun Kim

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

[diff] [blame]

97

<code class="details" id="delete">delete(annotationId, source=None, x__xgafv=None)</code>

John Asmuth

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

[diff] [blame]

98

<pre>Deletes an annotation.

99

100

Args:

101

annotationId: string, The ID for the annotation to delete. (required)

102

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

Bu Sun Kim

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

[diff] [blame]

103

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

110

111

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

112

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

116

<code class="details" id="insert">insert(body=None, country=None, source=None, annotationId=None, showOnlySummaryInResponse=None, x__xgafv=None)</code>

John Asmuth

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

[diff] [blame]

117

<pre>Inserts a new annotation.

118

119

Args:

Dan O'Meara

dd49464

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

[diff] [blame]

120

body: object, The request body.

John Asmuth

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

[diff] [blame]

121

The object takes the form of:

122

123

{

Bu Sun Kim

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

[diff] [blame]

124

"highlightStyle": "A String", # The highlight style for this annotation.

125

"clientVersionRanges": { # Selection ranges sent from the client.

126

"gbImageRange": { # Range in GB image format for this annotation sent by client.

127

"endPosition": "A String", # The ending position for the range.

128

"startOffset": "A String", # The offset from the starting position.

129

"startPosition": "A String", # The starting position for the range.

130

"endOffset": "A String", # The offset from the ending position.

131

},

132

"gbTextRange": { # Range in GB text format for this annotation sent by client.

133

"endPosition": "A String", # The ending position for the range.

134

"startOffset": "A String", # The offset from the starting position.

135

"startPosition": "A String", # The starting position for the range.

136

"endOffset": "A String", # The offset from the ending position.

137

},

138

"cfiRange": { # Range in CFI format for this annotation sent by client.

139

"endPosition": "A String", # The ending position for the range.

140

"startOffset": "A String", # The offset from the starting position.

141

"startPosition": "A String", # The starting position for the range.

142

"endOffset": "A String", # The offset from the ending position.

143

},

144

"contentVersion": "A String", # Content version the client sent in.

145

"imageCfiRange": { # Range in image CFI format for this annotation sent by client.

146

"endPosition": "A String", # The ending position for the range.

147

"startOffset": "A String", # The offset from the starting position.

148

"startPosition": "A String", # The starting position for the range.

149

"endOffset": "A String", # The offset from the ending position.

150

},

151

},

152

"beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

153

"pageIds": [ # Pages that this annotation spans.

154

"A String",

155

],

156

"selfLink": "A String", # URL to this resource.

157

"updated": "A String", # Timestamp for the last time this annotation was modified.

158

"selectedText": "A String", # Excerpt from the volume.

159

"id": "A String", # Id of this annotation, in the form of a GUID.

160

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

161

"layerId": "A String", # The layer this annotation is for.

162

"volumeId": "A String", # The volume that this annotation belongs to.

163

"created": "A String", # Timestamp for the created time of this annotation.

164

"deleted": True or False, # Indicates that this annotation is deleted.

165

"afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

166

"data": "A String", # User-created data for this annotation.

167

"layerSummary": {

168

"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.

169

"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.

170

"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.

171

},

172

"currentVersionRanges": { # Selection ranges for the most recent content version.

173

"cfiRange": { # Range in CFI format for this annotation for version above.

174

"endPosition": "A String", # The ending position for the range.

175

"startOffset": "A String", # The offset from the starting position.

176

"startPosition": "A String", # The starting position for the range.

177

"endOffset": "A String", # The offset from the ending position.

178

},

179

"gbTextRange": { # Range in GB text format for this annotation for version above.

180

"endPosition": "A String", # The ending position for the range.

181

"startOffset": "A String", # The offset from the starting position.

182

"startPosition": "A String", # The starting position for the range.

183

"endOffset": "A String", # The offset from the ending position.

184

},

185

"contentVersion": "A String", # Content version applicable to ranges below.

186

"gbImageRange": { # Range in GB image format for this annotation for version above.

187

"endPosition": "A String", # The ending position for the range.

188

"startOffset": "A String", # The offset from the starting position.

189

"startPosition": "A String", # The starting position for the range.

190

"endOffset": "A String", # The offset from the ending position.

191

},

192

"imageCfiRange": { # Range in image CFI format for this annotation for version above.

193

"endPosition": "A String", # The ending position for the range.

194

"startOffset": "A String", # The offset from the starting position.

195

"startPosition": "A String", # The starting position for the range.

196

"endOffset": "A String", # The offset from the ending position.

},

},

}

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

202

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

203

annotationId: string, The ID for the annotation to insert.

204

showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.

205

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

212

213

{

214

"highlightStyle": "A String", # The highlight style for this annotation.

Bu Sun Kim

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

[diff] [blame]

215

"clientVersionRanges": { # Selection ranges sent from the client.

Bu Sun Kim

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

[diff] [blame]

216

"gbImageRange": { # Range in GB image format for this annotation sent by client.

Bu Sun Kim

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

[diff] [blame]

217

"endPosition": "A String", # The ending position for the range.

218

"startOffset": "A String", # The offset from the starting position.

219

"startPosition": "A String", # The starting position for the range.

Bu Sun Kim

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

[diff] [blame]

220

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

221

},

Bu Sun Kim

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

[diff] [blame]

222

"gbTextRange": { # Range in GB text format for this annotation sent by client.

Bu Sun Kim

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

[diff] [blame]

223

"endPosition": "A String", # The ending position for the range.

224

"startOffset": "A String", # The offset from the starting position.

225

"startPosition": "A String", # The starting position for the range.

Bu Sun Kim

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

[diff] [blame]

226

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

227

},

Bu Sun Kim

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

[diff] [blame]

228

"cfiRange": { # Range in CFI format for this annotation sent by client.

229

"endPosition": "A String", # The ending position for the range.

230

"startOffset": "A String", # The offset from the starting position.

231

"startPosition": "A String", # The starting position for the range.

232

"endOffset": "A String", # The offset from the ending position.

233

},

234

"contentVersion": "A String", # Content version the client sent in.

Bu Sun Kim

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

[diff] [blame]

235

"imageCfiRange": { # Range in image CFI format for this annotation sent by client.

Bu Sun Kim

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

[diff] [blame]

236

"endPosition": "A String", # The ending position for the range.

237

"startOffset": "A String", # The offset from the starting position.

238

"startPosition": "A String", # The starting position for the range.

Bu Sun Kim

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

[diff] [blame]

239

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

240

},

241

},

Bu Sun Kim

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

[diff] [blame]

242

"beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

243

"pageIds": [ # Pages that this annotation spans.

244

"A String",

245

],

246

"selfLink": "A String", # URL to this resource.

247

"updated": "A String", # Timestamp for the last time this annotation was modified.

248

"selectedText": "A String", # Excerpt from the volume.

Bu Sun Kim

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

[diff] [blame]

249

"id": "A String", # Id of this annotation, in the form of a GUID.

Bu Sun Kim

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

[diff] [blame]

250

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

Bu Sun Kim

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

[diff] [blame]

251

"layerId": "A String", # The layer this annotation is for.

Bu Sun Kim

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

[diff] [blame]

252

"volumeId": "A String", # The volume that this annotation belongs to.

253

"created": "A String", # Timestamp for the created time of this annotation.

254

"deleted": True or False, # Indicates that this annotation is deleted.

255

"afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

256

"data": "A String", # User-created data for this annotation.

Bu Sun Kim

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

[diff] [blame]

257

"layerSummary": {

258

"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.

259

"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.

260

"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.

John Asmuth

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

[diff] [blame]

261

},

Bu Sun Kim

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

[diff] [blame]

262

"currentVersionRanges": { # Selection ranges for the most recent content version.

263

"cfiRange": { # Range in CFI format for this annotation for version above.

264

"endPosition": "A String", # The ending position for the range.

265

"startOffset": "A String", # The offset from the starting position.

266

"startPosition": "A String", # The starting position for the range.

267

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

268

},

Bu Sun Kim

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

[diff] [blame]

269

"gbTextRange": { # Range in GB text format for this annotation for version above.

270

"endPosition": "A String", # The ending position for the range.

271

"startOffset": "A String", # The offset from the starting position.

272

"startPosition": "A String", # The starting position for the range.

273

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

274

},

Bu Sun Kim

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

[diff] [blame]

275

"contentVersion": "A String", # Content version applicable to ranges below.

276

"gbImageRange": { # Range in GB image format for this annotation for version above.

277

"endPosition": "A String", # The ending position for the range.

278

"startOffset": "A String", # The offset from the starting position.

279

"startPosition": "A String", # The starting position for the range.

280

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

281

},

Bu Sun Kim

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

[diff] [blame]

282

"imageCfiRange": { # Range in image CFI format for this annotation for version above.

283

"endPosition": "A String", # The ending position for the range.

284

"startOffset": "A String", # The offset from the starting position.

285

"startPosition": "A String", # The starting position for the range.

286

"endOffset": "A String", # The offset from the ending position.

287

},

288

},

289

}</pre>

John Asmuth

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

293

<code class="details" id="list">list(showDeleted=None, source=None, contentVersion=None, volumeId=None, layerIds=None, updatedMax=None, layerId=None, maxResults=None, updatedMin=None, pageToken=None, x__xgafv=None)</code>

John Asmuth

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

[diff] [blame]

294

<pre>Retrieves a list of annotations, possibly filtered.

295

296

Args:

Bu Sun Kim

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

[diff] [blame]

297

showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

John Asmuth

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

[diff] [blame]

298

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

Bu Sun Kim

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

[diff] [blame]

299

contentVersion: string, The content version for the requested volume.

Bu Sun Kim

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

[diff] [blame]

300

volumeId: string, The volume to restrict annotations to.

Bu Sun Kim

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

[diff] [blame]

301

layerIds: string, The layer ID(s) to limit annotation by. (repeated)

302

updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

303

layerId: string, The layer ID to limit annotation by.

304

maxResults: integer, Maximum number of results to return

305

updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

306

pageToken: string, The value of the nextToken from the previous page.

307

x__xgafv: string, V1 error format.

308

Allowed values

309

1 - v1 error format

310

2 - v2 error format

John Asmuth

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

[diff] [blame]

311

312

Returns:

313

An object of the form:

314

315

{

Bu Sun Kim

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

[diff] [blame]

316

"nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.

Bu Sun Kim

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

[diff] [blame]

317

"items": [ # A list of annotations.

John Asmuth

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

[diff] [blame]

318

{

Bu Sun Kim

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

[diff] [blame]

319

"highlightStyle": "A String", # The highlight style for this annotation.

320

"clientVersionRanges": { # Selection ranges sent from the client.

321

"gbImageRange": { # Range in GB image format for this annotation sent by client.

322

"endPosition": "A String", # The ending position for the range.

323

"startOffset": "A String", # The offset from the starting position.

324

"startPosition": "A String", # The starting position for the range.

325

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

326

},

Bu Sun Kim

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

[diff] [blame]

327

"gbTextRange": { # Range in GB text format for this annotation sent by client.

328

"endPosition": "A String", # The ending position for the range.

329

"startOffset": "A String", # The offset from the starting position.

330

"startPosition": "A String", # The starting position for the range.

331

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

332

},

Bu Sun Kim

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

[diff] [blame]

333

"cfiRange": { # Range in CFI format for this annotation sent by client.

334

"endPosition": "A String", # The ending position for the range.

335

"startOffset": "A String", # The offset from the starting position.

336

"startPosition": "A String", # The starting position for the range.

337

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

338

},

Bu Sun Kim

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

[diff] [blame]

339

"contentVersion": "A String", # Content version the client sent in.

340

"imageCfiRange": { # Range in image CFI format for this annotation sent by client.

341

"endPosition": "A String", # The ending position for the range.

342

"startOffset": "A String", # The offset from the starting position.

343

"startPosition": "A String", # The starting position for the range.

344

"endOffset": "A String", # The offset from the ending position.

345

},

John Asmuth

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

[diff] [blame]

346

},

Bu Sun Kim

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

[diff] [blame]

347

"beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

348

"pageIds": [ # Pages that this annotation spans.

349

"A String",

350

],

351

"selfLink": "A String", # URL to this resource.

352

"updated": "A String", # Timestamp for the last time this annotation was modified.

353

"selectedText": "A String", # Excerpt from the volume.

354

"id": "A String", # Id of this annotation, in the form of a GUID.

355

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

356

"layerId": "A String", # The layer this annotation is for.

357

"volumeId": "A String", # The volume that this annotation belongs to.

358

"created": "A String", # Timestamp for the created time of this annotation.

359

"deleted": True or False, # Indicates that this annotation is deleted.

360

"afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

361

"data": "A String", # User-created data for this annotation.

362

"layerSummary": {

363

"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.

364

"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.

365

"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.

366

},

367

"currentVersionRanges": { # Selection ranges for the most recent content version.

368

"cfiRange": { # Range in CFI format for this annotation for version above.

369

"endPosition": "A String", # The ending position for the range.

370

"startOffset": "A String", # The offset from the starting position.

371

"startPosition": "A String", # The starting position for the range.

372

"endOffset": "A String", # The offset from the ending position.

373

},

374

"gbTextRange": { # Range in GB text format for this annotation for version above.

375

"endPosition": "A String", # The ending position for the range.

376

"startOffset": "A String", # The offset from the starting position.

377

"startPosition": "A String", # The starting position for the range.

378

"endOffset": "A String", # The offset from the ending position.

379

},

380

"contentVersion": "A String", # Content version applicable to ranges below.

381

"gbImageRange": { # Range in GB image format for this annotation for version above.

382

"endPosition": "A String", # The ending position for the range.

383

"startOffset": "A String", # The offset from the starting position.

384

"startPosition": "A String", # The starting position for the range.

385

"endOffset": "A String", # The offset from the ending position.

386

},

387

"imageCfiRange": { # Range in image CFI format for this annotation for version above.

388

"endPosition": "A String", # The ending position for the range.

389

"startOffset": "A String", # The offset from the starting position.

390

"startPosition": "A String", # The starting position for the range.

391

"endOffset": "A String", # The offset from the ending position.

392

},

393

},

394

},

John Asmuth

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

[diff] [blame]

395

],

Bu Sun Kim

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

[diff] [blame]

396

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

Bu Sun Kim

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

[diff] [blame]

397

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

John Asmuth

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

403

<pre>Retrieves the next page of results.

404

405

Args:

406

previous_request: The request for the previous page. (required)

407

previous_response: The response from the request for the previous page. (required)

408

409

Returns:

Bu Sun Kim

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

[diff] [blame]

410

A request object that you can call 'execute()' on to request the next

John Asmuth

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

[diff] [blame]

411

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

416

<code class="details" id="summary">summary(volumeId=None, layerIds=None, x__xgafv=None)</code>

John Asmuth

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

[diff] [blame]

417

<pre>Gets the summary of specified layers.

418

419

Args:

Bu Sun Kim

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

[diff] [blame]

420

volumeId: string, Volume id to get the summary for.

421

layerIds: string, Array of layer IDs to get the summary for. (repeated)

422

x__xgafv: string, V1 error format.

423

Allowed values

424

1 - v1 error format

425

2 - v2 error format

John Asmuth

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

[diff] [blame]

426

427

Returns:

428

An object of the form:

429

430

{

Bu Sun Kim

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

[diff] [blame]

431

"layers": [

John Asmuth

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

[diff] [blame]

432

{

Bu Sun Kim

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

[diff] [blame]

433

"updated": "A String",

Bu Sun Kim

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

[diff] [blame]

434

"allowedCharacterCount": 42,

Bu Sun Kim

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

[diff] [blame]

435

"remainingCharacterCount": 42,

Bu Sun Kim

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

[diff] [blame]

436

"layerId": "A String",

437

"limitType": "A String",

John Asmuth

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

[diff] [blame]

438

},

439

],

Bu Sun Kim

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

[diff] [blame]

440

"kind": "A String",

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

445

<code class="details" id="update">update(annotationId, body=None, source=None, x__xgafv=None)</code>

John Asmuth

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

[diff] [blame]

446

<pre>Updates an existing annotation.

447

448

Args:

449

annotationId: string, The ID for the annotation to update. (required)

Dan O'Meara

dd49464

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

[diff] [blame]

450

body: object, The request body.

John Asmuth

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

[diff] [blame]

451

The object takes the form of:

452

453

{

Bu Sun Kim

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

[diff] [blame]

454

"highlightStyle": "A String", # The highlight style for this annotation.

455

"clientVersionRanges": { # Selection ranges sent from the client.

456

"gbImageRange": { # Range in GB image format for this annotation sent by client.

457

"endPosition": "A String", # The ending position for the range.

458

"startOffset": "A String", # The offset from the starting position.

459

"startPosition": "A String", # The starting position for the range.

460

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

461

},

Bu Sun Kim

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

[diff] [blame]

462

"gbTextRange": { # Range in GB text format for this annotation sent by client.

463

"endPosition": "A String", # The ending position for the range.

464

"startOffset": "A String", # The offset from the starting position.

465

"startPosition": "A String", # The starting position for the range.

466

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

467

},

Bu Sun Kim

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

[diff] [blame]

468

"cfiRange": { # Range in CFI format for this annotation sent by client.

469

"endPosition": "A String", # The ending position for the range.

470

"startOffset": "A String", # The offset from the starting position.

471

"startPosition": "A String", # The starting position for the range.

472

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

473

},

Bu Sun Kim

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

[diff] [blame]

474

"contentVersion": "A String", # Content version the client sent in.

475

"imageCfiRange": { # Range in image CFI format for this annotation sent by client.

476

"endPosition": "A String", # The ending position for the range.

477

"startOffset": "A String", # The offset from the starting position.

478

"startPosition": "A String", # The starting position for the range.

479

"endOffset": "A String", # The offset from the ending position.

480

},

481

},

482

"beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

483

"pageIds": [ # Pages that this annotation spans.

484

"A String",

485

],

486

"selfLink": "A String", # URL to this resource.

487

"updated": "A String", # Timestamp for the last time this annotation was modified.

488

"selectedText": "A String", # Excerpt from the volume.

489

"id": "A String", # Id of this annotation, in the form of a GUID.

490

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

491

"layerId": "A String", # The layer this annotation is for.

492

"volumeId": "A String", # The volume that this annotation belongs to.

493

"created": "A String", # Timestamp for the created time of this annotation.

494

"deleted": True or False, # Indicates that this annotation is deleted.

495

"afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.

496

"data": "A String", # User-created data for this annotation.

497

"layerSummary": {

498

"allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.

499

"limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.

500

"remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.

501

},

502

"currentVersionRanges": { # Selection ranges for the most recent content version.

503

"cfiRange": { # Range in CFI format for this annotation for version above.

504

"endPosition": "A String", # The ending position for the range.

505

"startOffset": "A String", # The offset from the starting position.

506

"startPosition": "A String", # The starting position for the range.

507

"endOffset": "A String", # The offset from the ending position.

508

},

509

"gbTextRange": { # Range in GB text format for this annotation for version above.

510

"endPosition": "A String", # The ending position for the range.

511

"startOffset": "A String", # The offset from the starting position.

512

"startPosition": "A String", # The starting position for the range.

513

"endOffset": "A String", # The offset from the ending position.

514

},

515

"contentVersion": "A String", # Content version applicable to ranges below.

516

"gbImageRange": { # Range in GB image format for this annotation for version above.

517

"endPosition": "A String", # The ending position for the range.

518

"startOffset": "A String", # The offset from the starting position.

519

"startPosition": "A String", # The starting position for the range.

520

"endOffset": "A String", # The offset from the ending position.

521

},

522

"imageCfiRange": { # Range in image CFI format for this annotation for version above.

523

"endPosition": "A String", # The ending position for the range.

524

"startOffset": "A String", # The offset from the starting position.

525

"startPosition": "A String", # The starting position for the range.

526

"endOffset": "A String", # The offset from the ending position.

527

},

528

},

529

}

John Asmuth

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

[diff] [blame]

530

531

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

Bu Sun Kim

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

[diff] [blame]

532

x__xgafv: string, V1 error format.

533

Allowed values

534

1 - v1 error format

535

2 - v2 error format

John Asmuth

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

[diff] [blame]

536

537

Returns:

538

An object of the form:

539

540

{

Bu Sun Kim

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

[diff] [blame]

541

"highlightStyle": "A String", # The highlight style for this annotation.

542

"clientVersionRanges": { # Selection ranges sent from the client.

543

"gbImageRange": { # Range in GB image format for this annotation sent by client.

544

"endPosition": "A String", # The ending position for the range.

545

"startOffset": "A String", # The offset from the starting position.

546

"startPosition": "A String", # The starting position for the range.

547

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

548

},

Bu Sun Kim

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

[diff] [blame]

549

"gbTextRange": { # Range in GB text format for this annotation sent by client.

550

"endPosition": "A String", # The ending position for the range.

551

"startOffset": "A String", # The offset from the starting position.

552

"startPosition": "A String", # The starting position for the range.

553

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

554

},

Bu Sun Kim

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

[diff] [blame]

555

"cfiRange": { # Range in CFI format for this annotation sent by client.

556

"endPosition": "A String", # The ending position for the range.

557

"startOffset": "A String", # The offset from the starting position.

558

"startPosition": "A String", # The starting position for the range.

559

"endOffset": "A String", # The offset from the ending position.

John Asmuth

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

[diff] [blame]

560

},

Bu Sun Kim