Class: Google::Apis::BooksV1::BooksService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/books_v1/service.rb

Overview

Books API

Searches for books and manages your Google Books library.

Examples:

require 'google/apis/books_v1'

Books = Google::Apis::BooksV1 # Alias the module
service = Books::BooksService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeBooksService

Returns a new instance of BooksService


49
50
51
52
# File 'generated/google/apis/books_v1/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'books/v1/')
  @batch_path = 'batch/books/v1'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


38
39
40
# File 'generated/google/apis/books_v1/service.rb', line 38

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.


43
44
45
# File 'generated/google/apis/books_v1/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.


47
48
49
# File 'generated/google/apis/books_v1/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#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, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Parameters:

  • android_id (String)

    device android_id

  • device (String)

    device device

  • manufacturer (String)

    device manufacturer

  • model (String)

    device model

  • offer_id (String)
  • product (String)

    device product

  • serial (String)

    device serial

  • volume_id (String)

    Volume id to exercise the offer

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'generated/google/apis/books_v1/service.rb', line 1763

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'promooffer/accept', options)
  command.query['androidId'] = android_id unless android_id.nil?
  command.query['device'] = device unless device.nil?
  command.query['manufacturer'] = manufacturer unless manufacturer.nil?
  command.query['model'] = model unless model.nil?
  command.query['offerId'] = offer_id unless offer_id.nil?
  command.query['product'] = product unless product.nil?
  command.query['serial'] = serial unless serial.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LoadingResource

Parameters:

  • drive_document_id (String)

    A drive document id. The upload_client_token must not be set.

  • mime_type (String)

    The document MIME type. It can be set only if the drive_document_id is set.

  • name (String)

    The document name. It can be set only if the drive_document_id is set.

  • upload_client_token (String)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'generated/google/apis/books_v1/service.rb', line 204

def add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'cloudloading/addBook', options)
  command.response_representation = Google::Apis::BooksV1::LoadingResource::Representation
  command.response_class = Google::Apis::BooksV1::LoadingResource
  command.query['drive_document_id'] = drive_document_id unless drive_document_id.nil?
  command.query['mime_type'] = mime_type unless mime_type.nil?
  command.query['name'] = name unless name.nil?
  command.query['upload_client_token'] = upload_client_token unless upload_client_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Adds a volume to a bookshelf.

Parameters:

  • shelf (String)

    ID of bookshelf to which to add a volume.

  • volume_id (String)

    ID of volume to add.

  • reason (String)

    The reason for which the book is added to the library.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
# File 'generated/google/apis/books_v1/service.rb', line 1229

def add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/addVolume', options)
  command.params['shelf'] = shelf unless shelf.nil?
  command.query['reason'] = reason unless reason.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Clears all volumes from a bookshelf.

Parameters:

  • shelf (String)

    ID of bookshelf from which to remove a volume.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'generated/google/apis/books_v1/service.rb', line 1265

def clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/clearVolumes', options)
  command.params['shelf'] = shelf unless shelf.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_book(volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Remove the book and its contents

Parameters:

  • volume_id (String)

    The id of the book to be removed.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


240
241
242
243
244
245
246
247
# File 'generated/google/apis/books_v1/service.rb', line 240

def delete_book(volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'cloudloading/deleteBook', options)
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes an annotation.

Parameters:

  • annotation_id (String)

    The ID for the annotation to delete.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1007
1008
1009
1010
1011
1012
1013
1014
1015
# File 'generated/google/apis/books_v1/service.rb', line 1007

def delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'mylibrary/annotations/{annotationId}', options)
  command.params['annotationId'] = annotation_id unless annotation_id.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Parameters:

  • android_id (String)

    device android_id

  • device (String)

    device device

  • manufacturer (String)

    device manufacturer

  • model (String)

    device model

  • offer_id (String)

    Offer to dimiss

  • product (String)

    device product

  • serial (String)

    device serial

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
# File 'generated/google/apis/books_v1/service.rb', line 1813

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'promooffer/dismiss', options)
  command.query['androidId'] = android_id unless android_id.nil?
  command.query['device'] = device unless device.nil?
  command.query['manufacturer'] = manufacturer unless manufacturer.nil?
  command.query['model'] = model unless model.nil?
  command.query['offerId'] = offer_id unless offer_id.nil?
  command.query['product'] = product unless product.nil?
  command.query['serial'] = serial unless serial.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelf

Retrieves metadata for a specific bookshelf for the specified user.

Parameters:

  • user_id (String)

    ID of user for whom to retrieve bookshelves.

  • shelf (String)

    ID of bookshelf to retrieve.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


80
81
82
83
84
85
86
87
88
89
90
91
# File 'generated/google/apis/books_v1/service.rb', line 80

