class Resource(__builtin__.object)
    A class for interacting with a resource.
 
  Methods defined here:
__init__(self)
delete = method(self, **kwargs)
Deletes an annotation.
 
Args:
  source: string, String to identify the originator of this request.
  country: string, ISO-3166-1 code to override the IP-based location.
  annotationId: string, The annotation identifier for the annotation to delete. (required)
get = method(self, **kwargs)
Gets an annotation by its id.
 
Args:
  source: string, String to identify the originator of this request.
  country: string, ISO-3166-1 code to override the IP-based location.
  annotationId: string, The annotation identifier for the annotation to retrieve. (required)
 
Returns:
  An object of the form
 
    {
      "kind": "books#annotation", # Resource type.
      "updated": "A String", # Timestamp for the last time this annotation was modified.
      "created": "A String", # Timestamp for the created time of this annotation.
      "deleted": True or False, # Indicates that this annotation is deleted.
      "beforeSelectedText": "A String", # Anchor text before excerpt.
      "currentVersionRanges": { # Selection ranges for the most recent content version.
        "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.
        },
      },
      "afterSelectedText": "A String", # Anchor text after excerpt.
      "clientVersionRanges": { # Selection ranges sent from the client.
        "contentVersion": "A String", # Content version the client sent in.
        "gbTextRange": { # Range in GB text format for this annotation sent by client.
          "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 sent by client.
          "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 sent by client.
          "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.
        },
      },
      "volumeId": "A String", # The volume that this annotation belongs to.
      "pageIds": [ # Pages that this annotation spans.
        "A String",
      ],
      "layerId": "A String", # The layer this annotation is for.
      "selectedText": "A String", # Excerpt from the volume.
      "highlightStyle": "A String", # The highlight style for this annotation.
      "data": "A String", # User-created data for this annotation.
      "id": "A String", # Id of this annotation, in the form of a GUID.
      "selfLink": "A String", # URL to this resource.
    }
insert = method(self, **kwargs)
Inserts a new annotation.
 
Args:
  body: object, The request body. (required)
    The object takes the form of:
 
{
    "kind": "books#annotation", # Resource type.
    "updated": "A String", # Timestamp for the last time this annotation was modified.
    "created": "A String", # Timestamp for the created time of this annotation.
    "deleted": True or False, # Indicates that this annotation is deleted.
    "beforeSelectedText": "A String", # Anchor text before excerpt.
    "currentVersionRanges": { # Selection ranges for the most recent content version.
      "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.
      },
    },
    "afterSelectedText": "A String", # Anchor text after excerpt.
    "clientVersionRanges": { # Selection ranges sent from the client.
      "contentVersion": "A String", # Content version the client sent in.
      "gbTextRange": { # Range in GB text format for this annotation sent by client.
        "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 sent by client.
        "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 sent by client.
        "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.
      },
    },
    "volumeId": "A String", # The volume that this annotation belongs to.
    "pageIds": [ # Pages that this annotation spans.
      "A String",
    ],
    "layerId": "A String", # The layer this annotation is for.
    "selectedText": "A String", # Excerpt from the volume.
    "highlightStyle": "A String", # The highlight style for this annotation.
    "data": "A String", # User-created data for this annotation.
    "id": "A String", # Id of this annotation, in the form of a GUID.
    "selfLink": "A String", # URL to this resource.
  }
 
  source: string, String to identify the originator of this request.
  country: string, ISO-3166-1 code to override the IP-based location.
 
Returns:
  An object of the form
 
    {
      "kind": "books#annotation", # Resource type.
      "updated": "A String", # Timestamp for the last time this annotation was modified.
      "created": "A String", # Timestamp for the created time of this annotation.
      "deleted": True or False, # Indicates that this annotation is deleted.
      "beforeSelectedText": "A String", # Anchor text before excerpt.
      "currentVersionRanges": { # Selection ranges for the most recent content version.
        "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.
        },
      },
      "afterSelectedText": "A String", # Anchor text after excerpt.
      "clientVersionRanges": { # Selection ranges sent from the client.
        "contentVersion": "A String", # Content version the client sent in.
        "gbTextRange": { # Range in GB text format for this annotation sent by client.
          "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 sent by client.
          "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 sent by client.
          "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.
        },
      },
      "volumeId": "A String", # The volume that this annotation belongs to.
      "pageIds": [ # Pages that this annotation spans.
        "A String",
      ],
      "layerId": "A String", # The layer this annotation is for.
      "selectedText": "A String", # Excerpt from the volume.
      "highlightStyle": "A String", # The highlight style for this annotation.
      "data": "A String", # User-created data for this annotation.
      "id": "A String", # Id of this annotation, in the form of a GUID.
      "selfLink": "A String", # URL to this resource.
    }
list = method(self, **kwargs)
Retrieves a list of annotations, possibly filtered.
 
