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

Constructor Details

#initialize ⇒ BooksService

Returns a new instance of BooksService.



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

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

Instance Attribute Details

#key ⇒ String

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_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.



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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



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

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) (defaults to: nil) —

    device android_id

  • device (String) (defaults to: nil) —

    device device

  • manufacturer (String) (defaults to: nil) —

    device manufacturer

  • model (String) (defaults to: nil) —

    device model

  • offer_id (String) (defaults to: nil)
  • product (String) (defaults to: nil) —

    device product

  • serial (String) (defaults to: nil) —

    device serial

  • volume_id (String) (defaults to: nil) —

    Volume id to exercise the offer

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    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:



1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
 
# File 'generated/google/apis/books_v1/service.rb', line 1726

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) (defaults to: nil) —

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

  • mime_type (String) (defaults to: nil) —

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

  • name (String) (defaults to: nil) —

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

  • upload_client_token (String) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'generated/google/apis/books_v1/service.rb', line 213

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) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    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:



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
 
# File 'generated/google/apis/books_v1/service.rb', line 1166

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) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    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:



1204
1205
1206
1207
1208
1209
1210
1211
1212
 
# File 'generated/google/apis/books_v1/service.rb', line 1204

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    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:



251
252
253
254
255
256
257
258
 
# File 'generated/google/apis/books_v1/service.rb', line 251

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) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    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:



937
938
939
940
941
942
943
944
945
 
# File 'generated/google/apis/books_v1/service.rb', line 937

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) (defaults to: nil) —

    device android_id

  • device (String) (defaults to: nil) —

    device device

  • manufacturer (String) (defaults to: nil) —

    device manufacturer

  • model (String) (defaults to: nil) —

    device model

  • offer_id (String) (defaults to: nil) —

    Offer to dimiss

  • product (String) (defaults to: nil) —

    device product

  • serial (String) (defaults to: nil) —

    device serial

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    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:



1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
 
# File 'generated/google/apis/books_v1/service.rb', line 1778

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) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'generated/google/apis/books_v1/service.rb', line 83

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_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) (defaults to: nil) —

    The content version for the requested volume.

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'generated/google/apis/books_v1/service.rb', line 360

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) (defaults to: nil) —

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

  • h (Fixnum) (defaults to: nil) —

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

  • locale (String) (defaults to: nil) —

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

  • scale (Fixnum) (defaults to: nil) —

    The requested scale for the image.

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • w (Fixnum) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'generated/google/apis/books_v1/service.rb', line 466

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) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



596
597
598
599
600
601
602
603
604
605
606
607
608
609
 
# File 'generated/google/apis/books_v1/service.rb', line 596

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) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
 
# File 'generated/google/apis/books_v1/service.rb', line 1241

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) (defaults to: nil) —

    Volume content version for which this reading position is requested.

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
 
# File 'generated/google/apis/books_v1/service.rb', line 1457

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) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
 
# File 'generated/google/apis/books_v1/service.rb', line 1550

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) (defaults to: nil) —

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

  • max_allowed_maturity_rating (String) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
 
# File 'generated/google/apis/books_v1/service.rb', line 1676

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) (defaults to: nil) —

    device android_id

  • device (String) (defaults to: nil) —

    device device

  • manufacturer (String) (defaults to: nil) —

    device manufacturer

  • model (String) (defaults to: nil) —

    device model

  • product (String) (defaults to: nil) —

    device product

  • serial (String) (defaults to: nil) —

    device serial

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
 
# File 'generated/google/apis/books_v1/service.rb', line 1827

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
 
# File 'generated/google/apis/books_v1/service.rb', line 1867

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) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

    The value of the nextToken from the previous page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
 
# File 'generated/google/apis/books_v1/service.rb', line 1906

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



714
715
716
717
718
719
720
721
722
 