def get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/{userId}/bookshelves/{shelf}', options)
  command.response_representation = Google::Apis::BooksV1::Bookshelf::Representation
  command.response_class = Google::Apis::BooksV1::Bookshelf
  command.params['userId'] = user_id unless user_id.nil?
  command.params['shelf'] = shelf unless shelf.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_familysharing_family_info(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::FamilyInfo

Gets information regarding the family that the user is part of.

Parameters:

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


337
338
339
340
341
342
343
344
345
346
# File 'generated/google/apis/books_v1/service.rb', line 337

def get_familysharing_family_info(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'familysharing/getFamilyInfo', options)
  command.response_representation = Google::Apis::BooksV1::FamilyInfo::Representation
  command.response_class = Google::Apis::BooksV1::FamilyInfo
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LayerSummary

Gets the layer summary for a volume.

Parameters:

  • volume_id (String)

    The volume to retrieve layers for.

  • summary_id (String)

    The ID for the layer to get the summary for.

  • content_version (String)

    The content version for the requested volume.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


452
453
454
455
456
457
458
459
460
461
462
463
464
# File 'generated/google/apis/books_v1/service.rb', line 452

def get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/{volumeId}/layersummary/{summaryId}', options)
  command.response_representation = Google::Apis::BooksV1::LayerSummary::Representation
  command.response_class = Google::Apis::BooksV1::LayerSummary
  command.params['volumeId'] = volume_id unless volume_id.nil?
  command.params['summaryId'] = summary_id unless summary_id.nil?
  command.query['contentVersion'] = content_version unless content_version.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::AnnotationData

Gets the annotation data.

Parameters:

  • volume_id (String)

    The volume to retrieve annotations for.

  • layer_id (String)

    The ID for the layer to get the annotations.

  • annotation_data_id (String)

    The ID of the annotation data to retrieve.

  • content_version (String)

    The content version for the volume you are trying to retrieve.

  • allow_web_definitions (Boolean)

    For the dictionary layer. Whether or not to allow web definitions.

  • h (Fixnum)

    The requested pixel height for any images. If height is provided width must also be provided.

  • locale (String)

    The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

  • scale (Fixnum)

    The requested scale for the image.

  • source (String)

    String to identify the originator of this request.

  • w (Fixnum)

    The requested pixel width for any images. If width is provided height must also be provided.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
# File 'generated/google/apis/books_v1/service.rb', line 554

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}', options)
  command.response_representation = Google::Apis::BooksV1::AnnotationData::Representation
  command.response_class = Google::Apis::BooksV1::AnnotationData
  command.params['volumeId'] = volume_id unless volume_id.nil?
  command.params['layerId'] = layer_id unless layer_id.nil?
  command.params['annotationDataId'] = annotation_data_id unless annotation_data_id.nil?
  command.query['allowWebDefinitions'] = allow_web_definitions unless allow_web_definitions.nil?
  command.query['contentVersion'] = content_version unless content_version.nil?
  command.query['h'] = h unless h.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['scale'] = scale unless scale.nil?
  command.query['source'] = source unless source.nil?
  command.query['w'] = w unless w.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::VolumeAnnotation

Gets the volume annotation.

Parameters:

  • volume_id (String)

    The volume to retrieve annotations for.

  • layer_id (String)

    The ID for the layer to get the annotations.

  • annotation_id (String)

    The ID of the volume annotation to retrieve.

  • locale (String)

    The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


680
681
682
683
684
685
686
687
688
689
690
691
692
693
# File 'generated/google/apis/books_v1/service.rb', line 680

def get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}', options)
  command.response_representation = Google::Apis::BooksV1::VolumeAnnotation::Representation
  command.response_class = Google::Apis::BooksV1::VolumeAnnotation
  command.params['volumeId'] = volume_id unless volume_id.nil?
  command.params['layerId'] = layer_id unless layer_id.nil?
  command.params['annotationId'] = annotation_id unless annotation_id.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelf

Retrieves metadata for a specific bookshelf belonging to the authenticated user.

Parameters:

  • shelf (String)

    ID of bookshelf to retrieve.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
# File 'generated/google/apis/books_v1/service.rb', line 1300

def get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'mylibrary/bookshelves/{shelf}', options)
  command.response_representation = Google::Apis::BooksV1::Bookshelf::Representation
  command.response_class = Google::Apis::BooksV1::Bookshelf
  command.params['shelf'] = shelf unless shelf.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::ReadingPosition

Retrieves my reading position information for a volume.

Parameters:

  • volume_id (String)

    ID of volume for which to retrieve a reading position.

  • content_version (String)

    Volume content version for which this reading position is requested.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
# File 'generated/google/apis/books_v1/service.rb', line 1506

def get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'mylibrary/readingpositions/{volumeId}', options)
  command.response_representation = Google::Apis::BooksV1::ReadingPosition::Representation
  command.response_class = Google::Apis::BooksV1::ReadingPosition
  command.params['volumeId'] = volume_id unless volume_id.nil?
  command.query['contentVersion'] = content_version unless content_version.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Notification

Returns notification details for a given notification id.

Parameters:

  • notification_id (String)

    String to identify the notification.

  • locale (String)

    ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating notification title and body.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
