| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <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> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#get">get(volumeId, layerId, annotationDataId, w=None, scale=None, source=None, allowWebDefinitions=None, locale=None, h=None, contentVersion=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the annotation data.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(volumeId, layerId, updatedMax=None, w=None, h=None, contentVersion=None, annotationDataId=None, locale=None, source=None, pageToken=None, updatedMin=None, maxResults=None, scale=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the annotation data for a volume and layer.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="get">get(volumeId, layerId, annotationDataId, w=None, scale=None, source=None, allowWebDefinitions=None, locale=None, h=None, contentVersion=None, x__xgafv=None)</code> |
| <pre>Gets the annotation data. |
| |
| Args: |
| volumeId: string, The volume to retrieve annotations for. (required) |
| layerId: string, The ID for the layer to get the annotations. (required) |
| annotationDataId: string, The ID of the annotation data to retrieve. (required) |
| w: integer, The requested pixel width for any images. If width is provided height must also be provided. |
| scale: integer, The requested scale for the image. |
| source: string, String to identify the originator of this request. |
| allowWebDefinitions: boolean, For the dictionary layer. Whether or not to allow web definitions. |
| locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. |
| h: integer, The requested pixel height for any images. If height is provided width must also be provided. |
| contentVersion: string, The content version for the volume you are trying to retrieve. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "data": { # JSON encoded data for this dictionary annotation data. Emitted with name 'data' in JSON output. Either this or geo_data will be populated. |
| "common": { |
| "title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search. |
| }, |
| "kind": "A String", |
| "dict": { |
| "words": [ |
| { |
| "derivatives": [ |
| { |
| "source": { |
| "url": "A String", |
| "attribution": "A String", |
| }, |
| "text": "A String", |
| }, |
| ], |
| "examples": [ |
| { |
| "source": { |
| "url": "A String", |
| "attribution": "A String", |
| }, |
| "text": "A String", |
| }, |
| ], |
| "source": { # The words with different meanings but not related words, e.g. "go" (game) and "go" (verb). |
| "attribution": "A String", |
| "url": "A String", |
| }, |
| "senses": [ |
| { |
| "definitions": [ |
| { |
| "examples": [ |
| { |
| "source": { |
| "url": "A String", |
| "attribution": "A String", |
| }, |
| "text": "A String", |
| }, |
| ], |
| "definition": "A String", |
| }, |
| ], |
| "syllabification": "A String", |
| "source": { |
| "url": "A String", |
| "attribution": "A String", |
| }, |
| "conjugations": [ |
| { |
| "value": "A String", |
| "type": "A String", |
| }, |
| ], |
| "synonyms": [ |
| { |
| "text": "A String", |
| "source": { |
| "url": "A String", |
| "attribution": "A String", |
| }, |
| }, |
| ], |
| "pronunciationUrl": "A String", |
| "partOfSpeech": "A String", |
| "pronunciation": "A String", |
| }, |
| ], |
| }, |
| ], |
| "source": { # The source, url and attribution for this dictionary data. |
| "attribution": "A String", |
| "url": "A String", |
| }, |
| }, |
| }, |
| "selfLink": "A String", # URL for this resource. * |
| "layerId": "A String", # The Layer id for this data. * |
| "volumeId": "A String", # The volume id for this data. * |
| "id": "A String", # Unique id for this annotation data. |
| "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). |
| "kind": "A String", # Resource Type |
| "encodedData": "A String", # Base64 encoded data for this annotation data. |
| "annotationType": "A String", # The type of annotation this data is for. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(volumeId, layerId, updatedMax=None, w=None, h=None, contentVersion=None, annotationDataId=None, locale=None, source=None, pageToken=None, updatedMin=None, maxResults=None, scale=None, x__xgafv=None)</code> |
| <pre>Gets the annotation data for a volume and layer. |
| |
| Args: |
| volumeId: string, The volume to retrieve annotation data for. (required) |
| layerId: string, The ID for the layer to get the annotation data. (required) |
| updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). |
| w: integer, The requested pixel width for any images. If width is provided height must also be provided. |
| h: integer, The requested pixel height for any images. If height is provided width must also be provided. |
| contentVersion: string, The content version for the requested volume. |
| annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated) |
| locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. |
| source: string, String to identify the originator of this request. |
| pageToken: string, The value of the nextToken from the previous page. |
| updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). |
| maxResults: integer, Maximum number of results to return |
| scale: integer, The requested scale for the image. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "kind": "A String", # Resource type |
| "items": [ # A list of Annotation Data. |
| { |
| "volumeId": "A String", # The volume id for this data. * |
| "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format). |
| "encodedData": "A String", # Base64 encoded data for this annotation data. |
| "layerId": "A String", # The Layer id for this data. * |
| "id": "A String", # Unique id for this annotation data. |
| "kind": "A String", # Resource Type |
| "annotationType": "A String", # The type of annotation this data is for. |
| "data": { # JSON encoded data for this geo annotation data. Emitted with name 'data' in JSON output. Either this or dict_data will be populated. |
| "geo": { |
| "cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER |
| "mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN |
| "latitude": 3.14, # The latitude of the location. |
| "countryCode": "A String", # The country code of the location. |
| "boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates. |
| "A String", |
| ], |
| "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 |
| "longitude": 3.14, # The longitude of the location. |
| "viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle. |
| "hi": { |
| "longitude": 3.14, |
| "latitude": 3.14, |
| }, |
| "lo": { |
| "longitude": 3.14, |
| "latitude": 3.14, |
| }, |
| }, |
| }, |
| "common": { |
| "snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link. |
| "snippet": "A String", # The description for this location. |
| "lang": "A String", # The language of the information url and description. |
| "title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search. |
| "previewImageUrl": "A String", # The URL for the preview image information. |
| }, |
| "kind": "A String", |
| }, |
| "selfLink": "A String", # URL for this resource. * |
| }, |
| ], |
| "totalItems": 42, # The total number of volume annotations found. |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
