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

Inherits:

Core::BaseService

Object
Core::BaseService
Google::Apis::BooksV1::BooksService

show all

Defined in:: lib/google/apis/books_v1/service.rb

Overview

Books API

The Google Books API allows clients to access the Google Books repository.

Examples:

require 'google/apis/books_v1'

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

Instance Attribute Summary collapse

#key ⇒ String
API key.
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.

Instance Method Summary collapse

#accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Accepts the promo offer.
#add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LoadingResource
Add a user-upload volume and triggers processing.
#add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Adds a volume to a bookshelf.
#clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Clears all volumes from a bookshelf.
#delete_book(volume_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Remove the book and its contents.
#delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Deletes an annotation.
#dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Marks the promo offer as dismissed.
#get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelf
Retrieves metadata for a specific bookshelf for the specified user.
#get_familysharing_family_info(source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::FamilyInfo
Gets information regarding the family that the user is part of.
#get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LayerSummary
Gets the layer summary for a volume.
#get_layer_annotation_data(volume_id, layer_id, annotation_data_id, content_version, allow_web_definitions: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::DictionaryAnnotationdata
Gets the annotation data.
#get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::VolumeAnnotation
Gets the volume annotation.
#get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelf
Retrieves metadata for a specific bookshelf belonging to the authenticated user.
#get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::ReadingPosition
Retrieves my reading position information for a volume.
#get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Notification
Returns notification details for a given notification id.
#get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Discoveryclusters
Returns a stream of personalized book clusters.
#get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Offers
Returns a list of promo offers available to the user.
#get_series(series_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Series
Returns Series metadata for the given series ids.
#get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::SeriesMembership
Returns Series membership data given the series id.
#get_user_settings(country: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::UserSettings
Gets the current settings for the user.
#get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volume
Gets volume information for a single volume.
#initialize ⇒ BooksService constructor
A new instance of BooksService.
#insert_my_library_annotation(annotation_object = nil, annotation_id: nil, country: nil, show_only_summary_in_response: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Annotation
Inserts a new annotation.
#list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Return a list of associated books.
#list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Retrieves volumes in a specific bookshelf for the specified user.
#list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelves
Retrieves a list of public bookshelves for the specified user.
#list_layer_annotation_data(volume_id, layer_id, content_version, annotation_data_id: nil, h: nil, locale: nil, max_results: nil, page_token: nil, scale: nil, source: nil, updated_max: nil, updated_min: nil, w: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::AnnotationsData
Gets the annotation data for a volume and layer.
#list_layer_volume_annotations(volume_id, layer_id, content_version, end_offset: nil, end_position: nil, locale: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, start_offset: nil, start_position: nil, updated_max: nil, updated_min: nil, volume_annotations_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumeannotations
Gets the volume annotations for a volume and layer.
#list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LayerSummaries
List the layer summaries for a volume.
#list_my_books(acquire_method: nil, country: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Return a list of books in My Library.
#list_my_library_annotations(content_version: nil, layer_id: nil, layer_ids: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, updated_max: nil, updated_min: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Annotations
Retrieves a list of annotations, possibly filtered.
#list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelves
Retrieves a list of bookshelves belonging to the authenticated user.
#list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Gets volume information for volumes on a bookshelf.
#list_offline_metadata_dictionary(cpksver, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Metadata
Returns a list of offline dictionary metadata available.
#list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Category
List categories for onboarding experience.
#list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volume2
List available volumes under categories for onboarding experience.
#list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Return a list of recommended books for the current user.
#list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Return a list of books uploaded by the current user.
#list_volumes(q, download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_allowed_maturity_rating: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Performs a book search.
#move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Moves a volume within a bookshelf.
#rate_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::RateRecommendedVolumeResponse
Rate a recommended book for the current user.
#release_download_access(cpksver, volume_ids, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::DownloadAccesses
Release downloaded content access restriction.
#remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Removes a volume from a bookshelf.
#request_access(cpksver, nonce, source, volume_id, license_types: nil, locale: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::RequestAccessData
Request concurrent and download access restrictions.
#set_my_library_reading_position(volume_id, position, timestamp, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Sets my reading position information for a volume.
#share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Initiates sharing of the content with the user's family.
#summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::AnnotationsSummary
Gets the summary of specified layers.
#sync_volume_licenses(cpksver, nonce, source, features: nil, include_non_comics_series: nil, locale: nil, show_preorders: nil, volume_ids: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Request downloaded content access for specified volumes on the My eBooks shelf.
#unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty
Initiates revoking content that has already been shared with the user's family.
#update_book(loading_resource_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LoadingResource
Updates a user-upload volume.
#update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Annotation
Updates an existing annotation.
#update_user_settings(user_settings_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::UserSettings
Sets the settings for the user.

