| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: class Resource</title> |
| </head><body bgcolor="#f0f0f8"> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the volume annotation.<br> |
| <br> |
| Args:<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| source: string, String to identify the originator of this request.<br> |
| locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.<br> |
| annotationId: string, The ID of the volume annotation to retrieve. (required)<br> |
| volumeId: string, The volume to retrieve annotations for. (required)<br> |
| strict: string, A parameter<br> |
| layerId: string, The ID for the layer to get the annotations. (required)<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "annotationType": "A String", # The type of annotation this is.<br> |
| "kind": "books#volumeannotation", # Resource Type<br> |
| "updated": "A String", # Timestamp for the last time this anntoation was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br> |
| "deleted": True or False, # Indicates that this annotation is deleted.<br> |
| "contentRanges": { # The content ranges to identify the selected text.<br> |
| "contentVersion": "A String", # Content version applicable to ranges below.<br> |
| "gbTextRange": { # Range in GB text format for this annotation for version above.<br> |
| "startPosition": "A String", # The starting position for the range.<br> |
| "endPosition": "A String", # The ending position for the range.<br> |
| "startOffset": "A String", # The offset from the starting position.<br> |
| "endOffset": "A String", # The offset from the ending position.<br> |
| },<br> |
| "cfiRange": { # Range in CFI format for this annotation for version above.<br> |
| "startPosition": "A String", # The starting position for the range.<br> |
| "endPosition": "A String", # The ending position for the range.<br> |
| "startOffset": "A String", # The offset from the starting position.<br> |
| "endOffset": "A String", # The offset from the ending position.<br> |
| },<br> |
| "gbImageRange": { # Range in GB image format for this annotation for version above.<br> |
| "startPosition": "A String", # The starting position for the range.<br> |
| "endPosition": "A String", # The ending position for the range.<br> |
| "startOffset": "A String", # The offset from the starting position.<br> |
| "endOffset": "A String", # The offset from the ending position.<br> |
| },<br> |
| },<br> |
| "selectedText": "A String", # Excerpt from the volume.<br> |
| "volumeId": "A String", # The Volume this annotation is for.<br> |
| "annotationDataId": "A String", # The annotation data id for this volume annotation.<br> |
| "annotationDataLink": "A String", # Link to get data for this annotation.<br> |
| "pageIds": [ # Pages the annotation spans.<br> |
| "A String",<br> |
| ],<br> |
| "layerId": "A String", # The Layer this annotation is for.<br> |
| "data": "A String", # Data for this annotation.<br> |
| "id": "A String", # Unique id of this volume annotation.<br> |
| "selfLink": "A String", # URL to this resource.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the volume annotations for a volume and layer.<br> |
| <br> |
| Args:<br> |
| endPosition: string, The end position to end retrieving data from.<br> |
| locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.<br> |
| startOffset: string, The start offset to start retrieving data from.<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| pageToken: string, The value of the nextToken from the previous page.<br> |
| updatedMin: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated since this timestamp (inclusive).<br> |
| endOffset: string, The end offset to end retrieving data from.<br> |
| showDeleted: boolean, Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.<br> |
| contentVersion: string, The content version for the requested volume. (required)<br> |
| layerId: string, The ID for the layer to get the annotations. (required)<br> |
| strict: string, A parameter<br> |
| updatedMax: string, <a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> timestamp to restrict to items updated prior to this timestamp (exclusive).<br> |
| volumeId: string, The volume to retrieve annotations for. (required)<br> |
| maxResults: integer, Maximum number of results to return<br> |
| startPosition: string, The start position to start retrieving data from.<br> |
| source: string, String to identify the originator of this request.<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "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.<br> |
| "items": [ # A list of volume annotations.<br> |
| {<br> |
| "annotationType": "A String", # The type of annotation this is.<br> |
| "kind": "books#volumeannotation", # Resource Type<br> |
| "updated": "A String", # Timestamp for the last time this anntoation was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br> |
| "deleted": True or False, # Indicates that this annotation is deleted.<br> |
| "contentRanges": { # The content ranges to identify the selected text.<br> |
| "contentVersion": "A String", # Content version applicable to ranges below.<br> |
| "gbTextRange": { # Range in GB text format for this annotation for version above.<br> |
| "startPosition": "A String", # The starting position for the range.<br> |
| "endPosition": "A String", # The ending position for the range.<br> |
| "startOffset": "A String", # The offset from the starting position.<br> |
| "endOffset": "A String", # The offset from the ending position.<br> |
| },<br> |
| "cfiRange": { # Range in CFI format for this annotation for version above.<br> |
| "startPosition": "A String", # The starting position for the range.<br> |
| "endPosition": "A String", # The ending position for the range.<br> |
| "startOffset": "A String", # The offset from the starting position.<br> |
| "endOffset": "A String", # The offset from the ending position.<br> |
| },<br> |
| "gbImageRange": { # Range in GB image format for this annotation for version above.<br> |
| "startPosition": "A String", # The starting position for the range.<br> |
| "endPosition": "A String", # The ending position for the range.<br> |
| "startOffset": "A String", # The offset from the starting position.<br> |
| "endOffset": "A String", # The offset from the ending position.<br> |
| },<br> |
| },<br> |
| "selectedText": "A String", # Excerpt from the volume.<br> |
| "volumeId": "A String", # The Volume this annotation is for.<br> |
| "annotationDataId": "A String", # The annotation data id for this volume annotation.<br> |
| "annotationDataLink": "A String", # Link to get data for this annotation.<br> |
| "pageIds": [ # Pages the annotation spans.<br> |
| "A String",<br> |
| ],<br> |
| "layerId": "A String", # The Layer this annotation is for.<br> |
| "data": "A String", # Data for this annotation.<br> |
| "id": "A String", # Unique id of this volume annotation.<br> |
| "selfLink": "A String", # URL to this resource.<br> |
| },<br> |
| ],<br> |
| "kind": "books#volumeannotations", # Resource type<br> |
| "totalItems": 42, # The total number of volume annotations found.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous_request, previous_response)</dt><dd><tt>Retrieves the next page of results.<br> |
| <br> |
| Args:<br> |
| previous_request: The request for the previous page.<br> |
| previous_response: The response from the request for the previous page.<br> |
| <br> |
| Returns:<br> |
| A request object that you can call 'execute()' on to request the next<br> |
| page. Returns None if there are no more items in the collection.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table> |
| </body></html> |