| |
| <!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 annotation data.<br> |
| <br> |
| Args:<br> |
| annotationDataId: string, The ID of the annotation data to retrieve. (required)<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> |
| layerId: string, The ID for the layer to get the annotations. (required)<br> |
| volumeId: string, The volume to retrieve annotations for. (required)<br> |
| strict: string, A parameter<br> |
| contentVersion: string, The content version for the volume you are trying to retrieve. (required)<br> |
| h: integer, The requested pixel height for any images. If height is provided width must also be provided.<br> |
| userip: string, A parameter<br> |
| w: integer, The requested pixel width for any images. If width is provided height must also be provided.<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "annotationType": "A String", # The type of annotation this data is for.<br> |
| "kind": "books#annotationdata", # Resource Type<br> |
| "updated": "A String", # Timestamp for the last time this data was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br> |
| "volumeId": "A String", # The volume id for this data. *<br> |
| "encoded_data": "A String", # Base64 encoded data for this annotation data.<br> |
| "layerId": "A String", # The Layer id for this data. *<br> |
| "data": { # JSON encoded data for this annotation data.<br> |
| "geo": {<br> |
| "countryCode": "A String", # The country code of the location.<br> |
| "zoom": 42, # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels<br> |
| "longitude": 3.14, # The longitude of the location.<br> |
| "mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN<br> |
| "latitude": 3.14, # The latitude of the location.<br> |
| "boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.<br> |
| [<br> |
| {<br> |
| "latitude": 42,<br> |
| "longitude": 42,<br> |
| },<br> |
| ],<br> |
| ],<br> |
| "resolution": "A String", # The resolution of the location. Ex: POI_LEVEL<br> |
| "viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.<br> |
| "lo": {<br> |
| "latitude": 3.14,<br> |
| "longitude": 3.14,<br> |
| },<br> |
| "hi": {<br> |
| "latitude": 3.14,<br> |
| "longitude": 3.14,<br> |
| },<br> |
| },<br> |
| "cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER<br> |
| },<br> |
| "common": {<br> |
| "lang": "A String", # The language of the information url and description.<br> |
| "previewImageUrl": "A String", # The URL for the preview image information.<br> |
| "snippet": "A String", # The description for this location.<br> |
| "snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link.<br> |
| },<br> |
| },<br> |
| "id": "A String", # Unique id for this annotation data.<br> |
| "selfLink": "A String", # URL for this resource. *<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets the annotation data for a volume and layer.<br> |
| <br> |
| Args:<br> |
| locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.<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> |
| source: string, String to identify the originator of this request.<br> |
| contentVersion: string, The content version for the requested volume. (required)<br> |
| layerId: string, The ID for the layer to get the annotation data. (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 annotation data for. (required)<br> |
| maxResults: integer, Maximum number of results to return<br> |
| annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated)<br> |
| h: integer, The requested pixel height for any images. If height is provided width must also be provided.<br> |
| w: integer, The requested pixel width for any images. If width is provided height must also be provided.<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 Annotation Data.<br> |
| {<br> |
| "annotationType": "A String", # The type of annotation this data is for.<br> |
| "kind": "books#annotationdata", # Resource Type<br> |
| "updated": "A String", # Timestamp for the last time this data was updated. (<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC 3339</a> UTC date-time format).<br> |
| "volumeId": "A String", # The volume id for this data. *<br> |
| "encoded_data": "A String", # Base64 encoded data for this annotation data.<br> |
| "layerId": "A String", # The Layer id for this data. *<br> |
| "data": { # JSON encoded data for this annotation data.<br> |
| "geo": {<br> |
| "countryCode": "A String", # The country code of the location.<br> |
| "zoom": 42, # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https://developers.google.com/maps/documentation/staticmaps/#Zoomlevels<br> |
| "longitude": 3.14, # The longitude of the location.<br> |
| "mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN<br> |
| "latitude": 3.14, # The latitude of the location.<br> |
| "boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.<br> |
| [<br> |
| {<br> |
| "latitude": 42,<br> |
| "longitude": 42,<br> |
| },<br> |
| ],<br> |
| ],<br> |
| "resolution": "A String", # The resolution of the location. Ex: POI_LEVEL<br> |
| "viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.<br> |
| "lo": {<br> |
| "latitude": 3.14,<br> |
| "longitude": 3.14,<br> |
| },<br> |
| "hi": {<br> |
| "latitude": 3.14,<br> |
| "longitude": 3.14,<br> |
| },<br> |
| },<br> |
| "cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER<br> |
| },<br> |
| "common": {<br> |
| "lang": "A String", # The language of the information url and description.<br> |
| "previewImageUrl": "A String", # The URL for the preview image information.<br> |
| "snippet": "A String", # The description for this location.<br> |
| "snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link.<br> |
| },<br> |
| },<br> |
| "id": "A String", # Unique id for this annotation data.<br> |
| "selfLink": "A String", # URL for this resource. *<br> |
| },<br> |
| ],<br> |
| "kind": "books#annotationsdata", # 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> |