Books API . mylibrary . annotations

Instance Methods

close()

Close httplib2 connections.

delete(annotationId, source=None, x__xgafv=None)

Deletes an annotation.

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

Inserts a new annotation.

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

Retrieves a list of annotations, possibly filtered.

list_next(previous_request, previous_response)

Retrieves the next page of results.

summary(layerIds, volumeId, x__xgafv=None)

Gets the summary of specified layers.

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

Updates an existing annotation.

Method Details

close()
Close httplib2 connections.
delete(annotationId, source=None, x__xgafv=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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
  }
insert(body=None, source=None, annotationId=None, country=None, showOnlySummaryInResponse=None, x__xgafv=None)
Inserts a new annotation.

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

{
  "deleted": True or False, # Indicates that this annotation is deleted.
  "currentVersionRanges": { # Selection ranges for the most recent content version.
    "gbTextRange": { # Range in GB text format for this annotation for version above.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "gbImageRange": { # Range in GB image format for this annotation for version above.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "cfiRange": { # Range in CFI format for this annotation for version above.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "contentVersion": "A String", # Content version applicable to ranges below.
    "imageCfiRange": { # Range in image CFI format for this annotation for version above.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
  },
  "kind": "A String", # Resource type.
  "pageIds": [ # Pages that this annotation spans.
    "A String",
  ],
  "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.
  },
  "selectedText": "A String", # Excerpt from the volume.
  "clientVersionRanges": { # Selection ranges sent from the client.
    "cfiRange": { # Range in CFI format for this annotation sent by client.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "contentVersion": "A String", # Content version the client sent in.
    "gbTextRange": { # Range in GB text format for this annotation sent by client.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "gbImageRange": { # Range in GB image format for this annotation sent by client.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
  },
  "updated": "A String", # Timestamp for the last time this annotation was modified.
  "created": "A String", # Timestamp for the created time of this annotation.
  "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.
  "data": "A String", # User-created data for this annotation.
  "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.
  "id": "A String", # Id of this annotation, in the form of a GUID.
  "highlightStyle": "A String", # The highlight style for this annotation.
  "selfLink": "A String", # URL to this resource.
  "volumeId": "A String", # The volume that this annotation belongs to.
  "layerId": "A String", # The layer this annotation is for.
}

  source: string, String to identify the originator of this request.
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "deleted": True or False, # Indicates that this annotation is deleted.
    "currentVersionRanges": { # Selection ranges for the most recent content version.
      "gbTextRange": { # Range in GB text format for this annotation for version above.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "gbImageRange": { # Range in GB image format for this annotation for version above.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "cfiRange": { # Range in CFI format for this annotation for version above.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "contentVersion": "A String", # Content version applicable to ranges below.
      "imageCfiRange": { # Range in image CFI format for this annotation for version above.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
    },
    "kind": "A String", # Resource type.
    "pageIds": [ # Pages that this annotation spans.
      "A String",
    ],
    "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.
    },
    "selectedText": "A String", # Excerpt from the volume.
    "clientVersionRanges": { # Selection ranges sent from the client.
      "cfiRange": { # Range in CFI format for this annotation sent by client.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "contentVersion": "A String", # Content version the client sent in.
      "gbTextRange": { # Range in GB text format for this annotation sent by client.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "gbImageRange": { # Range in GB image format for this annotation sent by client.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
    },
    "updated": "A String", # Timestamp for the last time this annotation was modified.
    "created": "A String", # Timestamp for the created time of this annotation.
    "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.
    "data": "A String", # User-created data for this annotation.
    "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.
    "id": "A String", # Id of this annotation, in the form of a GUID.
    "highlightStyle": "A String", # The highlight style for this annotation.
    "selfLink": "A String", # URL to this resource.
    "volumeId": "A String", # The volume that this annotation belongs to.
    "layerId": "A String", # The layer this annotation is for.
  }
list(pageToken=None, volumeId=None, layerIds=None, maxResults=None, contentVersion=None, updatedMax=None, showDeleted=None, updatedMin=None, layerId=None, source=None, x__xgafv=None)
Retrieves a list of annotations, possibly filtered.

Args:
  pageToken: string, The value of the nextToken from the previous page.
  volumeId: string, The volume to restrict annotations to.
  layerIds: string, The layer ID(s) to limit annotation by. (repeated)
  maxResults: integer, Maximum number of results to return
  contentVersion: string, The content version for the requested volume.
  updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
  showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
  updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
  layerId: string, The layer ID to limit annotation by.
  source: string, String to identify the originator of this request.
  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 annotations.
      {
        "deleted": True or False, # Indicates that this annotation is deleted.
        "currentVersionRanges": { # Selection ranges for the most recent content version.
          "gbTextRange": { # Range in GB text format for this annotation for version above.
            "startOffset": "A String", # The offset from the starting position.
            "endPosition": "A String", # The ending position for the range.
            "endOffset": "A String", # The offset from the ending position.
            "startPosition": "A String", # The starting position for the range.
          },
          "gbImageRange": { # Range in GB image format for this annotation for version above.
            "startOffset": "A String", # The offset from the starting position.
            "endPosition": "A String", # The ending position for the range.
            "endOffset": "A String", # The offset from the ending position.
            "startPosition": "A String", # The starting position for the range.
          },
          "cfiRange": { # Range in CFI format for this annotation for version above.
            "startOffset": "A String", # The offset from the starting position.
            "endPosition": "A String", # The ending position for the range.
            "endOffset": "A String", # The offset from the ending position.
            "startPosition": "A String", # The starting position for the range.
          },
          "contentVersion": "A String", # Content version applicable to ranges below.
          "imageCfiRange": { # Range in image CFI format for this annotation for version above.
            "startOffset": "A String", # The offset from the starting position.
            "endPosition": "A String", # The ending position for the range.
            "endOffset": "A String", # The offset from the ending position.
            "startPosition": "A String", # The starting position for the range.
          },
        },
        "kind": "A String", # Resource type.
        "pageIds": [ # Pages that this annotation spans.
          "A String",
        ],
        "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.
        },
        "selectedText": "A String", # Excerpt from the volume.
        "clientVersionRanges": { # Selection ranges sent from the client.
          "cfiRange": { # Range in CFI format for this annotation sent by client.
            "startOffset": "A String", # The offset from the starting position.
            "endPosition": "A String", # The ending position for the range.
            "endOffset": "A String", # The offset from the ending position.
            "startPosition": "A String", # The starting position for the range.
          },
          "contentVersion": "A String", # Content version the client sent in.
          "gbTextRange": { # Range in GB text format for this annotation sent by client.
            "startOffset": "A String", # The offset from the starting position.
            "endPosition": "A String", # The ending position for the range.
            "endOffset": "A String", # The offset from the ending position.
            "startPosition": "A String", # The starting position for the range.
          },
          "gbImageRange": { # Range in GB image format for this annotation sent by client.
            "startOffset": "A String", # The offset from the starting position.
            "endPosition": "A String", # The ending position for the range.
            "endOffset": "A String", # The offset from the ending position.
            "startPosition": "A String", # The starting position for the range.
          },
          "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
            "startOffset": "A String", # The offset from the starting position.
            "endPosition": "A String", # The ending position for the range.
            "endOffset": "A String", # The offset from the ending position.
            "startPosition": "A String", # The starting position for the range.
          },
        },
        "updated": "A String", # Timestamp for the last time this annotation was modified.
        "created": "A String", # Timestamp for the created time of this annotation.
        "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.
        "data": "A String", # User-created data for this annotation.
        "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.
        "id": "A String", # Id of this annotation, in the form of a GUID.
        "highlightStyle": "A String", # The highlight style for this annotation.
        "selfLink": "A String", # URL to this resource.
        "volumeId": "A String", # The volume that this annotation belongs to.
        "layerId": "A String", # The layer this annotation is for.
      },
    ],
    "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.
    "kind": "A String", # Resource type.
  }
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, x__xgafv=None)
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)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "layers": [
      {
        "layerId": "A String",
        "allowedCharacterCount": 42,
        "limitType": "A String",
        "remainingCharacterCount": 42,
        "updated": "A String",
      },
    ],
    "kind": "A String",
  }