# File 'generated/google/apis/books_v1/service.rb', line 1595

def get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'notification/get', options)
  command.response_representation = Google::Apis::BooksV1::Notification::Representation
  command.response_class = Google::Apis::BooksV1::Notification
  command.query['locale'] = locale unless locale.nil?
  command.query['notification_id'] = notification_id unless notification_id.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Discoveryclusters

Returns a stream of personalized book clusters

Parameters:

  • locale (String)

    ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.

  • max_allowed_maturity_rating (String)

    The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
# File 'generated/google/apis/books_v1/service.rb', line 1715

def get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'personalizedstream/get', options)
  command.response_representation = Google::Apis::BooksV1::Discoveryclusters::Representation
  command.response_class = Google::Apis::BooksV1::Discoveryclusters
  command.query['locale'] = locale unless locale.nil?
  command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Offers

Returns a list of promo offers available to the user

Parameters:

  • android_id (String)

    device android_id

  • device (String)

    device device

  • manufacturer (String)

    device manufacturer

  • model (String)

    device model

  • product (String)

    device product

  • serial (String)

    device serial

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
# File 'generated/google/apis/books_v1/service.rb', line 1860

def get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'promooffer/get', options)
  command.response_representation = Google::Apis::BooksV1::Offers::Representation
  command.response_class = Google::Apis::BooksV1::Offers
  command.query['androidId'] = android_id unless android_id.nil?
  command.query['device'] = device unless device.nil?
  command.query['manufacturer'] = manufacturer unless manufacturer.nil?
  command.query['model'] = model unless model.nil?
  command.query['product'] = product unless product.nil?
  command.query['serial'] = serial unless serial.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_series(series_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Series

Returns Series metadata for the given series ids.

Parameters:

  • series_id (Array<String>, String)

    String that identifies the series

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
# File 'generated/google/apis/books_v1/service.rb', line 1898

def get_series(series_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'series/get', options)
  command.response_representation = Google::Apis::BooksV1::Series::Representation
  command.response_class = Google::Apis::BooksV1::Series
  command.query['series_id'] = series_id unless series_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::SeriesMembership

Returns Series membership data given the series id.

Parameters:

  • series_id (String)

    String that identifies the series

  • page_size (Fixnum)

    Number of maximum results per page to be included in the response.

  • page_token (String)

    The value of the nextToken from the previous page.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
# File 'generated/google/apis/books_v1/service.rb', line 1935

def get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'series/membership/get', options)
  command.response_representation = Google::Apis::BooksV1::SeriesMembership::Representation
  command.response_class = Google::Apis::BooksV1::SeriesMembership
  command.query['page_size'] = page_size unless page_size.nil?
  command.query['page_token'] = page_token unless page_token.nil?
  command.query['series_id'] = series_id unless series_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_user_settings(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::UserSettings

Gets the current settings for the user.

Parameters:

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


794
795
796
797
798
799
800
801
802
# File 'generated/google/apis/books_v1/service.rb', line 794

def (fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'myconfig/getUserSettings', options)
  command.response_representation = Google::Apis::BooksV1::UserSettings::Representation
  command.response_class = Google::Apis::BooksV1::UserSettings
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volume

Gets volume information for a single volume.

Parameters:

  • volume_id (String)

    ID of volume to retrieve.

  • country (String)

    ISO-3166-1 code to override the IP-based location.

  • include_non_comics_series (Boolean)

    Set to true to include non-comics series. Defaults to false.

  • partner (String)

    Brand results for partner ID.

  • projection (String)

    Restrict information returned to a set of selected fields.

  • source (String)

    String to identify the originator of this request.

  • user_library_consistent_read (Boolean)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
# File 'generated/google/apis/books_v1/service.rb', line 1981

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/{volumeId}', options)
  command.response_representation = Google::Apis::BooksV1::Volume::Representation
  command.response_class = Google::Apis::BooksV1::Volume
  command.params['volumeId'] = volume_id unless volume_id.nil?
  command.query['country'] = country unless country.nil?
  command.query['includeNonComicsSeries'] = include_non_comics_series unless include_non_comics_series.nil?
  command.query['partner'] = partner unless partner.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['source'] = source unless source.nil?
  command.query['user_library_consistent_read'] = user_library_consistent_read unless user_library_consistent_read.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Annotation

Inserts a new annotation.

Parameters:

  • annotation_object (Google::Apis::BooksV1::Annotation) (defaults to: nil)
  • annotation_id (String)

    The ID for the annotation to insert.

  • country (String)

    ISO-3166-1 code to override the IP-based location.

  • show_only_summary_in_response (Boolean)

    Requests that only the summary of the specified layer be provided in the response.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
# File 'generated/google/apis/books_v1/service.rb', line 1047

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'mylibrary/annotations', options)
  command.request_representation = Google::Apis::BooksV1::Annotation::Representation
  command.request_object = annotation_object
  command.response_representation = Google::Apis::BooksV1::Annotation::Representation
  command.response_class = Google::Apis::BooksV1::Annotation
  command.query['annotationId'] = annotation_id unless annotation_id.nil?
  command.query['country'] = country unless country.nil?
  command.query['showOnlySummaryInResponse'] = show_only_summary_in_response unless show_only_summary_in_response.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes

