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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(volumeId, layerId, annotationDataId, contentVersion, allowWebDefinitions=None, h=None, locale=None, scale=None, source=None, w=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets the annotation data.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(volumeId, layerId, contentVersion, annotationDataId=None, h=None, locale=None, maxResults=None, pageToken=None, scale=None, source=None, updatedMax=None, updatedMin=None, w=None, x__xgafv=None)</a></code></p> 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"> 91 <code class="details" id="close">close()</code> 92 <pre>Close httplib2 connections.</pre> 93</div> 94 95<div class="method"> 96 <code class="details" id="get">get(volumeId, layerId, annotationDataId, contentVersion, allowWebDefinitions=None, h=None, locale=None, scale=None, source=None, w=None, x__xgafv=None)</code> 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) 103 contentVersion: string, The content version for the volume you are trying to retrieve. (required) 104 allowWebDefinitions: boolean, For the dictionary layer. Whether or not to allow web definitions. 105 h: integer, The requested pixel height for any images. If height is provided width must also be provided. 106 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. 107 scale: integer, The requested scale for the image. 108 source: string, String to identify the originator of this request. 109 w: integer, The requested pixel width for any images. If width is provided height must also be provided. 110 x__xgafv: string, V1 error format. 111 Allowed values 112 1 - v1 error format 113 2 - v2 error format 114 115Returns: 116 An object of the form: 117 118 { 119 "annotationType": "A String", # The type of annotation this data is for. 120 "data": { # JSON encoded data for this dictionary annotation data. Emitted with name 'data' in JSON output. Either this or geo_data will be populated. 121 "common": { 122 "title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search. 123 }, 124 "dict": { 125 "source": { # The source, url and attribution for this dictionary data. 126 "attribution": "A String", 127 "url": "A String", 128 }, 129 "words": [ 130 { 131 "derivatives": [ 132 { 133 "source": { 134 "attribution": "A String", 135 "url": "A String", 136 }, 137 "text": "A String", 138 }, 139 ], 140 "examples": [ 141 { 142 "source": { 143 "attribution": "A String", 144 "url": "A String", 145 }, 146 "text": "A String", 147 }, 148 ], 149 "senses": [ 150 { 151 "conjugations": [ 152 { 153 "type": "A String", 154 "value": "A String", 155 }, 156 ], 157 "definitions": [ 158 { 159 "definition": "A String", 160 "examples": [ 161 { 162 "source": { 163 "attribution": "A String", 164 "url": "A String", 165 }, 166 "text": "A String", 167 }, 168 ], 169 }, 170 ], 171 "partOfSpeech": "A String", 172 "pronunciation": "A String", 173 "pronunciationUrl": "A String", 174 "source": { 175 "attribution": "A String", 176 "url": "A String", 177 }, 178 "syllabification": "A String", 179 "synonyms": [ 180 { 181 "source": { 182 "attribution": "A String", 183 "url": "A String", 184 }, 185 "text": "A String", 186 }, 187 ], 188 }, 189 ], 190 "source": { # The words with different meanings but not related words, e.g. "go" (game) and "go" (verb). 191 "attribution": "A String", 192 "url": "A String", 193 }, 194 }, 195 ], 196 }, 197 "kind": "A String", 198 }, 199 "encodedData": "A String", # Base64 encoded data for this annotation data. 200 "id": "A String", # Unique id for this annotation data. 201 "kind": "A String", # Resource Type 202 "layerId": "A String", # The Layer id for this data. * 203 "selfLink": "A String", # URL for this resource. * 204 "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). 205 "volumeId": "A String", # The volume id for this data. * 206}</pre> 207</div> 208 209<div class="method"> 210 <code class="details" id="list">list(volumeId, layerId, contentVersion, annotationDataId=None, h=None, locale=None, maxResults=None, pageToken=None, scale=None, source=None, updatedMax=None, updatedMin=None, w=None, x__xgafv=None)</code> 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) 216 contentVersion: string, The content version for the requested volume. (required) 217 annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated) 218 h: integer, The requested pixel height for any images. If height is provided width must also be provided. 219 locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. 220 maxResults: integer, Maximum number of results to return 221 pageToken: string, The value of the nextToken from the previous page. 222 scale: integer, The requested scale for the image. 223 source: string, String to identify the originator of this request. 224 updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). 225 updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). 226 w: integer, The requested pixel width for any images. If width is provided height must also be provided. 227 x__xgafv: string, V1 error format. 228 Allowed values 229 1 - v1 error format 230 2 - v2 error format 231 232Returns: 233 An object of the form: 234 235 { 236 "items": [ # A list of Annotation Data. 237 { 238 "annotationType": "A String", # The type of annotation this data is for. 239 "data": { # JSON encoded data for this geo annotation data. Emitted with name 'data' in JSON output. Either this or dict_data will be populated. 240 "common": { 241 "lang": "A String", # The language of the information url and description. 242 "previewImageUrl": "A String", # The URL for the preview image information. 243 "snippet": "A String", # The description for this location. 244 "snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link. 245 "title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search. 246 }, 247 "geo": { 248 "boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates. 249 "A String", 250 ], 251 "cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER 252 "countryCode": "A String", # The country code of the location. 253 "latitude": 3.14, # The latitude of the location. 254 "longitude": 3.14, # The longitude of the location. 255 "mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN 256 "viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle. 257 "hi": { 258 "latitude": 3.14, 259 "longitude": 3.14, 260 }, 261 "lo": { 262 "latitude": 3.14, 263 "longitude": 3.14, 264 }, 265 }, 266 "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 267 }, 268 "kind": "A String", 269 }, 270 "encodedData": "A String", # Base64 encoded data for this annotation data. 271 "id": "A String", # Unique id for this annotation data. 272 "kind": "A String", # Resource Type 273 "layerId": "A String", # The Layer id for this data. * 274 "selfLink": "A String", # URL for this resource. * 275 "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). 276 "volumeId": "A String", # The volume id for this data. * 277 }, 278 ], 279 "kind": "A String", # Resource type 280 "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. 281 "totalItems": 42, # The total number of volume annotations found. 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: 294 A request object that you can call 'execute()' on to request the next 295 page. Returns None if there are no more items in the collection. 296 </pre> 297</div> 298 299</body></html>