Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2b781287174b9335b6a77f14f87f2c28e6cfad8e / . / docs / dyn / books.v1.volumes.html
blob: 07de7315f4bea7cac7b8363444ff370d98ab9463 [file] [log] [blame]
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<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>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<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>
18&nbsp;<br>
19Args:<br>
20&nbsp;&nbsp;projection:&nbsp;string,&nbsp;Restrict&nbsp;information&nbsp;returned&nbsp;to&nbsp;a&nbsp;set&nbsp;of&nbsp;selected&nbsp;fields.<br>
21&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
22&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;full&nbsp;-&nbsp;Includes&nbsp;all&nbsp;volume&nbsp;data.<br>
23&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>
24&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]25&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
26&nbsp;&nbsp;volumeId:&nbsp;string,&nbsp;Id&nbsp;of&nbsp;volume&nbsp;to&nbsp;retrieve.&nbsp;(required)<br>
27&nbsp;&nbsp;partner:&nbsp;string,&nbsp;Identifier&nbsp;of&nbsp;partner&nbsp;for&nbsp;whom&nbsp;to&nbsp;brand&nbsp;results.</tt></dd></dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]28
29<dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Performs&nbsp;a&nbsp;book&nbsp;search.<br>
30&nbsp;<br>
31Args:<br>
32&nbsp;&nbsp;orderBy:&nbsp;string,&nbsp;Sort&nbsp;search&nbsp;results.<br>
33&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
34&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;newest&nbsp;-&nbsp;Most&nbsp;recently&nbsp;published.<br>
35&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;relevance&nbsp;-&nbsp;Relevance&nbsp;to&nbsp;search&nbsp;terms.<br>
36&nbsp;&nbsp;filter:&nbsp;string,&nbsp;Filter&nbsp;search&nbsp;results.<br>
37&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
38&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ebooks&nbsp;-&nbsp;All&nbsp;Google&nbsp;eBooks.<br>
39&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;free-ebooks&nbsp;-&nbsp;Google&nbsp;eBook&nbsp;with&nbsp;full&nbsp;volume&nbsp;text&nbsp;viewability.<br>
40&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;full&nbsp;-&nbsp;Public&nbsp;can&nbsp;view&nbsp;entire&nbsp;volume&nbsp;text.<br>
41&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;paid-ebooks&nbsp;-&nbsp;Google&nbsp;eBook&nbsp;with&nbsp;a&nbsp;price.<br>
42&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;partial&nbsp;-&nbsp;Public&nbsp;able&nbsp;to&nbsp;see&nbsp;parts&nbsp;of&nbsp;text.<br>
43&nbsp;&nbsp;projection:&nbsp;string,&nbsp;Restrict&nbsp;information&nbsp;returned&nbsp;to&nbsp;a&nbsp;set&nbsp;of&nbsp;selected&nbsp;fields.<br>
44&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
45&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;full&nbsp;-&nbsp;Includes&nbsp;all&nbsp;volume&nbsp;data.<br>
46&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>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]47&nbsp;&nbsp;libraryRestrict:&nbsp;string,&nbsp;Restrict&nbsp;search&nbsp;to&nbsp;this&nbsp;user's&nbsp;library.<br>
48&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
49&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>
50&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>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]51&nbsp;&nbsp;source:&nbsp;string,&nbsp;String&nbsp;to&nbsp;identify&nbsp;the&nbsp;originator&nbsp;of&nbsp;this&nbsp;request.<br>
52&nbsp;&nbsp;langRestrict:&nbsp;string,&nbsp;Restrict&nbsp;results&nbsp;to&nbsp;books&nbsp;with&nbsp;this&nbsp;language&nbsp;code.<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]53&nbsp;&nbsp;country:&nbsp;string,&nbsp;ISO-3166-1&nbsp;code&nbsp;to&nbsp;override&nbsp;the&nbsp;IP-based&nbsp;location.<br>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]54&nbsp;&nbsp;printType:&nbsp;string,&nbsp;Restrict&nbsp;to&nbsp;books&nbsp;or&nbsp;magazines.<br>
55&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
56&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;all&nbsp;-&nbsp;All&nbsp;volume&nbsp;content&nbsp;types.<br>
57&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;books&nbsp;-&nbsp;Just&nbsp;books.<br>
58&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;magazines&nbsp;-&nbsp;Just&nbsp;magazines.<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]59&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>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]60&nbsp;&nbsp;maxResults:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;return.<br>
61&nbsp;&nbsp;q:&nbsp;string,&nbsp;Full-text&nbsp;search&nbsp;query&nbsp;string.&nbsp;(required)<br>
Joe Gregorio02503852011-08-31 09:07:55 -0400[diff] [blame]62&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>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400[diff] [blame]63&nbsp;&nbsp;download:&nbsp;string,&nbsp;Restrict&nbsp;to&nbsp;volumes&nbsp;by&nbsp;download&nbsp;availability.<br>
64&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
65&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;epub&nbsp;-&nbsp;All&nbsp;volumes&nbsp;with&nbsp;epub.</tt></dd></dl>
66
67<hr>
68Data descriptors defined here:<br>
69<dl><dt><strong>__dict__</strong></dt>
70<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
71</dl>
72<dl><dt><strong>__weakref__</strong></dt>
73<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
74</dl>
75</td></tr></table>
76</body></html>