Return a list of associated books.

Parameters:

  • volume_id (String)

    ID of the source volume.

  • association (String)

    Association type.

  • locale (String)

    ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.

  • max_allowed_maturity_rating (String)

    The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
# File 'generated/google/apis/books_v1/service.rb', line 2103

def list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/{volumeId}/associated', options)
  command.response_representation = Google::Apis::BooksV1::Volumes::Representation
  command.response_class = Google::Apis::BooksV1::Volumes
  command.params['volumeId'] = volume_id unless volume_id.nil?
  command.query['association'] = association unless association.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes

Retrieves volumes in a specific bookshelf for the specified user.

Parameters:

  • user_id (String)

    ID of user for whom to retrieve bookshelf volumes.

  • shelf (String)

    ID of bookshelf to retrieve volumes.

  • max_results (Fixnum)

    Maximum number of results to return

  • show_preorders (Boolean)

    Set to true to show pre-ordered books. Defaults to false.

  • source (String)

    String to identify the originator of this request.

  • start_index (Fixnum)

    Index of the first element to return (starts at 0)

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# File 'generated/google/apis/books_v1/service.rb', line 161

def list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/{userId}/bookshelves/{shelf}/volumes', options)
  command.response_representation = Google::Apis::BooksV1::Volumes::Representation
  command.response_class = Google::Apis::BooksV1::Volumes
  command.params['userId'] = user_id unless user_id.nil?
  command.params['shelf'] = shelf unless shelf.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['showPreorders'] = show_preorders unless show_preorders.nil?
  command.query['source'] = source unless source.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelves

Retrieves a list of public bookshelves for the specified user.

Parameters:

  • user_id (String)

    ID of user for whom to retrieve bookshelves.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


117
118
119
120
121
122
123
124
125
126
127
# File 'generated/google/apis/books_v1/service.rb', line 117

def list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'users/{userId}/bookshelves', options)
  command.response_representation = Google::Apis::BooksV1::Bookshelves::Representation
  command.response_class = Google::Apis::BooksV1::Bookshelves
  command.params['userId'] = user_id unless user_id.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::AnnotationsData

Gets the annotation data for a volume and layer.

Parameters:

  • volume_id (String)

    The volume to retrieve annotation data for.

  • layer_id (String)

    The ID for the layer to get the annotation data.

  • content_version (String)

    The content version for the requested volume.

  • annotation_data_id (Array<String>, String)

    The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set.

  • h (Fixnum)

    The requested pixel height for any images. If height is provided width must also be provided.

  • locale (String)

    The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

  • max_results (Fixnum)

    Maximum number of results to return

  • page_token (String)

    The value of the nextToken from the previous page.

  • scale (Fixnum)

    The requested scale for the image.

  • source (String)

    String to identify the originator of this request.

  • updated_max (String)

    RFC 3339 timestamp to restrict to items updated prior to this timestamp ( exclusive).

  • updated_min (String)

    RFC 3339 timestamp to restrict to items updated since this timestamp ( inclusive).

  • w (Fixnum)

    The requested pixel width for any images. If width is provided height must also be provided.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
# File 'generated/google/apis/books_v1/service.rb', line 626

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/data', options)
  command.response_representation = Google::Apis::BooksV1::AnnotationsData::Representation
  command.response_class = Google::Apis::BooksV1::AnnotationsData
  command.params['volumeId'] = volume_id unless volume_id.nil?
  command.params['layerId'] = layer_id unless layer_id.nil?
  command.query['annotationDataId'] = annotation_data_id unless annotation_data_id.nil?
  command.query['contentVersion'] = content_version unless content_version.nil?
  command.query['h'] = h unless h.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['scale'] = scale unless scale.nil?
  command.query['source'] = source unless source.nil?
  command.query['updatedMax'] = updated_max unless updated_max.nil?
  command.query['updatedMin'] = updated_min unless updated_min.nil?
  command.query['w'] = w unless w.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumeannotations

Gets the volume annotations for a volume and layer.

Parameters:

  • volume_id (String)

    The volume to retrieve annotations for.

  • layer_id (String)

    The ID for the layer to get the annotations.

  • content_version (String)

    The content version for the requested volume.

  • end_offset (String)

    The end offset to end retrieving data from.

  • end_position (String)

    The end position to end retrieving data from.

  • locale (String)

    The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

  • max_results (Fixnum)

    Maximum number of results to return

  • page_token (String)

    The value of the nextToken from the previous page.

  • show_deleted (Boolean)

    Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

  • source (String)

    String to identify the originator of this request.

  • start_offset (String)

    The start offset to start retrieving data from.

  • start_position (String)

    The start position to start retrieving data from.

  • updated_max (String)

    RFC 3339 timestamp to restrict to items updated prior to this timestamp ( exclusive).

  • updated_min (String)

    RFC 3339 timestamp to restrict to items updated since this timestamp ( inclusive).

  • volume_annotations_version (String)

    The version of the volume annotations that you are requesting.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
