Books API . layers . volumeAnnotations

get(volumeId=*, layerId=*, annotationId=*, source=None, locale=None)

Gets the volume annotation.

Args:
  volumeId: string, The volume to retrieve annotations for. (required)
  layerId: string, The ID for the layer to get the annotations. (required)
  annotationId: string, The ID of the volume annotation to retrieve. (required)
  source: string, String to identify the originator of this request.
  locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

Returns:
  An object of the form:

    {
    "annotationType": "A String", # The type of annotation this is.
    "kind": "books#volumeannotation", # Resource Type
    "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
    "deleted": True or False, # Indicates that this annotation is deleted.
    "contentRanges": { # The content ranges to identify the selected text.
      "contentVersion": "A String", # Content version applicable to ranges below.
      "gbTextRange": { # Range in GB text format for this annotation for version above.
        "startPosition": "A String", # The starting position for the range.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "endOffset": "A String", # The offset from the ending position.
      },
      "cfiRange": { # Range in CFI format for this annotation for version above.
        "startPosition": "A String", # The starting position for the range.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "endOffset": "A String", # The offset from the ending position.
      },
      "gbImageRange": { # Range in GB image format for this annotation for version above.
        "startPosition": "A String", # The starting position for the range.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "endOffset": "A String", # The offset from the ending position.
      },
    },
    "selectedText": "A String", # Excerpt from the volume.
    "volumeId": "A String", # The Volume this annotation is for.
    "annotationDataId": "A String", # The annotation data id for this volume annotation.
    "annotationDataLink": "A String", # Link to get data for this annotation.
    "pageIds": [ # Pages the annotation spans.
      "A String",
    ],
    "layerId": "A String", # The Layer this annotation is for.
    "data": "A String", # Data for this annotation.
    "id": "A String", # Unique id of this volume annotation.
    "selfLink": "A String", # URL to this resource.
  }

list(volumeId=*, layerId=*, contentVersion=*, endPosition=None, locale=None, startOffset=None, volumeAnnotationsVersion=None, pageToken=None, updatedMin=None, endOffset=None, showDeleted=None, updatedMax=None, maxResults=None, startPosition=None, source=None)

Gets the volume annotations for a volume and layer.

Args:
  volumeId: string, The volume to retrieve annotations for. (required)
  layerId: string, The ID for the layer to get the annotations. (required)
  contentVersion: string, The content version for the requested volume. (required)
  endPosition: string, The end position to end retrieving data from.
  locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
  startOffset: string, The start offset to start retrieving data from.
  volumeAnnotationsVersion: string, The version of the volume annotations that you are requesting.
  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).
  endOffset: string, The end offset to end retrieving data from.
  showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
  updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
  maxResults: integer, Maximum number of results to return
  startPosition: string, The start position to start retrieving data from.
  source: string, String to identify the originator of this request.

Returns:
  An object of the form:

    {
    "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.
    "items": [ # A list of volume annotations.
      {
        "annotationType": "A String", # The type of annotation this is.
        "kind": "books#volumeannotation", # Resource Type
        "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format).
        "deleted": True or False, # Indicates that this annotation is deleted.
        "contentRanges": { # The content ranges to identify the selected text.
          "contentVersion": "A String", # Content version applicable to ranges below.
          "gbTextRange": { # Range in GB text format for this annotation for version above.
            "startPosition": "A String", # The starting position for the range.
            "endPosition": "A String", # The ending position for the range.
            "startOffset": "A String", # The offset from the starting position.
            "endOffset": "A String", # The offset from the ending position.
          },
          "cfiRange": { # Range in CFI format for this annotation for version above.
            "startPosition": "A String", # The starting position for the range.
            "endPosition": "A String", # The ending position for the range.
            "startOffset": "A String", # The offset from the starting position.
            "endOffset": "A String", # The offset from the ending position.
          },
          "gbImageRange": { # Range in GB image format for this annotation for version above.
            "startPosition": "A String", # The starting position for the range.
            "endPosition": "A String", # The ending position for the range.
            "startOffset": "A String", # The offset from the starting position.
            "endOffset": "A String", # The offset from the ending position.
          },
        },
        "selectedText": "A String", # Excerpt from the volume.
        "volumeId": "A String", # The Volume this annotation is for.
        "annotationDataId": "A String", # The annotation data id for this volume annotation.
        "annotationDataLink": "A String", # Link to get data for this annotation.
        "pageIds": [ # Pages the annotation spans.
          "A String",
        ],
        "layerId": "A String", # The Layer this annotation is for.
        "data": "A String", # Data for this annotation.
        "id": "A String", # Unique id of this volume annotation.
        "selfLink": "A String", # URL to this resource.
      },
    ],
    "kind": "books#volumeannotations", # Resource type
    "version": "A String", # The version string for all of the volume annotations in this layer (not just the ones in this response). Note: the version string doesn't apply to the annotation data, just the information in this response (e.g. the location of annotations in the book).
    "totalItems": 42, # The total number of volume annotations found.
  }

list_next(previous_request=*, previous_response=*)

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.