Class: Google::Apis::BooksV1::BooksService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::BooksV1::BooksService
- Defined in:
- generated/google/apis/books_v1/service.rb
Overview
Books API
Searches for books and manages your Google Books library.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
-
#user_ip ⇒ String
IP address of the site where the request originates.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
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, user_ip: nil, options: nil) {|result, err| ... }
- #add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LoadingResource
-
#add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Adds a volume to a bookshelf.
-
#clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Clears all volumes from a bookshelf.
-
#delete_book(volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Remove the book and its contents.
-
#delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
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, user_ip: nil, options: nil) {|result, err| ... }
-
#get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelf
Retrieves metadata for a specific bookshelf for the specified user.
-
#get_familysharing_family_info(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::FamilyInfo
Gets information regarding the family that the user is part of.
-
#get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LayerSummary
Gets the layer summary for a volume.
-
#get_layer_annotation_data(volume_id, layer_id, annotation_data_id, content_version, allow_web_definitions: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::AnnotationData
Gets the annotation data.
-
#get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::VolumeAnnotation
Gets the volume annotation.
-
#get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelf
Retrieves metadata for a specific bookshelf belonging to the authenticated user.
-
#get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::ReadingPosition
Retrieves my reading position information for a volume.
-
#get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Notification
Returns notification details for a given notification id.
-
#get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Discoveryclusters
Returns a stream of personalized book clusters.
-
#get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Offers
Returns a list of promo offers available to the user.
-
#get_series(series_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Series
Returns Series metadata for the given series ids.
-
#get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::SeriesMembership
Returns Series membership data given the series id.
-
#get_user_settings(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::UserSettings
Gets the current settings for the user.
-
#get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volume
Gets volume information for a single volume.
-
#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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: 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, user_ip: nil, options: nil) {|result, err| ... }
Moves a volume within a bookshelf.
-
#rate_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::RateRecommendedVolumeResponse
Rate a recommended book for the current user.
-
#release_download_access(volume_ids, cpksver, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::DownloadAccesses
Release downloaded content access restriction.
-
#remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Removes a volume from a bookshelf.
-
#request_access(source, volume_id, nonce, cpksver, license_types: nil, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::RequestAccess
Request concurrent and download access restrictions.
-
#set_my_library_reading_position(volume_id, timestamp, position, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Sets my reading position information for a volume.
-
#share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Initiates sharing of the content with the user's family.
-
#summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::AnnotationsSummary
Gets the summary of specified layers.
-
#sync_volume_licenses(source, nonce, cpksver, features: nil, include_non_comics_series: nil, locale: nil, show_preorders: nil, volume_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Request downloaded content access for specified volumes on the My eBooks shelf.
-
#unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Initiates revoking content that has already been shared with the user's family.
- #update_book(loading_resource_object = nil, fields: nil, quota_user: nil, user_ip: 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, user_ip: 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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::UserSettings
Sets the settings for the user.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ BooksService
Returns a new instance of BooksService
51 52 53 54 |
# File 'generated/google/apis/books_v1/service.rb', line 51 def initialize super('https://www.googleapis.com/', 'books/v1/') @batch_path = 'batch/books/v1' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'generated/google/apis/books_v1/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
44 45 46 |
# File 'generated/google/apis/books_v1/service.rb', line 44 def quota_user @quota_user end |
#user_ip ⇒ String
Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.
49 50 51 |
# File 'generated/google/apis/books_v1/service.rb', line 49 def user_ip @user_ip end |
Instance Method Details
#accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 |
# File 'generated/google/apis/books_v1/service.rb', line 1845 def accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'promooffer/accept', ) command.query['androidId'] = android_id unless android_id.nil? command.query['device'] = device unless device.nil? command.query['manufacturer'] = manufacturer unless manufacturer.nil? command.query['model'] = model unless model.nil? command.query['offerId'] = offer_id unless offer_id.nil? command.query['product'] = product unless product.nil? command.query['serial'] = serial unless serial.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LoadingResource
214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'generated/google/apis/books_v1/service.rb', line 214 def add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'cloudloading/addBook', ) command.response_representation = Google::Apis::BooksV1::LoadingResource::Representation command.response_class = Google::Apis::BooksV1::LoadingResource command.query['drive_document_id'] = drive_document_id unless drive_document_id.nil? command.query['mime_type'] = mime_type unless mime_type.nil? command.query['name'] = name unless name.nil? command.query['upload_client_token'] = upload_client_token unless upload_client_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Adds a volume to a bookshelf.
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 |
# File 'generated/google/apis/books_v1/service.rb', line 1285 def add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/addVolume', ) command.params['shelf'] = shelf unless shelf.nil? command.query['reason'] = reason unless reason.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Clears all volumes from a bookshelf.
1323 1324 1325 1326 1327 1328 1329 1330 1331 |
# File 'generated/google/apis/books_v1/service.rb', line 1323 def clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/clearVolumes', ) command.params['shelf'] = shelf unless shelf.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#delete_book(volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Remove the book and its contents
252 253 254 255 256 257 258 259 |
# File 'generated/google/apis/books_v1/service.rb', line 252 def delete_book(volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'cloudloading/deleteBook', ) command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Deletes an annotation.
1053 1054 1055 1056 1057 1058 1059 1060 1061 |
# File 'generated/google/apis/books_v1/service.rb', line 1053 def delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'mylibrary/annotations/{annotationId}', ) command.params['annotationId'] = annotation_id unless annotation_id.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 |
# File 'generated/google/apis/books_v1/service.rb', line 1897 def dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'promooffer/dismiss', ) command.query['androidId'] = android_id unless android_id.nil? command.query['device'] = device unless device.nil? command.query['manufacturer'] = manufacturer unless manufacturer.nil? command.query['model'] = model unless model.nil? command.query['offerId'] = offer_id unless offer_id.nil? command.query['product'] = product unless product.nil? command.query['serial'] = serial unless serial.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelf
Retrieves metadata for a specific bookshelf for the specified user.
84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'generated/google/apis/books_v1/service.rb', line 84 def get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'users/{userId}/bookshelves/{shelf}', ) command.response_representation = Google::Apis::BooksV1::Bookshelf::Representation command.response_class = Google::Apis::BooksV1::Bookshelf command.params['userId'] = user_id unless user_id.nil? command.params['shelf'] = shelf unless shelf.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_familysharing_family_info(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::FamilyInfo
Gets information regarding the family that the user is part of.
355 356 357 358 359 360 361 362 363 364 |
# File 'generated/google/apis/books_v1/service.rb', line 355 def get_familysharing_family_info(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'familysharing/getFamilyInfo', ) command.response_representation = Google::Apis::BooksV1::FamilyInfo::Representation command.response_class = Google::Apis::BooksV1::FamilyInfo command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LayerSummary
Gets the layer summary for a volume.
476 477 478 479 480 481 482 483 484 485 486 487 488 |
# File 'generated/google/apis/books_v1/service.rb', line 476 def get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layersummary/{summaryId}', ) command.response_representation = Google::Apis::BooksV1::LayerSummary::Representation command.response_class = Google::Apis::BooksV1::LayerSummary command.params['volumeId'] = volume_id unless volume_id.nil? command.params['summaryId'] = summary_id unless summary_id.nil? command.query['contentVersion'] = content_version unless content_version.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_layer_annotation_data(volume_id, layer_id, annotation_data_id, content_version, allow_web_definitions: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::AnnotationData
Gets the annotation data.
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'generated/google/apis/books_v1/service.rb', line 582 def get_layer_annotation_data(volume_id, layer_id, annotation_data_id, content_version, allow_web_definitions: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}', ) command.response_representation = Google::Apis::BooksV1::AnnotationData::Representation command.response_class = Google::Apis::BooksV1::AnnotationData command.params['volumeId'] = volume_id unless volume_id.nil? command.params['layerId'] = layer_id unless layer_id.nil? command.params['annotationDataId'] = annotation_data_id unless annotation_data_id.nil? command.query['allowWebDefinitions'] = allow_web_definitions unless allow_web_definitions.nil? command.query['contentVersion'] = content_version unless content_version.nil? command.query['h'] = h unless h.nil? command.query['locale'] = locale unless locale.nil? command.query['scale'] = scale unless scale.nil? command.query['source'] = source unless source.nil? command.query['w'] = w unless w.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::VolumeAnnotation
Gets the volume annotation.
712 713 714 715 716 717 718 719 720 721 722 723 724 725 |
# File 'generated/google/apis/books_v1/service.rb', line 712 def get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}', ) command.response_representation = Google::Apis::BooksV1::VolumeAnnotation::Representation command.response_class = Google::Apis::BooksV1::VolumeAnnotation command.params['volumeId'] = volume_id unless volume_id.nil? command.params['layerId'] = layer_id unless layer_id.nil? command.params['annotationId'] = annotation_id unless annotation_id.nil? command.query['locale'] = locale unless locale.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelf
Retrieves metadata for a specific bookshelf belonging to the authenticated user.
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 |
# File 'generated/google/apis/books_v1/service.rb', line 1360 def get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'mylibrary/bookshelves/{shelf}', ) command.response_representation = Google::Apis::BooksV1::Bookshelf::Representation command.response_class = Google::Apis::BooksV1::Bookshelf command.params['shelf'] = shelf unless shelf.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::ReadingPosition
Retrieves my reading position information for a volume.
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 |
# File 'generated/google/apis/books_v1/service.rb', line 1576 def get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'mylibrary/readingpositions/{volumeId}', ) command.response_representation = Google::Apis::BooksV1::ReadingPosition::Representation command.response_class = Google::Apis::BooksV1::ReadingPosition command.params['volumeId'] = volume_id unless volume_id.nil? command.query['contentVersion'] = content_version unless content_version.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Notification
Returns notification details for a given notification id.
1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 |
# File 'generated/google/apis/books_v1/service.rb', line 1669 def get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'notification/get', ) command.response_representation = Google::Apis::BooksV1::Notification::Representation command.response_class = Google::Apis::BooksV1::Notification command.query['locale'] = locale unless locale.nil? command.query['notification_id'] = notification_id unless notification_id.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Discoveryclusters
Returns a stream of personalized book clusters
1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 |
# File 'generated/google/apis/books_v1/service.rb', line 1795 def get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'personalizedstream/get', ) 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'] = unless .nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Offers
Returns a list of promo offers available to the user
1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 |
# File 'generated/google/apis/books_v1/service.rb', line 1946 def get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'promooffer/get', ) command.response_representation = Google::Apis::BooksV1::Offers::Representation command.response_class = Google::Apis::BooksV1::Offers command.query['androidId'] = android_id unless android_id.nil? command.query['device'] = device unless device.nil? command.query['manufacturer'] = manufacturer unless manufacturer.nil? command.query['model'] = model unless model.nil? command.query['product'] = product unless product.nil? command.query['serial'] = serial unless serial.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_series(series_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Series
Returns Series metadata for the given series ids.
1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 |
# File 'generated/google/apis/books_v1/service.rb', line 1986 def get_series(series_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'series/get', ) command.response_representation = Google::Apis::BooksV1::Series::Representation command.response_class = Google::Apis::BooksV1::Series command.query['series_id'] = series_id unless series_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::SeriesMembership
Returns Series membership data given the series id.
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 |
# File 'generated/google/apis/books_v1/service.rb', line 2025 def get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'series/membership/get', ) command.response_representation = Google::Apis::BooksV1::SeriesMembership::Representation command.response_class = Google::Apis::BooksV1::SeriesMembership command.query['page_size'] = page_size unless page_size.nil? command.query['page_token'] = page_token unless page_token.nil? command.query['series_id'] = series_id unless series_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_user_settings(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::UserSettings
Gets the current settings for the user.
830 831 832 833 834 835 836 837 838 |
# File 'generated/google/apis/books_v1/service.rb', line 830 def get_user_settings(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'myconfig/getUserSettings', ) command.response_representation = Google::Apis::BooksV1::UserSettings::Representation command.response_class = Google::Apis::BooksV1::UserSettings command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volume
Gets volume information for a single volume.
2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 |
# File 'generated/google/apis/books_v1/service.rb', line 2073 def get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}', ) command.response_representation = Google::Apis::BooksV1::Volume::Representation command.response_class = Google::Apis::BooksV1::Volume command.params['volumeId'] = volume_id unless volume_id.nil? command.query['country'] = country unless country.nil? command.query['includeNonComicsSeries'] = include_non_comics_series unless include_non_comics_series.nil? command.query['partner'] = partner unless partner.nil? command.query['projection'] = projection unless projection.nil? command.query['source'] = source unless source.nil? command.query['user_library_consistent_read'] = user_library_consistent_read unless user_library_consistent_read.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#insert_my_library_annotation(annotation_object = nil, annotation_id: nil, country: nil, show_only_summary_in_response: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Annotation
Inserts a new annotation.
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 |
# File 'generated/google/apis/books_v1/service.rb', line 1095 def insert_my_library_annotation(annotation_object = nil, annotation_id: nil, country: nil, show_only_summary_in_response: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/annotations', ) command.request_representation = Google::Apis::BooksV1::Annotation::Representation command.request_object = annotation_object command.response_representation = Google::Apis::BooksV1::Annotation::Representation command.response_class = Google::Apis::BooksV1::Annotation command.query['annotationId'] = annotation_id unless annotation_id.nil? command.query['country'] = country unless country.nil? command.query['showOnlySummaryInResponse'] = show_only_summary_in_response unless show_only_summary_in_response.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Return a list of associated books.
2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 |
# File 'generated/google/apis/books_v1/service.rb', line 2199 def list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/associated', ) 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'] = unless .nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Retrieves volumes in a specific bookshelf for the specified user.
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'generated/google/apis/books_v1/service.rb', line 169 def list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'users/{userId}/bookshelves/{shelf}/volumes', ) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.params['userId'] = user_id unless user_id.nil? command.params['shelf'] = shelf unless shelf.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['showPreorders'] = show_preorders unless show_preorders.nil? command.query['source'] = source unless source.nil? command.query['startIndex'] = start_index unless start_index.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelves
Retrieves a list of public bookshelves for the specified user.
123 124 125 126 127 128 129 130 131 132 133 |
# File 'generated/google/apis/books_v1/service.rb', line 123 def list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'users/{userId}/bookshelves', ) command.response_representation = Google::Apis::BooksV1::Bookshelves::Representation command.response_class = Google::Apis::BooksV1::Bookshelves command.params['userId'] = user_id unless user_id.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_layer_annotation_data(volume_id, layer_id, content_version, annotation_data_id: nil, h: nil, locale: nil, max_results: nil, page_token: nil, scale: nil, source: nil, updated_max: nil, updated_min: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::AnnotationsData
Gets the annotation data for a volume and layer.
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 |
# File 'generated/google/apis/books_v1/service.rb', line 656 def list_layer_annotation_data(volume_id, layer_id, content_version, annotation_data_id: nil, h: nil, locale: nil, max_results: nil, page_token: nil, scale: nil, source: nil, updated_max: nil, updated_min: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/data', ) command.response_representation = Google::Apis::BooksV1::AnnotationsData::Representation command.response_class = Google::Apis::BooksV1::AnnotationsData command.params['volumeId'] = volume_id unless volume_id.nil? command.params['layerId'] = layer_id unless layer_id.nil? command.query['annotationDataId'] = annotation_data_id unless annotation_data_id.nil? command.query['contentVersion'] = content_version unless content_version.nil? command.query['h'] = h unless h.nil? command.query['locale'] = locale unless locale.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['scale'] = scale unless scale.nil? command.query['source'] = source unless source.nil? command.query['updatedMax'] = updated_max unless updated_max.nil? command.query['updatedMin'] = updated_min unless updated_min.nil? command.query['w'] = w unless w.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_layer_volume_annotations(volume_id, layer_id, content_version, end_offset: nil, end_position: nil, locale: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, start_offset: nil, start_position: nil, updated_max: nil, updated_min: nil, volume_annotations_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumeannotations
Gets the volume annotations for a volume and layer.
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 |
# File 'generated/google/apis/books_v1/service.rb', line 783 def list_layer_volume_annotations(volume_id, layer_id, content_version, end_offset: nil, end_position: nil, locale: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, start_offset: nil, start_position: nil, updated_max: nil, updated_min: nil, volume_annotations_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}', ) command.response_representation = Google::Apis::BooksV1::Volumeannotations::Representation command.response_class = Google::Apis::BooksV1::Volumeannotations command.params['volumeId'] = volume_id unless volume_id.nil? command.params['layerId'] = layer_id unless layer_id.nil? command.query['contentVersion'] = content_version unless content_version.nil? command.query['endOffset'] = end_offset unless end_offset.nil? command.query['endPosition'] = end_position unless end_position.nil? command.query['locale'] = locale unless locale.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['showDeleted'] = show_deleted unless show_deleted.nil? command.query['source'] = source unless source.nil? command.query['startOffset'] = start_offset unless start_offset.nil? command.query['startPosition'] = start_position unless start_position.nil? command.query['updatedMax'] = updated_max unless updated_max.nil? command.query['updatedMin'] = updated_min unless updated_min.nil? command.query['volumeAnnotationsVersion'] = volume_annotations_version unless volume_annotations_version.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LayerSummaries
List the layer summaries for a volume.
522 523 524 525 526 527 528 529 530 531 532 533 534 535 |
# File 'generated/google/apis/books_v1/service.rb', line 522 def list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layersummary', ) command.response_representation = Google::Apis::BooksV1::LayerSummaries::Representation command.response_class = Google::Apis::BooksV1::LayerSummaries command.params['volumeId'] = volume_id unless volume_id.nil? command.query['contentVersion'] = content_version unless content_version.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_my_books(acquire_method: nil, country: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Return a list of books in My Library.
2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 |
# File 'generated/google/apis/books_v1/service.rb', line 2252 def list_my_books(acquire_method: nil, country: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/mybooks', ) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.query['acquireMethod'] = acquire_method unless acquire_method.nil? command.query['country'] = country unless country.nil? command.query['locale'] = locale unless locale.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['processingState'] = processing_state unless processing_state.nil? command.query['source'] = source unless source.nil? command.query['startIndex'] = start_index unless start_index.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_my_library_annotations(content_version: nil, layer_id: nil, layer_ids: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, updated_max: nil, updated_min: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Annotations
Retrieves a list of annotations, possibly filtered.
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 |
# File 'generated/google/apis/books_v1/service.rb', line 1156 def list_my_library_annotations(content_version: nil, layer_id: nil, layer_ids: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, updated_max: nil, updated_min: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'mylibrary/annotations', ) command.response_representation = Google::Apis::BooksV1::Annotations::Representation command.response_class = Google::Apis::BooksV1::Annotations command.query['contentVersion'] = content_version unless content_version.nil? command.query['layerId'] = layer_id unless layer_id.nil? command.query['layerIds'] = layer_ids unless layer_ids.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['showDeleted'] = show_deleted unless show_deleted.nil? command.query['source'] = source unless source.nil? command.query['updatedMax'] = updated_max unless updated_max.nil? command.query['updatedMin'] = updated_min unless updated_min.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Bookshelves
Retrieves a list of bookshelves belonging to the authenticated user.
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 |
# File 'generated/google/apis/books_v1/service.rb', line 1396 def list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'mylibrary/bookshelves', ) command.response_representation = Google::Apis::BooksV1::Bookshelves::Representation command.response_class = Google::Apis::BooksV1::Bookshelves command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Gets volume information for volumes on a bookshelf.
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 |
# File 'generated/google/apis/books_v1/service.rb', line 1530 def list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'mylibrary/bookshelves/{shelf}/volumes', ) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.params['shelf'] = shelf unless shelf.nil? command.query['country'] = country unless country.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['projection'] = projection unless projection.nil? command.query['q'] = q unless q.nil? command.query['showPreorders'] = show_preorders unless show_preorders.nil? command.query['source'] = source unless source.nil? command.query['startIndex'] = start_index unless start_index.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_offline_metadata_dictionary(cpksver, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Metadata
Returns a list of offline dictionary metadata available
320 321 322 323 324 325 326 327 328 329 |
# File 'generated/google/apis/books_v1/service.rb', line 320 def (cpksver, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'dictionary/listOfflineMetadata', ) command.response_representation = Google::Apis::BooksV1::Metadata::Representation command.response_class = Google::Apis::BooksV1::Metadata command.query['cpksver'] = cpksver unless cpksver.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Category
List categories for onboarding experience.
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 |
# File 'generated/google/apis/books_v1/service.rb', line 1706 def list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'onboarding/listCategories', ) command.response_representation = Google::Apis::BooksV1::Category::Representation command.response_class = Google::Apis::BooksV1::Category command.query['locale'] = locale unless locale.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volume2
List available volumes under categories for onboarding experience.
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 |
# File 'generated/google/apis/books_v1/service.rb', line 1750 def list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'onboarding/listCategoryVolumes', ) 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'] = unless .nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Return a list of recommended books for the current user.
2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 |
# File 'generated/google/apis/books_v1/service.rb', line 2299 def list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/recommended', ) 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'] = unless .nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Return a list of books uploaded by the current user.
2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 |
# File 'generated/google/apis/books_v1/service.rb', line 2393 def list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/useruploaded', ) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.query['locale'] = locale unless locale.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['processingState'] = processing_state unless processing_state.nil? command.query['source'] = source unless source.nil? command.query['startIndex'] = start_index unless start_index.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_volumes(q, download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_allowed_maturity_rating: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Performs a book search.
2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 |
# File 'generated/google/apis/books_v1/service.rb', line 2141 def list_volumes(q, download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_allowed_maturity_rating: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes', ) 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'] = unless .nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['partner'] = partner unless partner.nil? command.query['printType'] = print_type unless print_type.nil? command.query['projection'] = projection unless projection.nil? command.query['q'] = q unless q.nil? command.query['showPreorders'] = show_preorders unless show_preorders.nil? command.query['source'] = source unless source.nil? command.query['startIndex'] = start_index unless start_index.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Moves a volume within a bookshelf.
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 |
# File 'generated/google/apis/books_v1/service.rb', line 1438 def move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/moveVolume', ) command.params['shelf'] = shelf unless shelf.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['volumePosition'] = volume_position unless volume_position.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#rate_recommended_volume(rating, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::RateRecommendedVolumeResponse
Rate a recommended book for the current user.
2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 |
# File 'generated/google/apis/books_v1/service.rb', line 2343 def rate_recommended_volume(, volume_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'volumes/recommended/rate', ) 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'] = unless .nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#release_download_access(volume_ids, cpksver, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::DownloadAccesses
Release downloaded content access restriction.
870 871 872 873 874 875 876 877 878 879 880 881 882 |
# File 'generated/google/apis/books_v1/service.rb', line 870 def release_download_access(volume_ids, cpksver, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'myconfig/releaseDownloadAccess', ) command.response_representation = Google::Apis::BooksV1::DownloadAccesses::Representation command.response_class = Google::Apis::BooksV1::DownloadAccesses command.query['cpksver'] = cpksver unless cpksver.nil? command.query['locale'] = locale unless locale.nil? command.query['source'] = source unless source.nil? command.query['volumeIds'] = volume_ids unless volume_ids.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Removes a volume from a bookshelf.
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 |
# File 'generated/google/apis/books_v1/service.rb', line 1480 def remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/removeVolume', ) command.params['shelf'] = shelf unless shelf.nil? command.query['reason'] = reason unless reason.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#request_access(source, volume_id, nonce, cpksver, license_types: nil, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::RequestAccess
Request concurrent and download access restrictions.
918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 |
# File 'generated/google/apis/books_v1/service.rb', line 918 def request_access(source, volume_id, nonce, cpksver, license_types: nil, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'myconfig/requestAccess', ) command.response_representation = Google::Apis::BooksV1::RequestAccess::Representation command.response_class = Google::Apis::BooksV1::RequestAccess command.query['cpksver'] = cpksver unless cpksver.nil? command.query['licenseTypes'] = license_types unless license_types.nil? command.query['locale'] = locale unless locale.nil? command.query['nonce'] = nonce unless nonce.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#set_my_library_reading_position(volume_id, timestamp, position, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Sets my reading position information for a volume.
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 |
# File 'generated/google/apis/books_v1/service.rb', line 1625 def set_my_library_reading_position(volume_id, , position, action: nil, content_version: nil, device_cookie: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/readingpositions/{volumeId}/setPosition', ) 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'] = unless .nil? command.query['position'] = position unless position.nil? command.query['source'] = source unless source.nil? command.query['timestamp'] = unless .nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Initiates sharing of the content with the user's family. Empty response indicates success.
395 396 397 398 399 400 401 402 403 404 |
# File 'generated/google/apis/books_v1/service.rb', line 395 def share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'familysharing/share', ) command.query['docId'] = doc_id unless doc_id.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::AnnotationsSummary
Gets the summary of specified layers.
1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 |
# File 'generated/google/apis/books_v1/service.rb', line 1202 def summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/annotations/summary', ) command.response_representation = Google::Apis::BooksV1::AnnotationsSummary::Representation command.response_class = Google::Apis::BooksV1::AnnotationsSummary command.query['layerIds'] = layer_ids unless layer_ids.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#sync_volume_licenses(source, nonce, cpksver, features: nil, include_non_comics_series: nil, locale: nil, show_preorders: nil, volume_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Volumes
Request downloaded content access for specified volumes on the My eBooks shelf.
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 |
# File 'generated/google/apis/books_v1/service.rb', line 972 def sync_volume_licenses(source, nonce, cpksver, features: nil, include_non_comics_series: nil, locale: nil, show_preorders: nil, volume_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'myconfig/syncVolumeLicenses', ) command.response_representation = Google::Apis::BooksV1::Volumes::Representation command.response_class = Google::Apis::BooksV1::Volumes command.query['cpksver'] = cpksver unless cpksver.nil? command.query['features'] = features unless features.nil? command.query['includeNonComicsSeries'] = include_non_comics_series unless include_non_comics_series.nil? command.query['locale'] = locale unless locale.nil? command.query['nonce'] = nonce unless nonce.nil? command.query['showPreorders'] = show_preorders unless show_preorders.nil? command.query['source'] = source unless source.nil? command.query['volumeIds'] = volume_ids unless volume_ids.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
Initiates revoking content that has already been shared with the user's family. Empty response indicates success.
435 436 437 438 439 440 441 442 443 444 |
# File 'generated/google/apis/books_v1/service.rb', line 435 def unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'familysharing/unshare', ) command.query['docId'] = doc_id unless doc_id.nil? command.query['source'] = source unless source.nil? command.query['volumeId'] = volume_id unless volume_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#update_book(loading_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::LoadingResource
284 285 286 287 288 289 290 291 292 293 294 |
# File 'generated/google/apis/books_v1/service.rb', line 284 def update_book(loading_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'cloudloading/updateBook', ) command.request_representation = Google::Apis::BooksV1::LoadingResource::Representation command.request_object = loading_resource_object command.response_representation = Google::Apis::BooksV1::LoadingResource::Representation command.response_class = Google::Apis::BooksV1::LoadingResource command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::Annotation
Updates an existing annotation.
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 |
# File 'generated/google/apis/books_v1/service.rb', line 1241 def update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'mylibrary/annotations/{annotationId}', ) command.request_representation = Google::Apis::BooksV1::Annotation::Representation command.request_object = annotation_object command.response_representation = Google::Apis::BooksV1::Annotation::Representation command.response_class = Google::Apis::BooksV1::Annotation command.params['annotationId'] = annotation_id unless annotation_id.nil? command.query['source'] = source unless source.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#update_user_settings(user_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BooksV1::UserSettings
Sets the settings for the user. If a sub-object is specified, it will overwrite the existing sub-object stored in the server. Unspecified sub- objects will retain the existing value.
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 |
# File 'generated/google/apis/books_v1/service.rb', line 1015 def update_user_settings(user_settings_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'myconfig/updateUserSettings', ) 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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |