Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0bf565cdd7eac073130c7d9700285524a0efd1a3 / . / docs / dyn / books_v1.layers.annotationData.html
blob: 2f58d43589f30092d5c308a635209f4f60da4d83 [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.annotationData.html">annotationData</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, annotationDataId, contentVersion, source=None, allowWebDefinitions=None, w=None, locale=None, scale=None, h=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]82<p class="firstline">Gets the annotation data.</p>
83<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]84 <code><a href="#list">list(volumeId, layerId, contentVersion, maxResults=None, h=None, locale=None, w=None, pageToken=None, annotationDataId=None, updatedMin=None, updatedMax=None, source=None, scale=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Gets the annotation data 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, annotationDataId, contentVersion, source=None, allowWebDefinitions=None, w=None, locale=None, scale=None, h=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]97 <pre>Gets the annotation data.
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 annotationDataId: string, The ID of the annotation data to retrieve. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]103 contentVersion: string, The content version for the volume you are trying to retrieve. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]104 source: string, String to identify the originator of this request.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]105 allowWebDefinitions: boolean, For the dictionary layer. Whether or not to allow web definitions.
106 w: integer, The requested pixel width for any images. If width is provided height must also be provided.
107 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: &#x27;en_US&#x27;.
108 scale: integer, The requested scale for the image.
109 h: integer, The requested pixel height for any images. If height is provided width must also be provided.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114
115Returns:
116 An object of the form:
117
118 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]119 &quot;annotationType&quot;: &quot;A String&quot;, # The type of annotation this data is for.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]120 &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]121 &quot;encodedData&quot;: &quot;A String&quot;, # Base64 encoded data for this annotation data.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]122 &quot;data&quot;: { # JSON encoded data for this dictionary annotation data. Emitted with name &#x27;data&#x27; in JSON output. Either this or geo_data will be populated.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]123 &quot;common&quot;: {
124 &quot;title&quot;: &quot;A String&quot;, # The display title and localized canonical name to use when searching for this entity on Google search.
125 },
126 &quot;kind&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]127 &quot;dict&quot;: {
128 &quot;words&quot;: [
129 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]130 &quot;examples&quot;: [
131 {
132 &quot;text&quot;: &quot;A String&quot;,
133 &quot;source&quot;: {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]134 &quot;attribution&quot;: &quot;A String&quot;,
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]135 &quot;url&quot;: &quot;A String&quot;,
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]136 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]137 },
138 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]139 &quot;source&quot;: { # The words with different meanings but not related words, e.g. &quot;go&quot; (game) and &quot;go&quot; (verb).
140 &quot;url&quot;: &quot;A String&quot;,
141 &quot;attribution&quot;: &quot;A String&quot;,
142 },
143 &quot;derivatives&quot;: [
144 {
145 &quot;text&quot;: &quot;A String&quot;,
146 &quot;source&quot;: {
147 &quot;url&quot;: &quot;A String&quot;,
148 &quot;attribution&quot;: &quot;A String&quot;,
149 },
150 },
151 ],
152 &quot;senses&quot;: [
153 {
154 &quot;syllabification&quot;: &quot;A String&quot;,
155 &quot;pronunciation&quot;: &quot;A String&quot;,
156 &quot;synonyms&quot;: [
157 {
158 &quot;text&quot;: &quot;A String&quot;,
159 &quot;source&quot;: {
160 &quot;attribution&quot;: &quot;A String&quot;,
161 &quot;url&quot;: &quot;A String&quot;,
162 },
163 },
164 ],
165 &quot;conjugations&quot;: [
166 {
167 &quot;value&quot;: &quot;A String&quot;,
168 &quot;type&quot;: &quot;A String&quot;,
169 },
170 ],
171 &quot;partOfSpeech&quot;: &quot;A String&quot;,
172 &quot;source&quot;: {
173 &quot;url&quot;: &quot;A String&quot;,
174 &quot;attribution&quot;: &quot;A String&quot;,
175 },
176 &quot;definitions&quot;: [
177 {
178 &quot;definition&quot;: &quot;A String&quot;,
179 &quot;examples&quot;: [
180 {
181 &quot;source&quot;: {
182 &quot;attribution&quot;: &quot;A String&quot;,
183 &quot;url&quot;: &quot;A String&quot;,
184 },
185 &quot;text&quot;: &quot;A String&quot;,
186 },
187 ],
188 },
189 ],
190 &quot;pronunciationUrl&quot;: &quot;A String&quot;,
191 },
192 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]193 },
194 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]195 &quot;source&quot;: { # The source, url and attribution for this dictionary data.
196 &quot;url&quot;: &quot;A String&quot;,
197 &quot;attribution&quot;: &quot;A String&quot;,
198 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]199 },
200 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]201 &quot;id&quot;: &quot;A String&quot;, # Unique id for this annotation data.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]202 &quot;kind&quot;: &quot;A String&quot;, # Resource Type
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]203 &quot;layerId&quot;: &quot;A String&quot;, # The Layer id for this data. *
204 &quot;selfLink&quot;: &quot;A String&quot;, # URL for this resource. *
205 &quot;volumeId&quot;: &quot;A String&quot;, # The volume id for this data. *
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]206 }</pre>
207</div>
208
209<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]210 <code class="details" id="list">list(volumeId, layerId, contentVersion, maxResults=None, h=None, locale=None, w=None, pageToken=None, annotationDataId=None, updatedMin=None, updatedMax=None, source=None, scale=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211 <pre>Gets the annotation data for a volume and layer.
212
213Args:
214 volumeId: string, The volume to retrieve annotation data for. (required)
215 layerId: string, The ID for the layer to get the annotation data. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]216 contentVersion: string, The content version for the requested volume. (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]217 maxResults: integer, Maximum number of results to return
218 h: integer, The requested pixel height for any images. If height is provided width must also be provided.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]219 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: &#x27;en_US&#x27;.
220 w: integer, The requested pixel width for any images. If width is provided height must also be provided.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]221 pageToken: string, The value of the nextToken from the previous page.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]222 annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated)
223 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
224 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
225 source: string, String to identify the originator of this request.
226 scale: integer, The requested scale for the image.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]227 x__xgafv: string, V1 error format.
228 Allowed values
229 1 - v1 error format
230 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231
232Returns:
233 An object of the form:
234
235 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]236 &quot;items&quot;: [ # A list of Annotation Data.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]237 {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]238 &quot;id&quot;: &quot;A String&quot;, # Unique id for this annotation data.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]239 &quot;annotationType&quot;: &quot;A String&quot;, # The type of annotation this data is for.
240 &quot;volumeId&quot;: &quot;A String&quot;, # The volume id for this data. *
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]241 &quot;layerId&quot;: &quot;A String&quot;, # The Layer id for this data. *
242 &quot;encodedData&quot;: &quot;A String&quot;, # Base64 encoded data for this annotation data.
243 &quot;selfLink&quot;: &quot;A String&quot;, # URL for this resource. *
244 &quot;kind&quot;: &quot;A String&quot;, # Resource Type
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]245 &quot;data&quot;: { # JSON encoded data for this geo annotation data. Emitted with name &#x27;data&#x27; in JSON output. Either this or dict_data will be populated.
246 &quot;geo&quot;: {
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]247 &quot;latitude&quot;: 3.14, # The latitude of the location.
248 &quot;zoom&quot;: 42, # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https: //developers.google.com/maps/documentation/staticmaps/#Zoomlevels
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]249 &quot;viewport&quot;: { # The viewport for showing this location. This is a latitude, longitude rectangle.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]250 &quot;hi&quot;: {
251 &quot;longitude&quot;: 3.14,
252 &quot;latitude&quot;: 3.14,
253 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]254 &quot;lo&quot;: {
255 &quot;longitude&quot;: 3.14,
256 &quot;latitude&quot;: 3.14,
257 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]258 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]259 &quot;mapType&quot;: &quot;A String&quot;, # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN
260 &quot;countryCode&quot;: &quot;A String&quot;, # The country code of the location.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]261 &quot;longitude&quot;: 3.14, # The longitude of the location.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]262 &quot;cachePolicy&quot;: &quot;A String&quot;, # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]263 &quot;boundary&quot;: [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.
264 &quot;A String&quot;,
265 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]266 },
267 &quot;common&quot;: {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]268 &quot;snippetUrl&quot;: &quot;A String&quot;, # The URL for information for this location. Ex: wikipedia link.
269 &quot;title&quot;: &quot;A String&quot;, # The display title and localized canonical name to use when searching for this entity on Google search.
270 &quot;snippet&quot;: &quot;A String&quot;, # The description for this location.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]271 &quot;lang&quot;: &quot;A String&quot;, # The language of the information url and description.
272 &quot;previewImageUrl&quot;: &quot;A String&quot;, # The URL for the preview image information.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]273 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]274 &quot;kind&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]275 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]276 &quot;updated&quot;: &quot;A String&quot;, # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]277 },
278 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame^]279 &quot;totalItems&quot;: 42, # The total number of volume annotations found.
280 &quot;kind&quot;: &quot;A String&quot;, # Resource type
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]281 &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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]282 }</pre>
283</div>
284
285<div class="method">
286 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
287 <pre>Retrieves the next page of results.
288
289Args:
290 previous_request: The request for the previous page. (required)
291 previous_response: The response from the request for the previous page. (required)
292
293Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]294 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]295 page. Returns None if there are no more items in the collection.
296 </pre>
297</div>
298
299</body></html>