# File 'generated/google/apis/books_v1/service.rb', line 749

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}', options)
  command.response_representation = Google::Apis::BooksV1::Volumeannotations::Representation
  command.response_class = Google::Apis::BooksV1::Volumeannotations
  command.params['volumeId'] = volume_id unless volume_id.nil?
  command.params['layerId'] = layer_id unless layer_id.nil?
  command.query['contentVersion'] = content_version unless content_version.nil?
  command.query['endOffset'] = end_offset unless end_offset.nil?
  command.query['endPosition'] = end_position unless end_position.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['source'] = source unless source.nil?
  command.query['startOffset'] = start_offset unless start_offset.nil?
  command.query['startPosition'] = start_position unless start_position.nil?
  command.query['updatedMax'] = updated_max unless updated_max.nil?
  command.query['updatedMin'] = updated_min unless updated_min.nil?
  command.query['volumeAnnotationsVersion'] = volume_annotations_version unless volume_annotations_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LayerSummaries

List the layer summaries for a volume.

Parameters:

  • volume_id (String)

    The volume to retrieve layers for.

  • content_version (String)

    The content version for the requested volume.

  • max_results (Fixnum)

    Maximum number of results to return

  • page_token (String)

    The value of the nextToken from the previous page.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'generated/google/apis/books_v1/service.rb', line 496

def list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/{volumeId}/layersummary', options)
  command.response_representation = Google::Apis::BooksV1::LayerSummaries::Representation
  command.response_class = Google::Apis::BooksV1::LayerSummaries
  command.params['volumeId'] = volume_id unless volume_id.nil?
  command.query['contentVersion'] = content_version unless content_version.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes

Return a list of books in My Library.

Parameters:

  • acquire_method (Array<String>, String)

    How the book was acquired

  • country (String)

    ISO-3166-1 code to override the IP-based location.

  • locale (String)

    ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.

  • max_results (Fixnum)

    Maximum number of results to return.

  • processing_state (Array<String>, String)

    The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.

  • source (String)

    String to identify the originator of this request.

  • start_index (Fixnum)

    Index of the first result to return (starts at 0)

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
# File 'generated/google/apis/books_v1/service.rb', line 2154

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/mybooks', options)
  command.response_representation = Google::Apis::BooksV1::Volumes::Representation
  command.response_class = Google::Apis::BooksV1::Volumes
  command.query['acquireMethod'] = acquire_method unless acquire_method.nil?
  command.query['country'] = country unless country.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['processingState'] = processing_state unless processing_state.nil?
  command.query['source'] = source unless source.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Annotations

Retrieves a list of annotations, possibly filtered.

Parameters:

  • content_version (String)

    The content version for the requested volume.

  • layer_id (String)

    The layer ID to limit annotation by.

  • layer_ids (Array<String>, String)

    The layer ID(s) to limit annotation by.

  • max_results (Fixnum)

    Maximum number of results to return

  • page_token (String)

    The value of the nextToken from the previous page.

  • show_deleted (Boolean)

    Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

  • source (String)

    String to identify the originator of this request.

  • updated_max (String)

    RFC 3339 timestamp to restrict to items updated prior to this timestamp ( exclusive).

  • updated_min (String)

    RFC 3339 timestamp to restrict to items updated since this timestamp ( inclusive).

  • volume_id (String)

    The volume to restrict annotations to.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
# File 'generated/google/apis/books_v1/service.rb', line 1106

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'mylibrary/annotations', options)
  command.response_representation = Google::Apis::BooksV1::Annotations::Representation
  command.response_class = Google::Apis::BooksV1::Annotations
  command.query['contentVersion'] = content_version unless content_version.nil?
  command.query['layerId'] = layer_id unless layer_id.nil?
  command.query['layerIds'] = layer_ids unless layer_ids.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['showDeleted'] = show_deleted unless show_deleted.nil?
  command.query['source'] = source unless source.nil?
  command.query['updatedMax'] = updated_max unless updated_max.nil?
  command.query['updatedMin'] = updated_min unless updated_min.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelves

Retrieves a list of bookshelves belonging to the authenticated user.

Parameters:

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
# File 'generated/google/apis/books_v1/service.rb', line 1334

def list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'mylibrary/bookshelves', options)
  command.response_representation = Google::Apis::BooksV1::Bookshelves::Representation
  command.response_class = Google::Apis::BooksV1::Bookshelves
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes

Gets volume information for volumes on a bookshelf.

