Close httplib2 connections.
get(volumeId, layerId, annotationId, locale=None, source=None, x__xgafv=None)
Gets the volume annotation.
Gets the volume annotations for a volume and layer.
list_next(previous_request, previous_response)
Retrieves the next page of results.
close()
Close httplib2 connections.
get(volumeId, layerId, annotationId, locale=None, source=None, x__xgafv=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) locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. 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: { "annotationDataLink": "A String", # Link to get data for this annotation. "data": "A String", # Data for this annotation. "selectedText": "A String", # Excerpt from the volume. "layerId": "A String", # The Layer this annotation is for. "deleted": True or False, # Indicates that this annotation is deleted. "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). "annotationType": "A String", # The type of annotation this is. "volumeId": "A String", # The Volume this annotation is for. "annotationDataId": "A String", # The annotation data id for this volume annotation. "pageIds": [ # Pages the annotation spans. "A String", ], "id": "A String", # Unique id of this volume annotation. "kind": "A String", # Resource Type "selfLink": "A String", # URL to this resource. "contentRanges": { # The content ranges to identify the selected text. "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. }, "contentVersion": "A String", # Content version applicable to ranges below. "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. }, "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. }, }, }
list(volumeId, layerId, contentVersion, updatedMax=None, startOffset=None, source=None, locale=None, startPosition=None, maxResults=None, updatedMin=None, pageToken=None, endPosition=None, endOffset=None, showDeleted=None, volumeAnnotationsVersion=None, x__xgafv=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) updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive). startOffset: string, The start offset to start retrieving data from. 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'. startPosition: string, The start position to start retrieving data from. maxResults: integer, Maximum number of results to return updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive). pageToken: string, The value of the nextToken from the previous page. endPosition: string, The end position to end retrieving data from. 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. volumeAnnotationsVersion: string, The version of the volume annotations that you are requesting. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { "kind": "A String", # 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). "items": [ # A list of volume annotations. { "annotationDataLink": "A String", # Link to get data for this annotation. "data": "A String", # Data for this annotation. "selectedText": "A String", # Excerpt from the volume. "layerId": "A String", # The Layer this annotation is for. "deleted": True or False, # Indicates that this annotation is deleted. "updated": "A String", # Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-time format). "annotationType": "A String", # The type of annotation this is. "volumeId": "A String", # The Volume this annotation is for. "annotationDataId": "A String", # The annotation data id for this volume annotation. "pageIds": [ # Pages the annotation spans. "A String", ], "id": "A String", # Unique id of this volume annotation. "kind": "A String", # Resource Type "selfLink": "A String", # URL to this resource. "contentRanges": { # The content ranges to identify the selected text. "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. }, "contentVersion": "A String", # Content version applicable to ranges below. "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. }, "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. }, }, }, ], "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, # 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.