google-apis-books_v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-books_v1.rb +15 -0
- data/lib/google/apis/books_v1.rb +36 -0
- data/lib/google/apis/books_v1/classes.rb +4558 -0
- data/lib/google/apis/books_v1/gem_version.rb +28 -0
- data/lib/google/apis/books_v1/representations.rb +1952 -0
- data/lib/google/apis/books_v1/service.rb +2185 -0
- metadata +76 -0
@@ -0,0 +1,2185 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/core/base_service'
|
16
|
+
require 'google/apis/core/json_representation'
|
17
|
+
require 'google/apis/core/hashable'
|
18
|
+
require 'google/apis/errors'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
module BooksV1
|
23
|
+
# Books API
|
24
|
+
#
|
25
|
+
# The Google Books API allows clients to access the Google Books repository.
|
26
|
+
#
|
27
|
+
# @example
|
28
|
+
# require 'google/apis/books_v1'
|
29
|
+
#
|
30
|
+
# Books = Google::Apis::BooksV1 # Alias the module
|
31
|
+
# service = Books::BooksService.new
|
32
|
+
#
|
33
|
+
# @see https://code.google.com/apis/books/docs/v1/getting_started.html
|
34
|
+
class BooksService < Google::Apis::Core::BaseService
|
35
|
+
# @return [String]
|
36
|
+
# API key. Your API key identifies your project and provides you with API access,
|
37
|
+
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
38
|
+
attr_accessor :key
|
39
|
+
|
40
|
+
# @return [String]
|
41
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
42
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
43
|
+
attr_accessor :quota_user
|
44
|
+
|
45
|
+
def initialize
|
46
|
+
super('https://books.googleapis.com/', '',
|
47
|
+
client_name: 'google-apis-books_v1',
|
48
|
+
client_version: Google::Apis::BooksV1::GEM_VERSION)
|
49
|
+
@batch_path = 'batch'
|
50
|
+
end
|
51
|
+
|
52
|
+
# Retrieves metadata for a specific bookshelf for the specified user.
|
53
|
+
# @param [String] user_id
|
54
|
+
# ID of user for whom to retrieve bookshelves.
|
55
|
+
# @param [String] shelf
|
56
|
+
# ID of bookshelf to retrieve.
|
57
|
+
# @param [String] source
|
58
|
+
# String to identify the originator of this request.
|
59
|
+
# @param [String] fields
|
60
|
+
# Selector specifying which fields to include in a partial response.
|
61
|
+
# @param [String] quota_user
|
62
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
63
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
64
|
+
# @param [Google::Apis::RequestOptions] options
|
65
|
+
# Request-specific options
|
66
|
+
#
|
67
|
+
# @yield [result, err] Result & error if block supplied
|
68
|
+
# @yieldparam result [Google::Apis::BooksV1::Bookshelf] parsed result object
|
69
|
+
# @yieldparam err [StandardError] error object if request failed
|
70
|
+
#
|
71
|
+
# @return [Google::Apis::BooksV1::Bookshelf]
|
72
|
+
#
|
73
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
74
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
75
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
76
|
+
def get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
77
|
+
command = make_simple_command(:get, 'books/v1/users/{userId}/bookshelves/{shelf}', options)
|
78
|
+
command.response_representation = Google::Apis::BooksV1::Bookshelf::Representation
|
79
|
+
command.response_class = Google::Apis::BooksV1::Bookshelf
|
80
|
+
command.params['userId'] = user_id unless user_id.nil?
|
81
|
+
command.params['shelf'] = shelf unless shelf.nil?
|
82
|
+
command.query['source'] = source unless source.nil?
|
83
|
+
command.query['fields'] = fields unless fields.nil?
|
84
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
85
|
+
execute_or_queue_command(command, &block)
|
86
|
+
end
|
87
|
+
|
88
|
+
# Retrieves a list of public bookshelves for the specified user.
|
89
|
+
# @param [String] user_id
|
90
|
+
# ID of user for whom to retrieve bookshelves.
|
91
|
+
# @param [String] source
|
92
|
+
# String to identify the originator of this request.
|
93
|
+
# @param [String] fields
|
94
|
+
# Selector specifying which fields to include in a partial response.
|
95
|
+
# @param [String] quota_user
|
96
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
97
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
98
|
+
# @param [Google::Apis::RequestOptions] options
|
99
|
+
# Request-specific options
|
100
|
+
#
|
101
|
+
# @yield [result, err] Result & error if block supplied
|
102
|
+
# @yieldparam result [Google::Apis::BooksV1::Bookshelves] parsed result object
|
103
|
+
# @yieldparam err [StandardError] error object if request failed
|
104
|
+
#
|
105
|
+
# @return [Google::Apis::BooksV1::Bookshelves]
|
106
|
+
#
|
107
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
108
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
109
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
110
|
+
def list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
111
|
+
command = make_simple_command(:get, 'books/v1/users/{userId}/bookshelves', options)
|
112
|
+
command.response_representation = Google::Apis::BooksV1::Bookshelves::Representation
|
113
|
+
command.response_class = Google::Apis::BooksV1::Bookshelves
|
114
|
+
command.params['userId'] = user_id unless user_id.nil?
|
115
|
+
command.query['source'] = source unless source.nil?
|
116
|
+
command.query['fields'] = fields unless fields.nil?
|
117
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
118
|
+
execute_or_queue_command(command, &block)
|
119
|
+
end
|
120
|
+
|
121
|
+
# Retrieves volumes in a specific bookshelf for the specified user.
|
122
|
+
# @param [String] user_id
|
123
|
+
# ID of user for whom to retrieve bookshelf volumes.
|
124
|
+
# @param [String] shelf
|
125
|
+
# ID of bookshelf to retrieve volumes.
|
126
|
+
# @param [Fixnum] max_results
|
127
|
+
# Maximum number of results to return
|
128
|
+
# @param [Boolean] show_preorders
|
129
|
+
# Set to true to show pre-ordered books. Defaults to false.
|
130
|
+
# @param [String] source
|
131
|
+
# String to identify the originator of this request.
|
132
|
+
# @param [Fixnum] start_index
|
133
|
+
# Index of the first element to return (starts at 0)
|
134
|
+
# @param [String] fields
|
135
|
+
# Selector specifying which fields to include in a partial response.
|
136
|
+
# @param [String] quota_user
|
137
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
138
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
139
|
+
# @param [Google::Apis::RequestOptions] options
|
140
|
+
# Request-specific options
|
141
|
+
#
|
142
|
+
# @yield [result, err] Result & error if block supplied
|
143
|
+
# @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
|
144
|
+
# @yieldparam err [StandardError] error object if request failed
|
145
|
+
#
|
146
|
+
# @return [Google::Apis::BooksV1::Volumes]
|
147
|
+
#
|
148
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
149
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
150
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
151
|
+
def list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block)
|
152
|
+
command = make_simple_command(:get, 'books/v1/users/{userId}/bookshelves/{shelf}/volumes', options)
|
153
|
+
command.response_representation = Google::Apis::BooksV1::Volumes::Representation
|
154
|
+
command.response_class = Google::Apis::BooksV1::Volumes
|
155
|
+
command.params['userId'] = user_id unless user_id.nil?
|
156
|
+
command.params['shelf'] = shelf unless shelf.nil?
|
157
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
158
|
+
command.query['showPreorders'] = show_preorders unless show_preorders.nil?
|
159
|
+
command.query['source'] = source unless source.nil?
|
160
|
+
command.query['startIndex'] = start_index unless start_index.nil?
|
161
|
+
command.query['fields'] = fields unless fields.nil?
|
162
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
163
|
+
execute_or_queue_command(command, &block)
|
164
|
+
end
|
165
|
+
|
166
|
+
# Add a user-upload volume and triggers processing.
|
167
|
+
# @param [String] drive_document_id
|
168
|
+
# A drive document id. The upload_client_token must not be set.
|
169
|
+
# @param [String] mime_type
|
170
|
+
# The document MIME type. It can be set only if the drive_document_id is set.
|
171
|
+
# @param [String] name
|
172
|
+
# The document name. It can be set only if the drive_document_id is set.
|
173
|
+
# @param [String] upload_client_token
|
174
|
+
# Scotty upload token.
|
175
|
+
# @param [String] fields
|
176
|
+
# Selector specifying which fields to include in a partial response.
|
177
|
+
# @param [String] quota_user
|
178
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
179
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
180
|
+
# @param [Google::Apis::RequestOptions] options
|
181
|
+
# Request-specific options
|
182
|
+
#
|
183
|
+
# @yield [result, err] Result & error if block supplied
|
184
|
+
# @yieldparam result [Google::Apis::BooksV1::LoadingResource] parsed result object
|
185
|
+
# @yieldparam err [StandardError] error object if request failed
|
186
|
+
#
|
187
|
+
# @return [Google::Apis::BooksV1::LoadingResource]
|
188
|
+
#
|
189
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
190
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
191
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
192
|
+
def add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
193
|
+
command = make_simple_command(:post, 'books/v1/cloudloading/addBook', options)
|
194
|
+
command.response_representation = Google::Apis::BooksV1::LoadingResource::Representation
|
195
|
+
command.response_class = Google::Apis::BooksV1::LoadingResource
|
196
|
+
command.query['drive_document_id'] = drive_document_id unless drive_document_id.nil?
|
197
|
+
command.query['mime_type'] = mime_type unless mime_type.nil?
|
198
|
+
command.query['name'] = name unless name.nil?
|
199
|
+
command.query['upload_client_token'] = upload_client_token unless upload_client_token.nil?
|
200
|
+
command.query['fields'] = fields unless fields.nil?
|
201
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
202
|
+
execute_or_queue_command(command, &block)
|
203
|
+
end
|
204
|
+
|
205
|
+
# Remove the book and its contents
|
206
|
+
# @param [String] volume_id
|
207
|
+
# The id of the book to be removed.
|
208
|
+
# @param [String] fields
|
209
|
+
# Selector specifying which fields to include in a partial response.
|
210
|
+
# @param [String] quota_user
|
211
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
212
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
213
|
+
# @param [Google::Apis::RequestOptions] options
|
214
|
+
# Request-specific options
|
215
|
+
#
|
216
|
+
# @yield [result, err] Result & error if block supplied
|
217
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
218
|
+
# @yieldparam err [StandardError] error object if request failed
|
219
|
+
#
|
220
|
+
# @return [Google::Apis::BooksV1::Empty]
|
221
|
+
#
|
222
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
223
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
224
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
225
|
+
def delete_book(volume_id, fields: nil, quota_user: nil, options: nil, &block)
|
226
|
+
command = make_simple_command(:post, 'books/v1/cloudloading/deleteBook', options)
|
227
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
228
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
229
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
230
|
+
command.query['fields'] = fields unless fields.nil?
|
231
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
232
|
+
execute_or_queue_command(command, &block)
|
233
|
+
end
|
234
|
+
|
235
|
+
# Updates a user-upload volume.
|
236
|
+
# @param [Google::Apis::BooksV1::LoadingResource] loading_resource_object
|
237
|
+
# @param [String] fields
|
238
|
+
# Selector specifying which fields to include in a partial response.
|
239
|
+
# @param [String] quota_user
|
240
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
241
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
242
|
+
# @param [Google::Apis::RequestOptions] options
|
243
|
+
# Request-specific options
|
244
|
+
#
|
245
|
+
# @yield [result, err] Result & error if block supplied
|
246
|
+
# @yieldparam result [Google::Apis::BooksV1::LoadingResource] parsed result object
|
247
|
+
# @yieldparam err [StandardError] error object if request failed
|
248
|
+
#
|
249
|
+
# @return [Google::Apis::BooksV1::LoadingResource]
|
250
|
+
#
|
251
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
252
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
253
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
254
|
+
def update_book(loading_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
255
|
+
command = make_simple_command(:post, 'books/v1/cloudloading/updateBook', options)
|
256
|
+
command.request_representation = Google::Apis::BooksV1::LoadingResource::Representation
|
257
|
+
command.request_object = loading_resource_object
|
258
|
+
command.response_representation = Google::Apis::BooksV1::LoadingResource::Representation
|
259
|
+
command.response_class = Google::Apis::BooksV1::LoadingResource
|
260
|
+
command.query['fields'] = fields unless fields.nil?
|
261
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
262
|
+
execute_or_queue_command(command, &block)
|
263
|
+
end
|
264
|
+
|
265
|
+
# Returns a list of offline dictionary metadata available
|
266
|
+
# @param [String] cpksver
|
267
|
+
# The device/version ID from which to request the data.
|
268
|
+
# @param [String] fields
|
269
|
+
# Selector specifying which fields to include in a partial response.
|
270
|
+
# @param [String] quota_user
|
271
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
272
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
273
|
+
# @param [Google::Apis::RequestOptions] options
|
274
|
+
# Request-specific options
|
275
|
+
#
|
276
|
+
# @yield [result, err] Result & error if block supplied
|
277
|
+
# @yieldparam result [Google::Apis::BooksV1::Metadata] parsed result object
|
278
|
+
# @yieldparam err [StandardError] error object if request failed
|
279
|
+
#
|
280
|
+
# @return [Google::Apis::BooksV1::Metadata]
|
281
|
+
#
|
282
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
283
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
284
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
285
|
+
def list_offline_metadata_dictionary(cpksver, fields: nil, quota_user: nil, options: nil, &block)
|
286
|
+
command = make_simple_command(:get, 'books/v1/dictionary/listOfflineMetadata', options)
|
287
|
+
command.response_representation = Google::Apis::BooksV1::Metadata::Representation
|
288
|
+
command.response_class = Google::Apis::BooksV1::Metadata
|
289
|
+
command.query['cpksver'] = cpksver unless cpksver.nil?
|
290
|
+
command.query['fields'] = fields unless fields.nil?
|
291
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
292
|
+
execute_or_queue_command(command, &block)
|
293
|
+
end
|
294
|
+
|
295
|
+
# Gets information regarding the family that the user is part of.
|
296
|
+
# @param [String] source
|
297
|
+
# String to identify the originator of this request.
|
298
|
+
# @param [String] fields
|
299
|
+
# Selector specifying which fields to include in a partial response.
|
300
|
+
# @param [String] quota_user
|
301
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
302
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
303
|
+
# @param [Google::Apis::RequestOptions] options
|
304
|
+
# Request-specific options
|
305
|
+
#
|
306
|
+
# @yield [result, err] Result & error if block supplied
|
307
|
+
# @yieldparam result [Google::Apis::BooksV1::FamilyInfo] parsed result object
|
308
|
+
# @yieldparam err [StandardError] error object if request failed
|
309
|
+
#
|
310
|
+
# @return [Google::Apis::BooksV1::FamilyInfo]
|
311
|
+
#
|
312
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
313
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
314
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
315
|
+
def get_familysharing_family_info(source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
316
|
+
command = make_simple_command(:get, 'books/v1/familysharing/getFamilyInfo', options)
|
317
|
+
command.response_representation = Google::Apis::BooksV1::FamilyInfo::Representation
|
318
|
+
command.response_class = Google::Apis::BooksV1::FamilyInfo
|
319
|
+
command.query['source'] = source unless source.nil?
|
320
|
+
command.query['fields'] = fields unless fields.nil?
|
321
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
322
|
+
execute_or_queue_command(command, &block)
|
323
|
+
end
|
324
|
+
|
325
|
+
# Initiates sharing of the content with the user's family. Empty response
|
326
|
+
# indicates success.
|
327
|
+
# @param [String] doc_id
|
328
|
+
# The docid to share.
|
329
|
+
# @param [String] source
|
330
|
+
# String to identify the originator of this request.
|
331
|
+
# @param [String] volume_id
|
332
|
+
# The volume to share.
|
333
|
+
# @param [String] fields
|
334
|
+
# Selector specifying which fields to include in a partial response.
|
335
|
+
# @param [String] quota_user
|
336
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
337
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
338
|
+
# @param [Google::Apis::RequestOptions] options
|
339
|
+
# Request-specific options
|
340
|
+
#
|
341
|
+
# @yield [result, err] Result & error if block supplied
|
342
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
343
|
+
# @yieldparam err [StandardError] error object if request failed
|
344
|
+
#
|
345
|
+
# @return [Google::Apis::BooksV1::Empty]
|
346
|
+
#
|
347
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
348
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
349
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
350
|
+
def share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
351
|
+
command = make_simple_command(:post, 'books/v1/familysharing/share', options)
|
352
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
353
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
354
|
+
command.query['docId'] = doc_id unless doc_id.nil?
|
355
|
+
command.query['source'] = source unless source.nil?
|
356
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
357
|
+
command.query['fields'] = fields unless fields.nil?
|
358
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
359
|
+
execute_or_queue_command(command, &block)
|
360
|
+
end
|
361
|
+
|
362
|
+
# Initiates revoking content that has already been shared with the user's family.
|
363
|
+
# Empty response indicates success.
|
364
|
+
# @param [String] doc_id
|
365
|
+
# The docid to unshare.
|
366
|
+
# @param [String] source
|
367
|
+
# String to identify the originator of this request.
|
368
|
+
# @param [String] volume_id
|
369
|
+
# The volume to unshare.
|
370
|
+
# @param [String] fields
|
371
|
+
# Selector specifying which fields to include in a partial response.
|
372
|
+
# @param [String] quota_user
|
373
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
374
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
375
|
+
# @param [Google::Apis::RequestOptions] options
|
376
|
+
# Request-specific options
|
377
|
+
#
|
378
|
+
# @yield [result, err] Result & error if block supplied
|
379
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
380
|
+
# @yieldparam err [StandardError] error object if request failed
|
381
|
+
#
|
382
|
+
# @return [Google::Apis::BooksV1::Empty]
|
383
|
+
#
|
384
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
385
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
386
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
387
|
+
def unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
388
|
+
command = make_simple_command(:post, 'books/v1/familysharing/unshare', options)
|
389
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
390
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
391
|
+
command.query['docId'] = doc_id unless doc_id.nil?
|
392
|
+
command.query['source'] = source unless source.nil?
|
393
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
394
|
+
command.query['fields'] = fields unless fields.nil?
|
395
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
396
|
+
execute_or_queue_command(command, &block)
|
397
|
+
end
|
398
|
+
|
399
|
+
# Gets the layer summary for a volume.
|
400
|
+
# @param [String] volume_id
|
401
|
+
# The volume to retrieve layers for.
|
402
|
+
# @param [String] summary_id
|
403
|
+
# The ID for the layer to get the summary for.
|
404
|
+
# @param [String] content_version
|
405
|
+
# The content version for the requested volume.
|
406
|
+
# @param [String] source
|
407
|
+
# String to identify the originator of this request.
|
408
|
+
# @param [String] fields
|
409
|
+
# Selector specifying which fields to include in a partial response.
|
410
|
+
# @param [String] quota_user
|
411
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
412
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
413
|
+
# @param [Google::Apis::RequestOptions] options
|
414
|
+
# Request-specific options
|
415
|
+
#
|
416
|
+
# @yield [result, err] Result & error if block supplied
|
417
|
+
# @yieldparam result [Google::Apis::BooksV1::LayerSummary] parsed result object
|
418
|
+
# @yieldparam err [StandardError] error object if request failed
|
419
|
+
#
|
420
|
+
# @return [Google::Apis::BooksV1::LayerSummary]
|
421
|
+
#
|
422
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
423
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
424
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
425
|
+
def get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
426
|
+
command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layersummary/{summaryId}', options)
|
427
|
+
command.response_representation = Google::Apis::BooksV1::LayerSummary::Representation
|
428
|
+
command.response_class = Google::Apis::BooksV1::LayerSummary
|
429
|
+
command.params['volumeId'] = volume_id unless volume_id.nil?
|
430
|
+
command.params['summaryId'] = summary_id unless summary_id.nil?
|
431
|
+
command.query['contentVersion'] = content_version unless content_version.nil?
|
432
|
+
command.query['source'] = source unless source.nil?
|
433
|
+
command.query['fields'] = fields unless fields.nil?
|
434
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
435
|
+
execute_or_queue_command(command, &block)
|
436
|
+
end
|
437
|
+
|
438
|
+
# List the layer summaries for a volume.
|
439
|
+
# @param [String] volume_id
|
440
|
+
# The volume to retrieve layers for.
|
441
|
+
# @param [String] content_version
|
442
|
+
# The content version for the requested volume.
|
443
|
+
# @param [Fixnum] max_results
|
444
|
+
# Maximum number of results to return
|
445
|
+
# @param [String] page_token
|
446
|
+
# The value of the nextToken from the previous page.
|
447
|
+
# @param [String] source
|
448
|
+
# String to identify the originator of this request.
|
449
|
+
# @param [String] fields
|
450
|
+
# Selector specifying which fields to include in a partial response.
|
451
|
+
# @param [String] quota_user
|
452
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
453
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
454
|
+
# @param [Google::Apis::RequestOptions] options
|
455
|
+
# Request-specific options
|
456
|
+
#
|
457
|
+
# @yield [result, err] Result & error if block supplied
|
458
|
+
# @yieldparam result [Google::Apis::BooksV1::LayerSummaries] parsed result object
|
459
|
+
# @yieldparam err [StandardError] error object if request failed
|
460
|
+
#
|
461
|
+
# @return [Google::Apis::BooksV1::LayerSummaries]
|
462
|
+
#
|
463
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
464
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
465
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
466
|
+
def list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
467
|
+
command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layersummary', options)
|
468
|
+
command.response_representation = Google::Apis::BooksV1::LayerSummaries::Representation
|
469
|
+
command.response_class = Google::Apis::BooksV1::LayerSummaries
|
470
|
+
command.params['volumeId'] = volume_id unless volume_id.nil?
|
471
|
+
command.query['contentVersion'] = content_version unless content_version.nil?
|
472
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
473
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
474
|
+
command.query['source'] = source unless source.nil?
|
475
|
+
command.query['fields'] = fields unless fields.nil?
|
476
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
477
|
+
execute_or_queue_command(command, &block)
|
478
|
+
end
|
479
|
+
|
480
|
+
# Gets the annotation data.
|
481
|
+
# @param [String] volume_id
|
482
|
+
# The volume to retrieve annotations for.
|
483
|
+
# @param [String] layer_id
|
484
|
+
# The ID for the layer to get the annotations.
|
485
|
+
# @param [String] annotation_data_id
|
486
|
+
# The ID of the annotation data to retrieve.
|
487
|
+
# @param [String] content_version
|
488
|
+
# The content version for the volume you are trying to retrieve.
|
489
|
+
# @param [Boolean] allow_web_definitions
|
490
|
+
# For the dictionary layer. Whether or not to allow web definitions.
|
491
|
+
# @param [Fixnum] h
|
492
|
+
# The requested pixel height for any images. If height is provided width must
|
493
|
+
# also be provided.
|
494
|
+
# @param [String] locale
|
495
|
+
# The locale information for the data. ISO-639-1 language and ISO-3166-1 country
|
496
|
+
# code. Ex: 'en_US'.
|
497
|
+
# @param [Fixnum] scale
|
498
|
+
# The requested scale for the image.
|
499
|
+
# @param [String] source
|
500
|
+
# String to identify the originator of this request.
|
501
|
+
# @param [Fixnum] w
|
502
|
+
# The requested pixel width for any images. If width is provided height must
|
503
|
+
# also be provided.
|
504
|
+
# @param [String] fields
|
505
|
+
# Selector specifying which fields to include in a partial response.
|
506
|
+
# @param [String] quota_user
|
507
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
508
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
509
|
+
# @param [Google::Apis::RequestOptions] options
|
510
|
+
# Request-specific options
|
511
|
+
#
|
512
|
+
# @yield [result, err] Result & error if block supplied
|
513
|
+
# @yieldparam result [Google::Apis::BooksV1::DictionaryAnnotationdata] parsed result object
|
514
|
+
# @yieldparam err [StandardError] error object if request failed
|
515
|
+
#
|
516
|
+
# @return [Google::Apis::BooksV1::DictionaryAnnotationdata]
|
517
|
+
#
|
518
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
519
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
520
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
521
|
+
def get_layer_annotation_data(volume_id, layer_id, annotation_data_id, content_version, allow_web_definitions: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, options: nil, &block)
|
522
|
+
command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}', options)
|
523
|
+
command.response_representation = Google::Apis::BooksV1::DictionaryAnnotationdata::Representation
|
524
|
+
command.response_class = Google::Apis::BooksV1::DictionaryAnnotationdata
|
525
|
+
command.params['volumeId'] = volume_id unless volume_id.nil?
|
526
|
+
command.params['layerId'] = layer_id unless layer_id.nil?
|
527
|
+
command.params['annotationDataId'] = annotation_data_id unless annotation_data_id.nil?
|
528
|
+
command.query['allowWebDefinitions'] = allow_web_definitions unless allow_web_definitions.nil?
|
529
|
+
command.query['contentVersion'] = content_version unless content_version.nil?
|
530
|
+
command.query['h'] = h unless h.nil?
|
531
|
+
command.query['locale'] = locale unless locale.nil?
|
532
|
+
command.query['scale'] = scale unless scale.nil?
|
533
|
+
command.query['source'] = source unless source.nil?
|
534
|
+
command.query['w'] = w unless w.nil?
|
535
|
+
command.query['fields'] = fields unless fields.nil?
|
536
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
537
|
+
execute_or_queue_command(command, &block)
|
538
|
+
end
|
539
|
+
|
540
|
+
# Gets the annotation data for a volume and layer.
|
541
|
+
# @param [String] volume_id
|
542
|
+
# The volume to retrieve annotation data for.
|
543
|
+
# @param [String] layer_id
|
544
|
+
# The ID for the layer to get the annotation data.
|
545
|
+
# @param [String] content_version
|
546
|
+
# The content version for the requested volume.
|
547
|
+
# @param [Array<String>, String] annotation_data_id
|
548
|
+
# The list of Annotation Data Ids to retrieve. Pagination is ignored if this is
|
549
|
+
# set.
|
550
|
+
# @param [Fixnum] h
|
551
|
+
# The requested pixel height for any images. If height is provided width must
|
552
|
+
# also be provided.
|
553
|
+
# @param [String] locale
|
554
|
+
# The locale information for the data. ISO-639-1 language and ISO-3166-1 country
|
555
|
+
# code. Ex: 'en_US'.
|
556
|
+
# @param [Fixnum] max_results
|
557
|
+
# Maximum number of results to return
|
558
|
+
# @param [String] page_token
|
559
|
+
# The value of the nextToken from the previous page.
|
560
|
+
# @param [Fixnum] scale
|
561
|
+
# The requested scale for the image.
|
562
|
+
# @param [String] source
|
563
|
+
# String to identify the originator of this request.
|
564
|
+
# @param [String] updated_max
|
565
|
+
# RFC 3339 timestamp to restrict to items updated prior to this timestamp (
|
566
|
+
# exclusive).
|
567
|
+
# @param [String] updated_min
|
568
|
+
# RFC 3339 timestamp to restrict to items updated since this timestamp (
|
569
|
+
# inclusive).
|
570
|
+
# @param [Fixnum] w
|
571
|
+
# The requested pixel width for any images. If width is provided height must
|
572
|
+
# also be provided.
|
573
|
+
# @param [String] fields
|
574
|
+
# Selector specifying which fields to include in a partial response.
|
575
|
+
# @param [String] quota_user
|
576
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
577
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
578
|
+
# @param [Google::Apis::RequestOptions] options
|
579
|
+
# Request-specific options
|
580
|
+
#
|
581
|
+
# @yield [result, err] Result & error if block supplied
|
582
|
+
# @yieldparam result [Google::Apis::BooksV1::AnnotationsData] parsed result object
|
583
|
+
# @yieldparam err [StandardError] error object if request failed
|
584
|
+
#
|
585
|
+
# @return [Google::Apis::BooksV1::AnnotationsData]
|
586
|
+
#
|
587
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
588
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
589
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
590
|
+
def list_layer_annotation_data(volume_id, layer_id, content_version, annotation_data_id: nil, h: nil, locale: nil, max_results: nil, page_token: nil, scale: nil, source: nil, updated_max: nil, updated_min: nil, w: nil, fields: nil, quota_user: nil, options: nil, &block)
|
591
|
+
command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layers/{layerId}/data', options)
|
592
|
+
command.response_representation = Google::Apis::BooksV1::AnnotationsData::Representation
|
593
|
+
command.response_class = Google::Apis::BooksV1::AnnotationsData
|
594
|
+
command.params['volumeId'] = volume_id unless volume_id.nil?
|
595
|
+
command.params['layerId'] = layer_id unless layer_id.nil?
|
596
|
+
command.query['annotationDataId'] = annotation_data_id unless annotation_data_id.nil?
|
597
|
+
command.query['contentVersion'] = content_version unless content_version.nil?
|
598
|
+
command.query['h'] = h unless h.nil?
|
599
|
+
command.query['locale'] = locale unless locale.nil?
|
600
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
601
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
602
|
+
command.query['scale'] = scale unless scale.nil?
|
603
|
+
command.query['source'] = source unless source.nil?
|
604
|
+
command.query['updatedMax'] = updated_max unless updated_max.nil?
|
605
|
+
command.query['updatedMin'] = updated_min unless updated_min.nil?
|
606
|
+
command.query['w'] = w unless w.nil?
|
607
|
+
command.query['fields'] = fields unless fields.nil?
|
608
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
609
|
+
execute_or_queue_command(command, &block)
|
610
|
+
end
|
611
|
+
|
612
|
+
# Gets the volume annotation.
|
613
|
+
# @param [String] volume_id
|
614
|
+
# The volume to retrieve annotations for.
|
615
|
+
# @param [String] layer_id
|
616
|
+
# The ID for the layer to get the annotations.
|
617
|
+
# @param [String] annotation_id
|
618
|
+
# The ID of the volume annotation to retrieve.
|
619
|
+
# @param [String] locale
|
620
|
+
# The locale information for the data. ISO-639-1 language and ISO-3166-1 country
|
621
|
+
# code. Ex: 'en_US'.
|
622
|
+
# @param [String] source
|
623
|
+
# String to identify the originator of this request.
|
624
|
+
# @param [String] fields
|
625
|
+
# Selector specifying which fields to include in a partial response.
|
626
|
+
# @param [String] quota_user
|
627
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
628
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
629
|
+
# @param [Google::Apis::RequestOptions] options
|
630
|
+
# Request-specific options
|
631
|
+
#
|
632
|
+
# @yield [result, err] Result & error if block supplied
|
633
|
+
# @yieldparam result [Google::Apis::BooksV1::VolumeAnnotation] parsed result object
|
634
|
+
# @yieldparam err [StandardError] error object if request failed
|
635
|
+
#
|
636
|
+
# @return [Google::Apis::BooksV1::VolumeAnnotation]
|
637
|
+
#
|
638
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
639
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
640
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
641
|
+
def get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
642
|
+
command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}', options)
|
643
|
+
command.response_representation = Google::Apis::BooksV1::VolumeAnnotation::Representation
|
644
|
+
command.response_class = Google::Apis::BooksV1::VolumeAnnotation
|
645
|
+
command.params['volumeId'] = volume_id unless volume_id.nil?
|
646
|
+
command.params['layerId'] = layer_id unless layer_id.nil?
|
647
|
+
command.params['annotationId'] = annotation_id unless annotation_id.nil?
|
648
|
+
command.query['locale'] = locale unless locale.nil?
|
649
|
+
command.query['source'] = source unless source.nil?
|
650
|
+
command.query['fields'] = fields unless fields.nil?
|
651
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
652
|
+
execute_or_queue_command(command, &block)
|
653
|
+
end
|
654
|
+
|
655
|
+
# Gets the volume annotations for a volume and layer.
|
656
|
+
# @param [String] volume_id
|
657
|
+
# The volume to retrieve annotations for.
|
658
|
+
# @param [String] layer_id
|
659
|
+
# The ID for the layer to get the annotations.
|
660
|
+
# @param [String] content_version
|
661
|
+
# The content version for the requested volume.
|
662
|
+
# @param [String] end_offset
|
663
|
+
# The end offset to end retrieving data from.
|
664
|
+
# @param [String] end_position
|
665
|
+
# The end position to end retrieving data from.
|
666
|
+
# @param [String] locale
|
667
|
+
# The locale information for the data. ISO-639-1 language and ISO-3166-1 country
|
668
|
+
# code. Ex: 'en_US'.
|
669
|
+
# @param [Fixnum] max_results
|
670
|
+
# Maximum number of results to return
|
671
|
+
# @param [String] page_token
|
672
|
+
# The value of the nextToken from the previous page.
|
673
|
+
# @param [Boolean] show_deleted
|
674
|
+
# Set to true to return deleted annotations. updatedMin must be in the request
|
675
|
+
# to use this. Defaults to false.
|
676
|
+
# @param [String] source
|
677
|
+
# String to identify the originator of this request.
|
678
|
+
# @param [String] start_offset
|
679
|
+
# The start offset to start retrieving data from.
|
680
|
+
# @param [String] start_position
|
681
|
+
# The start position to start retrieving data from.
|
682
|
+
# @param [String] updated_max
|
683
|
+
# RFC 3339 timestamp to restrict to items updated prior to this timestamp (
|
684
|
+
# exclusive).
|
685
|
+
# @param [String] updated_min
|
686
|
+
# RFC 3339 timestamp to restrict to items updated since this timestamp (
|
687
|
+
# inclusive).
|
688
|
+
# @param [String] volume_annotations_version
|
689
|
+
# The version of the volume annotations that you are requesting.
|
690
|
+
# @param [String] fields
|
691
|
+
# Selector specifying which fields to include in a partial response.
|
692
|
+
# @param [String] quota_user
|
693
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
694
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
695
|
+
# @param [Google::Apis::RequestOptions] options
|
696
|
+
# Request-specific options
|
697
|
+
#
|
698
|
+
# @yield [result, err] Result & error if block supplied
|
699
|
+
# @yieldparam result [Google::Apis::BooksV1::Volumeannotations] parsed result object
|
700
|
+
# @yieldparam err [StandardError] error object if request failed
|
701
|
+
#
|
702
|
+
# @return [Google::Apis::BooksV1::Volumeannotations]
|
703
|
+
#
|
704
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
705
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
706
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
707
|
+
def list_layer_volume_annotations(volume_id, layer_id, content_version, end_offset: nil, end_position: nil, locale: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, start_offset: nil, start_position: nil, updated_max: nil, updated_min: nil, volume_annotations_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
708
|
+
command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layers/{layerId}', options)
|
709
|
+
command.response_representation = Google::Apis::BooksV1::Volumeannotations::Representation
|
710
|
+
command.response_class = Google::Apis::BooksV1::Volumeannotations
|
711
|
+
command.params['volumeId'] = volume_id unless volume_id.nil?
|
712
|
+
command.params['layerId'] = layer_id unless layer_id.nil?
|
713
|
+
command.query['contentVersion'] = content_version unless content_version.nil?
|
714
|
+
command.query['endOffset'] = end_offset unless end_offset.nil?
|
715
|
+
command.query['endPosition'] = end_position unless end_position.nil?
|
716
|
+
command.query['locale'] = locale unless locale.nil?
|
717
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
718
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
719
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
720
|
+
command.query['source'] = source unless source.nil?
|
721
|
+
command.query['startOffset'] = start_offset unless start_offset.nil?
|
722
|
+
command.query['startPosition'] = start_position unless start_position.nil?
|
723
|
+
command.query['updatedMax'] = updated_max unless updated_max.nil?
|
724
|
+
command.query['updatedMin'] = updated_min unless updated_min.nil?
|
725
|
+
command.query['volumeAnnotationsVersion'] = volume_annotations_version unless volume_annotations_version.nil?
|
726
|
+
command.query['fields'] = fields unless fields.nil?
|
727
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
728
|
+
execute_or_queue_command(command, &block)
|
729
|
+
end
|
730
|
+
|
731
|
+
# Gets the current settings for the user.
|
732
|
+
# @param [String] country
|
733
|
+
# Unused. Added only to workaround TEX mandatory request template requirement
|
734
|
+
# @param [String] fields
|
735
|
+
# Selector specifying which fields to include in a partial response.
|
736
|
+
# @param [String] quota_user
|
737
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
738
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
739
|
+
# @param [Google::Apis::RequestOptions] options
|
740
|
+
# Request-specific options
|
741
|
+
#
|
742
|
+
# @yield [result, err] Result & error if block supplied
|
743
|
+
# @yieldparam result [Google::Apis::BooksV1::UserSettings] parsed result object
|
744
|
+
# @yieldparam err [StandardError] error object if request failed
|
745
|
+
#
|
746
|
+
# @return [Google::Apis::BooksV1::UserSettings]
|
747
|
+
#
|
748
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
749
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
750
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
751
|
+
def get_user_settings(country: nil, fields: nil, quota_user: nil, options: nil, &block)
|
752
|
+
command = make_simple_command(:get, 'books/v1/myconfig/getUserSettings', options)
|
753
|
+
command.response_representation = Google::Apis::BooksV1::UserSettings::Representation
|
754
|
+
command.response_class = Google::Apis::BooksV1::UserSettings
|
755
|
+
command.query['country'] = country unless country.nil?
|
756
|
+
command.query['fields'] = fields unless fields.nil?
|
757
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
758
|
+
execute_or_queue_command(command, &block)
|
759
|
+
end
|
760
|
+
|
761
|
+
# Release downloaded content access restriction.
|
762
|
+
# @param [String] cpksver
|
763
|
+
# The device/version ID from which to release the restriction.
|
764
|
+
# @param [Array<String>, String] volume_ids
|
765
|
+
# The volume(s) to release restrictions for.
|
766
|
+
# @param [String] locale
|
767
|
+
# ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
|
768
|
+
# @param [String] source
|
769
|
+
# String to identify the originator of this request.
|
770
|
+
# @param [String] fields
|
771
|
+
# Selector specifying which fields to include in a partial response.
|
772
|
+
# @param [String] quota_user
|
773
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
774
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
775
|
+
# @param [Google::Apis::RequestOptions] options
|
776
|
+
# Request-specific options
|
777
|
+
#
|
778
|
+
# @yield [result, err] Result & error if block supplied
|
779
|
+
# @yieldparam result [Google::Apis::BooksV1::DownloadAccesses] parsed result object
|
780
|
+
# @yieldparam err [StandardError] error object if request failed
|
781
|
+
#
|
782
|
+
# @return [Google::Apis::BooksV1::DownloadAccesses]
|
783
|
+
#
|
784
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
785
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
786
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
787
|
+
def release_download_access(cpksver, volume_ids, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
788
|
+
command = make_simple_command(:post, 'books/v1/myconfig/releaseDownloadAccess', options)
|
789
|
+
command.response_representation = Google::Apis::BooksV1::DownloadAccesses::Representation
|
790
|
+
command.response_class = Google::Apis::BooksV1::DownloadAccesses
|
791
|
+
command.query['cpksver'] = cpksver unless cpksver.nil?
|
792
|
+
command.query['locale'] = locale unless locale.nil?
|
793
|
+
command.query['source'] = source unless source.nil?
|
794
|
+
command.query['volumeIds'] = volume_ids unless volume_ids.nil?
|
795
|
+
command.query['fields'] = fields unless fields.nil?
|
796
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
797
|
+
execute_or_queue_command(command, &block)
|
798
|
+
end
|
799
|
+
|
800
|
+
# Request concurrent and download access restrictions.
|
801
|
+
# @param [String] cpksver
|
802
|
+
# The device/version ID from which to request the restrictions.
|
803
|
+
# @param [String] nonce
|
804
|
+
# The client nonce value.
|
805
|
+
# @param [String] source
|
806
|
+
# String to identify the originator of this request.
|
807
|
+
# @param [String] volume_id
|
808
|
+
# The volume to request concurrent/download restrictions for.
|
809
|
+
# @param [String] license_types
|
810
|
+
# The type of access license to request. If not specified, the default is BOTH.
|
811
|
+
# @param [String] locale
|
812
|
+
# ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
|
813
|
+
# @param [String] fields
|
814
|
+
# Selector specifying which fields to include in a partial response.
|
815
|
+
# @param [String] quota_user
|
816
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
817
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
818
|
+
# @param [Google::Apis::RequestOptions] options
|
819
|
+
# Request-specific options
|
820
|
+
#
|
821
|
+
# @yield [result, err] Result & error if block supplied
|
822
|
+
# @yieldparam result [Google::Apis::BooksV1::RequestAccessData] parsed result object
|
823
|
+
# @yieldparam err [StandardError] error object if request failed
|
824
|
+
#
|
825
|
+
# @return [Google::Apis::BooksV1::RequestAccessData]
|
826
|
+
#
|
827
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
828
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
829
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
830
|
+
def request_access(cpksver, nonce, source, volume_id, license_types: nil, locale: nil, fields: nil, quota_user: nil, options: nil, &block)
|
831
|
+
command = make_simple_command(:post, 'books/v1/myconfig/requestAccess', options)
|
832
|
+
command.response_representation = Google::Apis::BooksV1::RequestAccessData::Representation
|
833
|
+
command.response_class = Google::Apis::BooksV1::RequestAccessData
|
834
|
+
command.query['cpksver'] = cpksver unless cpksver.nil?
|
835
|
+
command.query['licenseTypes'] = license_types unless license_types.nil?
|
836
|
+
command.query['locale'] = locale unless locale.nil?
|
837
|
+
command.query['nonce'] = nonce unless nonce.nil?
|
838
|
+
command.query['source'] = source unless source.nil?
|
839
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
840
|
+
command.query['fields'] = fields unless fields.nil?
|
841
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
842
|
+
execute_or_queue_command(command, &block)
|
843
|
+
end
|
844
|
+
|
845
|
+
# Request downloaded content access for specified volumes on the My eBooks shelf.
|
846
|
+
# @param [String] cpksver
|
847
|
+
# The device/version ID from which to release the restriction.
|
848
|
+
# @param [String] nonce
|
849
|
+
# The client nonce value.
|
850
|
+
# @param [String] source
|
851
|
+
# String to identify the originator of this request.
|
852
|
+
# @param [Array<String>, String] features
|
853
|
+
# List of features supported by the client, i.e., 'RENTALS'
|
854
|
+
# @param [Boolean] include_non_comics_series
|
855
|
+
# Set to true to include non-comics series. Defaults to false.
|
856
|
+
# @param [String] locale
|
857
|
+
# ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
|
858
|
+
# @param [Boolean] show_preorders
|
859
|
+
# Set to true to show pre-ordered books. Defaults to false.
|
860
|
+
# @param [Array<String>, String] volume_ids
|
861
|
+
# The volume(s) to request download restrictions for.
|
862
|
+
# @param [String] fields
|
863
|
+
# Selector specifying which fields to include in a partial response.
|
864
|
+
# @param [String] quota_user
|
865
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
866
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
867
|
+
# @param [Google::Apis::RequestOptions] options
|
868
|
+
# Request-specific options
|
869
|
+
#
|
870
|
+
# @yield [result, err] Result & error if block supplied
|
871
|
+
# @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
|
872
|
+
# @yieldparam err [StandardError] error object if request failed
|
873
|
+
#
|
874
|
+
# @return [Google::Apis::BooksV1::Volumes]
|
875
|
+
#
|
876
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
877
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
878
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
879
|
+
def sync_volume_licenses(cpksver, nonce, source, features: nil, include_non_comics_series: nil, locale: nil, show_preorders: nil, volume_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
|
880
|
+
command = make_simple_command(:post, 'books/v1/myconfig/syncVolumeLicenses', options)
|
881
|
+
command.response_representation = Google::Apis::BooksV1::Volumes::Representation
|
882
|
+
command.response_class = Google::Apis::BooksV1::Volumes
|
883
|
+
command.query['cpksver'] = cpksver unless cpksver.nil?
|
884
|
+
command.query['features'] = features unless features.nil?
|
885
|
+
command.query['includeNonComicsSeries'] = include_non_comics_series unless include_non_comics_series.nil?
|
886
|
+
command.query['locale'] = locale unless locale.nil?
|
887
|
+
command.query['nonce'] = nonce unless nonce.nil?
|
888
|
+
command.query['showPreorders'] = show_preorders unless show_preorders.nil?
|
889
|
+
command.query['source'] = source unless source.nil?
|
890
|
+
command.query['volumeIds'] = volume_ids unless volume_ids.nil?
|
891
|
+
command.query['fields'] = fields unless fields.nil?
|
892
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
893
|
+
execute_or_queue_command(command, &block)
|
894
|
+
end
|
895
|
+
|
896
|
+
# Sets the settings for the user. If a sub-object is specified, it will
|
897
|
+
# overwrite the existing sub-object stored in the server. Unspecified sub-
|
898
|
+
# objects will retain the existing value.
|
899
|
+
# @param [Google::Apis::BooksV1::UserSettings] user_settings_object
|
900
|
+
# @param [String] fields
|
901
|
+
# Selector specifying which fields to include in a partial response.
|
902
|
+
# @param [String] quota_user
|
903
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
904
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
905
|
+
# @param [Google::Apis::RequestOptions] options
|
906
|
+
# Request-specific options
|
907
|
+
#
|
908
|
+
# @yield [result, err] Result & error if block supplied
|
909
|
+
# @yieldparam result [Google::Apis::BooksV1::UserSettings] parsed result object
|
910
|
+
# @yieldparam err [StandardError] error object if request failed
|
911
|
+
#
|
912
|
+
# @return [Google::Apis::BooksV1::UserSettings]
|
913
|
+
#
|
914
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
915
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
916
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
917
|
+
def update_user_settings(user_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
918
|
+
command = make_simple_command(:post, 'books/v1/myconfig/updateUserSettings', options)
|
919
|
+
command.request_representation = Google::Apis::BooksV1::UserSettings::Representation
|
920
|
+
command.request_object = user_settings_object
|
921
|
+
command.response_representation = Google::Apis::BooksV1::UserSettings::Representation
|
922
|
+
command.response_class = Google::Apis::BooksV1::UserSettings
|
923
|
+
command.query['fields'] = fields unless fields.nil?
|
924
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
925
|
+
execute_or_queue_command(command, &block)
|
926
|
+
end
|
927
|
+
|
928
|
+
# Deletes an annotation.
|
929
|
+
# @param [String] annotation_id
|
930
|
+
# The ID for the annotation to delete.
|
931
|
+
# @param [String] source
|
932
|
+
# String to identify the originator of this request.
|
933
|
+
# @param [String] fields
|
934
|
+
# Selector specifying which fields to include in a partial response.
|
935
|
+
# @param [String] quota_user
|
936
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
937
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
938
|
+
# @param [Google::Apis::RequestOptions] options
|
939
|
+
# Request-specific options
|
940
|
+
#
|
941
|
+
# @yield [result, err] Result & error if block supplied
|
942
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
943
|
+
# @yieldparam err [StandardError] error object if request failed
|
944
|
+
#
|
945
|
+
# @return [Google::Apis::BooksV1::Empty]
|
946
|
+
#
|
947
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
948
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
949
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
950
|
+
def delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
951
|
+
command = make_simple_command(:delete, 'books/v1/mylibrary/annotations/{annotationId}', options)
|
952
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
953
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
954
|
+
command.params['annotationId'] = annotation_id unless annotation_id.nil?
|
955
|
+
command.query['source'] = source unless source.nil?
|
956
|
+
command.query['fields'] = fields unless fields.nil?
|
957
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
958
|
+
execute_or_queue_command(command, &block)
|
959
|
+
end
|
960
|
+
|
961
|
+
# Inserts a new annotation.
|
962
|
+
# @param [Google::Apis::BooksV1::Annotation] annotation_object
|
963
|
+
# @param [String] annotation_id
|
964
|
+
# The ID for the annotation to insert.
|
965
|
+
# @param [String] country
|
966
|
+
# ISO-3166-1 code to override the IP-based location.
|
967
|
+
# @param [Boolean] show_only_summary_in_response
|
968
|
+
# Requests that only the summary of the specified layer be provided in the
|
969
|
+
# response.
|
970
|
+
# @param [String] source
|
971
|
+
# String to identify the originator of this request.
|
972
|
+
# @param [String] fields
|
973
|
+
# Selector specifying which fields to include in a partial response.
|
974
|
+
# @param [String] quota_user
|
975
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
976
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
977
|
+
# @param [Google::Apis::RequestOptions] options
|
978
|
+
# Request-specific options
|
979
|
+
#
|
980
|
+
# @yield [result, err] Result & error if block supplied
|
981
|
+
# @yieldparam result [Google::Apis::BooksV1::Annotation] parsed result object
|
982
|
+
# @yieldparam err [StandardError] error object if request failed
|
983
|
+
#
|
984
|
+
# @return [Google::Apis::BooksV1::Annotation]
|
985
|
+
#
|
986
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
987
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
988
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
989
|
+
def insert_my_library_annotation(annotation_object = nil, annotation_id: nil, country: nil, show_only_summary_in_response: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
990
|
+
command = make_simple_command(:post, 'books/v1/mylibrary/annotations', options)
|
991
|
+
command.request_representation = Google::Apis::BooksV1::Annotation::Representation
|
992
|
+
command.request_object = annotation_object
|
993
|
+
command.response_representation = Google::Apis::BooksV1::Annotation::Representation
|
994
|
+
command.response_class = Google::Apis::BooksV1::Annotation
|
995
|
+
command.query['annotationId'] = annotation_id unless annotation_id.nil?
|
996
|
+
command.query['country'] = country unless country.nil?
|
997
|
+
command.query['showOnlySummaryInResponse'] = show_only_summary_in_response unless show_only_summary_in_response.nil?
|
998
|
+
command.query['source'] = source unless source.nil?
|
999
|
+
command.query['fields'] = fields unless fields.nil?
|
1000
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1001
|
+
execute_or_queue_command(command, &block)
|
1002
|
+
end
|
1003
|
+
|
1004
|
+
# Retrieves a list of annotations, possibly filtered.
|
1005
|
+
# @param [String] content_version
|
1006
|
+
# The content version for the requested volume.
|
1007
|
+
# @param [String] layer_id
|
1008
|
+
# The layer ID to limit annotation by.
|
1009
|
+
# @param [Array<String>, String] layer_ids
|
1010
|
+
# The layer ID(s) to limit annotation by.
|
1011
|
+
# @param [Fixnum] max_results
|
1012
|
+
# Maximum number of results to return
|
1013
|
+
# @param [String] page_token
|
1014
|
+
# The value of the nextToken from the previous page.
|
1015
|
+
# @param [Boolean] show_deleted
|
1016
|
+
# Set to true to return deleted annotations. updatedMin must be in the request
|
1017
|
+
# to use this. Defaults to false.
|
1018
|
+
# @param [String] source
|
1019
|
+
# String to identify the originator of this request.
|
1020
|
+
# @param [String] updated_max
|
1021
|
+
# RFC 3339 timestamp to restrict to items updated prior to this timestamp (
|
1022
|
+
# exclusive).
|
1023
|
+
# @param [String] updated_min
|
1024
|
+
# RFC 3339 timestamp to restrict to items updated since this timestamp (
|
1025
|
+
# inclusive).
|
1026
|
+
# @param [String] volume_id
|
1027
|
+
# The volume to restrict annotations to.
|
1028
|
+
# @param [String] fields
|
1029
|
+
# Selector specifying which fields to include in a partial response.
|
1030
|
+
# @param [String] quota_user
|
1031
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1032
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1033
|
+
# @param [Google::Apis::RequestOptions] options
|
1034
|
+
# Request-specific options
|
1035
|
+
#
|
1036
|
+
# @yield [result, err] Result & error if block supplied
|
1037
|
+
# @yieldparam result [Google::Apis::BooksV1::Annotations] parsed result object
|
1038
|
+
# @yieldparam err [StandardError] error object if request failed
|
1039
|
+
#
|
1040
|
+
# @return [Google::Apis::BooksV1::Annotations]
|
1041
|
+
#
|
1042
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1043
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1044
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1045
|
+
def list_my_library_annotations(content_version: nil, layer_id: nil, layer_ids: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, updated_max: nil, updated_min: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1046
|
+
command = make_simple_command(:get, 'books/v1/mylibrary/annotations', options)
|
1047
|
+
command.response_representation = Google::Apis::BooksV1::Annotations::Representation
|
1048
|
+
command.response_class = Google::Apis::BooksV1::Annotations
|
1049
|
+
command.query['contentVersion'] = content_version unless content_version.nil?
|
1050
|
+
command.query['layerId'] = layer_id unless layer_id.nil?
|
1051
|
+
command.query['layerIds'] = layer_ids unless layer_ids.nil?
|
1052
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
1053
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1054
|
+
command.query['showDeleted'] = show_deleted unless show_deleted.nil?
|
1055
|
+
command.query['source'] = source unless source.nil?
|
1056
|
+
command.query['updatedMax'] = updated_max unless updated_max.nil?
|
1057
|
+
command.query['updatedMin'] = updated_min unless updated_min.nil?
|
1058
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
1059
|
+
command.query['fields'] = fields unless fields.nil?
|
1060
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1061
|
+
execute_or_queue_command(command, &block)
|
1062
|
+
end
|
1063
|
+
|
1064
|
+
# Gets the summary of specified layers.
|
1065
|
+
# @param [Array<String>, String] layer_ids
|
1066
|
+
# Array of layer IDs to get the summary for.
|
1067
|
+
# @param [String] volume_id
|
1068
|
+
# Volume id to get the summary for.
|
1069
|
+
# @param [String] fields
|
1070
|
+
# Selector specifying which fields to include in a partial response.
|
1071
|
+
# @param [String] quota_user
|
1072
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1073
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1074
|
+
# @param [Google::Apis::RequestOptions] options
|
1075
|
+
# Request-specific options
|
1076
|
+
#
|
1077
|
+
# @yield [result, err] Result & error if block supplied
|
1078
|
+
# @yieldparam result [Google::Apis::BooksV1::AnnotationsSummary] parsed result object
|
1079
|
+
# @yieldparam err [StandardError] error object if request failed
|
1080
|
+
#
|
1081
|
+
# @return [Google::Apis::BooksV1::AnnotationsSummary]
|
1082
|
+
#
|
1083
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1084
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1085
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1086
|
+
def summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: nil, options: nil, &block)
|
1087
|
+
command = make_simple_command(:post, 'books/v1/mylibrary/annotations/summary', options)
|
1088
|
+
command.response_representation = Google::Apis::BooksV1::AnnotationsSummary::Representation
|
1089
|
+
command.response_class = Google::Apis::BooksV1::AnnotationsSummary
|
1090
|
+
command.query['layerIds'] = layer_ids unless layer_ids.nil?
|
1091
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
1092
|
+
command.query['fields'] = fields unless fields.nil?
|
1093
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1094
|
+
execute_or_queue_command(command, &block)
|
1095
|
+
end
|
1096
|
+
|
1097
|
+
# Updates an existing annotation.
|
1098
|
+
# @param [String] annotation_id
|
1099
|
+
# The ID for the annotation to update.
|
1100
|
+
# @param [Google::Apis::BooksV1::Annotation] annotation_object
|
1101
|
+
# @param [String] source
|
1102
|
+
# String to identify the originator of this request.
|
1103
|
+
# @param [String] fields
|
1104
|
+
# Selector specifying which fields to include in a partial response.
|
1105
|
+
# @param [String] quota_user
|
1106
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1107
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1108
|
+
# @param [Google::Apis::RequestOptions] options
|
1109
|
+
# Request-specific options
|
1110
|
+
#
|
1111
|
+
# @yield [result, err] Result & error if block supplied
|
1112
|
+
# @yieldparam result [Google::Apis::BooksV1::Annotation] parsed result object
|
1113
|
+
# @yieldparam err [StandardError] error object if request failed
|
1114
|
+
#
|
1115
|
+
# @return [Google::Apis::BooksV1::Annotation]
|
1116
|
+
#
|
1117
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1118
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1119
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1120
|
+
def update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1121
|
+
command = make_simple_command(:put, 'books/v1/mylibrary/annotations/{annotationId}', options)
|
1122
|
+
command.request_representation = Google::Apis::BooksV1::Annotation::Representation
|
1123
|
+
command.request_object = annotation_object
|
1124
|
+
command.response_representation = Google::Apis::BooksV1::Annotation::Representation
|
1125
|
+
command.response_class = Google::Apis::BooksV1::Annotation
|
1126
|
+
command.params['annotationId'] = annotation_id unless annotation_id.nil?
|
1127
|
+
command.query['source'] = source unless source.nil?
|
1128
|
+
command.query['fields'] = fields unless fields.nil?
|
1129
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1130
|
+
execute_or_queue_command(command, &block)
|
1131
|
+
end
|
1132
|
+
|
1133
|
+
# Adds a volume to a bookshelf.
|
1134
|
+
# @param [String] shelf
|
1135
|
+
# ID of bookshelf to which to add a volume.
|
1136
|
+
# @param [String] volume_id
|
1137
|
+
# ID of volume to add.
|
1138
|
+
# @param [String] reason
|
1139
|
+
# The reason for which the book is added to the library.
|
1140
|
+
# @param [String] source
|
1141
|
+
# String to identify the originator of this request.
|
1142
|
+
# @param [String] fields
|
1143
|
+
# Selector specifying which fields to include in a partial response.
|
1144
|
+
# @param [String] quota_user
|
1145
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1146
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1147
|
+
# @param [Google::Apis::RequestOptions] options
|
1148
|
+
# Request-specific options
|
1149
|
+
#
|
1150
|
+
# @yield [result, err] Result & error if block supplied
|
1151
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
1152
|
+
# @yieldparam err [StandardError] error object if request failed
|
1153
|
+
#
|
1154
|
+
# @return [Google::Apis::BooksV1::Empty]
|
1155
|
+
#
|
1156
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1157
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1158
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1159
|
+
def add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1160
|
+
command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/addVolume', options)
|
1161
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
1162
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
1163
|
+
command.params['shelf'] = shelf unless shelf.nil?
|
1164
|
+
command.query['reason'] = reason unless reason.nil?
|
1165
|
+
command.query['source'] = source unless source.nil?
|
1166
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
1167
|
+
command.query['fields'] = fields unless fields.nil?
|
1168
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1169
|
+
execute_or_queue_command(command, &block)
|
1170
|
+
end
|
1171
|
+
|
1172
|
+
# Clears all volumes from a bookshelf.
|
1173
|
+
# @param [String] shelf
|
1174
|
+
# ID of bookshelf from which to remove a volume.
|
1175
|
+
# @param [String] source
|
1176
|
+
# String to identify the originator of this request.
|
1177
|
+
# @param [String] fields
|
1178
|
+
# Selector specifying which fields to include in a partial response.
|
1179
|
+
# @param [String] quota_user
|
1180
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1181
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1182
|
+
# @param [Google::Apis::RequestOptions] options
|
1183
|
+
# Request-specific options
|
1184
|
+
#
|
1185
|
+
# @yield [result, err] Result & error if block supplied
|
1186
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
1187
|
+
# @yieldparam err [StandardError] error object if request failed
|
1188
|
+
#
|
1189
|
+
# @return [Google::Apis::BooksV1::Empty]
|
1190
|
+
#
|
1191
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1192
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1193
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1194
|
+
def clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1195
|
+
command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/clearVolumes', options)
|
1196
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
1197
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
1198
|
+
command.params['shelf'] = shelf unless shelf.nil?
|
1199
|
+
command.query['source'] = source unless source.nil?
|
1200
|
+
command.query['fields'] = fields unless fields.nil?
|
1201
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1202
|
+
execute_or_queue_command(command, &block)
|
1203
|
+
end
|
1204
|
+
|
1205
|
+
# Retrieves metadata for a specific bookshelf belonging to the authenticated
|
1206
|
+
# user.
|
1207
|
+
# @param [String] shelf
|
1208
|
+
# ID of bookshelf to retrieve.
|
1209
|
+
# @param [String] source
|
1210
|
+
# String to identify the originator of this request.
|
1211
|
+
# @param [String] fields
|
1212
|
+
# Selector specifying which fields to include in a partial response.
|
1213
|
+
# @param [String] quota_user
|
1214
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1215
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1216
|
+
# @param [Google::Apis::RequestOptions] options
|
1217
|
+
# Request-specific options
|
1218
|
+
#
|
1219
|
+
# @yield [result, err] Result & error if block supplied
|
1220
|
+
# @yieldparam result [Google::Apis::BooksV1::Bookshelf] parsed result object
|
1221
|
+
# @yieldparam err [StandardError] error object if request failed
|
1222
|
+
#
|
1223
|
+
# @return [Google::Apis::BooksV1::Bookshelf]
|
1224
|
+
#
|
1225
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1226
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1227
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1228
|
+
def get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1229
|
+
command = make_simple_command(:get, 'books/v1/mylibrary/bookshelves/{shelf}', options)
|
1230
|
+
command.response_representation = Google::Apis::BooksV1::Bookshelf::Representation
|
1231
|
+
command.response_class = Google::Apis::BooksV1::Bookshelf
|
1232
|
+
command.params['shelf'] = shelf unless shelf.nil?
|
1233
|
+
command.query['source'] = source unless source.nil?
|
1234
|
+
command.query['fields'] = fields unless fields.nil?
|
1235
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1236
|
+
execute_or_queue_command(command, &block)
|
1237
|
+
end
|
1238
|
+
|
1239
|
+
# Retrieves a list of bookshelves belonging to the authenticated user.
|
1240
|
+
# @param [String] source
|
1241
|
+
# String to identify the originator of this request.
|
1242
|
+
# @param [String] fields
|
1243
|
+
# Selector specifying which fields to include in a partial response.
|
1244
|
+
# @param [String] quota_user
|
1245
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1246
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1247
|
+
# @param [Google::Apis::RequestOptions] options
|
1248
|
+
# Request-specific options
|
1249
|
+
#
|
1250
|
+
# @yield [result, err] Result & error if block supplied
|
1251
|
+
# @yieldparam result [Google::Apis::BooksV1::Bookshelves] parsed result object
|
1252
|
+
# @yieldparam err [StandardError] error object if request failed
|
1253
|
+
#
|
1254
|
+
# @return [Google::Apis::BooksV1::Bookshelves]
|
1255
|
+
#
|
1256
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1257
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1258
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1259
|
+
def list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1260
|
+
command = make_simple_command(:get, 'books/v1/mylibrary/bookshelves', options)
|
1261
|
+
command.response_representation = Google::Apis::BooksV1::Bookshelves::Representation
|
1262
|
+
command.response_class = Google::Apis::BooksV1::Bookshelves
|
1263
|
+
command.query['source'] = source unless source.nil?
|
1264
|
+
command.query['fields'] = fields unless fields.nil?
|
1265
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1266
|
+
execute_or_queue_command(command, &block)
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
# Moves a volume within a bookshelf.
|
1270
|
+
# @param [String] shelf
|
1271
|
+
# ID of bookshelf with the volume.
|
1272
|
+
# @param [String] volume_id
|
1273
|
+
# ID of volume to move.
|
1274
|
+
# @param [Fixnum] volume_position
|
1275
|
+
# Position on shelf to move the item (0 puts the item before the current first
|
1276
|
+
# item, 1 puts it between the first and the second and so on.)
|
1277
|
+
# @param [String] source
|
1278
|
+
# String to identify the originator of this request.
|
1279
|
+
# @param [String] fields
|
1280
|
+
# Selector specifying which fields to include in a partial response.
|
1281
|
+
# @param [String] quota_user
|
1282
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1283
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1284
|
+
# @param [Google::Apis::RequestOptions] options
|
1285
|
+
# Request-specific options
|
1286
|
+
#
|
1287
|
+
# @yield [result, err] Result & error if block supplied
|
1288
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
1289
|
+
# @yieldparam err [StandardError] error object if request failed
|
1290
|
+
#
|
1291
|
+
# @return [Google::Apis::BooksV1::Empty]
|
1292
|
+
#
|
1293
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1294
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1295
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1296
|
+
def move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1297
|
+
command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/moveVolume', options)
|
1298
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
1299
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
1300
|
+
command.params['shelf'] = shelf unless shelf.nil?
|
1301
|
+
command.query['source'] = source unless source.nil?
|
1302
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
1303
|
+
command.query['volumePosition'] = volume_position unless volume_position.nil?
|
1304
|
+
command.query['fields'] = fields unless fields.nil?
|
1305
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1306
|
+
execute_or_queue_command(command, &block)
|
1307
|
+
end
|
1308
|
+
|
1309
|
+
# Removes a volume from a bookshelf.
|
1310
|
+
# @param [String] shelf
|
1311
|
+
# ID of bookshelf from which to remove a volume.
|
1312
|
+
# @param [String] volume_id
|
1313
|
+
# ID of volume to remove.
|
1314
|
+
# @param [String] reason
|
1315
|
+
# The reason for which the book is removed from the library.
|
1316
|
+
# @param [String] source
|
1317
|
+
# String to identify the originator of this request.
|
1318
|
+
# @param [String] fields
|
1319
|
+
# Selector specifying which fields to include in a partial response.
|
1320
|
+
# @param [String] quota_user
|
1321
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1322
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1323
|
+
# @param [Google::Apis::RequestOptions] options
|
1324
|
+
# Request-specific options
|
1325
|
+
#
|
1326
|
+
# @yield [result, err] Result & error if block supplied
|
1327
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
1328
|
+
# @yieldparam err [StandardError] error object if request failed
|
1329
|
+
#
|
1330
|
+
# @return [Google::Apis::BooksV1::Empty]
|
1331
|
+
#
|
1332
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1333
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1334
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1335
|
+
def remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1336
|
+
command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/removeVolume', options)
|
1337
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
1338
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
1339
|
+
command.params['shelf'] = shelf unless shelf.nil?
|
1340
|
+
command.query['reason'] = reason unless reason.nil?
|
1341
|
+
command.query['source'] = source unless source.nil?
|
1342
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
1343
|
+
command.query['fields'] = fields unless fields.nil?
|
1344
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1345
|
+
execute_or_queue_command(command, &block)
|
1346
|
+
end
|
1347
|
+
|
1348
|
+
# Gets volume information for volumes on a bookshelf.
|
1349
|
+
# @param [String] shelf
|
1350
|
+
# The bookshelf ID or name retrieve volumes for.
|
1351
|
+
# @param [String] country
|
1352
|
+
# ISO-3166-1 code to override the IP-based location.
|
1353
|
+
# @param [Fixnum] max_results
|
1354
|
+
# Maximum number of results to return
|
1355
|
+
# @param [String] projection
|
1356
|
+
# Restrict information returned to a set of selected fields.
|
1357
|
+
# @param [String] q
|
1358
|
+
# Full-text search query string in this bookshelf.
|
1359
|
+
# @param [Boolean] show_preorders
|
1360
|
+
# Set to true to show pre-ordered books. Defaults to false.
|
1361
|
+
# @param [String] source
|
1362
|
+
# String to identify the originator of this request.
|
1363
|
+
# @param [Fixnum] start_index
|
1364
|
+
# Index of the first element to return (starts at 0)
|
1365
|
+
# @param [String] fields
|
1366
|
+
# Selector specifying which fields to include in a partial response.
|
1367
|
+
# @param [String] quota_user
|
1368
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1369
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1370
|
+
# @param [Google::Apis::RequestOptions] options
|
1371
|
+
# Request-specific options
|
1372
|
+
#
|
1373
|
+
# @yield [result, err] Result & error if block supplied
|
1374
|
+
# @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
|
1375
|
+
# @yieldparam err [StandardError] error object if request failed
|
1376
|
+
#
|
1377
|
+
# @return [Google::Apis::BooksV1::Volumes]
|
1378
|
+
#
|
1379
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1380
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1381
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1382
|
+
def list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1383
|
+
command = make_simple_command(:get, 'books/v1/mylibrary/bookshelves/{shelf}/volumes', options)
|
1384
|
+
command.response_representation = Google::Apis::BooksV1::Volumes::Representation
|
1385
|
+
command.response_class = Google::Apis::BooksV1::Volumes
|
1386
|
+
command.params['shelf'] = shelf unless shelf.nil?
|
1387
|
+
command.query['country'] = country unless country.nil?
|
1388
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
1389
|
+
command.query['projection'] = projection unless projection.nil?
|
1390
|
+
command.query['q'] = q unless q.nil?
|
1391
|
+
command.query['showPreorders'] = show_preorders unless show_preorders.nil?
|
1392
|
+
command.query['source'] = source unless source.nil?
|
1393
|
+
command.query['startIndex'] = start_index unless start_index.nil?
|
1394
|
+
command.query['fields'] = fields unless fields.nil?
|
1395
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1396
|
+
execute_or_queue_command(command, &block)
|
1397
|
+
end
|
1398
|
+
|
1399
|
+
# Retrieves my reading position information for a volume.
|
1400
|
+
# @param [String] volume_id
|
1401
|
+
# ID of volume for which to retrieve a reading position.
|
1402
|
+
# @param [String] content_version
|
1403
|
+
# Volume content version for which this reading position is requested.
|
1404
|
+
# @param [String] source
|
1405
|
+
# String to identify the originator of this request.
|
1406
|
+
# @param [String] fields
|
1407
|
+
# Selector specifying which fields to include in a partial response.
|
1408
|
+
# @param [String] quota_user
|
1409
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1410
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1411
|
+
# @param [Google::Apis::RequestOptions] options
|
1412
|
+
# Request-specific options
|
1413
|
+
#
|
1414
|
+
# @yield [result, err] Result & error if block supplied
|
1415
|
+
# @yieldparam result [Google::Apis::BooksV1::ReadingPosition] parsed result object
|
1416
|
+
# @yieldparam err [StandardError] error object if request failed
|
1417
|
+
#
|
1418
|
+
# @return [Google::Apis::BooksV1::ReadingPosition]
|
1419
|
+
#
|
1420
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1421
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1422
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1423
|
+
def get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1424
|
+
command = make_simple_command(:get, 'books/v1/mylibrary/readingpositions/{volumeId}', options)
|
1425
|
+
command.response_representation = Google::Apis::BooksV1::ReadingPosition::Representation
|
1426
|
+
command.response_class = Google::Apis::BooksV1::ReadingPosition
|
1427
|
+
command.params['volumeId'] = volume_id unless volume_id.nil?
|
1428
|
+
command.query['contentVersion'] = content_version unless content_version.nil?
|
1429
|
+
command.query['source'] = source unless source.nil?
|
1430
|
+
command.query['fields'] = fields unless fields.nil?
|
1431
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1432
|
+
execute_or_queue_command(command, &block)
|
1433
|
+
end
|
1434
|
+
|
1435
|
+
# Sets my reading position information for a volume.
|
1436
|
+
# @param [String] volume_id
|
1437
|
+
# ID of volume for which to update the reading position.
|
1438
|
+
# @param [String] position
|
1439
|
+
# Position string for the new volume reading position.
|
1440
|
+
# @param [String] timestamp
|
1441
|
+
# RFC 3339 UTC format timestamp associated with this reading position.
|
1442
|
+
# @param [String] action
|
1443
|
+
# Action that caused this reading position to be set.
|
1444
|
+
# @param [String] content_version
|
1445
|
+
# Volume content version for which this reading position applies.
|
1446
|
+
# @param [String] device_cookie
|
1447
|
+
# Random persistent device cookie optional on set position.
|
1448
|
+
# @param [String] source
|
1449
|
+
# String to identify the originator of this request.
|
1450
|
+
# @param [String] fields
|
1451
|
+
# Selector specifying which fields to include in a partial response.
|
1452
|
+
# @param [String] quota_user
|
1453
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1454
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1455
|
+
# @param [Google::Apis::RequestOptions] options
|
1456
|
+
# Request-specific options
|
1457
|
+
#
|
1458
|
+
# @yield [result, err] Result & error if block supplied
|
1459
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
1460
|
+
# @yieldparam err [StandardError] error object if request failed
|
1461
|
+
#
|
1462
|
+
# @return [Google::Apis::BooksV1::Empty]
|
1463
|
+
#
|
1464
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1465
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1466
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1467
|
+
def set_my_library_reading_position(volume_id, position, timestamp, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1468
|
+
command = make_simple_command(:post, 'books/v1/mylibrary/readingpositions/{volumeId}/setPosition', options)
|
1469
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
1470
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
1471
|
+
command.params['volumeId'] = volume_id unless volume_id.nil?
|
1472
|
+
command.query['action'] = action unless action.nil?
|
1473
|
+
command.query['contentVersion'] = content_version unless content_version.nil?
|
1474
|
+
command.query['deviceCookie'] = device_cookie unless device_cookie.nil?
|
1475
|
+
command.query['position'] = position unless position.nil?
|
1476
|
+
command.query['source'] = source unless source.nil?
|
1477
|
+
command.query['timestamp'] = timestamp unless timestamp.nil?
|
1478
|
+
command.query['fields'] = fields unless fields.nil?
|
1479
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1480
|
+
execute_or_queue_command(command, &block)
|
1481
|
+
end
|
1482
|
+
|
1483
|
+
# Returns notification details for a given notification id.
|
1484
|
+
# @param [String] notification_id
|
1485
|
+
# String to identify the notification.
|
1486
|
+
# @param [String] locale
|
1487
|
+
# ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
|
1488
|
+
# generating notification title and body.
|
1489
|
+
# @param [String] source
|
1490
|
+
# String to identify the originator of this request.
|
1491
|
+
# @param [String] fields
|
1492
|
+
# Selector specifying which fields to include in a partial response.
|
1493
|
+
# @param [String] quota_user
|
1494
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1495
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1496
|
+
# @param [Google::Apis::RequestOptions] options
|
1497
|
+
# Request-specific options
|
1498
|
+
#
|
1499
|
+
# @yield [result, err] Result & error if block supplied
|
1500
|
+
# @yieldparam result [Google::Apis::BooksV1::Notification] parsed result object
|
1501
|
+
# @yieldparam err [StandardError] error object if request failed
|
1502
|
+
#
|
1503
|
+
# @return [Google::Apis::BooksV1::Notification]
|
1504
|
+
#
|
1505
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1506
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1507
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1508
|
+
def get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1509
|
+
command = make_simple_command(:get, 'books/v1/notification/get', options)
|
1510
|
+
command.response_representation = Google::Apis::BooksV1::Notification::Representation
|
1511
|
+
command.response_class = Google::Apis::BooksV1::Notification
|
1512
|
+
command.query['locale'] = locale unless locale.nil?
|
1513
|
+
command.query['notification_id'] = notification_id unless notification_id.nil?
|
1514
|
+
command.query['source'] = source unless source.nil?
|
1515
|
+
command.query['fields'] = fields unless fields.nil?
|
1516
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1517
|
+
execute_or_queue_command(command, &block)
|
1518
|
+
end
|
1519
|
+
|
1520
|
+
# List categories for onboarding experience.
|
1521
|
+
# @param [String] locale
|
1522
|
+
# ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
|
1523
|
+
# @param [String] fields
|
1524
|
+
# Selector specifying which fields to include in a partial response.
|
1525
|
+
# @param [String] quota_user
|
1526
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1527
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1528
|
+
# @param [Google::Apis::RequestOptions] options
|
1529
|
+
# Request-specific options
|
1530
|
+
#
|
1531
|
+
# @yield [result, err] Result & error if block supplied
|
1532
|
+
# @yieldparam result [Google::Apis::BooksV1::Category] parsed result object
|
1533
|
+
# @yieldparam err [StandardError] error object if request failed
|
1534
|
+
#
|
1535
|
+
# @return [Google::Apis::BooksV1::Category]
|
1536
|
+
#
|
1537
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1538
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1539
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1540
|
+
def list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1541
|
+
command = make_simple_command(:get, 'books/v1/onboarding/listCategories', options)
|
1542
|
+
command.response_representation = Google::Apis::BooksV1::Category::Representation
|
1543
|
+
command.response_class = Google::Apis::BooksV1::Category
|
1544
|
+
command.query['locale'] = locale unless locale.nil?
|
1545
|
+
command.query['fields'] = fields unless fields.nil?
|
1546
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1547
|
+
execute_or_queue_command(command, &block)
|
1548
|
+
end
|
1549
|
+
|
1550
|
+
# List available volumes under categories for onboarding experience.
|
1551
|
+
# @param [Array<String>, String] category_id
|
1552
|
+
# List of category ids requested.
|
1553
|
+
# @param [String] locale
|
1554
|
+
# ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.
|
1555
|
+
# @param [String] max_allowed_maturity_rating
|
1556
|
+
# The maximum allowed maturity rating of returned volumes. Books with a higher
|
1557
|
+
# maturity rating are filtered out.
|
1558
|
+
# @param [Fixnum] page_size
|
1559
|
+
# Number of maximum results per page to be included in the response.
|
1560
|
+
# @param [String] page_token
|
1561
|
+
# The value of the nextToken from the previous page.
|
1562
|
+
# @param [String] fields
|
1563
|
+
# Selector specifying which fields to include in a partial response.
|
1564
|
+
# @param [String] quota_user
|
1565
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1566
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1567
|
+
# @param [Google::Apis::RequestOptions] options
|
1568
|
+
# Request-specific options
|
1569
|
+
#
|
1570
|
+
# @yield [result, err] Result & error if block supplied
|
1571
|
+
# @yieldparam result [Google::Apis::BooksV1::Volume2] parsed result object
|
1572
|
+
# @yieldparam err [StandardError] error object if request failed
|
1573
|
+
#
|
1574
|
+
# @return [Google::Apis::BooksV1::Volume2]
|
1575
|
+
#
|
1576
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1577
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1578
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1579
|
+
def list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1580
|
+
command = make_simple_command(:get, 'books/v1/onboarding/listCategoryVolumes', options)
|
1581
|
+
command.response_representation = Google::Apis::BooksV1::Volume2::Representation
|
1582
|
+
command.response_class = Google::Apis::BooksV1::Volume2
|
1583
|
+
command.query['categoryId'] = category_id unless category_id.nil?
|
1584
|
+
command.query['locale'] = locale unless locale.nil?
|
1585
|
+
command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
|
1586
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1587
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1588
|
+
command.query['fields'] = fields unless fields.nil?
|
1589
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1590
|
+
execute_or_queue_command(command, &block)
|
1591
|
+
end
|
1592
|
+
|
1593
|
+
# Returns a stream of personalized book clusters
|
1594
|
+
# @param [String] locale
|
1595
|
+
# ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
|
1596
|
+
# generating recommendations.
|
1597
|
+
# @param [String] max_allowed_maturity_rating
|
1598
|
+
# The maximum allowed maturity rating of returned recommendations. Books with a
|
1599
|
+
# higher maturity rating are filtered out.
|
1600
|
+
# @param [String] source
|
1601
|
+
# String to identify the originator of this request.
|
1602
|
+
# @param [String] fields
|
1603
|
+
# Selector specifying which fields to include in a partial response.
|
1604
|
+
# @param [String] quota_user
|
1605
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1606
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1607
|
+
# @param [Google::Apis::RequestOptions] options
|
1608
|
+
# Request-specific options
|
1609
|
+
#
|
1610
|
+
# @yield [result, err] Result & error if block supplied
|
1611
|
+
# @yieldparam result [Google::Apis::BooksV1::Discoveryclusters] parsed result object
|
1612
|
+
# @yieldparam err [StandardError] error object if request failed
|
1613
|
+
#
|
1614
|
+
# @return [Google::Apis::BooksV1::Discoveryclusters]
|
1615
|
+
#
|
1616
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1617
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1618
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1619
|
+
def get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1620
|
+
command = make_simple_command(:get, 'books/v1/personalizedstream/get', options)
|
1621
|
+
command.response_representation = Google::Apis::BooksV1::Discoveryclusters::Representation
|
1622
|
+
command.response_class = Google::Apis::BooksV1::Discoveryclusters
|
1623
|
+
command.query['locale'] = locale unless locale.nil?
|
1624
|
+
command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
|
1625
|
+
command.query['source'] = source unless source.nil?
|
1626
|
+
command.query['fields'] = fields unless fields.nil?
|
1627
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1628
|
+
execute_or_queue_command(command, &block)
|
1629
|
+
end
|
1630
|
+
|
1631
|
+
# Accepts the promo offer.
|
1632
|
+
# @param [String] android_id
|
1633
|
+
# device android_id
|
1634
|
+
# @param [String] device
|
1635
|
+
# device device
|
1636
|
+
# @param [String] manufacturer
|
1637
|
+
# device manufacturer
|
1638
|
+
# @param [String] model
|
1639
|
+
# device model
|
1640
|
+
# @param [String] offer_id
|
1641
|
+
# @param [String] product
|
1642
|
+
# device product
|
1643
|
+
# @param [String] serial
|
1644
|
+
# device serial
|
1645
|
+
# @param [String] volume_id
|
1646
|
+
# Volume id to exercise the offer
|
1647
|
+
# @param [String] fields
|
1648
|
+
# Selector specifying which fields to include in a partial response.
|
1649
|
+
# @param [String] quota_user
|
1650
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1651
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1652
|
+
# @param [Google::Apis::RequestOptions] options
|
1653
|
+
# Request-specific options
|
1654
|
+
#
|
1655
|
+
# @yield [result, err] Result & error if block supplied
|
1656
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
1657
|
+
# @yieldparam err [StandardError] error object if request failed
|
1658
|
+
#
|
1659
|
+
# @return [Google::Apis::BooksV1::Empty]
|
1660
|
+
#
|
1661
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1662
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1663
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1664
|
+
def accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1665
|
+
command = make_simple_command(:post, 'books/v1/promooffer/accept', options)
|
1666
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
1667
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
1668
|
+
command.query['androidId'] = android_id unless android_id.nil?
|
1669
|
+
command.query['device'] = device unless device.nil?
|
1670
|
+
command.query['manufacturer'] = manufacturer unless manufacturer.nil?
|
1671
|
+
command.query['model'] = model unless model.nil?
|
1672
|
+
command.query['offerId'] = offer_id unless offer_id.nil?
|
1673
|
+
command.query['product'] = product unless product.nil?
|
1674
|
+
command.query['serial'] = serial unless serial.nil?
|
1675
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
1676
|
+
command.query['fields'] = fields unless fields.nil?
|
1677
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1678
|
+
execute_or_queue_command(command, &block)
|
1679
|
+
end
|
1680
|
+
|
1681
|
+
# Marks the promo offer as dismissed.
|
1682
|
+
# @param [String] android_id
|
1683
|
+
# device android_id
|
1684
|
+
# @param [String] device
|
1685
|
+
# device device
|
1686
|
+
# @param [String] manufacturer
|
1687
|
+
# device manufacturer
|
1688
|
+
# @param [String] model
|
1689
|
+
# device model
|
1690
|
+
# @param [String] offer_id
|
1691
|
+
# Offer to dimiss
|
1692
|
+
# @param [String] product
|
1693
|
+
# device product
|
1694
|
+
# @param [String] serial
|
1695
|
+
# device serial
|
1696
|
+
# @param [String] fields
|
1697
|
+
# Selector specifying which fields to include in a partial response.
|
1698
|
+
# @param [String] quota_user
|
1699
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1700
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1701
|
+
# @param [Google::Apis::RequestOptions] options
|
1702
|
+
# Request-specific options
|
1703
|
+
#
|
1704
|
+
# @yield [result, err] Result & error if block supplied
|
1705
|
+
# @yieldparam result [Google::Apis::BooksV1::Empty] parsed result object
|
1706
|
+
# @yieldparam err [StandardError] error object if request failed
|
1707
|
+
#
|
1708
|
+
# @return [Google::Apis::BooksV1::Empty]
|
1709
|
+
#
|
1710
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1711
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1712
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1713
|
+
def dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1714
|
+
command = make_simple_command(:post, 'books/v1/promooffer/dismiss', options)
|
1715
|
+
command.response_representation = Google::Apis::BooksV1::Empty::Representation
|
1716
|
+
command.response_class = Google::Apis::BooksV1::Empty
|
1717
|
+
command.query['androidId'] = android_id unless android_id.nil?
|
1718
|
+
command.query['device'] = device unless device.nil?
|
1719
|
+
command.query['manufacturer'] = manufacturer unless manufacturer.nil?
|
1720
|
+
command.query['model'] = model unless model.nil?
|
1721
|
+
command.query['offerId'] = offer_id unless offer_id.nil?
|
1722
|
+
command.query['product'] = product unless product.nil?
|
1723
|
+
command.query['serial'] = serial unless serial.nil?
|
1724
|
+
command.query['fields'] = fields unless fields.nil?
|
1725
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1726
|
+
execute_or_queue_command(command, &block)
|
1727
|
+
end
|
1728
|
+
|
1729
|
+
# Returns a list of promo offers available to the user
|
1730
|
+
# @param [String] android_id
|
1731
|
+
# device android_id
|
1732
|
+
# @param [String] device
|
1733
|
+
# device device
|
1734
|
+
# @param [String] manufacturer
|
1735
|
+
# device manufacturer
|
1736
|
+
# @param [String] model
|
1737
|
+
# device model
|
1738
|
+
# @param [String] product
|
1739
|
+
# device product
|
1740
|
+
# @param [String] serial
|
1741
|
+
# device serial
|
1742
|
+
# @param [String] fields
|
1743
|
+
# Selector specifying which fields to include in a partial response.
|
1744
|
+
# @param [String] quota_user
|
1745
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1746
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1747
|
+
# @param [Google::Apis::RequestOptions] options
|
1748
|
+
# Request-specific options
|
1749
|
+
#
|
1750
|
+
# @yield [result, err] Result & error if block supplied
|
1751
|
+
# @yieldparam result [Google::Apis::BooksV1::Offers] parsed result object
|
1752
|
+
# @yieldparam err [StandardError] error object if request failed
|
1753
|
+
#
|
1754
|
+
# @return [Google::Apis::BooksV1::Offers]
|
1755
|
+
#
|
1756
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1757
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1758
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1759
|
+
def get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1760
|
+
command = make_simple_command(:get, 'books/v1/promooffer/get', options)
|
1761
|
+
command.response_representation = Google::Apis::BooksV1::Offers::Representation
|
1762
|
+
command.response_class = Google::Apis::BooksV1::Offers
|
1763
|
+
command.query['androidId'] = android_id unless android_id.nil?
|
1764
|
+
command.query['device'] = device unless device.nil?
|
1765
|
+
command.query['manufacturer'] = manufacturer unless manufacturer.nil?
|
1766
|
+
command.query['model'] = model unless model.nil?
|
1767
|
+
command.query['product'] = product unless product.nil?
|
1768
|
+
command.query['serial'] = serial unless serial.nil?
|
1769
|
+
command.query['fields'] = fields unless fields.nil?
|
1770
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1771
|
+
execute_or_queue_command(command, &block)
|
1772
|
+
end
|
1773
|
+
|
1774
|
+
# Returns Series metadata for the given series ids.
|
1775
|
+
# @param [Array<String>, String] series_id
|
1776
|
+
# String that identifies the series
|
1777
|
+
# @param [String] fields
|
1778
|
+
# Selector specifying which fields to include in a partial response.
|
1779
|
+
# @param [String] quota_user
|
1780
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1781
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1782
|
+
# @param [Google::Apis::RequestOptions] options
|
1783
|
+
# Request-specific options
|
1784
|
+
#
|
1785
|
+
# @yield [result, err] Result & error if block supplied
|
1786
|
+
# @yieldparam result [Google::Apis::BooksV1::Series] parsed result object
|
1787
|
+
# @yieldparam err [StandardError] error object if request failed
|
1788
|
+
#
|
1789
|
+
# @return [Google::Apis::BooksV1::Series]
|
1790
|
+
#
|
1791
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1792
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1793
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1794
|
+
def get_series(series_id, fields: nil, quota_user: nil, options: nil, &block)
|
1795
|
+
command = make_simple_command(:get, 'books/v1/series/get', options)
|
1796
|
+
command.response_representation = Google::Apis::BooksV1::Series::Representation
|
1797
|
+
command.response_class = Google::Apis::BooksV1::Series
|
1798
|
+
command.query['series_id'] = series_id unless series_id.nil?
|
1799
|
+
command.query['fields'] = fields unless fields.nil?
|
1800
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1801
|
+
execute_or_queue_command(command, &block)
|
1802
|
+
end
|
1803
|
+
|
1804
|
+
# Returns Series membership data given the series id.
|
1805
|
+
# @param [String] series_id
|
1806
|
+
# String that identifies the series
|
1807
|
+
# @param [Fixnum] page_size
|
1808
|
+
# Number of maximum results per page to be included in the response.
|
1809
|
+
# @param [String] page_token
|
1810
|
+
# The value of the nextToken from the previous page.
|
1811
|
+
# @param [String] fields
|
1812
|
+
# Selector specifying which fields to include in a partial response.
|
1813
|
+
# @param [String] quota_user
|
1814
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1815
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1816
|
+
# @param [Google::Apis::RequestOptions] options
|
1817
|
+
# Request-specific options
|
1818
|
+
#
|
1819
|
+
# @yield [result, err] Result & error if block supplied
|
1820
|
+
# @yieldparam result [Google::Apis::BooksV1::SeriesMembership] parsed result object
|
1821
|
+
# @yieldparam err [StandardError] error object if request failed
|
1822
|
+
#
|
1823
|
+
# @return [Google::Apis::BooksV1::SeriesMembership]
|
1824
|
+
#
|
1825
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1826
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1827
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1828
|
+
def get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1829
|
+
command = make_simple_command(:get, 'books/v1/series/membership/get', options)
|
1830
|
+
command.response_representation = Google::Apis::BooksV1::SeriesMembership::Representation
|
1831
|
+
command.response_class = Google::Apis::BooksV1::SeriesMembership
|
1832
|
+
command.query['page_size'] = page_size unless page_size.nil?
|
1833
|
+
command.query['page_token'] = page_token unless page_token.nil?
|
1834
|
+
command.query['series_id'] = series_id unless series_id.nil?
|
1835
|
+
command.query['fields'] = fields unless fields.nil?
|
1836
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1837
|
+
execute_or_queue_command(command, &block)
|
1838
|
+
end
|
1839
|
+
|
1840
|
+
# Gets volume information for a single volume.
|
1841
|
+
# @param [String] volume_id
|
1842
|
+
# ID of volume to retrieve.
|
1843
|
+
# @param [String] country
|
1844
|
+
# ISO-3166-1 code to override the IP-based location.
|
1845
|
+
# @param [Boolean] include_non_comics_series
|
1846
|
+
# Set to true to include non-comics series. Defaults to false.
|
1847
|
+
# @param [String] partner
|
1848
|
+
# Brand results for partner ID.
|
1849
|
+
# @param [String] projection
|
1850
|
+
# Restrict information returned to a set of selected fields.
|
1851
|
+
# @param [String] source
|
1852
|
+
# string to identify the originator of this request.
|
1853
|
+
# @param [Boolean] user_library_consistent_read
|
1854
|
+
# @param [String] fields
|
1855
|
+
# Selector specifying which fields to include in a partial response.
|
1856
|
+
# @param [String] quota_user
|
1857
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1858
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1859
|
+
# @param [Google::Apis::RequestOptions] options
|
1860
|
+
# Request-specific options
|
1861
|
+
#
|
1862
|
+
# @yield [result, err] Result & error if block supplied
|
1863
|
+
# @yieldparam result [Google::Apis::BooksV1::Volume] parsed result object
|
1864
|
+
# @yieldparam err [StandardError] error object if request failed
|
1865
|
+
#
|
1866
|
+
# @return [Google::Apis::BooksV1::Volume]
|
1867
|
+
#
|
1868
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1869
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1870
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1871
|
+
def get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1872
|
+
command = make_simple_command(:get, 'books/v1/volumes/{volumeId}', options)
|
1873
|
+
command.response_representation = Google::Apis::BooksV1::Volume::Representation
|
1874
|
+
command.response_class = Google::Apis::BooksV1::Volume
|
1875
|
+
command.params['volumeId'] = volume_id unless volume_id.nil?
|
1876
|
+
command.query['country'] = country unless country.nil?
|
1877
|
+
command.query['includeNonComicsSeries'] = include_non_comics_series unless include_non_comics_series.nil?
|
1878
|
+
command.query['partner'] = partner unless partner.nil?
|
1879
|
+
command.query['projection'] = projection unless projection.nil?
|
1880
|
+
command.query['source'] = source unless source.nil?
|
1881
|
+
command.query['user_library_consistent_read'] = user_library_consistent_read unless user_library_consistent_read.nil?
|
1882
|
+
command.query['fields'] = fields unless fields.nil?
|
1883
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1884
|
+
execute_or_queue_command(command, &block)
|
1885
|
+
end
|
1886
|
+
|
1887
|
+
# Performs a book search.
|
1888
|
+
# @param [String] q
|
1889
|
+
# Full-text search query string.
|
1890
|
+
# @param [String] download
|
1891
|
+
# Restrict to volumes by download availability.
|
1892
|
+
# @param [String] filter
|
1893
|
+
# Filter search results.
|
1894
|
+
# @param [String] lang_restrict
|
1895
|
+
# Restrict results to books with this language code.
|
1896
|
+
# @param [String] library_restrict
|
1897
|
+
# Restrict search to this user's library.
|
1898
|
+
# @param [String] max_allowed_maturity_rating
|
1899
|
+
# The maximum allowed maturity rating of returned recommendations. Books with a
|
1900
|
+
# higher maturity rating are filtered out.
|
1901
|
+
# @param [Fixnum] max_results
|
1902
|
+
# Maximum number of results to return.
|
1903
|
+
# @param [String] order_by
|
1904
|
+
# Sort search results.
|
1905
|
+
# @param [String] partner
|
1906
|
+
# Restrict and brand results for partner ID.
|
1907
|
+
# @param [String] print_type
|
1908
|
+
# Restrict to books or magazines.
|
1909
|
+
# @param [String] projection
|
1910
|
+
# Restrict information returned to a set of selected fields.
|
1911
|
+
# @param [Boolean] show_preorders
|
1912
|
+
# Set to true to show books available for preorder. Defaults to false.
|
1913
|
+
# @param [String] source
|
1914
|
+
# String to identify the originator of this request.
|
1915
|
+
# @param [Fixnum] start_index
|
1916
|
+
# Index of the first result to return (starts at 0)
|
1917
|
+
# @param [String] fields
|
1918
|
+
# Selector specifying which fields to include in a partial response.
|
1919
|
+
# @param [String] quota_user
|
1920
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1921
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1922
|
+
# @param [Google::Apis::RequestOptions] options
|
1923
|
+
# Request-specific options
|
1924
|
+
#
|
1925
|
+
# @yield [result, err] Result & error if block supplied
|
1926
|
+
# @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
|
1927
|
+
# @yieldparam err [StandardError] error object if request failed
|
1928
|
+
#
|
1929
|
+
# @return [Google::Apis::BooksV1::Volumes]
|
1930
|
+
#
|
1931
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1932
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1933
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1934
|
+
def list_volumes(q, download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_allowed_maturity_rating: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1935
|
+
command = make_simple_command(:get, 'books/v1/volumes', options)
|
1936
|
+
command.response_representation = Google::Apis::BooksV1::Volumes::Representation
|
1937
|
+
command.response_class = Google::Apis::BooksV1::Volumes
|
1938
|
+
command.query['download'] = download unless download.nil?
|
1939
|
+
command.query['filter'] = filter unless filter.nil?
|
1940
|
+
command.query['langRestrict'] = lang_restrict unless lang_restrict.nil?
|
1941
|
+
command.query['libraryRestrict'] = library_restrict unless library_restrict.nil?
|
1942
|
+
command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
|
1943
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
1944
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
1945
|
+
command.query['partner'] = partner unless partner.nil?
|
1946
|
+
command.query['printType'] = print_type unless print_type.nil?
|
1947
|
+
command.query['projection'] = projection unless projection.nil?
|
1948
|
+
command.query['q'] = q unless q.nil?
|
1949
|
+
command.query['showPreorders'] = show_preorders unless show_preorders.nil?
|
1950
|
+
command.query['source'] = source unless source.nil?
|
1951
|
+
command.query['startIndex'] = start_index unless start_index.nil?
|
1952
|
+
command.query['fields'] = fields unless fields.nil?
|
1953
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1954
|
+
execute_or_queue_command(command, &block)
|
1955
|
+
end
|
1956
|
+
|
1957
|
+
# Return a list of associated books.
|
1958
|
+
# @param [String] volume_id
|
1959
|
+
# ID of the source volume.
|
1960
|
+
# @param [String] association
|
1961
|
+
# Association type.
|
1962
|
+
# @param [String] locale
|
1963
|
+
# ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
|
1964
|
+
# generating recommendations.
|
1965
|
+
# @param [String] max_allowed_maturity_rating
|
1966
|
+
# The maximum allowed maturity rating of returned recommendations. Books with a
|
1967
|
+
# higher maturity rating are filtered out.
|
1968
|
+
# @param [String] source
|
1969
|
+
# String to identify the originator of this request.
|
1970
|
+
# @param [String] fields
|
1971
|
+
# Selector specifying which fields to include in a partial response.
|
1972
|
+
# @param [String] quota_user
|
1973
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1974
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1975
|
+
# @param [Google::Apis::RequestOptions] options
|
1976
|
+
# Request-specific options
|
1977
|
+
#
|
1978
|
+
# @yield [result, err] Result & error if block supplied
|
1979
|
+
# @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
|
1980
|
+
# @yieldparam err [StandardError] error object if request failed
|
1981
|
+
#
|
1982
|
+
# @return [Google::Apis::BooksV1::Volumes]
|
1983
|
+
#
|
1984
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1985
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1986
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1987
|
+
def list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1988
|
+
command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/associated', options)
|
1989
|
+
command.response_representation = Google::Apis::BooksV1::Volumes::Representation
|
1990
|
+
command.response_class = Google::Apis::BooksV1::Volumes
|
1991
|
+
command.params['volumeId'] = volume_id unless volume_id.nil?
|
1992
|
+
command.query['association'] = association unless association.nil?
|
1993
|
+
command.query['locale'] = locale unless locale.nil?
|
1994
|
+
command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
|
1995
|
+
command.query['source'] = source unless source.nil?
|
1996
|
+
command.query['fields'] = fields unless fields.nil?
|
1997
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1998
|
+
execute_or_queue_command(command, &block)
|
1999
|
+
end
|
2000
|
+
|
2001
|
+
# Return a list of books in My Library.
|
2002
|
+
# @param [Array<String>, String] acquire_method
|
2003
|
+
# How the book was acquired
|
2004
|
+
# @param [String] country
|
2005
|
+
# ISO-3166-1 code to override the IP-based location.
|
2006
|
+
# @param [String] locale
|
2007
|
+
# ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for
|
2008
|
+
# generating recommendations.
|
2009
|
+
# @param [Fixnum] max_results
|
2010
|
+
# Maximum number of results to return.
|
2011
|
+
# @param [Array<String>, String] processing_state
|
2012
|
+
# The processing state of the user uploaded volumes to be returned. Applicable
|
2013
|
+
# only if the UPLOADED is specified in the acquireMethod.
|
2014
|
+
# @param [String] source
|
2015
|
+
# String to identify the originator of this request.
|
2016
|
+
# @param [Fixnum] start_index
|
2017
|
+
# Index of the first result to return (starts at 0)
|
2018
|
+
# @param [String] fields
|
2019
|
+
# Selector specifying which fields to include in a partial response.
|
2020
|
+
# @param [String] quota_user
|
2021
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2022
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2023
|
+
# @param [Google::Apis::RequestOptions] options
|
2024
|
+
# Request-specific options
|
2025
|
+
#
|
2026
|
+
# @yield [result, err] Result & error if block supplied
|
2027
|
+
# @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
|
2028
|
+
# @yieldparam err [StandardError] error object if request failed
|
2029
|
+
#
|
2030
|
+
# @return [Google::Apis::BooksV1::Volumes]
|
2031
|
+
#
|
2032
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2033
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2034
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2035
|
+
def list_my_books(acquire_method: nil, country: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2036
|
+
command = make_simple_command(:get, 'books/v1/volumes/mybooks', options)
|
2037
|
+
command.response_representation = Google::Apis::BooksV1::Volumes::Representation
|
2038
|
+
command.response_class = Google::Apis::BooksV1::Volumes
|
2039
|
+
command.query['acquireMethod'] = acquire_method unless acquire_method.nil?
|
2040
|
+
command.query['country'] = country unless country.nil?
|
2041
|
+
command.query['locale'] = locale unless locale.nil?
|
2042
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
2043
|
+
command.query['processingState'] = processing_state unless processing_state.nil?
|
2044
|
+
command.query['source'] = source unless source.nil?
|
2045
|
+
command.query['startIndex'] = start_index unless start_index.nil?
|
2046
|
+
command.query['fields'] = fields unless fields.nil?
|
2047
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2048
|
+
execute_or_queue_command(command, &block)
|
2049
|
+
end
|
2050
|
+
|
2051
|
+
# Return a list of recommended books for the current user.
|
2052
|
+
# @param [String] locale
|
2053
|
+
# ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
|
2054
|
+
# generating recommendations.
|
2055
|
+
# @param [String] max_allowed_maturity_rating
|
2056
|
+
# The maximum allowed maturity rating of returned recommendations. Books with a
|
2057
|
+
# higher maturity rating are filtered out.
|
2058
|
+
# @param [String] source
|
2059
|
+
# String to identify the originator of this request.
|
2060
|
+
# @param [String] fields
|
2061
|
+
# Selector specifying which fields to include in a partial response.
|
2062
|
+
# @param [String] quota_user
|
2063
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2064
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2065
|
+
# @param [Google::Apis::RequestOptions] options
|
2066
|
+
# Request-specific options
|
2067
|
+
#
|
2068
|
+
# @yield [result, err] Result & error if block supplied
|
2069
|
+
# @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
|
2070
|
+
# @yieldparam err [StandardError] error object if request failed
|
2071
|
+
#
|
2072
|
+
# @return [Google::Apis::BooksV1::Volumes]
|
2073
|
+
#
|
2074
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2075
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2076
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2077
|
+
def list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2078
|
+
command = make_simple_command(:get, 'books/v1/volumes/recommended', options)
|
2079
|
+
command.response_representation = Google::Apis::BooksV1::Volumes::Representation
|
2080
|
+
command.response_class = Google::Apis::BooksV1::Volumes
|
2081
|
+
command.query['locale'] = locale unless locale.nil?
|
2082
|
+
command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
|
2083
|
+
command.query['source'] = source unless source.nil?
|
2084
|
+
command.query['fields'] = fields unless fields.nil?
|
2085
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2086
|
+
execute_or_queue_command(command, &block)
|
2087
|
+
end
|
2088
|
+
|
2089
|
+
# Rate a recommended book for the current user.
|
2090
|
+
# @param [String] rating
|
2091
|
+
# Rating to be given to the volume.
|
2092
|
+
# @param [String] volume_id
|
2093
|
+
# ID of the source volume.
|
2094
|
+
# @param [String] locale
|
2095
|
+
# ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
|
2096
|
+
# generating recommendations.
|
2097
|
+
# @param [String] source
|
2098
|
+
# String to identify the originator of this request.
|
2099
|
+
# @param [String] fields
|
2100
|
+
# Selector specifying which fields to include in a partial response.
|
2101
|
+
# @param [String] quota_user
|
2102
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2103
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2104
|
+
# @param [Google::Apis::RequestOptions] options
|
2105
|
+
# Request-specific options
|
2106
|
+
#
|
2107
|
+
# @yield [result, err] Result & error if block supplied
|
2108
|
+
# @yieldparam result [Google::Apis::BooksV1::RateRecommendedVolumeResponse] parsed result object
|
2109
|
+
# @yieldparam err [StandardError] error object if request failed
|
2110
|
+
#
|
2111
|
+
# @return [Google::Apis::BooksV1::RateRecommendedVolumeResponse]
|
2112
|
+
#
|
2113
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2114
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2115
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2116
|
+
def rate_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2117
|
+
command = make_simple_command(:post, 'books/v1/volumes/recommended/rate', options)
|
2118
|
+
command.response_representation = Google::Apis::BooksV1::RateRecommendedVolumeResponse::Representation
|
2119
|
+
command.response_class = Google::Apis::BooksV1::RateRecommendedVolumeResponse
|
2120
|
+
command.query['locale'] = locale unless locale.nil?
|
2121
|
+
command.query['rating'] = rating unless rating.nil?
|
2122
|
+
command.query['source'] = source unless source.nil?
|
2123
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
2124
|
+
command.query['fields'] = fields unless fields.nil?
|
2125
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2126
|
+
execute_or_queue_command(command, &block)
|
2127
|
+
end
|
2128
|
+
|
2129
|
+
# Return a list of books uploaded by the current user.
|
2130
|
+
# @param [String] locale
|
2131
|
+
# ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for
|
2132
|
+
# generating recommendations.
|
2133
|
+
# @param [Fixnum] max_results
|
2134
|
+
# Maximum number of results to return.
|
2135
|
+
# @param [Array<String>, String] processing_state
|
2136
|
+
# The processing state of the user uploaded volumes to be returned.
|
2137
|
+
# @param [String] source
|
2138
|
+
# String to identify the originator of this request.
|
2139
|
+
# @param [Fixnum] start_index
|
2140
|
+
# Index of the first result to return (starts at 0)
|
2141
|
+
# @param [Array<String>, String] volume_id
|
2142
|
+
# The ids of the volumes to be returned. If not specified all that match the
|
2143
|
+
# processingState are returned.
|
2144
|
+
# @param [String] fields
|
2145
|
+
# Selector specifying which fields to include in a partial response.
|
2146
|
+
# @param [String] quota_user
|
2147
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
2148
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
2149
|
+
# @param [Google::Apis::RequestOptions] options
|
2150
|
+
# Request-specific options
|
2151
|
+
#
|
2152
|
+
# @yield [result, err] Result & error if block supplied
|
2153
|
+
# @yieldparam result [Google::Apis::BooksV1::Volumes] parsed result object
|
2154
|
+
# @yieldparam err [StandardError] error object if request failed
|
2155
|
+
#
|
2156
|
+
# @return [Google::Apis::BooksV1::Volumes]
|
2157
|
+
#
|
2158
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2159
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2160
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2161
|
+
def list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2162
|
+
command = make_simple_command(:get, 'books/v1/volumes/useruploaded', options)
|
2163
|
+
command.response_representation = Google::Apis::BooksV1::Volumes::Representation
|
2164
|
+
command.response_class = Google::Apis::BooksV1::Volumes
|
2165
|
+
command.query['locale'] = locale unless locale.nil?
|
2166
|
+
command.query['maxResults'] = max_results unless max_results.nil?
|
2167
|
+
command.query['processingState'] = processing_state unless processing_state.nil?
|
2168
|
+
command.query['source'] = source unless source.nil?
|
2169
|
+
command.query['startIndex'] = start_index unless start_index.nil?
|
2170
|
+
command.query['volumeId'] = volume_id unless volume_id.nil?
|
2171
|
+
command.query['fields'] = fields unless fields.nil?
|
2172
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2173
|
+
execute_or_queue_command(command, &block)
|
2174
|
+
end
|
2175
|
+
|
2176
|
+
protected
|
2177
|
+
|
2178
|
+
def apply_command_defaults(command)
|
2179
|
+
command.query['key'] = key unless key.nil?
|
2180
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2181
|
+
end
|
2182
|
+
end
|
2183
|
+
end
|
2184
|
+
end
|
2185
|
+
end
|