Parameters:

  • shelf (String)

    The bookshelf ID or name retrieve volumes for.

  • country (String)

    ISO-3166-1 code to override the IP-based location.

  • max_results (Fixnum)

    Maximum number of results to return

  • projection (String)

    Restrict information returned to a set of selected fields.

  • q (String)

    Full-text search query string in this bookshelf.

  • show_preorders (Boolean)

    Set to true to show pre-ordered books. Defaults to false.

  • source (String)

    String to identify the originator of this request.

  • start_index (Fixnum)

    Index of the first element to return (starts at 0)

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
# File 'generated/google/apis/books_v1/service.rb', line 1462

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'mylibrary/bookshelves/{shelf}/volumes', options)
  command.response_representation = Google::Apis::BooksV1::Volumes::Representation
  command.response_class = Google::Apis::BooksV1::Volumes
  command.params['shelf'] = shelf unless shelf.nil?
  command.query['country'] = country unless country.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['q'] = q unless q.nil?
  command.query['showPreorders'] = show_preorders unless show_preorders.nil?
  command.query['source'] = source unless source.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_offline_metadata_dictionary(cpksver, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Metadata

Returns a list of offline dictionary metadata available

Parameters:

  • cpksver (String)

    The device/version ID from which to request the data.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


304
305
306
307
308
309
310
311
312
313
# File 'generated/google/apis/books_v1/service.rb', line 304

def (cpksver, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'dictionary/listOfflineMetadata', options)
  command.response_representation = Google::Apis::BooksV1::Metadata::Representation
  command.response_class = Google::Apis::BooksV1::Metadata
  command.query['cpksver'] = cpksver unless cpksver.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Category

List categories for onboarding experience.

Parameters:

  • locale (String)

    ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
# File 'generated/google/apis/books_v1/service.rb', line 1630

def list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'onboarding/listCategories', options)
  command.response_representation = Google::Apis::BooksV1::Category::Representation
  command.response_class = Google::Apis::BooksV1::Category
  command.query['locale'] = locale unless locale.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volume2

List available volumes under categories for onboarding experience.

Parameters:

  • category_id (Array<String>, String)

    List of category ids requested.

  • locale (String)

    ISO-639-1 language and ISO-3166-1 country code. Default is en-US if unset.

  • max_allowed_maturity_rating (String)

    The maximum allowed maturity rating of returned volumes. Books with a higher maturity rating are filtered out.

  • page_size (Fixnum)

    Number of maximum results per page to be included in the response.

  • page_token (String)

    The value of the nextToken from the previous page.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
# File 'generated/google/apis/books_v1/service.rb', line 1672

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'onboarding/listCategoryVolumes', options)
  command.response_representation = Google::Apis::BooksV1::Volume2::Representation
  command.response_class = Google::Apis::BooksV1::Volume2
  command.query['categoryId'] = category_id unless category_id.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Return a list of recommended books for the current user.

Parameters:

  • locale (String)

    ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.

  • max_allowed_maturity_rating (String)

    The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
# File 'generated/google/apis/books_v1/service.rb', line 2199

def list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/recommended', options)
  command.response_representation = Google::Apis::BooksV1::Volumes::Representation
  command.response_class = Google::Apis::BooksV1::Volumes
  command.query['locale'] = locale unless locale.nil?
  command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes

Return a list of books uploaded by the current user.

Parameters:

  • locale (String)

    ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.

  • max_results (Fixnum)

    Maximum number of results to return.

  • processing_state (Array<String>, String)

    The processing state of the user uploaded volumes to be returned.

  • source (String)

    String to identify the originator of this request.

  • start_index (Fixnum)

    Index of the first result to return (starts at 0)

  • volume_id (Array<String>, String)

    The ids of the volumes to be returned. If not specified all that match the processingState are returned.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
# File 'generated/google/apis/books_v1/service.rb', line 2289

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes/useruploaded', options)
  command.response_representation = Google::Apis::BooksV1::Volumes::Representation
  command.response_class = Google::Apis::BooksV1::Volumes
  command.query['locale'] = locale unless locale.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['processingState'] = processing_state unless processing_state.nil?
  command.query['source'] = source unless source.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes

Performs a book search.

Parameters:

  • q (String)

    Full-text search query string.

  • download (String)

    Restrict to volumes by download availability.

  • filter (String)

    Filter search results.

  • lang_restrict (String)

    Restrict results to books with this language code.

  • library_restrict (String)

    Restrict search to this user's library.

  • max_allowed_maturity_rating (String)

    The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.

  • max_results (Fixnum)

    Maximum number of results to return.

  • order_by (String)

    Sort search results.

  • partner (String)

    Restrict and brand results for partner ID.

  • print_type (String)

    Restrict to books or magazines.

  • projection (String)

    Restrict information returned to a set of selected fields.

  • show_preorders (Boolean)

    Set to true to show books available for preorder. Defaults to false.

  • source (String)

    String to identify the originator of this request.

  • start_index (Fixnum)

    Index of the first result to return (starts at 0)

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
# File 'generated/google/apis/books_v1/service.rb', line 2047

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'volumes', options)
  command.response_representation = Google::Apis::BooksV1::Volumes::Representation
  command.response_class = Google::Apis::BooksV1::Volumes
  command.query['download'] = download unless download.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['langRestrict'] = lang_restrict unless lang_restrict.nil?
  command.query['libraryRestrict'] = library_restrict unless library_restrict.nil?
  command.query['maxAllowedMaturityRating'] = max_allowed_maturity_rating unless max_allowed_maturity_rating.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['partner'] = partner unless partner.nil?
  command.query['printType'] = print_type unless print_type.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['q'] = q unless q.nil?
  command.query['showPreorders'] = show_preorders unless show_preorders.nil?
  command.query['source'] = source unless source.nil?
  command.query['startIndex'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Moves a volume within a bookshelf.

Parameters:

  • shelf (String)

    ID of bookshelf with the volume.

  • volume_id (String)

    ID of volume to move.

  • volume_position (Fixnum)

    Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.)

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
# File 'generated/google/apis/books_v1/service.rb', line 1374

