docs/dyn/books.v1.layers.annotationData.html - platform/external/python/google-api-python-client - Gitiles


 <!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>&nbsp;<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>&nbsp;&nbsp;&nbsp;</tt></td>
 <td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
 <tr><td>&nbsp;</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&nbsp;the&nbsp;annotation&nbsp;data.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
 &nbsp;&nbsp;locale:&nbsp;string,&nbsp;The&nbsp;locale&nbsp;information&nbsp;for&nbsp;the&nbsp;data.&nbsp;ISO-639-1&nbsp;language&nbsp;and&nbsp;ISO-3166-1&nbsp;country&nbsp;code.&nbsp;Ex:&nbsp;'en_US'.<br>
 &nbsp;&nbsp;layerId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;for&nbsp;the&nbsp;layer&nbsp;to&nbsp;get&nbsp;the&nbsp;annotations.&nbsp;(required)<br>
 &nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;The&nbsp;volume&nbsp;to&nbsp;retrieve&nbsp;annotations&nbsp;for.&nbsp;(required)<br>
 &nbsp;&nbsp;annotationDataId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;of&nbsp;the&nbsp;annotation&nbsp;data&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
 &nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
 &nbsp;<br>
 &nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"annotationType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;type&nbsp;of&nbsp;annotation&nbsp;this&nbsp;data&nbsp;is&nbsp;for.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotationdata",&nbsp;#&nbsp;Resource&nbsp;Type<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;this&nbsp;data&nbsp;was&nbsp;updated.&nbsp;(<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;UTC&nbsp;date-time&nbsp;format).<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;id&nbsp;for&nbsp;this&nbsp;data.&nbsp;*<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"encoded_data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Base64&nbsp;encoded&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;Layer&nbsp;id&nbsp;for&nbsp;this&nbsp;data.&nbsp;*<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;JSON&nbsp;enoded&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;id&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;for&nbsp;this&nbsp;resource.&nbsp;*<br>
 &nbsp;&nbsp;}</tt></dd></dl>

 <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Gets&nbsp;the&nbsp;annotation&nbsp;data&nbsp;for&nbsp;a&nbsp;volume&nbsp;and&nbsp;layer.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;pageToken:&nbsp;string,&nbsp;The&nbsp;value&nbsp;of&nbsp;the&nbsp;nextToken&nbsp;from&nbsp;the&nbsp;previous&nbsp;page.<br>
 &nbsp;&nbsp;updatedMax:&nbsp;string,&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp&nbsp;to&nbsp;restrict&nbsp;to&nbsp;items&nbsp;updated&nbsp;prior&nbsp;to&nbsp;this&nbsp;timestamp&nbsp;(exclusive).<br>
 &nbsp;&nbsp;locale:&nbsp;string,&nbsp;The&nbsp;locale&nbsp;information&nbsp;for&nbsp;the&nbsp;data.&nbsp;ISO-639-1&nbsp;language&nbsp;and&nbsp;ISO-3166-1&nbsp;country&nbsp;code.&nbsp;Ex:&nbsp;'en_US'.<br>
 &nbsp;&nbsp;layerId:&nbsp;string,&nbsp;The&nbsp;ID&nbsp;for&nbsp;the&nbsp;layer&nbsp;to&nbsp;get&nbsp;the&nbsp;annotation&nbsp;data.&nbsp;(required)<br>
 &nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;The&nbsp;volume&nbsp;to&nbsp;retrieve&nbsp;annotation&nbsp;data&nbsp;for.&nbsp;(required)<br>
 &nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return<br>
 &nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
 &nbsp;&nbsp;contentVersion:&nbsp;string,&nbsp;The&nbsp;content&nbsp;version&nbsp;for&nbsp;the&nbsp;requested&nbsp;volume.&nbsp;(required)<br>
 &nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
 &nbsp;&nbsp;updatedMin:&nbsp;string,&nbsp;<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;timestamp&nbsp;to&nbsp;restrict&nbsp;to&nbsp;items&nbsp;updated&nbsp;since&nbsp;this&nbsp;timestamp&nbsp;(inclusive).<br>
 &nbsp;<br>
 Returns:<br>
 &nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
 &nbsp;<br>
 &nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"totalItems":&nbsp;42,&nbsp;#&nbsp;The&nbsp;total&nbsp;number&nbsp;of&nbsp;volume&nbsp;annotations&nbsp;found.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"items":&nbsp;[&nbsp;#&nbsp;A&nbsp;list&nbsp;of&nbsp;Annotation&nbsp;Data.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"annotationType":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;type&nbsp;of&nbsp;annotation&nbsp;this&nbsp;data&nbsp;is&nbsp;for.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotationdata",&nbsp;#&nbsp;Resource&nbsp;Type<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Timestamp&nbsp;for&nbsp;the&nbsp;last&nbsp;time&nbsp;this&nbsp;data&nbsp;was&nbsp;updated.&nbsp;(<a href="http://www.rfc-editor.org/rfc/rfc3339.txt">RFC&nbsp;3339</a>&nbsp;UTC&nbsp;date-time&nbsp;format).<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"volumeId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;volume&nbsp;id&nbsp;for&nbsp;this&nbsp;data.&nbsp;*<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"encoded_data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Base64&nbsp;encoded&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"layerId":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;Layer&nbsp;id&nbsp;for&nbsp;this&nbsp;data.&nbsp;*<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"data":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;JSON&nbsp;enoded&nbsp;data&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;Unique&nbsp;id&nbsp;for&nbsp;this&nbsp;annotation&nbsp;data.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"selfLink":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;URL&nbsp;for&nbsp;this&nbsp;resource.&nbsp;*<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;},<br>
 &nbsp;&nbsp;&nbsp;&nbsp;],<br>
 &nbsp;&nbsp;&nbsp;&nbsp;"kind":&nbsp;"books#annotationsdata",&nbsp;#&nbsp;Resource&nbsp;type<br>
 &nbsp;&nbsp;}</tt></dd></dl>

 <hr>
 Data descriptors defined here:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 </td></tr></table>
 </body></html>

	<!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>
	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>
	annotationDataId: string, The ID of the annotation data to retrieve. (required)<br>
	country: string, ISO-3166-1 code to override the IP-based location.<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": "A String", # JSON enoded data for this annotation data.<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>
	pageToken: string, The value of the nextToken from the previous page.<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>
	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 annotation data. (required)<br>
	volumeId: string, The volume to retrieve annotation data for. (required)<br>
	maxResults: integer, Maximum number of results to return<br>
	source: string, String to identify the originator of this request.<br>
	contentVersion: string, The content version for the requested volume. (required)<br>
	country: string, ISO-3166-1 code to override the IP-based location.<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>
	<br>
	Returns:<br>
	An object of the form<br>
	<br>
	{<br>
	"totalItems": 42, # The total number of volume annotations found.<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": "A String", # JSON enoded data for this annotation data.<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>
	}</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>