Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4f877e562986034f25ea4246ad1256eabd339526 / . / docs / dyn / books_v1.mylibrary.annotations.html
blob: f1e9719a1cfb5f182d5848c8716643c732df106d [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.mylibrary.html">mylibrary</a> . <a href="books_v1.mylibrary.annotations.html">annotations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(annotationId, source=None)</a></code></p>
79<p class="firstline">Deletes an annotation.</p>
80<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]81 <code><a href="#insert">insert(body, source=None, country=None, showOnlySummaryInResponse=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Inserts a new annotation.</p>
83<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]84 <code><a href="#list">list(layerId=None, pageToken=None, layerIds=None, volumeId=None, maxResults=None, showDeleted=None, updatedMax=None, contentVersion=None, source=None, updatedMin=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Retrieves a list of annotations, possibly filtered.</p>
86<p class="toc_element">
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<p class="toc_element">
90 <code><a href="#summary">summary(layerIds, volumeId)</a></code></p>
91<p class="firstline">Gets the summary of specified layers.</p>
92<p class="toc_element">
93 <code><a href="#update">update(annotationId, body, source=None)</a></code></p>
94<p class="firstline">Updates an existing annotation.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="delete">delete(annotationId, source=None)</code>
98 <pre>Deletes an annotation.
99
100Args:
101 annotationId: string, The ID for the annotation to delete. (required)
102 source: string, String to identify the originator of this request.
103</pre>
104</div>
105
106<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]107 <code class="details" id="insert">insert(body, source=None, country=None, showOnlySummaryInResponse=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108 <pre>Inserts a new annotation.
109
110Args:
111 body: object, The request body. (required)
112 The object takes the form of:
113
114{
115 "kind": "books#annotation", # Resource type.
116 "updated": "A String", # Timestamp for the last time this annotation was modified.
117 "created": "A String", # Timestamp for the created time of this annotation.
118 "deleted": True or False, # Indicates that this annotation is deleted.
119 "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.
120 "currentVersionRanges": { # Selection ranges for the most recent content version.
121 "contentVersion": "A String", # Content version applicable to ranges below.
122 "gbTextRange": { # Range in GB text format for this annotation for version above.
123 "startPosition": "A String", # The starting position for the range.
124 "endPosition": "A String", # The ending position for the range.
125 "startOffset": "A String", # The offset from the starting position.
126 "endOffset": "A String", # The offset from the ending position.
127 },
128 "cfiRange": { # Range in CFI format for this annotation for version above.
129 "startPosition": "A String", # The starting position for the range.
130 "endPosition": "A String", # The ending position for the range.
131 "startOffset": "A String", # The offset from the starting position.
132 "endOffset": "A String", # The offset from the ending position.
133 },
134 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
135 "startPosition": "A String", # The starting position for the range.
136 "endPosition": "A String", # The ending position for the range.
137 "startOffset": "A String", # The offset from the starting position.
138 "endOffset": "A String", # The offset from the ending position.
139 },
140 "gbImageRange": { # Range in GB image format for this annotation for version above.
141 "startPosition": "A String", # The starting position for the range.
142 "endPosition": "A String", # The ending position for the range.
143 "startOffset": "A String", # The offset from the starting position.
144 "endOffset": "A String", # The offset from the ending position.
145 },
146 },
147 "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.
148 "clientVersionRanges": { # Selection ranges sent from the client.
149 "contentVersion": "A String", # Content version the client sent in.
150 "gbTextRange": { # Range in GB text format for this annotation sent by client.
151 "startPosition": "A String", # The starting position for the range.
152 "endPosition": "A String", # The ending position for the range.
153 "startOffset": "A String", # The offset from the starting position.
154 "endOffset": "A String", # The offset from the ending position.
155 },
156 "cfiRange": { # Range in CFI format for this annotation sent by client.
157 "startPosition": "A String", # The starting position for the range.
158 "endPosition": "A String", # The ending position for the range.
159 "startOffset": "A String", # The offset from the starting position.
160 "endOffset": "A String", # The offset from the ending position.
161 },
162 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
163 "startPosition": "A String", # The starting position for the range.
164 "endPosition": "A String", # The ending position for the range.
165 "startOffset": "A String", # The offset from the starting position.
166 "endOffset": "A String", # The offset from the ending position.
167 },
168 "gbImageRange": { # Range in GB image format for this annotation sent by client.
169 "startPosition": "A String", # The starting position for the range.
170 "endPosition": "A String", # The ending position for the range.
171 "startOffset": "A String", # The offset from the starting position.
172 "endOffset": "A String", # The offset from the ending position.
173 },
174 },
175 "layerSummary": {
176 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
177 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
178 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
179 },
180 "volumeId": "A String", # The volume that this annotation belongs to.
181 "pageIds": [ # Pages that this annotation spans.
182 "A String",
183 ],
184 "layerId": "A String", # The layer this annotation is for.
185 "selectedText": "A String", # Excerpt from the volume.
186 "highlightStyle": "A String", # The highlight style for this annotation.
187 "data": "A String", # User-created data for this annotation.
188 "id": "A String", # Id of this annotation, in the form of a GUID.
189 "selfLink": "A String", # URL to this resource.
190 }
191
192 source: string, String to identify the originator of this request.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]193 country: string, ISO-3166-1 code to override the IP-based location.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]194 showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
195
196Returns:
197 An object of the form:
198
199 {
200 "kind": "books#annotation", # Resource type.
201 "updated": "A String", # Timestamp for the last time this annotation was modified.
202 "created": "A String", # Timestamp for the created time of this annotation.
203 "deleted": True or False, # Indicates that this annotation is deleted.
204 "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.
205 "currentVersionRanges": { # Selection ranges for the most recent content version.
206 "contentVersion": "A String", # Content version applicable to ranges below.
207 "gbTextRange": { # Range in GB text format for this annotation for version above.
208 "startPosition": "A String", # The starting position for the range.
209 "endPosition": "A String", # The ending position for the range.
210 "startOffset": "A String", # The offset from the starting position.
211 "endOffset": "A String", # The offset from the ending position.
212 },
213 "cfiRange": { # Range in CFI format for this annotation for version above.
214 "startPosition": "A String", # The starting position for the range.
215 "endPosition": "A String", # The ending position for the range.
216 "startOffset": "A String", # The offset from the starting position.
217 "endOffset": "A String", # The offset from the ending position.
218 },
219 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
220 "startPosition": "A String", # The starting position for the range.
221 "endPosition": "A String", # The ending position for the range.
222 "startOffset": "A String", # The offset from the starting position.
223 "endOffset": "A String", # The offset from the ending position.
224 },
225 "gbImageRange": { # Range in GB image format for this annotation for version above.
226 "startPosition": "A String", # The starting position for the range.
227 "endPosition": "A String", # The ending position for the range.
228 "startOffset": "A String", # The offset from the starting position.
229 "endOffset": "A String", # The offset from the ending position.
230 },
231 },
232 "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.
233 "clientVersionRanges": { # Selection ranges sent from the client.
234 "contentVersion": "A String", # Content version the client sent in.
235 "gbTextRange": { # Range in GB text format for this annotation sent by client.
236 "startPosition": "A String", # The starting position for the range.
237 "endPosition": "A String", # The ending position for the range.
238 "startOffset": "A String", # The offset from the starting position.
239 "endOffset": "A String", # The offset from the ending position.
240 },
241 "cfiRange": { # Range in CFI format for this annotation sent by client.
242 "startPosition": "A String", # The starting position for the range.
243 "endPosition": "A String", # The ending position for the range.
244 "startOffset": "A String", # The offset from the starting position.
245 "endOffset": "A String", # The offset from the ending position.
246 },
247 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
248 "startPosition": "A String", # The starting position for the range.
249 "endPosition": "A String", # The ending position for the range.
250 "startOffset": "A String", # The offset from the starting position.
251 "endOffset": "A String", # The offset from the ending position.
252 },
253 "gbImageRange": { # Range in GB image format for this annotation sent by client.
254 "startPosition": "A String", # The starting position for the range.
255 "endPosition": "A String", # The ending position for the range.
256 "startOffset": "A String", # The offset from the starting position.
257 "endOffset": "A String", # The offset from the ending position.
258 },
259 },
260 "layerSummary": {
261 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
262 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
263 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
264 },
265 "volumeId": "A String", # The volume that this annotation belongs to.
266 "pageIds": [ # Pages that this annotation spans.
267 "A String",
268 ],
269 "layerId": "A String", # The layer this annotation is for.
270 "selectedText": "A String", # Excerpt from the volume.
271 "highlightStyle": "A String", # The highlight style for this annotation.
272 "data": "A String", # User-created data for this annotation.
273 "id": "A String", # Id of this annotation, in the form of a GUID.
274 "selfLink": "A String", # URL to this resource.
275 }</pre>
276</div>
277
278<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]279 <code class="details" id="list">list(layerId=None, pageToken=None, layerIds=None, volumeId=None, maxResults=None, showDeleted=None, updatedMax=None, contentVersion=None, source=None, updatedMin=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]280 <pre>Retrieves a list of annotations, possibly filtered.
281
282Args:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]283 layerId: string, The layer ID to limit annotation by.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]284 pageToken: string, The value of the nextToken from the previous page.
285 layerIds: string, The layer ID(s) to limit annotation by. (repeated)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]286 volumeId: string, The volume to restrict annotations to.
287 maxResults: integer, Maximum number of results to return
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]288 showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
289 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
290 contentVersion: string, The content version for the requested volume.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]291 source: string, String to identify the originator of this request.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame^]292 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]293
294Returns:
295 An object of the form:
296
297 {
298 "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.
299 "items": [ # A list of annotations.
300 {
301 "kind": "books#annotation", # Resource type.
302 "updated": "A String", # Timestamp for the last time this annotation was modified.
303 "created": "A String", # Timestamp for the created time of this annotation.
304 "deleted": True or False, # Indicates that this annotation is deleted.
305 "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.
306 "currentVersionRanges": { # Selection ranges for the most recent content version.
307 "contentVersion": "A String", # Content version applicable to ranges below.
308 "gbTextRange": { # Range in GB text format for this annotation for version above.
309 "startPosition": "A String", # The starting position for the range.
310 "endPosition": "A String", # The ending position for the range.
311 "startOffset": "A String", # The offset from the starting position.
312 "endOffset": "A String", # The offset from the ending position.
313 },
314 "cfiRange": { # Range in CFI format for this annotation for version above.
315 "startPosition": "A String", # The starting position for the range.
316 "endPosition": "A String", # The ending position for the range.
317 "startOffset": "A String", # The offset from the starting position.
318 "endOffset": "A String", # The offset from the ending position.
319 },
320 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
321 "startPosition": "A String", # The starting position for the range.
322 "endPosition": "A String", # The ending position for the range.
323 "startOffset": "A String", # The offset from the starting position.
324 "endOffset": "A String", # The offset from the ending position.
325 },
326 "gbImageRange": { # Range in GB image format for this annotation for version above.
327 "startPosition": "A String", # The starting position for the range.
328 "endPosition": "A String", # The ending position for the range.
329 "startOffset": "A String", # The offset from the starting position.
330 "endOffset": "A String", # The offset from the ending position.
331 },
332 },
333 "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.
334 "clientVersionRanges": { # Selection ranges sent from the client.
335 "contentVersion": "A String", # Content version the client sent in.
336 "gbTextRange": { # Range in GB text format for this annotation sent by client.
337 "startPosition": "A String", # The starting position for the range.
338 "endPosition": "A String", # The ending position for the range.
339 "startOffset": "A String", # The offset from the starting position.
340 "endOffset": "A String", # The offset from the ending position.
341 },
342 "cfiRange": { # Range in CFI format for this annotation sent by client.
343 "startPosition": "A String", # The starting position for the range.
344 "endPosition": "A String", # The ending position for the range.
345 "startOffset": "A String", # The offset from the starting position.
346 "endOffset": "A String", # The offset from the ending position.
347 },
348 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
349 "startPosition": "A String", # The starting position for the range.
350 "endPosition": "A String", # The ending position for the range.
351 "startOffset": "A String", # The offset from the starting position.
352 "endOffset": "A String", # The offset from the ending position.
353 },
354 "gbImageRange": { # Range in GB image format for this annotation sent by client.
355 "startPosition": "A String", # The starting position for the range.
356 "endPosition": "A String", # The ending position for the range.
357 "startOffset": "A String", # The offset from the starting position.
358 "endOffset": "A String", # The offset from the ending position.
359 },
360 },
361 "layerSummary": {
362 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
363 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
364 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
365 },
366 "volumeId": "A String", # The volume that this annotation belongs to.
367 "pageIds": [ # Pages that this annotation spans.
368 "A String",
369 ],
370 "layerId": "A String", # The layer this annotation is for.
371 "selectedText": "A String", # Excerpt from the volume.
372 "highlightStyle": "A String", # The highlight style for this annotation.
373 "data": "A String", # User-created data for this annotation.
374 "id": "A String", # Id of this annotation, in the form of a GUID.
375 "selfLink": "A String", # URL to this resource.
376 },
377 ],
378 "kind": "books#annotations", # Resource type.
379 "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.
380 }</pre>
381</div>
382
383<div class="method">
384 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
385 <pre>Retrieves the next page of results.
386
387Args:
388 previous_request: The request for the previous page. (required)
389 previous_response: The response from the request for the previous page. (required)
390
391Returns:
392 A request object that you can call 'execute()' on to request the next
393 page. Returns None if there are no more items in the collection.
394 </pre>
395</div>
396
397<div class="method">
398 <code class="details" id="summary">summary(layerIds, volumeId)</code>
399 <pre>Gets the summary of specified layers.
400
401Args:
402 layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
403 volumeId: string, Volume id to get the summary for. (required)
404
405Returns:
406 An object of the form:
407
408 {
409 "layers": [
410 {
411 "limitType": "A String",
412 "remainingCharacterCount": 42,
413 "updated": "A String",
414 "layerId": "A String",
415 "allowedCharacterCount": 42,
416 },
417 ],
418 "kind": "books#annotationsSummary",
419 }</pre>
420</div>
421
422<div class="method">
423 <code class="details" id="update">update(annotationId, body, source=None)</code>
424 <pre>Updates an existing annotation.
425
426Args:
427 annotationId: string, The ID for the annotation to update. (required)
428 body: object, The request body. (required)
429 The object takes the form of:
430
431{
432 "kind": "books#annotation", # Resource type.
433 "updated": "A String", # Timestamp for the last time this annotation was modified.
434 "created": "A String", # Timestamp for the created time of this annotation.
435 "deleted": True or False, # Indicates that this annotation is deleted.
436 "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.
437 "currentVersionRanges": { # Selection ranges for the most recent content version.
438 "contentVersion": "A String", # Content version applicable to ranges below.
439 "gbTextRange": { # Range in GB text format for this annotation for version above.
440 "startPosition": "A String", # The starting position for the range.
441 "endPosition": "A String", # The ending position for the range.
442 "startOffset": "A String", # The offset from the starting position.
443 "endOffset": "A String", # The offset from the ending position.
444 },
445 "cfiRange": { # Range in CFI format for this annotation for version above.
446 "startPosition": "A String", # The starting position for the range.
447 "endPosition": "A String", # The ending position for the range.
448 "startOffset": "A String", # The offset from the starting position.
449 "endOffset": "A String", # The offset from the ending position.
450 },
451 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
452 "startPosition": "A String", # The starting position for the range.
453 "endPosition": "A String", # The ending position for the range.
454 "startOffset": "A String", # The offset from the starting position.
455 "endOffset": "A String", # The offset from the ending position.
456 },
457 "gbImageRange": { # Range in GB image format for this annotation for version above.
458 "startPosition": "A String", # The starting position for the range.
459 "endPosition": "A String", # The ending position for the range.
460 "startOffset": "A String", # The offset from the starting position.
461 "endOffset": "A String", # The offset from the ending position.
462 },
463 },
464 "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.
465 "clientVersionRanges": { # Selection ranges sent from the client.
466 "contentVersion": "A String", # Content version the client sent in.
467 "gbTextRange": { # Range in GB text format for this annotation sent by client.
468 "startPosition": "A String", # The starting position for the range.
469 "endPosition": "A String", # The ending position for the range.
470 "startOffset": "A String", # The offset from the starting position.
471 "endOffset": "A String", # The offset from the ending position.
472 },
473 "cfiRange": { # Range in CFI format for this annotation sent by client.
474 "startPosition": "A String", # The starting position for the range.
475 "endPosition": "A String", # The ending position for the range.
476 "startOffset": "A String", # The offset from the starting position.
477 "endOffset": "A String", # The offset from the ending position.
478 },
479 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
480 "startPosition": "A String", # The starting position for the range.
481 "endPosition": "A String", # The ending position for the range.
482 "startOffset": "A String", # The offset from the starting position.
483 "endOffset": "A String", # The offset from the ending position.
484 },
485 "gbImageRange": { # Range in GB image format for this annotation sent by client.
486 "startPosition": "A String", # The starting position for the range.
487 "endPosition": "A String", # The ending position for the range.
488 "startOffset": "A String", # The offset from the starting position.
489 "endOffset": "A String", # The offset from the ending position.
490 },
491 },
492 "layerSummary": {
493 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
494 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
495 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
496 },
497 "volumeId": "A String", # The volume that this annotation belongs to.
498 "pageIds": [ # Pages that this annotation spans.
499 "A String",
500 ],
501 "layerId": "A String", # The layer this annotation is for.
502 "selectedText": "A String", # Excerpt from the volume.
503 "highlightStyle": "A String", # The highlight style for this annotation.
504 "data": "A String", # User-created data for this annotation.
505 "id": "A String", # Id of this annotation, in the form of a GUID.
506 "selfLink": "A String", # URL to this resource.
507 }
508
509 source: string, String to identify the originator of this request.
510
511Returns:
512 An object of the form:
513
514 {
515 "kind": "books#annotation", # Resource type.
516 "updated": "A String", # Timestamp for the last time this annotation was modified.
517 "created": "A String", # Timestamp for the created time of this annotation.
518 "deleted": True or False, # Indicates that this annotation is deleted.
519 "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.
520 "currentVersionRanges": { # Selection ranges for the most recent content version.
521 "contentVersion": "A String", # Content version applicable to ranges below.
522 "gbTextRange": { # Range in GB text format for this annotation for version above.
523 "startPosition": "A String", # The starting position for the range.
524 "endPosition": "A String", # The ending position for the range.
525 "startOffset": "A String", # The offset from the starting position.
526 "endOffset": "A String", # The offset from the ending position.
527 },
528 "cfiRange": { # Range in CFI format for this annotation for version above.
529 "startPosition": "A String", # The starting position for the range.
530 "endPosition": "A String", # The ending position for the range.
531 "startOffset": "A String", # The offset from the starting position.
532 "endOffset": "A String", # The offset from the ending position.
533 },
534 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
535 "startPosition": "A String", # The starting position for the range.
536 "endPosition": "A String", # The ending position for the range.
537 "startOffset": "A String", # The offset from the starting position.
538 "endOffset": "A String", # The offset from the ending position.
539 },
540 "gbImageRange": { # Range in GB image format for this annotation for version above.
541 "startPosition": "A String", # The starting position for the range.
542 "endPosition": "A String", # The ending position for the range.
543 "startOffset": "A String", # The offset from the starting position.
544 "endOffset": "A String", # The offset from the ending position.
545 },
546 },
547 "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.
548 "clientVersionRanges": { # Selection ranges sent from the client.
549 "contentVersion": "A String", # Content version the client sent in.
550 "gbTextRange": { # Range in GB text format for this annotation sent by client.
551 "startPosition": "A String", # The starting position for the range.
552 "endPosition": "A String", # The ending position for the range.
553 "startOffset": "A String", # The offset from the starting position.
554 "endOffset": "A String", # The offset from the ending position.
555 },
556 "cfiRange": { # Range in CFI format for this annotation sent by client.
557 "startPosition": "A String", # The starting position for the range.
558 "endPosition": "A String", # The ending position for the range.
559 "startOffset": "A String", # The offset from the starting position.
560 "endOffset": "A String", # The offset from the ending position.
561 },
562 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
563 "startPosition": "A String", # The starting position for the range.
564 "endPosition": "A String", # The ending position for the range.
565 "startOffset": "A String", # The offset from the starting position.
566 "endOffset": "A String", # The offset from the ending position.
567 },
568 "gbImageRange": { # Range in GB image format for this annotation sent by client.
569 "startPosition": "A String", # The starting position for the range.
570 "endPosition": "A String", # The ending position for the range.
571 "startOffset": "A String", # The offset from the starting position.
572 "endOffset": "A String", # The offset from the ending position.
573 },
574 },
575 "layerSummary": {
576 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
577 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
578 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
579 },
580 "volumeId": "A String", # The volume that this annotation belongs to.
581 "pageIds": [ # Pages that this annotation spans.
582 "A String",
583 ],
584 "layerId": "A String", # The layer this annotation is for.
585 "selectedText": "A String", # Excerpt from the volume.
586 "highlightStyle": "A String", # The highlight style for this annotation.
587 "data": "A String", # User-created data for this annotation.
588 "id": "A String", # Id of this annotation, in the form of a GUID.
589 "selfLink": "A String", # URL to this resource.
590 }</pre>
591</div>
592
593</body></html>