Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f0edebc7e6c6077cfed0404ae7e73bb0e6ef1776 / . / docs / dyn / books_v1.layers.annotationData.html
blob: 6dc4cd7a69b951afcc945cb9b67a13836751d37c [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.layers.html">layers</a> . <a href="books_v1.layers.annotationData.html">annotationData</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(volumeId, layerId, annotationDataId, contentVersion, scale=None, source=None, locale=None, h=None, w=None)</a></code></p>
79<p class="firstline">Gets the annotation data.</p>
80<p class="toc_element">
81 <code><a href="#list">list(volumeId, layerId, contentVersion, locale=None, scale=None, pageToken=None, updatedMin=None, source=None, updatedMax=None, maxResults=None, annotationDataId=None, w=None, h=None)</a></code></p>
82<p class="firstline">Gets the annotation data for a volume and layer.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(volumeId, layerId, annotationDataId, contentVersion, scale=None, source=None, locale=None, h=None, w=None)</code>
89 <pre>Gets the annotation data.
90
91Args:
92 volumeId: string, The volume to retrieve annotations for. (required)
93 layerId: string, The ID for the layer to get the annotations. (required)
94 annotationDataId: string, The ID of the annotation data to retrieve. (required)
95 contentVersion: string, The content version for the volume you are trying to retrieve. (required)
96 scale: integer, The requested scale for the image.
97 source: string, String to identify the originator of this request.
98 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
99 h: integer, The requested pixel height for any images. If height is provided width must also be provided.
100 w: integer, The requested pixel width for any images. If width is provided height must also be provided.
101
102Returns:
103 An object of the form:
104
105 {
106 "annotationType": "A String", # The type of annotation this data is for.
107 "kind": "books#annotationdata", # Resource Type
108 "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
109 "volumeId": "A String", # The volume id for this data. *
110 "encoded_data": "A String", # Base64 encoded data for this annotation data.
111 "layerId": "A String", # The Layer id for this data. *
112 "data": { # JSON encoded data for this annotation data.
113 "geo": {
114 "countryCode": "A String", # The country code of the location.
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]115 "title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]116 "zoom": 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
117 "longitude": 3.14, # The longitude of the location.
118 "mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN
119 "latitude": 3.14, # The latitude of the location.
120 "boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.
121 [
122 {
123 "latitude": 42,
124 "longitude": 42,
125 },
126 ],
127 ],
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]128 "viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.
129 "lo": {
130 "latitude": 3.14,
131 "longitude": 3.14,
132 },
133 "hi": {
134 "latitude": 3.14,
135 "longitude": 3.14,
136 },
137 },
138 "cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER
139 },
140 "common": {
141 "lang": "A String", # The language of the information url and description.
142 "previewImageUrl": "A String", # The URL for the preview image information.
143 "snippet": "A String", # The description for this location.
144 "snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link.
145 },
146 },
147 "id": "A String", # Unique id for this annotation data.
148 "selfLink": "A String", # URL for this resource. *
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="list">list(volumeId, layerId, contentVersion, locale=None, scale=None, pageToken=None, updatedMin=None, source=None, updatedMax=None, maxResults=None, annotationDataId=None, w=None, h=None)</code>
154 <pre>Gets the annotation data for a volume and layer.
155
156Args:
157 volumeId: string, The volume to retrieve annotation data for. (required)
158 layerId: string, The ID for the layer to get the annotation data. (required)
159 contentVersion: string, The content version for the requested volume. (required)
160 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
161 scale: integer, The requested scale for the image.
162 pageToken: string, The value of the nextToken from the previous page.
163 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
164 source: string, String to identify the originator of this request.
165 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
166 maxResults: integer, Maximum number of results to return
167 annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated)
168 w: integer, The requested pixel width for any images. If width is provided height must also be provided.
169 h: integer, The requested pixel height for any images. If height is provided width must also be provided.
170
171Returns:
172 An object of the form:
173
174 {
175 "nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.
176 "items": [ # A list of Annotation Data.
177 {
178 "annotationType": "A String", # The type of annotation this data is for.
179 "kind": "books#annotationdata", # Resource Type
180 "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
181 "volumeId": "A String", # The volume id for this data. *
182 "encoded_data": "A String", # Base64 encoded data for this annotation data.
183 "layerId": "A String", # The Layer id for this data. *
184 "data": { # JSON encoded data for this annotation data.
185 "geo": {
186 "countryCode": "A String", # The country code of the location.
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]187 "title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]188 "zoom": 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
189 "longitude": 3.14, # The longitude of the location.
190 "mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN
191 "latitude": 3.14, # The latitude of the location.
192 "boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.
193 [
194 {
195 "latitude": 42,
196 "longitude": 42,
197 },
198 ],
199 ],
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]200 "viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.
201 "lo": {
202 "latitude": 3.14,
203 "longitude": 3.14,
204 },
205 "hi": {
206 "latitude": 3.14,
207 "longitude": 3.14,
208 },
209 },
210 "cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER
211 },
212 "common": {
213 "lang": "A String", # The language of the information url and description.
214 "previewImageUrl": "A String", # The URL for the preview image information.
215 "snippet": "A String", # The description for this location.
216 "snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link.
217 },
218 },
219 "id": "A String", # Unique id for this annotation data.
220 "selfLink": "A String", # URL for this resource. *
221 },
222 ],
223 "kind": "books#annotationsdata", # Resource type
224 "totalItems": 42, # The total number of volume annotations found.
225 }</pre>
226</div>
227
228<div class="method">
229 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
230 <pre>Retrieves the next page of results.
231
232Args:
233 previous_request: The request for the previous page. (required)
234 previous_response: The response from the request for the previous page. (required)
235
236Returns:
237 A request object that you can call 'execute()' on to request the next
238 page. Returns None if there are no more items in the collection.
239 </pre>
240</div>
241
242</body></html>