Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4d50cd6883f37e19a26fabe3af6a75d407146520 / . / docs / dyn / books_v1.mylibrary.annotations.html
blob: b2da444e621161aa0b3739b827289bd0186454f6 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]84 <code><a href="#insert">insert(body, source=None, showOnlySummaryInResponse=None)</a></code></p>
Joe Gregorio075572b2012-07-09 16:53:09 -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, updatedMax=None, layerId=None, volumeId=None, maxResults=None, showDeleted=None, pageIds=None, contentVersion=None, source=None, updatedMin=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">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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">
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]200 <code class="details" id="insert">insert(body, source=None, showOnlySummaryInResponse=None)</code>
Joe Gregorio075572b2012-07-09 16:53:09 -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.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]286 showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]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 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]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, updatedMax=None, layerId=None, volumeId=None, maxResults=None, showDeleted=None, pageIds=None, contentVersion=None, source=None, updatedMin=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 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
377 layerId: string, The layer ID to limit annotation by.
378 volumeId: string, The volume to restrict annotations to.
379 maxResults: integer, Maximum number of results to return
380 showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
381 pageIds: string, The page ID(s) for the volume that is being queried. (repeated)
382 contentVersion: string, The content version for the requested volume.
383 source: string, String to identify the originator of this request.
384 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
385
386Returns:
387 An object of the form:
388
389 {
390 "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.
391 "items": [ # A list of annotations.
392 {
393 "kind": "books#annotation", # Resource type.
394 "updated": "A String", # Timestamp for the last time this annotation was modified.
395 "created": "A String", # Timestamp for the created time of this annotation.
396 "deleted": True or False, # Indicates that this annotation is deleted.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]397 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]398 "currentVersionRanges": { # Selection ranges for the most recent content version.
399 "contentVersion": "A String", # Content version applicable to ranges below.
400 "gbTextRange": { # Range in GB text format for this annotation for version above.
401 "startPosition": "A String", # The starting position for the range.
402 "endPosition": "A String", # The ending position for the range.
403 "startOffset": "A String", # The offset from the starting position.
404 "endOffset": "A String", # The offset from the ending position.
405 },
406 "cfiRange": { # Range in CFI format for this annotation for version above.
407 "startPosition": "A String", # The starting position for the range.
408 "endPosition": "A String", # The ending position for the range.
409 "startOffset": "A String", # The offset from the starting position.
410 "endOffset": "A String", # The offset from the ending position.
411 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]412 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
413 "startPosition": "A String", # The starting position for the range.
414 "endPosition": "A String", # The ending position for the range.
415 "startOffset": "A String", # The offset from the starting position.
416 "endOffset": "A String", # The offset from the ending position.
417 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]418 "gbImageRange": { # Range in GB image format for this annotation for version above.
419 "startPosition": "A String", # The starting position for the range.
420 "endPosition": "A String", # The ending position for the range.
421 "startOffset": "A String", # The offset from the starting position.
422 "endOffset": "A String", # The offset from the ending position.
423 },
424 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]425 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]426 "clientVersionRanges": { # Selection ranges sent from the client.
427 "contentVersion": "A String", # Content version the client sent in.
428 "gbTextRange": { # Range in GB text format for this annotation sent by client.
429 "startPosition": "A String", # The starting position for the range.
430 "endPosition": "A String", # The ending position for the range.
431 "startOffset": "A String", # The offset from the starting position.
432 "endOffset": "A String", # The offset from the ending position.
433 },
434 "cfiRange": { # Range in CFI format for this annotation sent by client.
435 "startPosition": "A String", # The starting position for the range.
436 "endPosition": "A String", # The ending position for the range.
437 "startOffset": "A String", # The offset from the starting position.
438 "endOffset": "A String", # The offset from the ending position.
439 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]440 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
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 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]446 "gbImageRange": { # Range in GB image format for this annotation sent by client.
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 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]453 "layerSummary": {
454 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
455 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
456 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
457 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]458 "volumeId": "A String", # The volume that this annotation belongs to.
459 "pageIds": [ # Pages that this annotation spans.
460 "A String",
461 ],
462 "layerId": "A String", # The layer this annotation is for.
463 "selectedText": "A String", # Excerpt from the volume.
464 "highlightStyle": "A String", # The highlight style for this annotation.
465 "data": "A String", # User-created data for this annotation.
466 "id": "A String", # Id of this annotation, in the form of a GUID.
467 "selfLink": "A String", # URL to this resource.
468 },
469 ],
470 "kind": "books#annotations", # Resource type.
471 "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.
472 }</pre>
473</div>
474
475<div class="method">
476 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
477 <pre>Retrieves the next page of results.
478
479Args:
480 previous_request: The request for the previous page. (required)
481 previous_response: The response from the request for the previous page. (required)
482
483Returns:
484 A request object that you can call 'execute()' on to request the next
485 page. Returns None if there are no more items in the collection.
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]486 </pre>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]487</div>
488
489<div class="method">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]490 <code class="details" id="summary">summary(layerIds, volumeId)</code>
491 <pre>Gets the summary of specified layers.
492
493Args:
494 layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
495 volumeId: string, Volume id to get the summary for. (required)
496
497Returns:
498 An object of the form:
499
500 {
501 "layers": [
502 {
503 "limitType": "A String",
504 "remainingCharacterCount": 42,
505 "updated": "A String",
506 "layerId": "A String",
507 "allowedCharacterCount": 42,
508 },
509 ],
510 "kind": "books#annotationsSummary",
511 }</pre>
512</div>
513
514<div class="method">
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]515 <code class="details" id="update">update(annotationId, body, source=None)</code>
516 <pre>Updates an existing annotation.
517
518Args:
519 annotationId: string, The ID for the annotation to update. (required)
520 body: object, The request body. (required)
521 The object takes the form of:
522
523{
524 "kind": "books#annotation", # Resource type.
525 "updated": "A String", # Timestamp for the last time this annotation was modified.
526 "created": "A String", # Timestamp for the created time of this annotation.
527 "deleted": True or False, # Indicates that this annotation is deleted.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]528 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]529 "currentVersionRanges": { # Selection ranges for the most recent content version.
530 "contentVersion": "A String", # Content version applicable to ranges below.
531 "gbTextRange": { # Range in GB text format for this annotation for version above.
532 "startPosition": "A String", # The starting position for the range.
533 "endPosition": "A String", # The ending position for the range.
534 "startOffset": "A String", # The offset from the starting position.
535 "endOffset": "A String", # The offset from the ending position.
536 },
537 "cfiRange": { # Range in CFI format for this annotation for version above.
538 "startPosition": "A String", # The starting position for the range.
539 "endPosition": "A String", # The ending position for the range.
540 "startOffset": "A String", # The offset from the starting position.
541 "endOffset": "A String", # The offset from the ending position.
542 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]543 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
544 "startPosition": "A String", # The starting position for the range.
545 "endPosition": "A String", # The ending position for the range.
546 "startOffset": "A String", # The offset from the starting position.
547 "endOffset": "A String", # The offset from the ending position.
548 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]549 "gbImageRange": { # Range in GB image format for this annotation for version above.
550 "startPosition": "A String", # The starting position for the range.
551 "endPosition": "A String", # The ending position for the range.
552 "startOffset": "A String", # The offset from the starting position.
553 "endOffset": "A String", # The offset from the ending position.
554 },
555 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]556 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]557 "clientVersionRanges": { # Selection ranges sent from the client.
558 "contentVersion": "A String", # Content version the client sent in.
559 "gbTextRange": { # Range in GB text format for this annotation sent by client.
560 "startPosition": "A String", # The starting position for the range.
561 "endPosition": "A String", # The ending position for the range.
562 "startOffset": "A String", # The offset from the starting position.
563 "endOffset": "A String", # The offset from the ending position.
564 },
565 "cfiRange": { # Range in CFI format for this annotation sent by client.
566 "startPosition": "A String", # The starting position for the range.
567 "endPosition": "A String", # The ending position for the range.
568 "startOffset": "A String", # The offset from the starting position.
569 "endOffset": "A String", # The offset from the ending position.
570 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]571 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
572 "startPosition": "A String", # The starting position for the range.
573 "endPosition": "A String", # The ending position for the range.
574 "startOffset": "A String", # The offset from the starting position.
575 "endOffset": "A String", # The offset from the ending position.
576 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]577 "gbImageRange": { # Range in GB image format for this annotation sent by client.
578 "startPosition": "A String", # The starting position for the range.
579 "endPosition": "A String", # The ending position for the range.
580 "startOffset": "A String", # The offset from the starting position.
581 "endOffset": "A String", # The offset from the ending position.
582 },
583 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]584 "layerSummary": {
585 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
586 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
587 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
588 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]589 "volumeId": "A String", # The volume that this annotation belongs to.
590 "pageIds": [ # Pages that this annotation spans.
591 "A String",
592 ],
593 "layerId": "A String", # The layer this annotation is for.
594 "selectedText": "A String", # Excerpt from the volume.
595 "highlightStyle": "A String", # The highlight style for this annotation.
596 "data": "A String", # User-created data for this annotation.
597 "id": "A String", # Id of this annotation, in the form of a GUID.
598 "selfLink": "A String", # URL to this resource.
599 }
600
601 source: string, String to identify the originator of this request.
602
603Returns:
604 An object of the form:
605
606 {
607 "kind": "books#annotation", # Resource type.
608 "updated": "A String", # Timestamp for the last time this annotation was modified.
609 "created": "A String", # Timestamp for the created time of this annotation.
610 "deleted": True or False, # Indicates that this annotation is deleted.
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]611 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]612 "currentVersionRanges": { # Selection ranges for the most recent content version.
613 "contentVersion": "A String", # Content version applicable to ranges below.
614 "gbTextRange": { # Range in GB text format for this annotation for version above.
615 "startPosition": "A String", # The starting position for the range.
616 "endPosition": "A String", # The ending position for the range.
617 "startOffset": "A String", # The offset from the starting position.
618 "endOffset": "A String", # The offset from the ending position.
619 },
620 "cfiRange": { # Range in CFI format for this annotation for version above.
621 "startPosition": "A String", # The starting position for the range.
622 "endPosition": "A String", # The ending position for the range.
623 "startOffset": "A String", # The offset from the starting position.
624 "endOffset": "A String", # The offset from the ending position.
625 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]626 "imageCfiRange": { # Range in image CFI format for this annotation for version above.
627 "startPosition": "A String", # The starting position for the range.
628 "endPosition": "A String", # The ending position for the range.
629 "startOffset": "A String", # The offset from the starting position.
630 "endOffset": "A String", # The offset from the ending position.
631 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]632 "gbImageRange": { # Range in GB image format for this annotation for version above.
633 "startPosition": "A String", # The starting position for the range.
634 "endPosition": "A String", # The ending position for the range.
635 "startOffset": "A String", # The offset from the starting position.
636 "endOffset": "A String", # The offset from the ending position.
637 },
638 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]639 "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.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]640 "clientVersionRanges": { # Selection ranges sent from the client.
641 "contentVersion": "A String", # Content version the client sent in.
642 "gbTextRange": { # Range in GB text format for this annotation sent by client.
643 "startPosition": "A String", # The starting position for the range.
644 "endPosition": "A String", # The ending position for the range.
645 "startOffset": "A String", # The offset from the starting position.
646 "endOffset": "A String", # The offset from the ending position.
647 },
648 "cfiRange": { # Range in CFI format for this annotation sent by client.
649 "startPosition": "A String", # The starting position for the range.
650 "endPosition": "A String", # The ending position for the range.
651 "startOffset": "A String", # The offset from the starting position.
652 "endOffset": "A String", # The offset from the ending position.
653 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]654 "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
655 "startPosition": "A String", # The starting position for the range.
656 "endPosition": "A String", # The ending position for the range.
657 "startOffset": "A String", # The offset from the starting position.
658 "endOffset": "A String", # The offset from the ending position.
659 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]660 "gbImageRange": { # Range in GB image format for this annotation sent by client.
661 "startPosition": "A String", # The starting position for the range.
662 "endPosition": "A String", # The ending position for the range.
663 "startOffset": "A String", # The offset from the starting position.
664 "endOffset": "A String", # The offset from the ending position.
665 },
666 },
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame]667 "layerSummary": {
668 "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
669 "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
670 "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
671 },
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]672 "volumeId": "A String", # The volume that this annotation belongs to.
673 "pageIds": [ # Pages that this annotation spans.
674 "A String",
675 ],
676 "layerId": "A String", # The layer this annotation is for.
677 "selectedText": "A String", # Excerpt from the volume.
678 "highlightStyle": "A String", # The highlight style for this annotation.
679 "data": "A String", # User-created data for this annotation.
680 "id": "A String", # Id of this annotation, in the form of a GUID.
681 "selfLink": "A String", # URL to this resource.
682 }</pre>
683</div>
684
685</body></html>