# File 'generated/google/apis/books_v1/service.rb', line 714

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) (defaults to: nil) —

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

  • include_non_comics_series (Boolean) (defaults to: nil) —

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

  • partner (String) (defaults to: nil) —

    Brand results for partner ID.

  • projection (String) (defaults to: nil) —

    Restrict information returned to a set of selected fields.

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • user_library_consistent_read (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
 
# File 'generated/google/apis/books_v1/service.rb', line 1954

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, 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)
  • country (String) (defaults to: nil) —

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

  • show_only_summary_in_response (Boolean) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



977
978
979
980
981
982
983
984
985
986
987
988
989
990
 
# File 'generated/google/apis/books_v1/service.rb', line 977

def insert_my_library_annotation(annotation_object = 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['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) (defaults to: nil) —

    Association type.

  • locale (String) (defaults to: nil) —

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

  • max_allowed_maturity_rating (String) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
 
# File 'generated/google/apis/books_v1/service.rb', line 2080

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) (defaults to: nil) —

    Maximum number of results to return

  • show_preorders (Boolean) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • start_index (Fixnum) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'generated/google/apis/books_v1/service.rb', line 168

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) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



122
123
124
125
126
127
128
129
130
131
132
 
# File 'generated/google/apis/books_v1/service.rb', line 122

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) (defaults to: nil) —

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

  • h (Fixnum) (defaults to: nil) —

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

  • locale (String) (defaults to: nil) —

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

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return

  • page_token (String) (defaults to: nil) —

    The value of the nextToken from the previous page.

  • scale (Fixnum) (defaults to: nil) —

    The requested scale for the image.

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • updated_max (String) (defaults to: nil) —

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

  • updated_min (String) (defaults to: nil) —

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

  • w (Fixnum) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'generated/google/apis/books_v1/service.rb', line 540

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) (defaults to: nil) —

    The end offset to end retrieving data from.

  • end_position (String) (defaults to: nil) —

    The end position to end retrieving data from.

  • locale (String) (defaults to: nil) —

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

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return

  • page_token (String) (defaults to: nil) —

    The value of the nextToken from the previous page.

  • show_deleted (Boolean) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • start_offset (String) (defaults to: nil) —

    The start offset to start retrieving data from.

  • start_position (String) (defaults to: nil) —

    The start position to start retrieving data from.

  • updated_max (String) (defaults to: nil) —

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

  • updated_min (String) (defaults to: nil) —

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

  • volume_annotations_version (String) (defaults to: nil) —

    The version of the volume annotations that you are requesting.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'generated/google/apis/books_v1/service.rb', line 667

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) (defaults to: nil) —

    The content version for the requested volume.

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return

  • page_token (String) (defaults to: nil) —

    The value of the nextToken from the previous page.

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'generated/google/apis/books_v1/service.rb', line 406

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) (defaults to: nil) —

    How the book was acquired

  • country (String) (defaults to: nil) —

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

  • locale (String) (defaults to: nil) —

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

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return.

  • processing_state (Array<String>, String) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • start_index (Fixnum) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
 
# File 'generated/google/apis/books_v1/service.rb', line 2133

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) (defaults to: nil) —

    The content version for the requested volume.

  • layer_id (String) (defaults to: nil) —

    The layer ID to limit annotation by.

  • layer_ids (Array<String>, String) (defaults to: nil) —

    The layer ID(s) to limit annotation by.

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return

  • page_token (String) (defaults to: nil) —

    The value of the nextToken from the previous page.

  • show_deleted (Boolean) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • updated_max (String) (defaults to: nil) —

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

  • updated_min (String) (defaults to: nil) —

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

  • volume_id (String) (defaults to: nil) —

    The volume to restrict annotations to.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'generated/google/apis/books_v1/service.rb', line 1037

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) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'generated/google/apis/books_v1/service.rb', line 1277

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) (defaults to: nil) —

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

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return

  • projection (String) (defaults to: nil) —

    Restrict information returned to a set of selected fields.

  • q (String) (defaults to: nil) —

    Full-text search query string in this bookshelf.

  • show_preorders (Boolean) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • start_index (Fixnum) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



