1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.mylibrary.html">mylibrary</a> . <a href="books_v1.mylibrary.bookshelves.html">bookshelves</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="books_v1.mylibrary.bookshelves.volumes.html">volumes()</a></code>
</p>
<p class="firstline">Returns the volumes Resource.</p>
<p class="toc_element">
<code><a href="#addVolume">addVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a volume to a bookshelf.</p>
<p class="toc_element">
<code><a href="#clearVolumes">clearVolumes(shelf, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Clears all volumes from a bookshelf.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(shelf, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves metadata for a specific bookshelf belonging to the authenticated user.</p>
<p class="toc_element">
<code><a href="#list">list(source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of bookshelves belonging to the authenticated user.</p>
<p class="toc_element">
<code><a href="#moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Moves a volume within a bookshelf.</p>
<p class="toc_element">
<code><a href="#removeVolume">removeVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a volume from a bookshelf.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addVolume">addVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</code>
<pre>Adds a volume to a bookshelf.
Args:
shelf: string, ID of bookshelf to which to add a volume. (required)
volumeId: string, ID of volume to add. (required)
reason: string, The reason for which the book is added to the library.
Allowed values
REASON_UNDEFINED -
IOS_PREX - Volumes added from the PREX flow on iOS.
IOS_SEARCH - Volumes added from the Search flow on iOS.
ONBOARDING - Volumes added from the Onboarding flow.
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="clearVolumes">clearVolumes(shelf, source=None, x__xgafv=None)</code>
<pre>Clears all volumes from a bookshelf.
Args:
shelf: string, ID of bookshelf from which to remove a volume. (required)
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(shelf, source=None, x__xgafv=None)</code>
<pre>Retrieves metadata for a specific bookshelf belonging to the authenticated user.
Args:
shelf: string, ID of bookshelf to retrieve. (required)
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
"created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
"description": "A String", # Description of this bookshelf.
"id": 42, # Id of this bookshelf, only unique by user.
"kind": "A String", # Resource type for bookshelf metadata.
"selfLink": "A String", # URL to this resource.
"title": "A String", # Title of this bookshelf.
"updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
"volumeCount": 42, # Number of volumes in this bookshelf.
"volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(source=None, x__xgafv=None)</code>
<pre>Retrieves a list of bookshelves belonging to the authenticated user.
Args:
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"items": [ # A list of bookshelves.
{
"access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
"created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
"description": "A String", # Description of this bookshelf.
"id": 42, # Id of this bookshelf, only unique by user.
"kind": "A String", # Resource type for bookshelf metadata.
"selfLink": "A String", # URL to this resource.
"title": "A String", # Title of this bookshelf.
"updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
"volumeCount": 42, # Number of volumes in this bookshelf.
"volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
},
],
"kind": "A String", # Resource type.
}</pre>
</div>
<div class="method">
<code class="details" id="moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None, x__xgafv=None)</code>
<pre>Moves a volume within a bookshelf.
Args:
shelf: string, ID of bookshelf with the volume. (required)
volumeId: string, ID of volume to move. (required)
volumePosition: integer, Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.) (required)
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="removeVolume">removeVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</code>
<pre>Removes a volume from a bookshelf.
Args:
shelf: string, ID of bookshelf from which to remove a volume. (required)
volumeId: string, ID of volume to remove. (required)
reason: string, The reason for which the book is removed from the library.
Allowed values
REASON_UNDEFINED -
ONBOARDING - Samples removed from the Onboarding flow.
source: string, String to identify the originator of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
</body></html>
|
