Books API . mylibrary . annotations

Instance Methods

delete(annotationId, source=None)

Deletes an annotation.

insert(body=None, annotationId=None, country=None, showOnlySummaryInResponse=None, source=None)

Inserts a new annotation.

list(contentVersion=None, layerId=None, layerIds=None, maxResults=None, pageToken=None, showDeleted=None, source=None, updatedMax=None, updatedMin=None, volumeId=None)

Retrieves a list of annotations, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

summary(layerIds, volumeId)

Gets the summary of specified layers.

update(annotationId, body=None, source=None)

Updates an existing annotation.

Method Details

delete(annotationId, source=None)
Deletes an annotation.

Args:
  annotationId: string, The ID for the annotation to delete. (required)
  source: string, String to identify the originator of this request.
insert(body=None, annotationId=None, country=None, showOnlySummaryInResponse=None, source=None)
Inserts a new annotation.

Args:
  body: object, The request body.
    The object takes the form of:

{
    "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
    "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
    "clientVersionRanges": { # Selection ranges sent from the client.
      "cfiRange": { # Range in CFI format for this annotation sent by client.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "contentVersion": "A String", # Content version the client sent in.
      "gbImageRange": { # Range in GB image format for this annotation sent by client.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "gbTextRange": { # Range in GB text format for this annotation sent by client.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
    },
    "created": "A String", # Timestamp for the created time of this annotation.
    "currentVersionRanges": { # Selection ranges for the most recent content version.
      "cfiRange": { # Range in CFI format for this annotation for version above.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "contentVersion": "A String", # Content version applicable to ranges below.
      "gbImageRange": { # Range in GB image format for this annotation for version above.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "gbTextRange": { # Range in GB text format for this annotation for version above.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "imageCfiRange": { # Range in image CFI format for this annotation for version above.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
    },
    "data": "A String", # User-created data for this annotation.
    "deleted": True or False, # Indicates that this annotation is deleted.
    "highlightStyle": "A String", # The highlight style for this annotation.
    "id": "A String", # Id of this annotation, in the form of a GUID.
    "kind": "books#annotation", # Resource type.
    "layerId": "A String", # The layer this annotation is for.
    "layerSummary": {
      "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
      "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
      "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
    },
    "pageIds": [ # Pages that this annotation spans.
      "A String",
    ],
    "selectedText": "A String", # Excerpt from the volume.
    "selfLink": "A String", # URL to this resource.
    "updated": "A String", # Timestamp for the last time this annotation was modified.
    "volumeId": "A String", # The volume that this annotation belongs to.
  }

  annotationId: string, The ID for the annotation to insert.
  country: string, ISO-3166-1 code to override the IP-based location.
  showOnlySummaryInResponse: boolean, Requests that only the summary of the specified layer be provided in the response.
  source: string, String to identify the originator of this request.

Returns:
  An object of the form:

    {
      "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
      "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
      "clientVersionRanges": { # Selection ranges sent from the client.
        "cfiRange": { # Range in CFI format for this annotation sent by client.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "contentVersion": "A String", # Content version the client sent in.
        "gbImageRange": { # Range in GB image format for this annotation sent by client.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "gbTextRange": { # Range in GB text format for this annotation sent by client.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
      },
      "created": "A String", # Timestamp for the created time of this annotation.
      "currentVersionRanges": { # Selection ranges for the most recent content version.
        "cfiRange": { # Range in CFI format for this annotation for version above.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "contentVersion": "A String", # Content version applicable to ranges below.
        "gbImageRange": { # Range in GB image format for this annotation for version above.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "gbTextRange": { # Range in GB text format for this annotation for version above.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "imageCfiRange": { # Range in image CFI format for this annotation for version above.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
      },
      "data": "A String", # User-created data for this annotation.
      "deleted": True or False, # Indicates that this annotation is deleted.
      "highlightStyle": "A String", # The highlight style for this annotation.
      "id": "A String", # Id of this annotation, in the form of a GUID.
      "kind": "books#annotation", # Resource type.
      "layerId": "A String", # The layer this annotation is for.
      "layerSummary": {
        "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
        "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
        "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
      },
      "pageIds": [ # Pages that this annotation spans.
        "A String",
      ],
      "selectedText": "A String", # Excerpt from the volume.
      "selfLink": "A String", # URL to this resource.
      "updated": "A String", # Timestamp for the last time this annotation was modified.
      "volumeId": "A String", # The volume that this annotation belongs to.
    }
list(contentVersion=None, layerId=None, layerIds=None, maxResults=None, pageToken=None, showDeleted=None, source=None, updatedMax=None, updatedMin=None, volumeId=None)
Retrieves a list of annotations, possibly filtered.

Args:
  contentVersion: string, The content version for the requested volume.
  layerId: string, The layer ID to limit annotation by.
  layerIds: string, The layer ID(s) to limit annotation by. (repeated)
  maxResults: integer, Maximum number of results to return
  pageToken: string, The value of the nextToken from the previous page.
  showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
  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).
  volumeId: string, The volume to restrict annotations to.

Returns:
  An object of the form:

    {
    "items": [ # A list of annotations.
      {
          "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
          "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
          "clientVersionRanges": { # Selection ranges sent from the client.
            "cfiRange": { # Range in CFI format for this annotation sent by client.
              "endOffset": "A String", # The offset from the ending position.
              "endPosition": "A String", # The ending position for the range.
              "startOffset": "A String", # The offset from the starting position.
              "startPosition": "A String", # The starting position for the range.
            },
            "contentVersion": "A String", # Content version the client sent in.
            "gbImageRange": { # Range in GB image format for this annotation sent by client.
              "endOffset": "A String", # The offset from the ending position.
              "endPosition": "A String", # The ending position for the range.
              "startOffset": "A String", # The offset from the starting position.
              "startPosition": "A String", # The starting position for the range.
            },
            "gbTextRange": { # Range in GB text format for this annotation sent by client.
              "endOffset": "A String", # The offset from the ending position.
              "endPosition": "A String", # The ending position for the range.
              "startOffset": "A String", # The offset from the starting position.
              "startPosition": "A String", # The starting position for the range.
            },
            "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
              "endOffset": "A String", # The offset from the ending position.
              "endPosition": "A String", # The ending position for the range.
              "startOffset": "A String", # The offset from the starting position.
              "startPosition": "A String", # The starting position for the range.
            },
          },
          "created": "A String", # Timestamp for the created time of this annotation.
          "currentVersionRanges": { # Selection ranges for the most recent content version.
            "cfiRange": { # Range in CFI format for this annotation for version above.
              "endOffset": "A String", # The offset from the ending position.
              "endPosition": "A String", # The ending position for the range.
              "startOffset": "A String", # The offset from the starting position.
              "startPosition": "A String", # The starting position for the range.
            },
            "contentVersion": "A String", # Content version applicable to ranges below.
            "gbImageRange": { # Range in GB image format for this annotation for version above.
              "endOffset": "A String", # The offset from the ending position.
              "endPosition": "A String", # The ending position for the range.
              "startOffset": "A String", # The offset from the starting position.
              "startPosition": "A String", # The starting position for the range.
            },
            "gbTextRange": { # Range in GB text format for this annotation for version above.
              "endOffset": "A String", # The offset from the ending position.
              "endPosition": "A String", # The ending position for the range.
              "startOffset": "A String", # The offset from the starting position.
              "startPosition": "A String", # The starting position for the range.
            },
            "imageCfiRange": { # Range in image CFI format for this annotation for version above.
              "endOffset": "A String", # The offset from the ending position.
              "endPosition": "A String", # The ending position for the range.
              "startOffset": "A String", # The offset from the starting position.
              "startPosition": "A String", # The starting position for the range.
            },
          },
          "data": "A String", # User-created data for this annotation.
          "deleted": True or False, # Indicates that this annotation is deleted.
          "highlightStyle": "A String", # The highlight style for this annotation.
          "id": "A String", # Id of this annotation, in the form of a GUID.
          "kind": "books#annotation", # Resource type.
          "layerId": "A String", # The layer this annotation is for.
          "layerSummary": {
            "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
            "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
            "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
          },
          "pageIds": [ # Pages that this annotation spans.
            "A String",
          ],
          "selectedText": "A String", # Excerpt from the volume.
          "selfLink": "A String", # URL to this resource.
          "updated": "A String", # Timestamp for the last time this annotation was modified.
          "volumeId": "A String", # The volume that this annotation belongs to.
        },
    ],
    "kind": "books#annotations", # 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, # Total number of annotations found. This may be greater than the number of notes returned in this response if results have been paginated.
  }
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.
    
summary(layerIds, volumeId)
Gets the summary of specified layers.

Args:
  layerIds: string, Array of layer IDs to get the summary for. (required) (repeated)
  volumeId: string, Volume id to get the summary for. (required)

Returns:
  An object of the form:

    {
    "kind": "books#annotationsSummary",
    "layers": [
      {
        "allowedCharacterCount": 42,
        "layerId": "A String",
        "limitType": "A String",
        "remainingCharacterCount": 42,
        "updated": "A String",
      },
    ],
  }
update(annotationId, body=None, source=None)
Updates an existing annotation.

Args:
  annotationId: string, The ID for the annotation to update. (required)
  body: object, The request body.
    The object takes the form of:

{
    "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
    "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
    "clientVersionRanges": { # Selection ranges sent from the client.
      "cfiRange": { # Range in CFI format for this annotation sent by client.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "contentVersion": "A String", # Content version the client sent in.
      "gbImageRange": { # Range in GB image format for this annotation sent by client.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "gbTextRange": { # Range in GB text format for this annotation sent by client.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
    },
    "created": "A String", # Timestamp for the created time of this annotation.
    "currentVersionRanges": { # Selection ranges for the most recent content version.
      "cfiRange": { # Range in CFI format for this annotation for version above.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "contentVersion": "A String", # Content version applicable to ranges below.
      "gbImageRange": { # Range in GB image format for this annotation for version above.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "gbTextRange": { # Range in GB text format for this annotation for version above.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
      "imageCfiRange": { # Range in image CFI format for this annotation for version above.
        "endOffset": "A String", # The offset from the ending position.
        "endPosition": "A String", # The ending position for the range.
        "startOffset": "A String", # The offset from the starting position.
        "startPosition": "A String", # The starting position for the range.
      },
    },
    "data": "A String", # User-created data for this annotation.
    "deleted": True or False, # Indicates that this annotation is deleted.
    "highlightStyle": "A String", # The highlight style for this annotation.
    "id": "A String", # Id of this annotation, in the form of a GUID.
    "kind": "books#annotation", # Resource type.
    "layerId": "A String", # The layer this annotation is for.
    "layerSummary": {
      "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
      "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
      "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
    },
    "pageIds": [ # Pages that this annotation spans.
      "A String",
    ],
    "selectedText": "A String", # Excerpt from the volume.
    "selfLink": "A String", # URL to this resource.
    "updated": "A String", # Timestamp for the last time this annotation was modified.
    "volumeId": "A String", # The volume that this annotation belongs to.
  }

  source: string, String to identify the originator of this request.

Returns:
  An object of the form:

    {
      "afterSelectedText": "A String", # Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
      "beforeSelectedText": "A String", # Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
      "clientVersionRanges": { # Selection ranges sent from the client.
        "cfiRange": { # Range in CFI format for this annotation sent by client.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "contentVersion": "A String", # Content version the client sent in.
        "gbImageRange": { # Range in GB image format for this annotation sent by client.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "gbTextRange": { # Range in GB text format for this annotation sent by client.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
      },
      "created": "A String", # Timestamp for the created time of this annotation.
      "currentVersionRanges": { # Selection ranges for the most recent content version.
        "cfiRange": { # Range in CFI format for this annotation for version above.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "contentVersion": "A String", # Content version applicable to ranges below.
        "gbImageRange": { # Range in GB image format for this annotation for version above.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "gbTextRange": { # Range in GB text format for this annotation for version above.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
        "imageCfiRange": { # Range in image CFI format for this annotation for version above.
          "endOffset": "A String", # The offset from the ending position.
          "endPosition": "A String", # The ending position for the range.
          "startOffset": "A String", # The offset from the starting position.
          "startPosition": "A String", # The starting position for the range.
        },
      },
      "data": "A String", # User-created data for this annotation.
      "deleted": True or False, # Indicates that this annotation is deleted.
      "highlightStyle": "A String", # The highlight style for this annotation.
      "id": "A String", # Id of this annotation, in the form of a GUID.
      "kind": "books#annotation", # Resource type.
      "layerId": "A String", # The layer this annotation is for.
      "layerSummary": {
        "allowedCharacterCount": 42, # Maximum allowed characters on this layer, especially for the "copy" layer.
        "limitType": "A String", # Type of limitation on this layer. "limited" or "unlimited" for the "copy" layer.
        "remainingCharacterCount": 42, # Remaining allowed characters on this layer, especially for the "copy" layer.
      },
      "pageIds": [ # Pages that this annotation spans.
        "A String",
      ],
      "selectedText": "A String", # Excerpt from the volume.
      "selfLink": "A String", # URL to this resource.
      "updated": "A String", # Timestamp for the last time this annotation was modified.
      "volumeId": "A String", # The volume that this annotation belongs to.
    }