docs/dyn/books.v1.volumes.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;volume&nbsp;information&nbsp;for&nbsp;a&nbsp;single&nbsp;volume.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;projection:&nbsp;string,&nbsp;Restrict&nbsp;information&nbsp;returned&nbsp;to&nbsp;a&nbsp;set&nbsp;of&nbsp;selected&nbsp;fields.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;full&nbsp;-&nbsp;Includes&nbsp;all&nbsp;volume&nbsp;data.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lite&nbsp;-&nbsp;Includes&nbsp;a&nbsp;subset&nbsp;of&nbsp;fields&nbsp;in&nbsp;volumeInfo&nbsp;and&nbsp;accessInfo.<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;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
 &nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;volume&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
 &nbsp;&nbsp;partner:&nbsp;string,&nbsp;Identifier&nbsp;of&nbsp;partner&nbsp;for&nbsp;whom&nbsp;to&nbsp;brand&nbsp;results.</tt></dd></dl>

 <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Performs&nbsp;a&nbsp;book&nbsp;search.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;orderBy:&nbsp;string,&nbsp;Sort&nbsp;search&nbsp;results.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;newest&nbsp;-&nbsp;Most&nbsp;recently&nbsp;published.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;relevance&nbsp;-&nbsp;Relevance&nbsp;to&nbsp;search&nbsp;terms.<br>
 &nbsp;&nbsp;filter:&nbsp;string,&nbsp;Filter&nbsp;search&nbsp;results.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ebooks&nbsp;-&nbsp;All&nbsp;Google&nbsp;eBooks.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;free-ebooks&nbsp;-&nbsp;Google&nbsp;eBook&nbsp;with&nbsp;full&nbsp;volume&nbsp;text&nbsp;viewability.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;full&nbsp;-&nbsp;Public&nbsp;can&nbsp;view&nbsp;entire&nbsp;volume&nbsp;text.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;paid-ebooks&nbsp;-&nbsp;Google&nbsp;eBook&nbsp;with&nbsp;a&nbsp;price.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;partial&nbsp;-&nbsp;Public&nbsp;able&nbsp;to&nbsp;see&nbsp;parts&nbsp;of&nbsp;text.<br>
 &nbsp;&nbsp;projection:&nbsp;string,&nbsp;Restrict&nbsp;information&nbsp;returned&nbsp;to&nbsp;a&nbsp;set&nbsp;of&nbsp;selected&nbsp;fields.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;full&nbsp;-&nbsp;Includes&nbsp;all&nbsp;volume&nbsp;data.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;lite&nbsp;-&nbsp;Includes&nbsp;a&nbsp;subset&nbsp;of&nbsp;fields&nbsp;in&nbsp;volumeInfo&nbsp;and&nbsp;accessInfo.<br>
 &nbsp;&nbsp;libraryRestrict:&nbsp;string,&nbsp;Restrict&nbsp;search&nbsp;to&nbsp;this&nbsp;user's&nbsp;library.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;my-library&nbsp;-&nbsp;Restrict&nbsp;to&nbsp;the&nbsp;user's&nbsp;library,&nbsp;any&nbsp;shelf.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;no-restrict&nbsp;-&nbsp;Do&nbsp;not&nbsp;restrict&nbsp;based&nbsp;on&nbsp;user's&nbsp;library.<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;langRestrict:&nbsp;string,&nbsp;Restrict&nbsp;results&nbsp;to&nbsp;books&nbsp;with&nbsp;this&nbsp;language&nbsp;code.<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;printType:&nbsp;string,&nbsp;Restrict&nbsp;to&nbsp;books&nbsp;or&nbsp;magazines.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;all&nbsp;-&nbsp;All&nbsp;volume&nbsp;content&nbsp;types.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;books&nbsp;-&nbsp;Just&nbsp;books.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;magazines&nbsp;-&nbsp;Just&nbsp;magazines.<br>
 &nbsp;&nbsp;startIndex:&nbsp;integer,&nbsp;Index&nbsp;of&nbsp;the&nbsp;first&nbsp;result&nbsp;to&nbsp;return&nbsp;(starts&nbsp;at&nbsp;0)<br>
 &nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return.<br>
 &nbsp;&nbsp;q:&nbsp;string,&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.&nbsp;(required)<br>
 &nbsp;&nbsp;partner:&nbsp;string,&nbsp;Identifier&nbsp;of&nbsp;partner&nbsp;for&nbsp;whom&nbsp;to&nbsp;restrict&nbsp;and&nbsp;brand&nbsp;results.<br>
 &nbsp;&nbsp;download:&nbsp;string,&nbsp;Restrict&nbsp;to&nbsp;volumes&nbsp;by&nbsp;download&nbsp;availability.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;epub&nbsp;-&nbsp;All&nbsp;volumes&nbsp;with&nbsp;epub.</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 volume information for a single volume.<br>
	<br>
	Args:<br>
	projection: string, Restrict information returned to a set of selected fields.<br>
	Allowed values<br>
	full - Includes all volume data.<br>
	lite - Includes a subset of fields in volumeInfo and accessInfo.<br>
	source: string, String to identify the originator of this request.<br>
	country: string, ISO-3166-1 code to override the IP-based location.<br>
	volumeId: string, Id of volume to retrieve. (required)<br>
	partner: string, Identifier of partner for whom to brand results.</tt></dd></dl>

	<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Performs a book search.<br>
	<br>
	Args:<br>
	orderBy: string, Sort search results.<br>
	Allowed values<br>
	newest - Most recently published.<br>
	relevance - Relevance to search terms.<br>
	filter: string, Filter search results.<br>
	Allowed values<br>
	ebooks - All Google eBooks.<br>
	free-ebooks - Google eBook with full volume text viewability.<br>
	full - Public can view entire volume text.<br>
	paid-ebooks - Google eBook with a price.<br>
	partial - Public able to see parts of text.<br>
	projection: string, Restrict information returned to a set of selected fields.<br>
	Allowed values<br>
	full - Includes all volume data.<br>
	lite - Includes a subset of fields in volumeInfo and accessInfo.<br>
	libraryRestrict: string, Restrict search to this user's library.<br>
	Allowed values<br>
	my-library - Restrict to the user's library, any shelf.<br>
	no-restrict - Do not restrict based on user's library.<br>
	source: string, String to identify the originator of this request.<br>
	langRestrict: string, Restrict results to books with this language code.<br>
	country: string, ISO-3166-1 code to override the IP-based location.<br>
	printType: string, Restrict to books or magazines.<br>
	Allowed values<br>
	all - All volume content types.<br>
	books - Just books.<br>
	magazines - Just magazines.<br>
	startIndex: integer, Index of the first result to return (starts at 0)<br>
	maxResults: integer, Maximum number of results to return.<br>
	q: string, Full-text search query string. (required)<br>
	partner: string, Identifier of partner for whom to restrict and brand results.<br>
	download: string, Restrict to volumes by download availability.<br>
	Allowed values<br>
	epub - All volumes with epub.</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>