def move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/moveVolume', options)
  command.params['shelf'] = shelf unless shelf.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['volumePosition'] = volume_position unless volume_position.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

Rate a recommended book for the current user.

Parameters:

  • rating (String)

    Rating to be given to the volume.

  • volume_id (String)

    ID of the source volume.

  • locale (String)

    ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
# File 'generated/google/apis/books_v1/service.rb', line 2241

def rate_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'volumes/recommended/rate', options)
  command.response_representation = Google::Apis::BooksV1::RateRecommendedVolumeResponse::Representation
  command.response_class = Google::Apis::BooksV1::RateRecommendedVolumeResponse
  command.query['locale'] = locale unless locale.nil?
  command.query['rating'] = rating unless rating.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#release_download_access(volume_ids, cpksver, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::DownloadAccesses

Release downloaded content access restriction.

Parameters:

  • volume_ids (Array<String>, String)

    The volume(s) to release restrictions for.

  • cpksver (String)

    The device/version ID from which to release the restriction.

  • locale (String)

    ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


832
833
834
835
836
837
838
839
840
841
842
843
844
# File 'generated/google/apis/books_v1/service.rb', line 832

def release_download_access(volume_ids, cpksver, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'myconfig/releaseDownloadAccess', options)
  command.response_representation = Google::Apis::BooksV1::DownloadAccesses::Representation
  command.response_class = Google::Apis::BooksV1::DownloadAccesses
  command.query['cpksver'] = cpksver unless cpksver.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeIds'] = volume_ids unless volume_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes a volume from a bookshelf.

Parameters:

  • shelf (String)

    ID of bookshelf from which to remove a volume.

  • volume_id (String)

    ID of volume to remove.

  • reason (String)

    The reason for which the book is removed from the library.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
# File 'generated/google/apis/books_v1/service.rb', line 1414

def remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/removeVolume', options)
  command.params['shelf'] = shelf unless shelf.nil?
  command.query['reason'] = reason unless reason.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#request_access(source, volume_id, nonce, cpksver, license_types: nil, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::RequestAccess

Request concurrent and download access restrictions.

Parameters:

  • source (String)

    String to identify the originator of this request.

  • volume_id (String)

    The volume to request concurrent/download restrictions for.

  • nonce (String)

    The client nonce value.

  • cpksver (String)

    The device/version ID from which to request the restrictions.

  • license_types (String)

    The type of access license to request. If not specified, the default is BOTH.

  • locale (String)

    ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
# File 'generated/google/apis/books_v1/service.rb', line 878

def request_access(source, volume_id, nonce, cpksver, license_types: nil, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'myconfig/requestAccess', options)
  command.response_representation = Google::Apis::BooksV1::RequestAccess::Representation
  command.response_class = Google::Apis::BooksV1::RequestAccess
  command.query['cpksver'] = cpksver unless cpksver.nil?
  command.query['licenseTypes'] = license_types unless license_types.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['nonce'] = nonce unless nonce.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#set_my_library_reading_position(volume_id, timestamp, position, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Sets my reading position information for a volume.

Parameters:

  • volume_id (String)

    ID of volume for which to update the reading position.

  • timestamp (String)

    RFC 3339 UTC format timestamp associated with this reading position.

  • position (String)

    Position string for the new volume reading position.

  • action (String)

    Action that caused this reading position to be set.

  • content_version (String)

    Volume content version for which this reading position applies.

  • device_cookie (String)

    Random persistent device cookie optional on set position.

  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
# File 'generated/google/apis/books_v1/service.rb', line 1553

def set_my_library_reading_position(volume_id, timestamp, position, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'mylibrary/readingpositions/{volumeId}/setPosition', options)
  command.params['volumeId'] = volume_id unless volume_id.nil?
  command.query['action'] = action unless action.nil?
  command.query['contentVersion'] = content_version unless content_version.nil?
  command.query['deviceCookie'] = device_cookie unless device_cookie.nil?
  command.query['position'] = position unless position.nil?
  command.query['source'] = source unless source.nil?
  command.query['timestamp'] = timestamp unless timestamp.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Initiates sharing of the content with the user's family. Empty response indicates success.