update(annotationId, body=None, source=None, x__xgafv=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:

{
  "deleted": True or False, # Indicates that this annotation is deleted.
  "currentVersionRanges": { # Selection ranges for the most recent content version.
    "gbTextRange": { # Range in GB text format for this annotation for version above.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "gbImageRange": { # Range in GB image format for this annotation for version above.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "cfiRange": { # Range in CFI format for this annotation for version above.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "contentVersion": "A String", # Content version applicable to ranges below.
    "imageCfiRange": { # Range in image CFI format for this annotation for version above.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
  },
  "kind": "A String", # Resource type.
  "pageIds": [ # Pages that this annotation spans.
    "A String",
  ],
  "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.
  },
  "selectedText": "A String", # Excerpt from the volume.
  "clientVersionRanges": { # Selection ranges sent from the client.
    "cfiRange": { # Range in CFI format for this annotation sent by client.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "contentVersion": "A String", # Content version the client sent in.
    "gbTextRange": { # Range in GB text format for this annotation sent by client.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "gbImageRange": { # Range in GB image format for this annotation sent by client.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
    "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
      "startOffset": "A String", # The offset from the starting position.
      "endPosition": "A String", # The ending position for the range.
      "endOffset": "A String", # The offset from the ending position.
      "startPosition": "A String", # The starting position for the range.
    },
  },
  "updated": "A String", # Timestamp for the last time this annotation was modified.
  "created": "A String", # Timestamp for the created time of this annotation.
  "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.
  "data": "A String", # User-created data for this annotation.
  "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.
  "id": "A String", # Id of this annotation, in the form of a GUID.
  "highlightStyle": "A String", # The highlight style for this annotation.
  "selfLink": "A String", # URL to this resource.
  "volumeId": "A String", # The volume that this annotation belongs to.
  "layerId": "A String", # The layer this annotation is for.
}

  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "deleted": True or False, # Indicates that this annotation is deleted.
    "currentVersionRanges": { # Selection ranges for the most recent content version.
      "gbTextRange": { # Range in GB text format for this annotation for version above.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "gbImageRange": { # Range in GB image format for this annotation for version above.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "cfiRange": { # Range in CFI format for this annotation for version above.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "contentVersion": "A String", # Content version applicable to ranges below.
      "imageCfiRange": { # Range in image CFI format for this annotation for version above.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
    },
    "kind": "A String", # Resource type.
    "pageIds": [ # Pages that this annotation spans.
      "A String",
    ],
    "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.
    },
    "selectedText": "A String", # Excerpt from the volume.
    "clientVersionRanges": { # Selection ranges sent from the client.
      "cfiRange": { # Range in CFI format for this annotation sent by client.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "contentVersion": "A String", # Content version the client sent in.
      "gbTextRange": { # Range in GB text format for this annotation sent by client.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "gbImageRange": { # Range in GB image format for this annotation sent by client.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
      "imageCfiRange": { # Range in image CFI format for this annotation sent by client.
        "startOffset": "A String", # The offset from the starting position.
        "endPosition": "A String", # The ending position for the range.
        "endOffset": "A String", # The offset from the ending position.
        "startPosition": "A String", # The starting position for the range.
      },
    },
    "updated": "A String", # Timestamp for the last time this annotation was modified.
    "created": "A String", # Timestamp for the created time of this annotation.
    "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.
    "data": "A String", # User-created data for this annotation.
    "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.
    "id": "A String", # Id of this annotation, in the form of a GUID.
    "highlightStyle": "A String", # The highlight style for this annotation.
    "selfLink": "A String", # URL to this resource.
    "volumeId": "A String", # The volume that this annotation belongs to.
    "layerId": "A String", # The layer this annotation is for.
  }