blob: 8d84a5456532a7d89b35592e757b3c81ae8784ee [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#delete">delete(annotationId, source=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040082<p class="firstline">Deletes an annotation.</p>
83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080084 <code><a href="#insert">insert(annotationId=None, body=None, country=None, showOnlySummaryInResponse=None, source=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040085<p class="firstline">Inserts a new annotation.</p>
86<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080087 <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>
John Asmuth614db982014-04-24 15:46:26 -040088<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">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070093 <code><a href="#summary">summary(layerIds, volumeId, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040094<p class="firstline">Gets the summary of specified layers.</p>
95<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070096 <code><a href="#update">update(annotationId, body=None, source=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -040097<p class="firstline">Updates an existing annotation.</p>
98<h3>Method Details</h3>
99<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700105 <code class="details" id="delete">delete(annotationId, source=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400106 <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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700111 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 `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800120}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400121</div>
122
123<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800124 <code class="details" id="insert">insert(annotationId=None, body=None, country=None, showOnlySummaryInResponse=None, source=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400125 <pre>Inserts a new annotation.
126
127Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700128 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400129 The object takes the form of:
130
131{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800132 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800134 &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800135 &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800136 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800137 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800140 },
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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800143 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800144 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800145 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800153 },
154 &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800155 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800156 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800157 &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800158 &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800159 },
160 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800161 &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800162 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800164 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800165 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800166 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800168 },
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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800171 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800172 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800173 &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800174 &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800175 },
176 &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800177 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800178 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800179 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800187 },
188 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800189 &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800190 &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800191 &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 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800200 &quot;pageIds&quot;: [ # Pages that this annotation spans.
201 &quot;A String&quot;,
202 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800203 &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
204 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800205 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800207}
208
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800209 annotationId: string, The ID for the annotation to insert.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800210 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800213 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 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800222 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800230 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800231 &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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700237 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800238 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800243 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800244 &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>
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800298</div>
299
300<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800301 <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>
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800302 <pre>Retrieves a list of annotations, possibly filtered.
303
304Args:
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800305 contentVersion: string, The content version for the requested volume.
306 layerId: string, The layer ID to limit annotation by.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800307 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800310 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800312 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).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800314 volumeId: string, The volume to restrict annotations to.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800315 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 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800324 &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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700334 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800335 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800341 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800342 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800347 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800348 &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 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800354 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800355 &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>
John Asmuth614db982014-04-24 15:46:26 -0400407</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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700418 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400419 page. Returns None if there are no more items in the collection.
420 </pre>
421</div>
422
423<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700424 <code class="details" id="summary">summary(layerIds, volumeId, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400425 <pre>Gets the summary of specified layers.
426
427Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700428 layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
429 volumeId: string, Volume id to get the summary for. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700430 x__xgafv: string, V1 error format.
431 Allowed values
432 1 - v1 error format
433 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400434
435Returns:
436 An object of the form:
437
438 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800439 &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>
John Asmuth614db982014-04-24 15:46:26 -0400450</div>
451
452<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700453 <code class="details" id="update">update(annotationId, body=None, source=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400454 <pre>Updates an existing annotation.
455
456Args:
457 annotationId: string, The ID for the annotation to update. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700458 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400459 The object takes the form of:
460
461{
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800462 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800464 &quot;clientVersionRanges&quot;: { # Selection ranges sent from the client.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800465 &quot;cfiRange&quot;: { # Range in CFI format for this annotation sent by client.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800466 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800467 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800468 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800470 },
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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800473 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800474 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800475 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800483 },
484 &quot;imageCfiRange&quot;: { # Range in image CFI format for this annotation sent by client.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800485 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800486 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800487 &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800488 &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800489 },
490 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800491 &quot;created&quot;: &quot;A String&quot;, # Timestamp for the created time of this annotation.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800492 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800494 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800495 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800496 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800498 },
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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800501 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800502 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800503 &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800504 &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800505 },
506 &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800507 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800508 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800509 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800517 },
518 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800519 &quot;data&quot;: &quot;A String&quot;, # User-created data for this annotation.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800520 &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800521 &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 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800530 &quot;pageIds&quot;: [ # Pages that this annotation spans.
531 &quot;A String&quot;,
532 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800533 &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
534 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800535 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800537}
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 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800549 &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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800557 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800558 &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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800564 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800565 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800570 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800571 &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>
John Asmuth614db982014-04-24 15:46:26 -0400625</div>
626
627</body></html>