319
320
321
322
323
324
325
326
327
328
 
# File 'generated/google/apis/books_v1/service.rb', line 319

def list_offline_metadata_dictionary(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) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
 
# File 'generated/google/apis/books_v1/service.rb', line 1587

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) (defaults to: nil) —

    List of category ids requested.

  • locale (String) (defaults to: nil) —

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

  • max_allowed_maturity_rating (String) (defaults to: nil) —

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

  • page_size (Fixnum) (defaults to: nil) —

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

  • page_token (String) (defaults to: nil) —

    The value of the nextToken from the previous page.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'generated/google/apis/books_v1/service.rb', line 1631

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

#list_recommended_volumes(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 recommended books for the current user.

Parameters:

  • locale (String) (defaults to: nil) —

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

  • max_allowed_maturity_rating (String) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
 
# File 'generated/google/apis/books_v1/service.rb', line 2180

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) (defaults to: nil) —

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

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return.

  • processing_state (Array<String>, String) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • start_index (Fixnum) (defaults to: nil) —

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

  • volume_id (Array<String>, String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
 
# File 'generated/google/apis/books_v1/service.rb', line 2274

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) (defaults to: nil) —

    Restrict to volumes by download availability.

  • filter (String) (defaults to: nil) —

    Filter search results.

  • lang_restrict (String) (defaults to: nil) —

    Restrict results to books with this language code.

  • library_restrict (String) (defaults to: nil) —

    Restrict search to this user's library.

  • max_allowed_maturity_rating (String) (defaults to: nil) —

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

  • max_results (Fixnum) (defaults to: nil) —

    Maximum number of results to return.

  • order_by (String) (defaults to: nil) —

    Sort search results.

  • partner (String) (defaults to: nil) —

    Restrict and brand results for partner ID.

  • print_type (String) (defaults to: nil) —

    Restrict to books or magazines.

  • projection (String) (defaults to: nil) —

    Restrict information returned to a set of selected fields.

  • show_preorders (Boolean) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • start_index (Fixnum) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
 
# File 'generated/google/apis/books_v1/service.rb', line 2022

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) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    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:



1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
 
# File 'generated/google/apis/books_v1/service.rb', line 1319

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_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::RateRecommendedVolumeResponse

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) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
 
# File 'generated/google/apis/books_v1/service.rb', line 2224

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) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'generated/google/apis/books_v1/service.rb', line 754

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) (defaults to: nil) —

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

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    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:



1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'generated/google/apis/books_v1/service.rb', line 1361

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) (defaults to: nil) —

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

  • locale (String) (defaults to: nil) —

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

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'generated/google/apis/books_v1/service.rb', line 802

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) (defaults to: nil) —

    Action that caused this reading position to be set.

  • content_version (String) (defaults to: nil) —

    Volume content version for which this reading position applies.

  • device_cookie (String) (defaults to: nil) —

    Random persistent device cookie optional on set position.

  • source (String) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    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:



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

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

#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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'generated/google/apis/books_v1/service.rb', line 1083

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) (defaults to: nil) —

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

  • include_non_comics_series (Boolean) (defaults to: nil) —

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

  • locale (String) (defaults to: nil) —

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

  • show_preorders (Boolean) (defaults to: nil) —

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

  • volume_ids (Array<String>, String) (defaults to: nil) —

    The volume(s) to request download restrictions for.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'generated/google/apis/books_v1/service.rb', line 856

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

#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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



283
284
285
286
287
288
289
290
291
292
293
 
# File 'generated/google/apis/books_v1/service.rb', line 283

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) (defaults to: nil) —

    String to identify the originator of this request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'generated/google/apis/books_v1/service.rb', line 1122

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

  • user_ip (String) (defaults to: nil) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



899
900
901
902
903
904
905
906
907
908
909
 
# File 'generated/google/apis/books_v1/service.rb', line 899

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