Constructor Details

#initialize ⇒ `BooksService`

Returns a new instance of BooksService.

# File 'lib/google/apis/books_v1/service.rb', line 45

def initialize
  super('https://books.googleapis.com/', '',
        client_name: 'google-apis-books_v1',
        client_version: Google::Apis::BooksV1::GEM_VERSION)
  @batch_path = 'batch'
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 'lib/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.

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.



43
44
45

# File 'lib/google/apis/books_v1/service.rb', line 43

def quota_user
  @quota_user
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, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

Accepts the promo offer.

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1664

def accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/promooffer/accept', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  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?
  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, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::LoadingResource`

Add a user-upload volume and triggers processing.

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) —
Scotty upload token.
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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::LoadingResource) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::LoadingResource)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 192

def add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1159

def add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/addVolume', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  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?
  execute_or_queue_command(command, &block)
end

#clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1194

def clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/clearVolumes', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  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?
  execute_or_queue_command(command, &block)
end

#delete_book(volume_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 225

def delete_book(volume_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/cloudloading/deleteBook', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  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?
  execute_or_queue_command(command, &block)
end

#delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 950

def delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'books/v1/mylibrary/annotations/{annotationId}', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  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?
  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, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

Marks the promo offer as dismissed.

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1713

def dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/promooffer/dismiss', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  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?
  execute_or_queue_command(command, &block)
end

#get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Bookshelf) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Bookshelf)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 76

def get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

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

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

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::FamilyInfo) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::FamilyInfo)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 315

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

#get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::LayerSummary) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::LayerSummary)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 425

def get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::DictionaryAnnotationdata`

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::DictionaryAnnotationdata) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::DictionaryAnnotationdata)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 521

def get_layer_annotation_data(volume_id, layer_id, annotation_data_id, content_version, allow_web_definitions: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}', options)
  command.response_representation = Google::Apis::BooksV1::DictionaryAnnotationdata::Representation
  command.response_class = Google::Apis::BooksV1::DictionaryAnnotationdata
  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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::VolumeAnnotation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::VolumeAnnotation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 641

def get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Bookshelf) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Bookshelf)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1228

def get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::ReadingPosition) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::ReadingPosition)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1423

def get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Notification) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Notification)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1508

def get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Discoveryclusters) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Discoveryclusters)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1619

def get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Offers) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Offers)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1759

def get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#get_series(series_id, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Series) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Series)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1794

def get_series(series_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::SeriesMembership) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::SeriesMembership)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1828

def get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

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

Gets the current settings for the user.

Parameters:

country (String) (defaults to: nil) —
Unused. Added only to workaround TEX mandatory request template requirement
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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::UserSettings) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::UserSettings)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 751

def get_user_settings(country: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/myconfig/getUserSettings', options)
  command.response_representation = Google::Apis::BooksV1::UserSettings::Representation
  command.response_class = Google::Apis::BooksV1::UserSettings
  command.query['country'] = country unless country.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volume) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volume)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1871

def get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

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

Inserts a new annotation.

Parameters:

