| |
Methods defined here:
- __init__(self)
- get = method(self, **kwargs)
- Gets the annotation data.
Args:
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'.
layerId: string, The ID for the layer to get the annotations. (required)
volumeId: string, The volume to retrieve annotations for. (required)
annotationDataId: string, The ID of the annotation data to retrieve. (required)
country: string, ISO-3166-1 code to override the IP-based location.
Returns:
An object of the form
{
"annotationType": "A String", # The type of annotation this data is for.
"kind": "books#annotationdata", # Resource Type
"updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
"volumeId": "A String", # The volume id for this data. *
"encoded_data": "A String", # Base64 encoded data for this annotation data.
"layerId": "A String", # The Layer id for this data. *
"data": "A String", # JSON enoded data for this annotation data.
"id": "A String", # Unique id for this annotation data.
"selfLink": "A String", # URL for this resource. *
}
- list = method(self, **kwargs)
- Gets the annotation data for a volume and layer.
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).
locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.
layerId: string, The ID for the layer to get the annotation data. (required)
volumeId: string, The volume to retrieve annotation data for. (required)
maxResults: integer, Maximum number of results to return
source: string, String to identify the originator of this request.
contentVersion: string, The content version for the requested volume. (required)
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
{
"totalItems": 42, # The total number of volume annotations found.
"items": [ # A list of Annotation Data.
{
"annotationType": "A String", # The type of annotation this data is for.
"kind": "books#annotationdata", # Resource Type
"updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).
"volumeId": "A String", # The volume id for this data. *
"encoded_data": "A String", # Base64 encoded data for this annotation data.
"layerId": "A String", # The Layer id for this data. *
"data": "A String", # JSON enoded data for this annotation data.
"id": "A String", # Unique id for this annotation data.
"selfLink": "A String", # URL for this resource. *
},
],
"kind": "books#annotationsdata", # Resource type
}
Data descriptors defined here:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|