Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3e17f8990db54bec16c48c319072799a14f5a53f / . / docs / dyn / books_v1.bookshelves.html
blob: 89c9179f50f4db362bc64e3353c3db46866fe9b3 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.bookshelves.html">bookshelves</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="books_v1.bookshelves.volumes.html">volumes()</a></code>
79</p>
80<p class="firstline">Returns the volumes Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]86 <code><a href="#get">get(userId, shelf, source=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]87<p class="firstline">Retrieves metadata for a specific bookshelf for the specified user.</p>
88<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]89 <code><a href="#list">list(userId, source=None, x__xgafv=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]90<p class="firstline">Retrieves a list of public bookshelves for the specified user.</p>
91<h3>Method Details</h3>
92<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]93 <code class="details" id="close">close()</code>
94 <pre>Close httplib2 connections.</pre>
95</div>
96
97<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]98 <code class="details" id="get">get(userId, shelf, source=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]99 <pre>Retrieves metadata for a specific bookshelf for the specified user.
100
101Args:
102 userId: string, ID of user for whom to retrieve bookshelves. (required)
103 shelf: string, ID of bookshelf to retrieve. (required)
104 source: string, String to identify the originator of this request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]109
110Returns:
111 An object of the form:
112
113 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]114 &quot;volumeCount&quot;: 42, # Number of volumes in this bookshelf.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]115 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]116 &quot;kind&quot;: &quot;A String&quot;, # Resource type for bookshelf metadata.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]117 &quot;id&quot;: 42, # Id of this bookshelf, only unique by user.
118 &quot;updated&quot;: &quot;A String&quot;, # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
119 &quot;title&quot;: &quot;A String&quot;, # Title of this bookshelf.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]120 &quot;description&quot;: &quot;A String&quot;, # Description of this bookshelf.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 &quot;volumesLastUpdated&quot;: &quot;A String&quot;, # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]122 &quot;created&quot;: &quot;A String&quot;, # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
123 &quot;access&quot;: &quot;A String&quot;, # Whether this bookshelf is PUBLIC or PRIVATE.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]124 }</pre>
125</div>
126
127<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]128 <code class="details" id="list">list(userId, source=None, x__xgafv=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]129 <pre>Retrieves a list of public bookshelves for the specified user.
130
131Args:
132 userId: string, ID of user for whom to retrieve bookshelves. (required)
133 source: string, String to identify the originator of this request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]134 x__xgafv: string, V1 error format.
135 Allowed values
136 1 - v1 error format
137 2 - v2 error format
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]138
139Returns:
140 An object of the form:
141
142 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;items&quot;: [ # A list of bookshelves.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 &quot;volumeCount&quot;: 42, # Number of volumes in this bookshelf.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]146 &quot;selfLink&quot;: &quot;A String&quot;, # URL to this resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]147 &quot;kind&quot;: &quot;A String&quot;, # Resource type for bookshelf metadata.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]148 &quot;id&quot;: 42, # Id of this bookshelf, only unique by user.
149 &quot;updated&quot;: &quot;A String&quot;, # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
150 &quot;title&quot;: &quot;A String&quot;, # Title of this bookshelf.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]151 &quot;description&quot;: &quot;A String&quot;, # Description of this bookshelf.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]152 &quot;volumesLastUpdated&quot;: &quot;A String&quot;, # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame^]153 &quot;created&quot;: &quot;A String&quot;, # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
154 &quot;access&quot;: &quot;A String&quot;, # Whether this bookshelf is PUBLIC or PRIVATE.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]155 },
156 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]157 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]158 }</pre>
159</div>
160
161</body></html>