annotation_object (Google::Apis::BooksV1::Annotation) (defaults to: nil)
annotation_id (String) (defaults to: nil) —
The ID for the annotation to insert.
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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Annotation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Annotation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 989

def insert_my_library_annotation(annotation_object = nil, annotation_id: nil, country: nil, show_only_summary_in_response: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/mylibrary/annotations', options)
  command.request_representation = Google::Apis::BooksV1::Annotation::Representation
  command.request_object = annotation_object
  command.response_representation = Google::Apis::BooksV1::Annotation::Representation
  command.response_class = Google::Apis::BooksV1::Annotation
  command.query['annotationId'] = annotation_id unless annotation_id.nil?
  command.query['country'] = country unless country.nil?
  command.query['showOnlySummaryInResponse'] = show_only_summary_in_response unless show_only_summary_in_response.nil?
  command.query['source'] = source unless source.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volumes) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volumes)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1987

def list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volumes) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volumes)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 151

def list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#list_bookshelves(user_id, source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Bookshelves) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Bookshelves)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 110

def list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::AnnotationsData) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::AnnotationsData)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 590

def list_layer_annotation_data(volume_id, layer_id, content_version, annotation_data_id: nil, h: nil, locale: nil, max_results: nil, page_token: nil, scale: nil, source: nil, updated_max: nil, updated_min: nil, w: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volumeannotations) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volumeannotations)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 707

def list_layer_volume_annotations(volume_id, layer_id, content_version, end_offset: nil, end_position: nil, locale: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, start_offset: nil, start_position: nil, updated_max: nil, updated_min: nil, volume_annotations_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::LayerSummaries) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::LayerSummaries)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 466

def list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volumes) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volumes)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 2035

def list_my_books(acquire_method: nil, country: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Annotations) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Annotations)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1045

def list_my_library_annotations(content_version: nil, layer_id: nil, layer_ids: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, updated_max: nil, updated_min: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#list_my_library_bookshelves(source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Bookshelves) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Bookshelves)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1259

def list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volumes) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volumes)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1382

def list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#list_offline_metadata_dictionary(cpksver, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Metadata) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Metadata)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 285

def list_offline_metadata_dictionary(cpksver, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#list_onboarding_categories(locale: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Category) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Category)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1540

def list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volume2) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volume2)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1579

def list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volumes) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volumes)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 2077

def list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volumes) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volumes)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 2161

def list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  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, 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volumes) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volumes)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1934

def list_volumes(q, download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_allowed_maturity_rating: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1296

def move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/moveVolume', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  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?
  execute_or_queue_command(command, &block)
end

#rate_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::RateRecommendedVolumeResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::RateRecommendedVolumeResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 2116

def rate_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

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

Release downloaded content access restriction.

Parameters:

cpksver (String) —
The device/version ID from which to release the restriction.
volume_ids (Array<String>, String) —
The volume(s) to release restrictions for.
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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::DownloadAccesses) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::DownloadAccesses)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 787

def release_download_access(cpksver, volume_ids, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1335

def remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/mylibrary/bookshelves/{shelf}/removeVolume', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  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?
  execute_or_queue_command(command, &block)
end

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

Request concurrent and download access restrictions.

Parameters:

cpksver (String) —
The device/version ID from which to request the restrictions.
nonce (String) —
The client nonce value.
source (String) —
String to identify the originator of this request.
volume_id (String) —
The volume to request concurrent/download restrictions for.
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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::RequestAccessData) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::RequestAccessData)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 830

