Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / books_v1.mylibrary.annotations.html
blob: 3dd48df580fea97bc474f9c53b877bc6af1213c6 [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">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]84 <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]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">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]200 <code class="details" id="insert">insert(body, source=None, country=None, showOnlySummaryInResponse=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame^]286 country: string, ISO-3166-1 code to override the IP-based location.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]287 showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
288
289Returns:
290 An object of the form:
291
292 {
293 "kind": "books#annotation", # Resource type.
294 "updated": "A String", # Timestamp for the last time this annotation was modified.
295 "created": "A String", # Timestamp for the created time of this annotation.
296 "deleted": True or False, # Indicates that this annotation is deleted.
297 "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.
298 "currentVersionRanges": { # Selection ranges for the most recent content version.
299 "contentVersion": "A String", # Content version applicable to ranges below.
300 "gbTextRange": { # Range in GB text format for this annotation for version above.
301 "startPosition": "A String", # The starting position for the range.
302 "endPosition": "A String", # The ending position for the range.
303 "startOffset": "A String", # The offset from the starting position.
304 "endOffset": "A String", # The offset from the ending position.
305 },
306 "cfiRange": { # Range in CFI format for this annotation for version above.
307 "startPosition": "A String", # The starting position for the range.
308 "endPosition": "A String", # The ending position for the range.
309 "startOffset": "A String", # The offset from the starting position.
310 "endOffset": "A String", # The offset from the ending position.
311 },
312 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
313 "startPosition": "A String", # The starting position for the range.
314 "endPosition": "A String", # The ending position for the range.
315 "startOffset": "A String", # The offset from the starting position.
316 "endOffset": "A String", # The offset from the ending position.
317 },
318 "gbImageRange": { # Range in GB image format for this annotation for version above.
319 "startPosition": "A String", # The starting position for the range.
320 "endPosition": "A String", # The ending position for the range.
321 "startOffset": "A String", # The offset from the starting position.
322 "endOffset": "A String", # The offset from the ending position.
323 },
324 },
325 "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.
326 "clientVersionRanges": { # Selection ranges sent from the client.
327 "contentVersion": "A String", # Content version the client sent in.
328 "gbTextRange": { # Range in GB text format for this annotation sent by client.
329 "startPosition": "A String", # The starting position for the range.
330 "endPosition": "A String", # The ending position for the range.
331 "startOffset": "A String", # The offset from the starting position.
332 "endOffset": "A String", # The offset from the ending position.
333 },
334 "cfiRange": { # Range in CFI format for this annotation sent by client.
335 "startPosition": "A String", # The starting position for the range.
336 "endPosition": "A String", # The ending position for the range.
337 "startOffset": "A String", # The offset from the starting position.
338 "endOffset": "A String", # The offset from the ending position.
339 },
340 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
341 "startPosition": "A String", # The starting position for the range.
342 "endPosition": "A String", # The ending position for the range.
343 "startOffset": "A String", # The offset from the starting position.
344 "endOffset": "A String", # The offset from the ending position.
345 },
346 "gbImageRange": { # Range in GB image format for this annotation sent by client.
347 "startPosition": "A String", # The starting position for the range.
348 "endPosition": "A String", # The ending position for the range.
349 "startOffset": "A String", # The offset from the starting position.
350 "endOffset": "A String", # The offset from the ending position.
351 },
352 },
353 "layerSummary": {
354 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
355 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
356 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
357 },
358 "volumeId": "A String", # The volume that this annotation belongs to.
359 "pageIds": [ # Pages that this annotation spans.
360 "A String",
361 ],
362 "layerId": "A String", # The layer this annotation is for.
363 "selectedText": "A String", # Excerpt from the volume.
364 "highlightStyle": "A String", # The highlight style for this annotation.
365 "data": "A String", # User-created data for this annotation.
366 "id": "A String", # Id of this annotation, in the form of a GUID.
367 "selfLink": "A String", # URL to this resource.
368 }</pre>
369</div>
370
371<div class="method">
372 <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>
373 <pre>Retrieves a list of annotations, possibly filtered.
374
375Args:
376 pageToken: string, The value of the nextToken from the previous page.
377 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
378 showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
379 pageIds: string, The page ID(s) for the volume that is being queried. (repeated)
380 contentVersion: string, The content version for the requested volume.
381 layerId: string, The layer ID to limit annotation by.
382 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
383 volumeId: string, The volume to restrict annotations to.
384 maxResults: integer, Maximum number of results to return
385 layerIds: string, The layer ID(s) to limit annotation by. (repeated)
386 source: string, String to identify the originator of this request.
387
388Returns:
389 An object of the form:
390
391 {
392 "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.
393 "items": [ # A list of annotations.
394 {
395 "kind": "books#annotation", # Resource type.
396 "updated": "A String", # Timestamp for the last time this annotation was modified.
397 "created": "A String", # Timestamp for the created time of this annotation.
398 "deleted": True or False, # Indicates that this annotation is deleted.
399 "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.
400 "currentVersionRanges": { # Selection ranges for the most recent content version.
401 "contentVersion": "A String", # Content version applicable to ranges below.
402 "gbTextRange": { # Range in GB text format for this annotation for version above.
403 "startPosition": "A String", # The starting position for the range.
404 "endPosition": "A String", # The ending position for the range.
405 "startOffset": "A String", # The offset from the starting position.
406 "endOffset": "A String", # The offset from the ending position.
407 },
408 "cfiRange": { # Range in CFI format for this annotation for version above.
409 "startPosition": "A String", # The starting position for the range.
410 "endPosition": "A String", # The ending position for the range.
411 "startOffset": "A String", # The offset from the starting position.
412 "endOffset": "A String", # The offset from the ending position.
413 },
414 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
415 "startPosition": "A String", # The starting position for the range.
416 "endPosition": "A String", # The ending position for the range.
417 "startOffset": "A String", # The offset from the starting position.
418 "endOffset": "A String", # The offset from the ending position.
419 },
420 "gbImageRange": { # Range in GB image format for this annotation for version above.
421 "startPosition": "A String", # The starting position for the range.
422 "endPosition": "A String", # The ending position for the range.
423 "startOffset": "A String", # The offset from the starting position.
424 "endOffset": "A String", # The offset from the ending position.
425 },
426 },
427 "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.
428 "clientVersionRanges": { # Selection ranges sent from the client.
429 "contentVersion": "A String", # Content version the client sent in.
430 "gbTextRange": { # Range in GB text format for this annotation sent by client.
431 "startPosition": "A String", # The starting position for the range.
432 "endPosition": "A String", # The ending position for the range.
433 "startOffset": "A String", # The offset from the starting position.
434 "endOffset": "A String", # The offset from the ending position.
435 },
436 "cfiRange": { # Range in CFI format for this annotation sent by client.
437 "startPosition": "A String", # The starting position for the range.
438 "endPosition": "A String", # The ending position for the range.
439 "startOffset": "A String", # The offset from the starting position.
440 "endOffset": "A String", # The offset from the ending position.
441 },
442 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
443 "startPosition": "A String", # The starting position for the range.
444 "endPosition": "A String", # The ending position for the range.
445 "startOffset": "A String", # The offset from the starting position.
446 "endOffset": "A String", # The offset from the ending position.
447 },
448 "gbImageRange": { # Range in GB image format for this annotation sent by client.
449 "startPosition": "A String", # The starting position for the range.
450 "endPosition": "A String", # The ending position for the range.
451 "startOffset": "A String", # The offset from the starting position.
452 "endOffset": "A String", # The offset from the ending position.
453 },
454 },
455 "layerSummary": {
456 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
457 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
458 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
459 },
460 "volumeId": "A String", # The volume that this annotation belongs to.
461 "pageIds": [ # Pages that this annotation spans.
462 "A String",
463 ],
464 "layerId": "A String", # The layer this annotation is for.
465 "selectedText": "A String", # Excerpt from the volume.
466 "highlightStyle": "A String", # The highlight style for this annotation.
467 "data": "A String", # User-created data for this annotation.
468 "id": "A String", # Id of this annotation, in the form of a GUID.
469 "selfLink": "A String", # URL to this resource.
470 },
471 ],
472 "kind": "books#annotations", # Resource type.
473 "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.
474 }</pre>
475</div>
476
477<div class="method">
478 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
479 <pre>Retrieves the next page of results.
480
481Args:
482 previous_request: The request for the previous page. (required)
483 previous_response: The response from the request for the previous page. (required)
484
485Returns:
486 A request object that you can call 'execute()' on to request the next
487 page. Returns None if there are no more items in the collection.
488 </pre>
489</div>
490
491<div class="method">
492 <code class="details" id="summary">summary(layerIds, volumeId)</code>
493 <pre>Gets the summary of specified layers.
494
495Args:
496 layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
497 volumeId: string, Volume id to get the summary for. (required)
498
499Returns:
500 An object of the form:
501
502 {
503 "layers": [
504 {
505 "limitType": "A String",
506 "remainingCharacterCount": 42,
507 "updated": "A String",
508 "layerId": "A String",
509 "allowedCharacterCount": 42,
510 },
511 ],
512 "kind": "books#annotationsSummary",
513 }</pre>
514</div>
515
516<div class="method">
517 <code class="details" id="update">update(annotationId, body, source=None)</code>
518 <pre>Updates an existing annotation.
519
520Args:
521 annotationId: string, The ID for the annotation to update. (required)
522 body: object, The request body. (required)
523 The object takes the form of:
524
525{
526 "kind": "books#annotation", # Resource type.
527 "updated": "A String", # Timestamp for the last time this annotation was modified.
528 "created": "A String", # Timestamp for the created time of this annotation.
529 "deleted": True or False, # Indicates that this annotation is deleted.
530 "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.
531 "currentVersionRanges": { # Selection ranges for the most recent content version.
532 "contentVersion": "A String", # Content version applicable to ranges below.
533 "gbTextRange": { # Range in GB text format for this annotation for version above.
534 "startPosition": "A String", # The starting position for the range.
535 "endPosition": "A String", # The ending position for the range.
536 "startOffset": "A String", # The offset from the starting position.
537 "endOffset": "A String", # The offset from the ending position.
538 },
539 "cfiRange": { # Range in CFI format for this annotation for version above.
540 "startPosition": "A String", # The starting position for the range.
541 "endPosition": "A String", # The ending position for the range.
542 "startOffset": "A String", # The offset from the starting position.
543 "endOffset": "A String", # The offset from the ending position.
544 },
545 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
546 "startPosition": "A String", # The starting position for the range.
547 "endPosition": "A String", # The ending position for the range.
548 "startOffset": "A String", # The offset from the starting position.
549 "endOffset": "A String", # The offset from the ending position.
550 },
551 "gbImageRange": { # Range in GB image format for this annotation for version above.
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 },
558 "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.
559 "clientVersionRanges": { # Selection ranges sent from the client.
560 "contentVersion": "A String", # Content version the client sent in.
561 "gbTextRange": { # Range in GB text format for this annotation sent by client.
562 "startPosition": "A String", # The starting position for the range.
563 "endPosition": "A String", # The ending position for the range.
564 "startOffset": "A String", # The offset from the starting position.
565 "endOffset": "A String", # The offset from the ending position.
566 },
567 "cfiRange": { # Range in CFI format for this annotation sent by client.
568 "startPosition": "A String", # The starting position for the range.
569 "endPosition": "A String", # The ending position for the range.
570 "startOffset": "A String", # The offset from the starting position.
571 "endOffset": "A String", # The offset from the ending position.
572 },
573 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
574 "startPosition": "A String", # The starting position for the range.
575 "endPosition": "A String", # The ending position for the range.
576 "startOffset": "A String", # The offset from the starting position.
577 "endOffset": "A String", # The offset from the ending position.
578 },
579 "gbImageRange": { # Range in GB image format for this annotation sent by client.
580 "startPosition": "A String", # The starting position for the range.
581 "endPosition": "A String", # The ending position for the range.
582 "startOffset": "A String", # The offset from the starting position.
583 "endOffset": "A String", # The offset from the ending position.
584 },
585 },
586 "layerSummary": {
587 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
588 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
589 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
590 },
591 "volumeId": "A String", # The volume that this annotation belongs to.
592 "pageIds": [ # Pages that this annotation spans.
593 "A String",
594 ],
595 "layerId": "A String", # The layer this annotation is for.
596 "selectedText": "A String", # Excerpt from the volume.
597 "highlightStyle": "A String", # The highlight style for this annotation.
598 "data": "A String", # User-created data for this annotation.
599 "id": "A String", # Id of this annotation, in the form of a GUID.
600 "selfLink": "A String", # URL to this resource.
601 }
602
603 source: string, String to identify the originator of this request.
604
605Returns:
606 An object of the form:
607
608 {
609 "kind": "books#annotation", # Resource type.
610 "updated": "A String", # Timestamp for the last time this annotation was modified.
611 "created": "A String", # Timestamp for the created time of this annotation.
612 "deleted": True or False, # Indicates that this annotation is deleted.
613 "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.
614 "currentVersionRanges": { # Selection ranges for the most recent content version.
615 "contentVersion": "A String", # Content version applicable to ranges below.
616 "gbTextRange": { # Range in GB text format for this annotation for version above.
617 "startPosition": "A String", # The starting position for the range.
618 "endPosition": "A String", # The ending position for the range.
619 "startOffset": "A String", # The offset from the starting position.
620 "endOffset": "A String", # The offset from the ending position.
621 },
622 "cfiRange": { # Range in CFI format for this annotation for version above.
623 "startPosition": "A String", # The starting position for the range.
624 "endPosition": "A String", # The ending position for the range.
625 "startOffset": "A String", # The offset from the starting position.
626 "endOffset": "A String", # The offset from the ending position.
627 },
628 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
629 "startPosition": "A String", # The starting position for the range.
630 "endPosition": "A String", # The ending position for the range.
631 "startOffset": "A String", # The offset from the starting position.
632 "endOffset": "A String", # The offset from the ending position.
633 },
634 "gbImageRange": { # Range in GB image format for this annotation for version above.
635 "startPosition": "A String", # The starting position for the range.
636 "endPosition": "A String", # The ending position for the range.
637 "startOffset": "A String", # The offset from the starting position.
638 "endOffset": "A String", # The offset from the ending position.
639 },
640 },
641 "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.
642 "clientVersionRanges": { # Selection ranges sent from the client.
643 "contentVersion": "A String", # Content version the client sent in.
644 "gbTextRange": { # Range in GB text format for this annotation sent by client.
645 "startPosition": "A String", # The starting position for the range.
646 "endPosition": "A String", # The ending position for the range.
647 "startOffset": "A String", # The offset from the starting position.
648 "endOffset": "A String", # The offset from the ending position.
649 },
650 "cfiRange": { # Range in CFI format for this annotation sent by client.
651 "startPosition": "A String", # The starting position for the range.
652 "endPosition": "A String", # The ending position for the range.
653 "startOffset": "A String", # The offset from the starting position.
654 "endOffset": "A String", # The offset from the ending position.
655 },
656 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
657 "startPosition": "A String", # The starting position for the range.
658 "endPosition": "A String", # The ending position for the range.
659 "startOffset": "A String", # The offset from the starting position.
660 "endOffset": "A String", # The offset from the ending position.
661 },
662 "gbImageRange": { # Range in GB image format for this annotation sent by client.
663 "startPosition": "A String", # The starting position for the range.
664 "endPosition": "A String", # The ending position for the range.
665 "startOffset": "A String", # The offset from the starting position.
666 "endOffset": "A String", # The offset from the ending position.
667 },
668 },
669 "layerSummary": {
670 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
671 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
672 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
673 },
674 "volumeId": "A String", # The volume that this annotation belongs to.
675 "pageIds": [ # Pages that this annotation spans.
676 "A String",
677 ],
678 "layerId": "A String", # The layer this annotation is for.
679 "selectedText": "A String", # Excerpt from the volume.
680 "highlightStyle": "A String", # The highlight style for this annotation.
681 "data": "A String", # User-created data for this annotation.
682 "id": "A String", # Id of this annotation, in the form of a GUID.
683 "selfLink": "A String", # URL to this resource.
684 }</pre>
685</div>
686
687</body></html>