Parameters:

  • doc_id (String)

    The docid to share.

  • source (String)

    String to identify the originator of this request.

  • volume_id (String)

    The volume to share.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


375
376
377
378
379
380
381
382
383
384
# File 'generated/google/apis/books_v1/service.rb', line 375

def share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'familysharing/share', options)
  command.query['docId'] = doc_id unless doc_id.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::AnnotationsSummary

Gets the summary of specified layers.

Parameters:

  • layer_ids (Array<String>, String)

    Array of layer IDs to get the summary for.

  • volume_id (String)

    Volume id to get the summary for.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
# File 'generated/google/apis/books_v1/service.rb', line 1150

def summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'mylibrary/annotations/summary', options)
  command.response_representation = Google::Apis::BooksV1::AnnotationsSummary::Representation
  command.response_class = Google::Apis::BooksV1::AnnotationsSummary
  command.query['layerIds'] = layer_ids unless layer_ids.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#sync_volume_licenses(source, nonce, cpksver, features: nil, include_non_comics_series: nil, locale: nil, show_preorders: nil, volume_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes

Request downloaded content access for specified volumes on the My eBooks shelf.

Parameters:

  • source (String)

    String to identify the originator of this request.

  • nonce (String)

    The client nonce value.

  • cpksver (String)

    The device/version ID from which to release the restriction.

  • features (Array<String>, String)

    List of features supported by the client, i.e., 'RENTALS'

  • include_non_comics_series (Boolean)

    Set to true to include non-comics series. Defaults to false.

  • locale (String)

    ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.

  • show_preorders (Boolean)

    Set to true to show pre-ordered books. Defaults to false.

  • volume_ids (Array<String>, String)

    The volume(s) to request download restrictions for.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
# File 'generated/google/apis/books_v1/service.rb', line 930

def sync_volume_licenses(source, nonce, cpksver, features: nil, include_non_comics_series: nil, locale: nil, show_preorders: nil, volume_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'myconfig/syncVolumeLicenses', options)
  command.response_representation = Google::Apis::BooksV1::Volumes::Representation
  command.response_class = Google::Apis::BooksV1::Volumes
  command.query['cpksver'] = cpksver unless cpksver.nil?
  command.query['features'] = features unless features.nil?
  command.query['includeNonComicsSeries'] = include_non_comics_series unless include_non_comics_series.nil?
  command.query['locale'] = locale unless locale.nil?
  command.query['nonce'] = nonce unless nonce.nil?
  command.query['showPreorders'] = show_preorders unless show_preorders.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeIds'] = volume_ids unless volume_ids.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Initiates revoking content that has already been shared with the user's family. Empty response indicates success.

Parameters:

  • doc_id (String)

    The docid to unshare.

  • source (String)

    String to identify the originator of this request.

  • volume_id (String)

    The volume to unshare.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


413
414
415
416
417
418
419
420
421
422
# File 'generated/google/apis/books_v1/service.rb', line 413

def unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'familysharing/unshare', options)
  command.query['docId'] = doc_id unless doc_id.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_book(loading_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LoadingResource

Parameters:

  • loading_resource_object (Google::Apis::BooksV1::LoadingResource) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


270
271
272
273
274
275
276
277
278
279
280
# File 'generated/google/apis/books_v1/service.rb', line 270

def update_book(loading_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'cloudloading/updateBook', options)
  command.request_representation = Google::Apis::BooksV1::LoadingResource::Representation
  command.request_object = loading_resource_object
  command.response_representation = Google::Apis::BooksV1::LoadingResource::Representation
  command.response_class = Google::Apis::BooksV1::LoadingResource
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Annotation

Updates an existing annotation.

Parameters:

  • annotation_id (String)

    The ID for the annotation to update.

  • annotation_object (Google::Apis::BooksV1::Annotation) (defaults to: nil)
  • source (String)

    String to identify the originator of this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
# File 'generated/google/apis/books_v1/service.rb', line 1187

def update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'mylibrary/annotations/{annotationId}', options)
  command.request_representation = Google::Apis::BooksV1::Annotation::Representation
  command.request_object = annotation_object
  command.response_representation = Google::Apis::BooksV1::Annotation::Representation
  command.response_class = Google::Apis::BooksV1::Annotation
  command.params['annotationId'] = annotation_id unless annotation_id.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_user_settings(user_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::UserSettings

Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub- objects will retain the existing value.

Parameters:

  • user_settings_object (Google::Apis::BooksV1::UserSettings) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


971
972
973
974
975
976
977
978
979
980
981
# File 'generated/google/apis/books_v1/service.rb', line 971

def ( = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'myconfig/updateUserSettings', options)
  command.request_representation = Google::Apis::BooksV1::UserSettings::Representation
  command.request_object = 
  command.response_representation = Google::Apis::BooksV1::UserSettings::Representation
  command.response_class = Google::Apis::BooksV1::UserSettings
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end