def request_access(cpksver, nonce, source, volume_id, license_types: nil, locale: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/myconfig/requestAccess', options)
  command.response_representation = Google::Apis::BooksV1::RequestAccessData::Representation
  command.response_class = Google::Apis::BooksV1::RequestAccessData
  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?
  execute_or_queue_command(command, &block)
end

#set_my_library_reading_position(volume_id, position, timestamp, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

Sets my reading position information for a volume.

Parameters:

volume_id (String) —
ID of volume for which to update the reading position.
position (String) —
Position string for the new volume reading position.
timestamp (String) —
RFC 3339 UTC format timestamp associated with this 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1467

def set_my_library_reading_position(volume_id, position, timestamp, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/mylibrary/readingpositions/{volumeId}/setPosition', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  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?
  execute_or_queue_command(command, &block)
end

#share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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

Parameters:

doc_id (String) (defaults to: nil) —
The docid to share.
source (String) (defaults to: nil) —
String to identify the originator of this request.
volume_id (String) (defaults to: nil) —
The volume to share.
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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 350

def share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/familysharing/share', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  command.query['docId'] = doc_id unless doc_id.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::AnnotationsSummary) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::AnnotationsSummary)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1086

def summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

cpksver (String) —
The device/version ID from which to release the restriction.
nonce (String) —
The client nonce value.
source (String) —
String to identify the originator of this request.
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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Volumes) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Volumes)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 879

def sync_volume_licenses(cpksver, nonce, source, features: nil, include_non_comics_series: nil, locale: nil, show_preorders: nil, volume_ids: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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

Parameters:

doc_id (String) (defaults to: nil) —
The docid to unshare.
source (String) (defaults to: nil) —
String to identify the originator of this request.
volume_id (String) (defaults to: nil) —
The volume to unshare.
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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 387

def unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/familysharing/unshare', options)
  command.response_representation = Google::Apis::BooksV1::Empty::Representation
  command.response_class = Google::Apis::BooksV1::Empty
  command.query['docId'] = doc_id unless doc_id.nil?
  command.query['source'] = source unless source.nil?
  command.query['volumeId'] = volume_id unless volume_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Updates a user-upload volume.

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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::LoadingResource) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::LoadingResource)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 254

def update_book(loading_resource_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::Annotation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::Annotation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 1120

def update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'books/v1/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?
  execute_or_queue_command(command, &block)
end

#update_user_settings(user_settings_object = nil, fields: nil, quota_user: 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.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::BooksV1::UserSettings) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::BooksV1::UserSettings)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/books_v1/service.rb', line 917

def update_user_settings(user_settings_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'books/v1/myconfig/updateUserSettings', options)
  command.request_representation = Google::Apis::BooksV1::UserSettings::Representation
  command.request_object = user_settings_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?
  execute_or_queue_command(command, &block)
end

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

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BooksService

Instance Attribute Details

#key ⇒ String

#quota_user ⇒ String

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

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

#add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty

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

#delete_book(volume_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty

#delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty

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

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

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

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

#get_layer_annotation_data(volume_id, layer_id, annotation_data_id, content_version, allow_web_definitions: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::DictionaryAnnotationdata

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

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

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

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

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

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

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

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

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

#get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volume

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

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

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

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

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

#list_my_books(acquire_method: nil, country: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes

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

#list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes

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

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

#list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volume2

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

#list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes

#move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty

#rate_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::RateRecommendedVolumeResponse

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

#remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty

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

#set_my_library_reading_position(volume_id, position, timestamp, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty

#share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty

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

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

#unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Empty

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

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

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

#initialize ⇒ `BooksService`

#key ⇒ `String`

#quota_user ⇒ `String`

#accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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

#add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

#clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

#delete_book(volume_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

#delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

#dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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

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

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

#get_layer_annotation_data(volume_id, layer_id, annotation_data_id, content_version, allow_web_definitions: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::DictionaryAnnotationdata`

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

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

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

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

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

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

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

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

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

#get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Volume`

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

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

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

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

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

#list_my_books(acquire_method: nil, country: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Volumes`

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

#list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Volumes`

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

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

#list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Volume2`

#list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Volumes`

#list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Volumes`

#move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

#rate_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::RateRecommendedVolumeResponse`

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

#remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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

#set_my_library_reading_position(volume_id, position, timestamp, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

#share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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

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

#unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::BooksV1::Empty`

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

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

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