Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cdf480e8145d58600a5224efc68ba2ace973ef62 / . / docs / dyn / books_v1.layers.volumeAnnotations.html
blob: bf28a3f5a1e1efd7f5c82fd127315b2c42aad52f [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.layers.html">layers</a> . <a href="books_v1.layers.volumeAnnotations.html">volumeAnnotations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]81 <code><a href="#get">get(volumeId, layerId, annotationId, locale=None, source=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Gets the volume annotation.</p>
83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]84 <code><a href="#list">list(volumeId, layerId, contentVersion, endOffset=None, endPosition=None, locale=None, maxResults=None, pageToken=None, showDeleted=None, source=None, startOffset=None, startPosition=None, updatedMax=None, updatedMin=None, volumeAnnotationsVersion=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Gets the volume annotations for a volume and layer.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]96 <code class="details" id="get">get(volumeId, layerId, annotationId, locale=None, source=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]97 <pre>Gets the volume annotation.
98
99Args:
100 volumeId: string, The volume to retrieve annotations for. (required)
101 layerId: string, The ID for the layer to get the annotations. (required)
102 annotationId: string, The ID of the volume annotation to retrieve. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]103 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: &#x27;en_US&#x27;.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]104 source: string, String to identify the originator of this request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]109
110Returns:
111 An object of the form:
112
113 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]114 &quot;annotationDataId&quot;: &quot;A String&quot;, # The annotation data id for this volume annotation.
115 &quot;annotationDataLink&quot;: &quot;A String&quot;, # Link to get data for this annotation.
116 &quot;annotationType&quot;: &quot;A String&quot;, # The type of annotation this is.
117 &quot;contentRanges&quot;: { # The content ranges to identify the selected text.
118 &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
119 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
120 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
121 &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
122 &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]123 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]124 &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
125 &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
126 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
127 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
128 &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
129 &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
130 },
131 &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
132 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
133 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
134 &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
135 &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
136 },
137 },
138 &quot;data&quot;: &quot;A String&quot;, # Data for this annotation.
139 &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
140 &quot;id&quot;: &quot;A String&quot;, # Unique id of this volume annotation.
141 &quot;kind&quot;: &quot;A String&quot;, # Resource Type
142 &quot;layerId&quot;: &quot;A String&quot;, # The Layer this annotation is for.
143 &quot;pageIds&quot;: [ # Pages the annotation spans.
144 &quot;A String&quot;,
145 ],
146 &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
147 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
148 &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
149 &quot;volumeId&quot;: &quot;A String&quot;, # The Volume this annotation is for.
150}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]151</div>
152
153<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]154 <code class="details" id="list">list(volumeId, layerId, contentVersion, endOffset=None, endPosition=None, locale=None, maxResults=None, pageToken=None, showDeleted=None, source=None, startOffset=None, startPosition=None, updatedMax=None, updatedMin=None, volumeAnnotationsVersion=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 <pre>Gets the volume annotations for a volume and layer.
156
157Args:
158 volumeId: string, The volume to retrieve annotations for. (required)
159 layerId: string, The ID for the layer to get the annotations. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]160 contentVersion: string, The content version for the requested volume. (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]161 endOffset: string, The end offset to end retrieving data from.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]162 endPosition: string, The end position to end retrieving data from.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]163 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: &#x27;en_US&#x27;.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]164 maxResults: integer, Maximum number of results to return
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]165 pageToken: string, The value of the nextToken from the previous page.
166 showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]167 source: string, String to identify the originator of this request.
168 startOffset: string, The start offset to start retrieving data from.
169 startPosition: string, The start position to start retrieving data from.
170 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
171 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
172 volumeAnnotationsVersion: string, The version of the volume annotations that you are requesting.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]173 x__xgafv: string, V1 error format.
174 Allowed values
175 1 - v1 error format
176 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]177
178Returns:
179 An object of the form:
180
181 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]182 &quot;items&quot;: [ # A list of volume annotations.
183 {
184 &quot;annotationDataId&quot;: &quot;A String&quot;, # The annotation data id for this volume annotation.
185 &quot;annotationDataLink&quot;: &quot;A String&quot;, # Link to get data for this annotation.
186 &quot;annotationType&quot;: &quot;A String&quot;, # The type of annotation this is.
187 &quot;contentRanges&quot;: { # The content ranges to identify the selected text.
188 &quot;cfiRange&quot;: { # Range in CFI format for this annotation for version above.
189 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
190 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
191 &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
192 &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]193 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]194 &quot;contentVersion&quot;: &quot;A String&quot;, # Content version applicable to ranges below.
195 &quot;gbImageRange&quot;: { # Range in GB image format for this annotation for version above.
196 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
197 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
198 &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
199 &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
200 },
201 &quot;gbTextRange&quot;: { # Range in GB text format for this annotation for version above.
202 &quot;endOffset&quot;: &quot;A String&quot;, # The offset from the ending position.
203 &quot;endPosition&quot;: &quot;A String&quot;, # The ending position for the range.
204 &quot;startOffset&quot;: &quot;A String&quot;, # The offset from the starting position.
205 &quot;startPosition&quot;: &quot;A String&quot;, # The starting position for the range.
206 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]207 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]208 &quot;data&quot;: &quot;A String&quot;, # Data for this annotation.
209 &quot;deleted&quot;: True or False, # Indicates that this annotation is deleted.
210 &quot;id&quot;: &quot;A String&quot;, # Unique id of this volume annotation.
211 &quot;kind&quot;: &quot;A String&quot;, # Resource Type
212 &quot;layerId&quot;: &quot;A String&quot;, # The Layer this annotation is for.
213 &quot;pageIds&quot;: [ # Pages the annotation spans.
214 &quot;A String&quot;,
215 ],
216 &quot;selectedText&quot;: &quot;A String&quot;, # Excerpt from the volume.
217 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
218 &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
219 &quot;volumeId&quot;: &quot;A String&quot;, # The Volume this annotation is for.
220 },
221 ],
222 &quot;kind&quot;: &quot;A String&quot;, # Resource type
223 &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.
224 &quot;totalItems&quot;: 42, # The total number of volume annotations found.
225 &quot;version&quot;: &quot;A String&quot;, # The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn&#x27;t apply to the annotation data, just the information in this response (e.g. the location of annotations in the book).
226}</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]227</div>
228
229<div class="method">
230 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
231 <pre>Retrieves the next page of results.
232
233Args:
234 previous_request: The request for the previous page. (required)
235 previous_response: The response from the request for the previous page. (required)
236
237Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]238 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]239 page. Returns None if there are no more items in the collection.
240 </pre>
241</div>
242
243</body></html>