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="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(annotationId, source=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes an annotation.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(annotationId=None, body=None, country=None, showOnlySummaryInResponse=None, source=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Inserts a new annotation.</p>
86<p class="toc_element">
87  <code><a href="#list">list(contentVersion=None, layerId=None, layerIds=None, maxResults=None, pageToken=None, showDeleted=None, source=None, updatedMax=None, updatedMin=None, volumeId=None, x__xgafv=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, x__xgafv=None)</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=None, source=None, x__xgafv=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="close">close()</code>
101  <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
105    <code class="details" id="delete">delete(annotationId, source=None, x__xgafv=None)</code>
106  <pre>Deletes an annotation.
107
108Args:
109  annotationId: string, The ID for the annotation to delete. (required)
110  source: string, String to identify the originator of this request.
111  x__xgafv: string, V1 error format.
112    Allowed values
113      1 - v1 error format
114      2 - v2 error format
115
116Returns:
117  An object of the form:
118
119    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
120}</pre>
121</div>
122
123<div class="method">
124    <code class="details" id="insert">insert(annotationId=None, body=None, country=None, showOnlySummaryInResponse=None, source=None, x__xgafv=None)</code>
125  <pre>Inserts a new annotation.
126
127Args:
128  body: object, The request body.
129    The object takes the form of:
130
131{
132  &quot;afterSelectedText&quot;: &quot;A String&quot;, # 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.
133  &quot;beforeSelectedText&quot;: &quot;A String&quot;, # 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.
134  &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
135    &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
136      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
137      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
138      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
139      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
140    },
141    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version the client sent in.
142    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation sent by client.
143      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
144      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
145      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
146      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
147    },
148    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation sent by client.
149      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
150      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
151      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
152      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
153    },
154    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
155      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
156      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
157      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
158      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
159    },
160  },
161  &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
162  &quot;currentVersionRanges&quot;: { # Selection ranges for the most recent content version.
163    &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
164      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
165      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
166      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
167      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
168    },
169    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
170    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
171      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
172      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
173      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
174      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
175    },
176    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
177      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
178      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
179      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
180      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
181    },
182    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation for version above.
183      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
184      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
185      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
186      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
187    },
188  },
189  &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
190  &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
191  &quot;highlightStyle&quot;: &quot;A String&quot;, # The highlight style for this annotation.
192  &quot;id&quot;: &quot;A String&quot;, # Id of this annotation, in the form of a GUID.
193  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
194  &quot;layerId&quot;: &quot;A String&quot;, # The layer this annotation is for.
195  &quot;layerSummary&quot;: {
196    &quot;allowedCharacterCount&quot;: 42, # Maximum allowed characters on this layer, especially for the &quot;copy&quot; layer.
197    &quot;limitType&quot;: &quot;A String&quot;, # Type of limitation on this layer. &quot;limited&quot; or &quot;unlimited&quot; for the &quot;copy&quot; layer.
198    &quot;remainingCharacterCount&quot;: 42, # Remaining allowed characters on this layer, especially for the &quot;copy&quot; layer.
199  },
200  &quot;pageIds&quot;: [ # Pages that this annotation spans.
201    &quot;A String&quot;,
202  ],
203  &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
204  &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
205  &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this annotation was modified.
206  &quot;volumeId&quot;: &quot;A String&quot;, # The volume that this annotation belongs to.
207}
208
209  annotationId: string, The ID for the annotation to insert.
210  country: string, ISO-3166-1 code to override the IP-based location.
211  showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
212  source: string, String to identify the originator of this request.
213  x__xgafv: string, V1 error format.
214    Allowed values
215      1 - v1 error format
216      2 - v2 error format
217
218Returns:
219  An object of the form:
220
221    {
222  &quot;afterSelectedText&quot;: &quot;A String&quot;, # 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.
223  &quot;beforeSelectedText&quot;: &quot;A String&quot;, # 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.
224  &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
225    &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
226      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
227      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
228      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
229      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
230    },
231    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version the client sent in.
232    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation sent by client.
233      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
234      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
235      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
236      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
237    },
238    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation sent by client.
239      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
240      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
241      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
242      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
243    },
244    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
245      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
246      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
247      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
248      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
249    },
250  },
251  &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
252  &quot;currentVersionRanges&quot;: { # Selection ranges for the most recent content version.
253    &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
254      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
255      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
256      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
257      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
258    },
259    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
260    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
261      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
262      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
263      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
264      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
265    },
266    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
267      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
268      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
269      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
270      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
271    },
272    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation for version above.
273      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
274      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
275      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
276      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
277    },
278  },
279  &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
280  &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
281  &quot;highlightStyle&quot;: &quot;A String&quot;, # The highlight style for this annotation.
282  &quot;id&quot;: &quot;A String&quot;, # Id of this annotation, in the form of a GUID.
283  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
284  &quot;layerId&quot;: &quot;A String&quot;, # The layer this annotation is for.
285  &quot;layerSummary&quot;: {
286    &quot;allowedCharacterCount&quot;: 42, # Maximum allowed characters on this layer, especially for the &quot;copy&quot; layer.
287    &quot;limitType&quot;: &quot;A String&quot;, # Type of limitation on this layer. &quot;limited&quot; or &quot;unlimited&quot; for the &quot;copy&quot; layer.
288    &quot;remainingCharacterCount&quot;: 42, # Remaining allowed characters on this layer, especially for the &quot;copy&quot; layer.
289  },
290  &quot;pageIds&quot;: [ # Pages that this annotation spans.
291    &quot;A String&quot;,
292  ],
293  &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
294  &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
295  &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this annotation was modified.
296  &quot;volumeId&quot;: &quot;A String&quot;, # The volume that this annotation belongs to.
297}</pre>
298</div>
299
300<div class="method">
301    <code class="details" id="list">list(contentVersion=None, layerId=None, layerIds=None, maxResults=None, pageToken=None, showDeleted=None, source=None, updatedMax=None, updatedMin=None, volumeId=None, x__xgafv=None)</code>
302  <pre>Retrieves a list of annotations, possibly filtered.
303
304Args:
305  contentVersion: string, The content version for the requested volume.
306  layerId: string, The layer ID to limit annotation by.
307  layerIds: string, The layer ID(s) to limit annotation by. (repeated)
308  maxResults: integer, Maximum number of results to return
309  pageToken: string, The value of the nextToken from the previous page.
310  showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
311  source: string, String to identify the originator of this request.
312  updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
313  updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
314  volumeId: string, The volume to restrict annotations to.
315  x__xgafv: string, V1 error format.
316    Allowed values
317      1 - v1 error format
318      2 - v2 error format
319
320Returns:
321  An object of the form:
322
323    {
324  &quot;items&quot;: [ # A list of annotations.
325    {
326      &quot;afterSelectedText&quot;: &quot;A String&quot;, # 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.
327      &quot;beforeSelectedText&quot;: &quot;A String&quot;, # 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.
328      &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
329        &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
330          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
331          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
332          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
333          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
334        },
335        &quot;contentVersion&quot;: &quot;A String&quot;, # Content version the client sent in.
336        &quot;gbImageRange&quot;: { # Range in GB image format for this annotation sent by client.
337          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
338          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
339          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
340          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
341        },
342        &quot;gbTextRange&quot;: { # Range in GB text format for this annotation sent by client.
343          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
344          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
345          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
346          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
347        },
348        &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
349          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
350          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
351          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
352          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
353        },
354      },
355      &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
356      &quot;currentVersionRanges&quot;: { # Selection ranges for the most recent content version.
357        &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
358          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
359          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
360          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
361          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
362        },
363        &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
364        &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
365          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
366          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
367          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
368          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
369        },
370        &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
371          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
372          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
373          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
374          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
375        },
376        &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation for version above.
377          &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
378          &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
379          &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
380          &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
381        },
382      },
383      &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
384      &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
385      &quot;highlightStyle&quot;: &quot;A String&quot;, # The highlight style for this annotation.
386      &quot;id&quot;: &quot;A String&quot;, # Id of this annotation, in the form of a GUID.
387      &quot;kind&quot;: &quot;A String&quot;, # Resource type.
388      &quot;layerId&quot;: &quot;A String&quot;, # The layer this annotation is for.
389      &quot;layerSummary&quot;: {
390        &quot;allowedCharacterCount&quot;: 42, # Maximum allowed characters on this layer, especially for the &quot;copy&quot; layer.
391        &quot;limitType&quot;: &quot;A String&quot;, # Type of limitation on this layer. &quot;limited&quot; or &quot;unlimited&quot; for the &quot;copy&quot; layer.
392        &quot;remainingCharacterCount&quot;: 42, # Remaining allowed characters on this layer, especially for the &quot;copy&quot; layer.
393      },
394      &quot;pageIds&quot;: [ # Pages that this annotation spans.
395        &quot;A String&quot;,
396      ],
397      &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
398      &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
399      &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this annotation was modified.
400      &quot;volumeId&quot;: &quot;A String&quot;, # The volume that this annotation belongs to.
401    },
402  ],
403  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
404  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
405  &quot;totalItems&quot;: 42, # Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.
406}</pre>
407</div>
408
409<div class="method">
410    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
411  <pre>Retrieves the next page of results.
412
413Args:
414  previous_request: The request for the previous page. (required)
415  previous_response: The response from the request for the previous page. (required)
416
417Returns:
418  A request object that you can call &#x27;execute()&#x27; on to request the next
419  page. Returns None if there are no more items in the collection.
420    </pre>
421</div>
422
423<div class="method">
424    <code class="details" id="summary">summary(layerIds, volumeId, x__xgafv=None)</code>
425  <pre>Gets the summary of specified layers.
426
427Args:
428  layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
429  volumeId: string, Volume id to get the summary for. (required)
430  x__xgafv: string, V1 error format.
431    Allowed values
432      1 - v1 error format
433      2 - v2 error format
434
435Returns:
436  An object of the form:
437
438    {
439  &quot;kind&quot;: &quot;A String&quot;,
440  &quot;layers&quot;: [
441    {
442      &quot;allowedCharacterCount&quot;: 42,
443      &quot;layerId&quot;: &quot;A String&quot;,
444      &quot;limitType&quot;: &quot;A String&quot;,
445      &quot;remainingCharacterCount&quot;: 42,
446      &quot;updated&quot;: &quot;A String&quot;,
447    },
448  ],
449}</pre>
450</div>
451
452<div class="method">
453    <code class="details" id="update">update(annotationId, body=None, source=None, x__xgafv=None)</code>
454  <pre>Updates an existing annotation.
455
456Args:
457  annotationId: string, The ID for the annotation to update. (required)
458  body: object, The request body.
459    The object takes the form of:
460
461{
462  &quot;afterSelectedText&quot;: &quot;A String&quot;, # 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.
463  &quot;beforeSelectedText&quot;: &quot;A String&quot;, # 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.
464  &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
465    &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
466      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
467      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
468      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
469      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
470    },
471    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version the client sent in.
472    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation sent by client.
473      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
474      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
475      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
476      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
477    },
478    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation sent by client.
479      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
480      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
481      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
482      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
483    },
484    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
485      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
486      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
487      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
488      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
489    },
490  },
491  &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
492  &quot;currentVersionRanges&quot;: { # Selection ranges for the most recent content version.
493    &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
494      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
495      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
496      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
497      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
498    },
499    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
500    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
501      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
502      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
503      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
504      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
505    },
506    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
507      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
508      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
509      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
510      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
511    },
512    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation for version above.
513      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
514      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
515      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
516      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
517    },
518  },
519  &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
520  &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
521  &quot;highlightStyle&quot;: &quot;A String&quot;, # The highlight style for this annotation.
522  &quot;id&quot;: &quot;A String&quot;, # Id of this annotation, in the form of a GUID.
523  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
524  &quot;layerId&quot;: &quot;A String&quot;, # The layer this annotation is for.
525  &quot;layerSummary&quot;: {
526    &quot;allowedCharacterCount&quot;: 42, # Maximum allowed characters on this layer, especially for the &quot;copy&quot; layer.
527    &quot;limitType&quot;: &quot;A String&quot;, # Type of limitation on this layer. &quot;limited&quot; or &quot;unlimited&quot; for the &quot;copy&quot; layer.
528    &quot;remainingCharacterCount&quot;: 42, # Remaining allowed characters on this layer, especially for the &quot;copy&quot; layer.
529  },
530  &quot;pageIds&quot;: [ # Pages that this annotation spans.
531    &quot;A String&quot;,
532  ],
533  &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
534  &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
535  &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this annotation was modified.
536  &quot;volumeId&quot;: &quot;A String&quot;, # The volume that this annotation belongs to.
537}
538
539  source: string, String to identify the originator of this request.
540  x__xgafv: string, V1 error format.
541    Allowed values
542      1 - v1 error format
543      2 - v2 error format
544
545Returns:
546  An object of the form:
547
548    {
549  &quot;afterSelectedText&quot;: &quot;A String&quot;, # 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.
550  &quot;beforeSelectedText&quot;: &quot;A String&quot;, # 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.
551  &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
552    &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
553      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
554      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
555      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
556      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
557    },
558    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version the client sent in.
559    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation sent by client.
560      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
561      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
562      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
563      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
564    },
565    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation sent by client.
566      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
567      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
568      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
569      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
570    },
571    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
572      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
573      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
574      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
575      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
576    },
577  },
578  &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
579  &quot;currentVersionRanges&quot;: { # Selection ranges for the most recent content version.
580    &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
581      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
582      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
583      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
584      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
585    },
586    &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
587    &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
588      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
589      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
590      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
591      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
592    },
593    &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
594      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
595      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
596      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
597      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
598    },
599    &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation for version above.
600      &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
601      &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
602      &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
603      &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
604    },
605  },
606  &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
607  &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
608  &quot;highlightStyle&quot;: &quot;A String&quot;, # The highlight style for this annotation.
609  &quot;id&quot;: &quot;A String&quot;, # Id of this annotation, in the form of a GUID.
610  &quot;kind&quot;: &quot;A String&quot;, # Resource type.
611  &quot;layerId&quot;: &quot;A String&quot;, # The layer this annotation is for.
612  &quot;layerSummary&quot;: {
613    &quot;allowedCharacterCount&quot;: 42, # Maximum allowed characters on this layer, especially for the &quot;copy&quot; layer.
614    &quot;limitType&quot;: &quot;A String&quot;, # Type of limitation on this layer. &quot;limited&quot; or &quot;unlimited&quot; for the &quot;copy&quot; layer.
615    &quot;remainingCharacterCount&quot;: 42, # Remaining allowed characters on this layer, especially for the &quot;copy&quot; layer.
616  },
617  &quot;pageIds&quot;: [ # Pages that this annotation spans.
618    &quot;A String&quot;,
619  ],
620  &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
621  &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
622  &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this annotation was modified.
623  &quot;volumeId&quot;: &quot;A String&quot;, # The volume that this annotation belongs to.
624}</pre>
625</div>
626
627</body></html>