Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / books_v1.mylibrary.annotations.html
blob: 44850a8571e943a4b7da361d242486e3ebaa3f93 [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">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]81 <code><a href="#insert">insert(body, source=None, country=None, showOnlySummaryInResponse=None, annotationId=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">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]107 <code class="details" id="insert">insert(body, source=None, country=None, showOnlySummaryInResponse=None, annotationId=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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]195 annotationId: string, The ID for the annotation to insert.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]196
197Returns:
198 An object of the form:
199
200 {
201 "kind": "books#annotation", # Resource type.
202 "updated": "A String", # Timestamp for the last time this annotation was modified.
203 "created": "A String", # Timestamp for the created time of this annotation.
204 "deleted": True or False, # Indicates that this annotation is deleted.
205 "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.
206 "currentVersionRanges": { # Selection ranges for the most recent content version.
207 "contentVersion": "A String", # Content version applicable to ranges below.
208 "gbTextRange": { # Range in GB text format for this annotation for version above.
209 "startPosition": "A String", # The starting position for the range.
210 "endPosition": "A String", # The ending position for the range.
211 "startOffset": "A String", # The offset from the starting position.
212 "endOffset": "A String", # The offset from the ending position.
213 },
214 "cfiRange": { # Range in CFI format for this annotation for version above.
215 "startPosition": "A String", # The starting position for the range.
216 "endPosition": "A String", # The ending position for the range.
217 "startOffset": "A String", # The offset from the starting position.
218 "endOffset": "A String", # The offset from the ending position.
219 },
220 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
221 "startPosition": "A String", # The starting position for the range.
222 "endPosition": "A String", # The ending position for the range.
223 "startOffset": "A String", # The offset from the starting position.
224 "endOffset": "A String", # The offset from the ending position.
225 },
226 "gbImageRange": { # Range in GB image format for this annotation for version above.
227 "startPosition": "A String", # The starting position for the range.
228 "endPosition": "A String", # The ending position for the range.
229 "startOffset": "A String", # The offset from the starting position.
230 "endOffset": "A String", # The offset from the ending position.
231 },
232 },
233 "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.
234 "clientVersionRanges": { # Selection ranges sent from the client.
235 "contentVersion": "A String", # Content version the client sent in.
236 "gbTextRange": { # Range in GB text format for this annotation sent by client.
237 "startPosition": "A String", # The starting position for the range.
238 "endPosition": "A String", # The ending position for the range.
239 "startOffset": "A String", # The offset from the starting position.
240 "endOffset": "A String", # The offset from the ending position.
241 },
242 "cfiRange": { # Range in CFI format for this annotation sent by client.
243 "startPosition": "A String", # The starting position for the range.
244 "endPosition": "A String", # The ending position for the range.
245 "startOffset": "A String", # The offset from the starting position.
246 "endOffset": "A String", # The offset from the ending position.
247 },
248 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
249 "startPosition": "A String", # The starting position for the range.
250 "endPosition": "A String", # The ending position for the range.
251 "startOffset": "A String", # The offset from the starting position.
252 "endOffset": "A String", # The offset from the ending position.
253 },
254 "gbImageRange": { # Range in GB image format for this annotation sent by client.
255 "startPosition": "A String", # The starting position for the range.
256 "endPosition": "A String", # The ending position for the range.
257 "startOffset": "A String", # The offset from the starting position.
258 "endOffset": "A String", # The offset from the ending position.
259 },
260 },
261 "layerSummary": {
262 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
263 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
264 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
265 },
266 "volumeId": "A String", # The volume that this annotation belongs to.
267 "pageIds": [ # Pages that this annotation spans.
268 "A String",
269 ],
270 "layerId": "A String", # The layer this annotation is for.
271 "selectedText": "A String", # Excerpt from the volume.
272 "highlightStyle": "A String", # The highlight style for this annotation.
273 "data": "A String", # User-created data for this annotation.
274 "id": "A String", # Id of this annotation, in the form of a GUID.
275 "selfLink": "A String", # URL to this resource.
276 }</pre>
277</div>
278
279<div class="method">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]280 <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]281 <pre>Retrieves a list of annotations, possibly filtered.
282
283Args:
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]284 layerId: string, The layer ID to limit annotation by.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]285 pageToken: string, The value of the nextToken from the previous page.
286 layerIds: string, The layer ID(s) to limit annotation by. (repeated)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]287 volumeId: string, The volume to restrict annotations to.
288 maxResults: integer, Maximum number of results to return
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]289 showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
290 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
291 contentVersion: string, The content version for the requested volume.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]292 source: string, String to identify the originator of this request.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]293 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]294
295Returns:
296 An object of the form:
297
298 {
299 "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.
300 "items": [ # A list of annotations.
301 {
302 "kind": "books#annotation", # Resource type.
303 "updated": "A String", # Timestamp for the last time this annotation was modified.
304 "created": "A String", # Timestamp for the created time of this annotation.
305 "deleted": True or False, # Indicates that this annotation is deleted.
306 "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.
307 "currentVersionRanges": { # Selection ranges for the most recent content version.
308 "contentVersion": "A String", # Content version applicable to ranges below.
309 "gbTextRange": { # Range in GB text format for this annotation for version above.
310 "startPosition": "A String", # The starting position for the range.
311 "endPosition": "A String", # The ending position for the range.
312 "startOffset": "A String", # The offset from the starting position.
313 "endOffset": "A String", # The offset from the ending position.
314 },
315 "cfiRange": { # Range in CFI format for this annotation for version above.
316 "startPosition": "A String", # The starting position for the range.
317 "endPosition": "A String", # The ending position for the range.
318 "startOffset": "A String", # The offset from the starting position.
319 "endOffset": "A String", # The offset from the ending position.
320 },
321 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
322 "startPosition": "A String", # The starting position for the range.
323 "endPosition": "A String", # The ending position for the range.
324 "startOffset": "A String", # The offset from the starting position.
325 "endOffset": "A String", # The offset from the ending position.
326 },
327 "gbImageRange": { # Range in GB image format for this annotation for version above.
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 },
334 "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.
335 "clientVersionRanges": { # Selection ranges sent from the client.
336 "contentVersion": "A String", # Content version the client sent in.
337 "gbTextRange": { # Range in GB text format for this annotation sent by client.
338 "startPosition": "A String", # The starting position for the range.
339 "endPosition": "A String", # The ending position for the range.
340 "startOffset": "A String", # The offset from the starting position.
341 "endOffset": "A String", # The offset from the ending position.
342 },
343 "cfiRange": { # Range in CFI format for this annotation sent by client.
344 "startPosition": "A String", # The starting position for the range.
345 "endPosition": "A String", # The ending position for the range.
346 "startOffset": "A String", # The offset from the starting position.
347 "endOffset": "A String", # The offset from the ending position.
348 },
349 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
350 "startPosition": "A String", # The starting position for the range.
351 "endPosition": "A String", # The ending position for the range.
352 "startOffset": "A String", # The offset from the starting position.
353 "endOffset": "A String", # The offset from the ending position.
354 },
355 "gbImageRange": { # Range in GB image format for this annotation sent by client.
356 "startPosition": "A String", # The starting position for the range.
357 "endPosition": "A String", # The ending position for the range.
358 "startOffset": "A String", # The offset from the starting position.
359 "endOffset": "A String", # The offset from the ending position.
360 },
361 },
362 "layerSummary": {
363 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
364 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
365 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
366 },
367 "volumeId": "A String", # The volume that this annotation belongs to.
368 "pageIds": [ # Pages that this annotation spans.
369 "A String",
370 ],
371 "layerId": "A String", # The layer this annotation is for.
372 "selectedText": "A String", # Excerpt from the volume.
373 "highlightStyle": "A String", # The highlight style for this annotation.
374 "data": "A String", # User-created data for this annotation.
375 "id": "A String", # Id of this annotation, in the form of a GUID.
376 "selfLink": "A String", # URL to this resource.
377 },
378 ],
379 "kind": "books#annotations", # Resource type.
380 "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.
381 }</pre>
382</div>
383
384<div class="method">
385 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
386 <pre>Retrieves the next page of results.
387
388Args:
389 previous_request: The request for the previous page. (required)
390 previous_response: The response from the request for the previous page. (required)
391
392Returns:
393 A request object that you can call 'execute()' on to request the next
394 page. Returns None if there are no more items in the collection.
395 </pre>
396</div>
397
398<div class="method">
399 <code class="details" id="summary">summary(layerIds, volumeId)</code>
400 <pre>Gets the summary of specified layers.
401
402Args:
403 layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
404 volumeId: string, Volume id to get the summary for. (required)
405
406Returns:
407 An object of the form:
408
409 {
410 "layers": [
411 {
412 "limitType": "A String",
413 "remainingCharacterCount": 42,
414 "updated": "A String",
415 "layerId": "A String",
416 "allowedCharacterCount": 42,
417 },
418 ],
419 "kind": "books#annotationsSummary",
420 }</pre>
421</div>
422
423<div class="method">
424 <code class="details" id="update">update(annotationId, body, source=None)</code>
425 <pre>Updates an existing annotation.
426
427Args:
428 annotationId: string, The ID for the annotation to update. (required)
429 body: object, The request body. (required)
430 The object takes the form of:
431
432{
433 "kind": "books#annotation", # Resource type.
434 "updated": "A String", # Timestamp for the last time this annotation was modified.
435 "created": "A String", # Timestamp for the created time of this annotation.
436 "deleted": True or False, # Indicates that this annotation is deleted.
437 "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.
438 "currentVersionRanges": { # Selection ranges for the most recent content version.
439 "contentVersion": "A String", # Content version applicable to ranges below.
440 "gbTextRange": { # Range in GB text format for this annotation for version above.
441 "startPosition": "A String", # The starting position for the range.
442 "endPosition": "A String", # The ending position for the range.
443 "startOffset": "A String", # The offset from the starting position.
444 "endOffset": "A String", # The offset from the ending position.
445 },
446 "cfiRange": { # Range in CFI format for this annotation for version above.
447 "startPosition": "A String", # The starting position for the range.
448 "endPosition": "A String", # The ending position for the range.
449 "startOffset": "A String", # The offset from the starting position.
450 "endOffset": "A String", # The offset from the ending position.
451 },
452 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
453 "startPosition": "A String", # The starting position for the range.
454 "endPosition": "A String", # The ending position for the range.
455 "startOffset": "A String", # The offset from the starting position.
456 "endOffset": "A String", # The offset from the ending position.
457 },
458 "gbImageRange": { # Range in GB image format for this annotation for version above.
459 "startPosition": "A String", # The starting position for the range.
460 "endPosition": "A String", # The ending position for the range.
461 "startOffset": "A String", # The offset from the starting position.
462 "endOffset": "A String", # The offset from the ending position.
463 },
464 },
465 "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.
466 "clientVersionRanges": { # Selection ranges sent from the client.
467 "contentVersion": "A String", # Content version the client sent in.
468 "gbTextRange": { # Range in GB text format for this annotation sent by client.
469 "startPosition": "A String", # The starting position for the range.
470 "endPosition": "A String", # The ending position for the range.
471 "startOffset": "A String", # The offset from the starting position.
472 "endOffset": "A String", # The offset from the ending position.
473 },
474 "cfiRange": { # Range in CFI format for this annotation sent by client.
475 "startPosition": "A String", # The starting position for the range.
476 "endPosition": "A String", # The ending position for the range.
477 "startOffset": "A String", # The offset from the starting position.
478 "endOffset": "A String", # The offset from the ending position.
479 },
480 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
481 "startPosition": "A String", # The starting position for the range.
482 "endPosition": "A String", # The ending position for the range.
483 "startOffset": "A String", # The offset from the starting position.
484 "endOffset": "A String", # The offset from the ending position.
485 },
486 "gbImageRange": { # Range in GB image format for this annotation sent by client.
487 "startPosition": "A String", # The starting position for the range.
488 "endPosition": "A String", # The ending position for the range.
489 "startOffset": "A String", # The offset from the starting position.
490 "endOffset": "A String", # The offset from the ending position.
491 },
492 },
493 "layerSummary": {
494 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
495 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
496 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
497 },
498 "volumeId": "A String", # The volume that this annotation belongs to.
499 "pageIds": [ # Pages that this annotation spans.
500 "A String",
501 ],
502 "layerId": "A String", # The layer this annotation is for.
503 "selectedText": "A String", # Excerpt from the volume.
504 "highlightStyle": "A String", # The highlight style for this annotation.
505 "data": "A String", # User-created data for this annotation.
506 "id": "A String", # Id of this annotation, in the form of a GUID.
507 "selfLink": "A String", # URL to this resource.
508 }
509
510 source: string, String to identify the originator of this request.
511
512Returns:
513 An object of the form:
514
515 {
516 "kind": "books#annotation", # Resource type.
517 "updated": "A String", # Timestamp for the last time this annotation was modified.
518 "created": "A String", # Timestamp for the created time of this annotation.
519 "deleted": True or False, # Indicates that this annotation is deleted.
520 "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.
521 "currentVersionRanges": { # Selection ranges for the most recent content version.
522 "contentVersion": "A String", # Content version applicable to ranges below.
523 "gbTextRange": { # Range in GB text format for this annotation for version above.
524 "startPosition": "A String", # The starting position for the range.
525 "endPosition": "A String", # The ending position for the range.
526 "startOffset": "A String", # The offset from the starting position.
527 "endOffset": "A String", # The offset from the ending position.
528 },
529 "cfiRange": { # Range in CFI format for this annotation for version above.
530 "startPosition": "A String", # The starting position for the range.
531 "endPosition": "A String", # The ending position for the range.
532 "startOffset": "A String", # The offset from the starting position.
533 "endOffset": "A String", # The offset from the ending position.
534 },
535 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
536 "startPosition": "A String", # The starting position for the range.
537 "endPosition": "A String", # The ending position for the range.
538 "startOffset": "A String", # The offset from the starting position.
539 "endOffset": "A String", # The offset from the ending position.
540 },
541 "gbImageRange": { # Range in GB image format for this annotation for version above.
542 "startPosition": "A String", # The starting position for the range.
543 "endPosition": "A String", # The ending position for the range.
544 "startOffset": "A String", # The offset from the starting position.
545 "endOffset": "A String", # The offset from the ending position.
546 },
547 },
548 "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.
549 "clientVersionRanges": { # Selection ranges sent from the client.
550 "contentVersion": "A String", # Content version the client sent in.
551 "gbTextRange": { # Range in GB text format for this annotation sent by client.
552 "startPosition": "A String", # The starting position for the range.
553 "endPosition": "A String", # The ending position for the range.
554 "startOffset": "A String", # The offset from the starting position.
555 "endOffset": "A String", # The offset from the ending position.
556 },
557 "cfiRange": { # Range in CFI format for this annotation sent by client.
558 "startPosition": "A String", # The starting position for the range.
559 "endPosition": "A String", # The ending position for the range.
560 "startOffset": "A String", # The offset from the starting position.
561 "endOffset": "A String", # The offset from the ending position.
562 },
563 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
564 "startPosition": "A String", # The starting position for the range.
565 "endPosition": "A String", # The ending position for the range.
566 "startOffset": "A String", # The offset from the starting position.
567 "endOffset": "A String", # The offset from the ending position.
568 },
569 "gbImageRange": { # Range in GB image format for this annotation sent by client.
570 "startPosition": "A String", # The starting position for the range.
571 "endPosition": "A String", # The ending position for the range.
572 "startOffset": "A String", # The offset from the starting position.
573 "endOffset": "A String", # The offset from the ending position.
574 },
575 },
576 "layerSummary": {
577 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
578 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
579 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
580 },
581 "volumeId": "A String", # The volume that this annotation belongs to.
582 "pageIds": [ # Pages that this annotation spans.
583 "A String",
584 ],
585 "layerId": "A String", # The layer this annotation is for.
586 "selectedText": "A String", # Excerpt from the volume.
587 "highlightStyle": "A String", # The highlight style for this annotation.
588 "data": "A String", # User-created data for this annotation.
589 "id": "A String", # Id of this annotation, in the form of a GUID.
590 "selfLink": "A String", # URL to this resource.
591 }</pre>
592</div>
593
594</body></html>