Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / books_v1.mylibrary.annotations.html
blob: d28c3613cc77fe23d2c0a5e10530c02bd1ef3437 [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">
81 <code><a href="#get">get(annotationId, source=None)</a></code></p>
82<p class="firstline">Gets an annotation by its ID.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(body, source=None, showOnlySummaryInResponse=None)</a></code></p>
85<p class="firstline">Inserts a new annotation.</p>
86<p class="toc_element">
87 <code><a href="#list">list(pageToken=None, updatedMin=None, showDeleted=None, pageIds=None, contentVersion=None, layerId=None, updatedMax=None, volumeId=None, maxResults=None, layerIds=None, source=None)</a></code></p>
88<p class="firstline">Retrieves a list of annotations, possibly filtered.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#summary">summary(layerIds, volumeId)</a></code></p>
94<p class="firstline">Gets the summary of specified layers.</p>
95<p class="toc_element">
96 <code><a href="#update">update(annotationId, body, source=None)</a></code></p>
97<p class="firstline">Updates an existing annotation.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(annotationId, source=None)</code>
101 <pre>Deletes an annotation.
102
103Args:
104 annotationId: string, The ID for the annotation to delete. (required)
105 source: string, String to identify the originator of this request.
106</pre>
107</div>
108
109<div class="method">
110 <code class="details" id="get">get(annotationId, source=None)</code>
111 <pre>Gets an annotation by its ID.
112
113Args:
114 annotationId: string, The ID for the annotation to retrieve. (required)
115 source: string, String to identify the originator of this request.
116
117Returns:
118 An object of the form:
119
120 {
121 "kind": "books#annotation", # Resource type.
122 "updated": "A String", # Timestamp for the last time this annotation was modified.
123 "created": "A String", # Timestamp for the created time of this annotation.
124 "deleted": True or False, # Indicates that this annotation is deleted.
125 "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.
126 "currentVersionRanges": { # Selection ranges for the most recent content version.
127 "contentVersion": "A String", # Content version applicable to ranges below.
128 "gbTextRange": { # Range in GB text 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 "cfiRange": { # Range in 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 "imageCfiRange": { # Range in image CFI 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 "gbImageRange": { # Range in GB image format for this annotation for version above.
147 "startPosition": "A String", # The starting position for the range.
148 "endPosition": "A String", # The ending position for the range.
149 "startOffset": "A String", # The offset from the starting position.
150 "endOffset": "A String", # The offset from the ending position.
151 },
152 },
153 "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.
154 "clientVersionRanges": { # Selection ranges sent from the client.
155 "contentVersion": "A String", # Content version the client sent in.
156 "gbTextRange": { # Range in GB text 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 "cfiRange": { # Range in 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 "imageCfiRange": { # Range in image CFI 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 "gbImageRange": { # Range in GB image format for this annotation sent by client.
175 "startPosition": "A String", # The starting position for the range.
176 "endPosition": "A String", # The ending position for the range.
177 "startOffset": "A String", # The offset from the starting position.
178 "endOffset": "A String", # The offset from the ending position.
179 },
180 },
181 "layerSummary": {
182 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
183 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
184 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
185 },
186 "volumeId": "A String", # The volume that this annotation belongs to.
187 "pageIds": [ # Pages that this annotation spans.
188 "A String",
189 ],
190 "layerId": "A String", # The layer this annotation is for.
191 "selectedText": "A String", # Excerpt from the volume.
192 "highlightStyle": "A String", # The highlight style for this annotation.
193 "data": "A String", # User-created data for this annotation.
194 "id": "A String", # Id of this annotation, in the form of a GUID.
195 "selfLink": "A String", # URL to this resource.
196 }</pre>
197</div>
198
199<div class="method">
200 <code class="details" id="insert">insert(body, source=None, showOnlySummaryInResponse=None)</code>
201 <pre>Inserts a new annotation.
202
203Args:
204 body: object, The request body. (required)
205 The object takes the form of:
206
207{
208 "kind": "books#annotation", # Resource type.
209 "updated": "A String", # Timestamp for the last time this annotation was modified.
210 "created": "A String", # Timestamp for the created time of this annotation.
211 "deleted": True or False, # Indicates that this annotation is deleted.
212 "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.
213 "currentVersionRanges": { # Selection ranges for the most recent content version.
214 "contentVersion": "A String", # Content version applicable to ranges below.
215 "gbTextRange": { # Range in GB text format for this annotation for version above.
216 "startPosition": "A String", # The starting position for the range.
217 "endPosition": "A String", # The ending position for the range.
218 "startOffset": "A String", # The offset from the starting position.
219 "endOffset": "A String", # The offset from the ending position.
220 },
221 "cfiRange": { # Range in CFI format for this annotation for version above.
222 "startPosition": "A String", # The starting position for the range.
223 "endPosition": "A String", # The ending position for the range.
224 "startOffset": "A String", # The offset from the starting position.
225 "endOffset": "A String", # The offset from the ending position.
226 },
227 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
228 "startPosition": "A String", # The starting position for the range.
229 "endPosition": "A String", # The ending position for the range.
230 "startOffset": "A String", # The offset from the starting position.
231 "endOffset": "A String", # The offset from the ending position.
232 },
233 "gbImageRange": { # Range in GB image format for this annotation for version above.
234 "startPosition": "A String", # The starting position for the range.
235 "endPosition": "A String", # The ending position for the range.
236 "startOffset": "A String", # The offset from the starting position.
237 "endOffset": "A String", # The offset from the ending position.
238 },
239 },
240 "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.
241 "clientVersionRanges": { # Selection ranges sent from the client.
242 "contentVersion": "A String", # Content version the client sent in.
243 "gbTextRange": { # Range in GB text format for this annotation sent by client.
244 "startPosition": "A String", # The starting position for the range.
245 "endPosition": "A String", # The ending position for the range.
246 "startOffset": "A String", # The offset from the starting position.
247 "endOffset": "A String", # The offset from the ending position.
248 },
249 "cfiRange": { # Range in CFI format for this annotation sent by client.
250 "startPosition": "A String", # The starting position for the range.
251 "endPosition": "A String", # The ending position for the range.
252 "startOffset": "A String", # The offset from the starting position.
253 "endOffset": "A String", # The offset from the ending position.
254 },
255 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
256 "startPosition": "A String", # The starting position for the range.
257 "endPosition": "A String", # The ending position for the range.
258 "startOffset": "A String", # The offset from the starting position.
259 "endOffset": "A String", # The offset from the ending position.
260 },
261 "gbImageRange": { # Range in GB image format for this annotation sent by client.
262 "startPosition": "A String", # The starting position for the range.
263 "endPosition": "A String", # The ending position for the range.
264 "startOffset": "A String", # The offset from the starting position.
265 "endOffset": "A String", # The offset from the ending position.
266 },
267 },
268 "layerSummary": {
269 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
270 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
271 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
272 },
273 "volumeId": "A String", # The volume that this annotation belongs to.
274 "pageIds": [ # Pages that this annotation spans.
275 "A String",
276 ],
277 "layerId": "A String", # The layer this annotation is for.
278 "selectedText": "A String", # Excerpt from the volume.
279 "highlightStyle": "A String", # The highlight style for this annotation.
280 "data": "A String", # User-created data for this annotation.
281 "id": "A String", # Id of this annotation, in the form of a GUID.
282 "selfLink": "A String", # URL to this resource.
283 }
284
285 source: string, String to identify the originator of this request.
286 showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
287
288Returns:
289 An object of the form:
290
291 {
292 "kind": "books#annotation", # Resource type.
293 "updated": "A String", # Timestamp for the last time this annotation was modified.
294 "created": "A String", # Timestamp for the created time of this annotation.
295 "deleted": True or False, # Indicates that this annotation is deleted.
296 "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.
297 "currentVersionRanges": { # Selection ranges for the most recent content version.
298 "contentVersion": "A String", # Content version applicable to ranges below.
299 "gbTextRange": { # Range in GB text format for this annotation for version above.
300 "startPosition": "A String", # The starting position for the range.
301 "endPosition": "A String", # The ending position for the range.
302 "startOffset": "A String", # The offset from the starting position.
303 "endOffset": "A String", # The offset from the ending position.
304 },
305 "cfiRange": { # Range in CFI format for this annotation for version above.
306 "startPosition": "A String", # The starting position for the range.
307 "endPosition": "A String", # The ending position for the range.
308 "startOffset": "A String", # The offset from the starting position.
309 "endOffset": "A String", # The offset from the ending position.
310 },
311 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
312 "startPosition": "A String", # The starting position for the range.
313 "endPosition": "A String", # The ending position for the range.
314 "startOffset": "A String", # The offset from the starting position.
315 "endOffset": "A String", # The offset from the ending position.
316 },
317 "gbImageRange": { # Range in GB image format for this annotation for version above.
318 "startPosition": "A String", # The starting position for the range.
319 "endPosition": "A String", # The ending position for the range.
320 "startOffset": "A String", # The offset from the starting position.
321 "endOffset": "A String", # The offset from the ending position.
322 },
323 },
324 "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.
325 "clientVersionRanges": { # Selection ranges sent from the client.
326 "contentVersion": "A String", # Content version the client sent in.
327 "gbTextRange": { # Range in GB text format for this annotation sent by client.
328 "startPosition": "A String", # The starting position for the range.
329 "endPosition": "A String", # The ending position for the range.
330 "startOffset": "A String", # The offset from the starting position.
331 "endOffset": "A String", # The offset from the ending position.
332 },
333 "cfiRange": { # Range in CFI format for this annotation sent by client.
334 "startPosition": "A String", # The starting position for the range.
335 "endPosition": "A String", # The ending position for the range.
336 "startOffset": "A String", # The offset from the starting position.
337 "endOffset": "A String", # The offset from the ending position.
338 },
339 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
340 "startPosition": "A String", # The starting position for the range.
341 "endPosition": "A String", # The ending position for the range.
342 "startOffset": "A String", # The offset from the starting position.
343 "endOffset": "A String", # The offset from the ending position.
344 },
345 "gbImageRange": { # Range in GB image format for this annotation sent by client.
346 "startPosition": "A String", # The starting position for the range.
347 "endPosition": "A String", # The ending position for the range.
348 "startOffset": "A String", # The offset from the starting position.
349 "endOffset": "A String", # The offset from the ending position.
350 },
351 },
352 "layerSummary": {
353 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
354 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
355 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
356 },
357 "volumeId": "A String", # The volume that this annotation belongs to.
358 "pageIds": [ # Pages that this annotation spans.
359 "A String",
360 ],
361 "layerId": "A String", # The layer this annotation is for.
362 "selectedText": "A String", # Excerpt from the volume.
363 "highlightStyle": "A String", # The highlight style for this annotation.
364 "data": "A String", # User-created data for this annotation.
365 "id": "A String", # Id of this annotation, in the form of a GUID.
366 "selfLink": "A String", # URL to this resource.
367 }</pre>
368</div>
369
370<div class="method">
371 <code class="details" id="list">list(pageToken=None, updatedMin=None, showDeleted=None, pageIds=None, contentVersion=None, layerId=None, updatedMax=None, volumeId=None, maxResults=None, layerIds=None, source=None)</code>
372 <pre>Retrieves a list of annotations, possibly filtered.
373
374Args:
375 pageToken: string, The value of the nextToken from the previous page.
376 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
377 showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
378 pageIds: string, The page ID(s) for the volume that is being queried. (repeated)
379 contentVersion: string, The content version for the requested volume.
380 layerId: string, The layer ID to limit annotation by.
381 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
382 volumeId: string, The volume to restrict annotations to.
383 maxResults: integer, Maximum number of results to return
384 layerIds: string, The layer ID(s) to limit annotation by. (repeated)
385 source: string, String to identify the originator of this request.
386
387Returns:
388 An object of the form:
389
390 {
391 "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.
392 "items": [ # A list of annotations.
393 {
394 "kind": "books#annotation", # Resource type.
395 "updated": "A String", # Timestamp for the last time this annotation was modified.
396 "created": "A String", # Timestamp for the created time of this annotation.
397 "deleted": True or False, # Indicates that this annotation is deleted.
398 "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.
399 "currentVersionRanges": { # Selection ranges for the most recent content version.
400 "contentVersion": "A String", # Content version applicable to ranges below.
401 "gbTextRange": { # Range in GB text format for this annotation for version above.
402 "startPosition": "A String", # The starting position for the range.
403 "endPosition": "A String", # The ending position for the range.
404 "startOffset": "A String", # The offset from the starting position.
405 "endOffset": "A String", # The offset from the ending position.
406 },
407 "cfiRange": { # Range in CFI format for this annotation for version above.
408 "startPosition": "A String", # The starting position for the range.
409 "endPosition": "A String", # The ending position for the range.
410 "startOffset": "A String", # The offset from the starting position.
411 "endOffset": "A String", # The offset from the ending position.
412 },
413 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
414 "startPosition": "A String", # The starting position for the range.
415 "endPosition": "A String", # The ending position for the range.
416 "startOffset": "A String", # The offset from the starting position.
417 "endOffset": "A String", # The offset from the ending position.
418 },
419 "gbImageRange": { # Range in GB image format for this annotation for version above.
420 "startPosition": "A String", # The starting position for the range.
421 "endPosition": "A String", # The ending position for the range.
422 "startOffset": "A String", # The offset from the starting position.
423 "endOffset": "A String", # The offset from the ending position.
424 },
425 },
426 "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.
427 "clientVersionRanges": { # Selection ranges sent from the client.
428 "contentVersion": "A String", # Content version the client sent in.
429 "gbTextRange": { # Range in GB text format for this annotation sent by client.
430 "startPosition": "A String", # The starting position for the range.
431 "endPosition": "A String", # The ending position for the range.
432 "startOffset": "A String", # The offset from the starting position.
433 "endOffset": "A String", # The offset from the ending position.
434 },
435 "cfiRange": { # Range in CFI format for this annotation sent by client.
436 "startPosition": "A String", # The starting position for the range.
437 "endPosition": "A String", # The ending position for the range.
438 "startOffset": "A String", # The offset from the starting position.
439 "endOffset": "A String", # The offset from the ending position.
440 },
441 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
442 "startPosition": "A String", # The starting position for the range.
443 "endPosition": "A String", # The ending position for the range.
444 "startOffset": "A String", # The offset from the starting position.
445 "endOffset": "A String", # The offset from the ending position.
446 },
447 "gbImageRange": { # Range in GB image format for this annotation sent by client.
448 "startPosition": "A String", # The starting position for the range.
449 "endPosition": "A String", # The ending position for the range.
450 "startOffset": "A String", # The offset from the starting position.
451 "endOffset": "A String", # The offset from the ending position.
452 },
453 },
454 "layerSummary": {
455 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
456 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
457 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
458 },
459 "volumeId": "A String", # The volume that this annotation belongs to.
460 "pageIds": [ # Pages that this annotation spans.
461 "A String",
462 ],
463 "layerId": "A String", # The layer this annotation is for.
464 "selectedText": "A String", # Excerpt from the volume.
465 "highlightStyle": "A String", # The highlight style for this annotation.
466 "data": "A String", # User-created data for this annotation.
467 "id": "A String", # Id of this annotation, in the form of a GUID.
468 "selfLink": "A String", # URL to this resource.
469 },
470 ],
471 "kind": "books#annotations", # Resource type.
472 "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.
473 }</pre>
474</div>
475
476<div class="method">
477 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
478 <pre>Retrieves the next page of results.
479
480Args:
481 previous_request: The request for the previous page. (required)
482 previous_response: The response from the request for the previous page. (required)
483
484Returns:
485 A request object that you can call 'execute()' on to request the next
486 page. Returns None if there are no more items in the collection.
487 </pre>
488</div>
489
490<div class="method">
491 <code class="details" id="summary">summary(layerIds, volumeId)</code>
492 <pre>Gets the summary of specified layers.
493
494Args:
495 layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
496 volumeId: string, Volume id to get the summary for. (required)
497
498Returns:
499 An object of the form:
500
501 {
502 "layers": [
503 {
504 "limitType": "A String",
505 "remainingCharacterCount": 42,
506 "updated": "A String",
507 "layerId": "A String",
508 "allowedCharacterCount": 42,
509 },
510 ],
511 "kind": "books#annotationsSummary",
512 }</pre>
513</div>
514
515<div class="method">
516 <code class="details" id="update">update(annotationId, body, source=None)</code>
517 <pre>Updates an existing annotation.
518
519Args:
520 annotationId: string, The ID for the annotation to update. (required)
521 body: object, The request body. (required)
522 The object takes the form of:
523
524{
525 "kind": "books#annotation", # Resource type.
526 "updated": "A String", # Timestamp for the last time this annotation was modified.
527 "created": "A String", # Timestamp for the created time of this annotation.
528 "deleted": True or False, # Indicates that this annotation is deleted.
529 "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.
530 "currentVersionRanges": { # Selection ranges for the most recent content version.
531 "contentVersion": "A String", # Content version applicable to ranges below.
532 "gbTextRange": { # Range in GB text format for this annotation for version above.
533 "startPosition": "A String", # The starting position for the range.
534 "endPosition": "A String", # The ending position for the range.
535 "startOffset": "A String", # The offset from the starting position.
536 "endOffset": "A String", # The offset from the ending position.
537 },
538 "cfiRange": { # Range in CFI format for this annotation for version above.
539 "startPosition": "A String", # The starting position for the range.
540 "endPosition": "A String", # The ending position for the range.
541 "startOffset": "A String", # The offset from the starting position.
542 "endOffset": "A String", # The offset from the ending position.
543 },
544 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
545 "startPosition": "A String", # The starting position for the range.
546 "endPosition": "A String", # The ending position for the range.
547 "startOffset": "A String", # The offset from the starting position.
548 "endOffset": "A String", # The offset from the ending position.
549 },
550 "gbImageRange": { # Range in GB image format for this annotation for version above.
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 },
557 "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.
558 "clientVersionRanges": { # Selection ranges sent from the client.
559 "contentVersion": "A String", # Content version the client sent in.
560 "gbTextRange": { # Range in GB text format for this annotation sent by client.
561 "startPosition": "A String", # The starting position for the range.
562 "endPosition": "A String", # The ending position for the range.
563 "startOffset": "A String", # The offset from the starting position.
564 "endOffset": "A String", # The offset from the ending position.
565 },
566 "cfiRange": { # Range in CFI format for this annotation sent by client.
567 "startPosition": "A String", # The starting position for the range.
568 "endPosition": "A String", # The ending position for the range.
569 "startOffset": "A String", # The offset from the starting position.
570 "endOffset": "A String", # The offset from the ending position.
571 },
572 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
573 "startPosition": "A String", # The starting position for the range.
574 "endPosition": "A String", # The ending position for the range.
575 "startOffset": "A String", # The offset from the starting position.
576 "endOffset": "A String", # The offset from the ending position.
577 },
578 "gbImageRange": { # Range in GB image format for this annotation sent by client.
579 "startPosition": "A String", # The starting position for the range.
580 "endPosition": "A String", # The ending position for the range.
581 "startOffset": "A String", # The offset from the starting position.
582 "endOffset": "A String", # The offset from the ending position.
583 },
584 },
585 "layerSummary": {
586 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
587 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
588 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
589 },
590 "volumeId": "A String", # The volume that this annotation belongs to.
591 "pageIds": [ # Pages that this annotation spans.
592 "A String",
593 ],
594 "layerId": "A String", # The layer this annotation is for.
595 "selectedText": "A String", # Excerpt from the volume.
596 "highlightStyle": "A String", # The highlight style for this annotation.
597 "data": "A String", # User-created data for this annotation.
598 "id": "A String", # Id of this annotation, in the form of a GUID.
599 "selfLink": "A String", # URL to this resource.
600 }
601
602 source: string, String to identify the originator of this request.
603
604Returns:
605 An object of the form:
606
607 {
608 "kind": "books#annotation", # Resource type.
609 "updated": "A String", # Timestamp for the last time this annotation was modified.
610 "created": "A String", # Timestamp for the created time of this annotation.
611 "deleted": True or False, # Indicates that this annotation is deleted.
612 "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.
613 "currentVersionRanges": { # Selection ranges for the most recent content version.
614 "contentVersion": "A String", # Content version applicable to ranges below.
615 "gbTextRange": { # Range in GB text format for this annotation for version above.
616 "startPosition": "A String", # The starting position for the range.
617 "endPosition": "A String", # The ending position for the range.
618 "startOffset": "A String", # The offset from the starting position.
619 "endOffset": "A String", # The offset from the ending position.
620 },
621 "cfiRange": { # Range in CFI format for this annotation for version above.
622 "startPosition": "A String", # The starting position for the range.
623 "endPosition": "A String", # The ending position for the range.
624 "startOffset": "A String", # The offset from the starting position.
625 "endOffset": "A String", # The offset from the ending position.
626 },
627 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
628 "startPosition": "A String", # The starting position for the range.
629 "endPosition": "A String", # The ending position for the range.
630 "startOffset": "A String", # The offset from the starting position.
631 "endOffset": "A String", # The offset from the ending position.
632 },
633 "gbImageRange": { # Range in GB image format for this annotation for version above.
634 "startPosition": "A String", # The starting position for the range.
635 "endPosition": "A String", # The ending position for the range.
636 "startOffset": "A String", # The offset from the starting position.
637 "endOffset": "A String", # The offset from the ending position.
638 },
639 },
640 "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.
641 "clientVersionRanges": { # Selection ranges sent from the client.
642 "contentVersion": "A String", # Content version the client sent in.
643 "gbTextRange": { # Range in GB text format for this annotation sent by client.
644 "startPosition": "A String", # The starting position for the range.
645 "endPosition": "A String", # The ending position for the range.
646 "startOffset": "A String", # The offset from the starting position.
647 "endOffset": "A String", # The offset from the ending position.
648 },
649 "cfiRange": { # Range in CFI format for this annotation sent by client.
650 "startPosition": "A String", # The starting position for the range.
651 "endPosition": "A String", # The ending position for the range.
652 "startOffset": "A String", # The offset from the starting position.
653 "endOffset": "A String", # The offset from the ending position.
654 },
655 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
656 "startPosition": "A String", # The starting position for the range.
657 "endPosition": "A String", # The ending position for the range.
658 "startOffset": "A String", # The offset from the starting position.
659 "endOffset": "A String", # The offset from the ending position.
660 },
661 "gbImageRange": { # Range in GB image format for this annotation sent by client.
662 "startPosition": "A String", # The starting position for the range.
663 "endPosition": "A String", # The ending position for the range.
664 "startOffset": "A String", # The offset from the starting position.
665 "endOffset": "A String", # The offset from the ending position.
666 },
667 },
668 "layerSummary": {
669 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
670 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
671 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
672 },
673 "volumeId": "A String", # The volume that this annotation belongs to.
674 "pageIds": [ # Pages that this annotation spans.
675 "A String",
676 ],
677 "layerId": "A String", # The layer this annotation is for.
678 "selectedText": "A String", # Excerpt from the volume.
679 "highlightStyle": "A String", # The highlight style for this annotation.
680 "data": "A String", # User-created data for this annotation.
681 "id": "A String", # Id of this annotation, in the form of a GUID.
682 "selfLink": "A String", # URL to this resource.
683 }</pre>
684</div>
685
686</body></html>