Args:
  pageToken: string, The value of the nextToken from the previous page.
  updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
  layerId: string, The layer id to limit annotation by.
  volumeId: string, The volume to restrict annotations to.
  maxResults: integer, Maximum number of results to return
  showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
  pageIds: string, The page id(s) for the volume that is being queried. (repeated)
  contentVersion: string, The content version for the requested volume.
  source: string, String to identify the originator of this request.
  country: string, ISO-3166-1 code to override the IP-based location.
  updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
 
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 annotations.
      {
          "kind": "books#annotation", # Resource type.
          "updated": "A String", # Timestamp for the last time this annotation was modified.
          "created": "A String", # Timestamp for the created time of this annotation.
          "deleted": True or False, # Indicates that this annotation is deleted.
          "beforeSelectedText": "A String", # Anchor text before excerpt.
          "currentVersionRanges": { # Selection ranges for the most recent content version.
            "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.
            },
          },
          "afterSelectedText": "A String", # Anchor text after excerpt.
          "clientVersionRanges": { # Selection ranges sent from the client.
            "contentVersion": "A String", # Content version the client sent in.
            "gbTextRange": { # Range in GB text format for this annotation sent by client.
              "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 sent by client.
              "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 sent by client.
              "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.
            },
          },
          "volumeId": "A String", # The volume that this annotation belongs to.
          "pageIds": [ # Pages that this annotation spans.
            "A String",
          ],
          "layerId": "A String", # The layer this annotation is for.
          "selectedText": "A String", # Excerpt from the volume.
          "highlightStyle": "A String", # The highlight style for this annotation.
          "data": "A String", # User-created data for this annotation.
          "id": "A String", # Id of this annotation, in the form of a GUID.
          "selfLink": "A String", # URL to this resource.
        },
    ],
    "kind": "books#annotations", # Resource type.
    "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 = methodNext(self, previous_request, previous_response)
Retrieves the next page of results.
 
Args:
  previous_request: The request for the previous page.
  previous_response: The response from the request for the previous page.
 
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.
update = method(self, **kwargs)
Updates an existing annotation.
 
Args:
  body: object, The request body. (required)
    The object takes the form of:
 
{
    "kind": "books#annotation", # Resource type.
    "updated": "A String", # Timestamp for the last time this annotation was modified.
    "created": "A String", # Timestamp for the created time of this annotation.
    "deleted": True or False, # Indicates that this annotation is deleted.
    "beforeSelectedText": "A String", # Anchor text before excerpt.
    "currentVersionRanges": { # Selection ranges for the most recent content version.
      "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.
      },
    },
    "afterSelectedText": "A String", # Anchor text after excerpt.
    "clientVersionRanges": { # Selection ranges sent from the client.
      "contentVersion": "A String", # Content version the client sent in.
      "gbTextRange": { # Range in GB text format for this annotation sent by client.
        "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 sent by client.
        "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 sent by client.
        "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.
      },
    },
    "volumeId": "A String", # The volume that this annotation belongs to.
    "pageIds": [ # Pages that this annotation spans.
      "A String",
    ],
    "layerId": "A String", # The layer this annotation is for.
    "selectedText": "A String", # Excerpt from the volume.
    "highlightStyle": "A String", # The highlight style for this annotation.
    "data": "A String", # User-created data for this annotation.
    "id": "A String", # Id of this annotation, in the form of a GUID.
    "selfLink": "A String", # URL to this resource.
  }
 
  source: string, String to identify the originator of this request.
  country: string, ISO-3166-1 code to override the IP-based location.
  annotationId: string, The annotation identifier for the annotation to update. (required)
 
Returns:
  An object of the form
 
    {
      "kind": "books#annotation", # Resource type.
      "updated": "A String", # Timestamp for the last time this annotation was modified.
      "created": "A String", # Timestamp for the created time of this annotation.
      "deleted": True or False, # Indicates that this annotation is deleted.
      "beforeSelectedText": "A String", # Anchor text before excerpt.
      "currentVersionRanges": { # Selection ranges for the most recent content version.
        "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.
        },
      },
      "afterSelectedText": "A String", # Anchor text after excerpt.
      "clientVersionRanges": { # Selection ranges sent from the client.
        "contentVersion": "A String", # Content version the client sent in.
        "gbTextRange": { # Range in GB text format for this annotation sent by client.
          "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 sent by client.
          "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 sent by client.
          "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.
        },
      },
      "volumeId": "A String", # The volume that this annotation belongs to.
      "pageIds": [ # Pages that this annotation spans.
        "A String",
      ],
      "layerId": "A String", # The layer this annotation is for.
      "selectedText": "A String", # Excerpt from the volume.
      "highlightStyle": "A String", # The highlight style for this annotation.
      "data": "A String", # User-created data for this annotation.
      "id": "A String", # Id of this annotation, in the form of a GUID.
      "selfLink": "A String", # URL to this resource.
    }

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)