# Books API . layers . annotationData

## Instance Methods

Close httplib2 connections.

Gets the annotation data.

Gets the annotation data for a volume and layer.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`get(volumeId, layerId, annotationDataId, contentVersion, allowWebDefinitions=None, h=None, locale=None, scale=None, source=None, w=None, x__xgafv=None)`

    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)
      contentVersion: string, The content version for the volume you are trying to retrieve. (required)
      allowWebDefinitions: boolean, For the dictionary layer. Whether or not to allow web definitions.
      h: integer, The requested pixel height for any images. If height is provided width must also be provided.
      locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
      scale: integer, The requested scale for the image.
      source: string, String to identify the originator of this request.
      w: integer, The requested pixel width for any images. If width is provided height must also be provided.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
      "annotationType": "A String", # The type of annotation this data is for.
      "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.
        },
        "dict": {
          "source": { # The source, url and attribution for this dictionary data.
            "attribution": "A String",
            "url": "A String",
          },
          "words": [
            {
              "derivatives": [
                {
                  "source": {
                    "attribution": "A String",
                    "url": "A String",
                  },
                  "text": "A String",
                },
              ],
              "examples": [
                {
                  "source": {
                    "attribution": "A String",
                    "url": "A String",
                  },
                  "text": "A String",
                },
              ],
              "senses": [
                {
                  "conjugations": [
                    {
                      "type": "A String",
                      "value": "A String",
                    },
                  ],
                  "definitions": [
                    {
                      "definition": "A String",
                      "examples": [
                        {
                          "source": {
                            "attribution": "A String",
                            "url": "A String",
                          },
                          "text": "A String",
                        },
                      ],
                    },
                  ],
                  "partOfSpeech": "A String",
                  "pronunciation": "A String",
                  "pronunciationUrl": "A String",
                  "source": {
                    "attribution": "A String",
                    "url": "A String",
                  },
                  "syllabification": "A String",
                  "synonyms": [
                    {
                      "source": {
                        "attribution": "A String",
                        "url": "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",
              },
            },
          ],
        },
        "kind": "A String",
      },
      "encodedData": "A String", # Base64 encoded data for this annotation data.
      "id": "A String", # Unique id for this annotation data.
      "kind": "A String", # Resource Type
      "layerId": "A String", # The Layer id for this data. *
      "selfLink": "A String", # URL for this resource. *
      "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
      "volumeId": "A String", # The volume id for this data. *
    }

`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)`

    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)
      contentVersion: string, The content version for the requested volume. (required)
      annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated)
      h: integer, The requested pixel height for any images. If height is provided width must also be provided.
      locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
      maxResults: integer, Maximum number of results to return
      pageToken: string, The value of the nextToken from the previous page.
      scale: integer, The requested scale for the image.
      source: string, String to identify the originator of this request.
      updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
      updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
      w: integer, The requested pixel width for any images. If width is provided height must also be provided.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
      "items": [ # A list of Annotation Data.
        {
          "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.
            "common": {
              "lang": "A String", # The language of the information url and description.
              "previewImageUrl": "A String", # The URL for the preview image information.
              "snippet": "A String", # The description for this location.
              "snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link.
              "title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search.
            },
            "geo": {
              "boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.
                "A String",
              ],
              "cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER
              "countryCode": "A String", # The country code of the location.
              "latitude": 3.14, # The latitude of the location.
              "longitude": 3.14, # The longitude of the location.
              "mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN
              "viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.
                "hi": {
                  "latitude": 3.14,
                  "longitude": 3.14,
                },
                "lo": {
                  "latitude": 3.14,
                  "longitude": 3.14,
                },
              },
              "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
            },
            "kind": "A String",
          },
          "encodedData": "A String", # Base64 encoded data for this annotation data.
          "id": "A String", # Unique id for this annotation data.
          "kind": "A String", # Resource Type
          "layerId": "A String", # The Layer id for this data. *
          "selfLink": "A String", # URL for this resource. *
          "updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
          "volumeId": "A String", # The volume id for this data. *
        },
      ],
      "kind": "A String", # Resource type
      "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.
      "totalItems": 42, # The total number of volume annotations found.
    }

`list_next()`

    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.