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 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    An opaque string that represents a user for quota purposes. 
- 
  
    
      #user_ip  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    Deprecated. 
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
| 49 50 51 52 | # File 'generated/google/apis/books_v1/service.rb', line 49 def initialize super('https://www.googleapis.com/', 'books/v1/') @batch_path = 'batch/books/v1' end | 
Instance Attribute Details
#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 An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
| 43 44 45 | # File 'generated/google/apis/books_v1/service.rb', line 43 def quota_user @quota_user end | 
#user_ip ⇒ String
Returns Deprecated. Please use quotaUser instead.
| 47 48 49 | # File 'generated/google/apis/books_v1/service.rb', line 47 def user_ip @user_ip end | 
Instance Method Details
#accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
This method returns an undefined value.
| 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 | # File 'generated/google/apis/books_v1/service.rb', line 1763 def accept_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'promooffer/accept', ) 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
| 204 205 206 207 208 209 210 211 212 213 214 215 216 | # File 'generated/google/apis/books_v1/service.rb', line 204 def add_book(drive_document_id: nil, mime_type: nil, name: nil, upload_client_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'cloudloading/addBook', ) 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.
| 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 | # File 'generated/google/apis/books_v1/service.rb', line 1229 def add_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/addVolume', ) 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.
| 1265 1266 1267 1268 1269 1270 1271 1272 1273 | # File 'generated/google/apis/books_v1/service.rb', line 1265 def clear_my_library_volumes(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/clearVolumes', ) 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
| 240 241 242 243 244 245 246 247 | # File 'generated/google/apis/books_v1/service.rb', line 240 def delete_book(volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'cloudloading/deleteBook', ) 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.
| 1007 1008 1009 1010 1011 1012 1013 1014 1015 | # File 'generated/google/apis/books_v1/service.rb', line 1007 def delete_my_library_annotation(annotation_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, 'mylibrary/annotations/{annotationId}', ) 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.
| 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 | # File 'generated/google/apis/books_v1/service.rb', line 1813 def dismiss_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, offer_id: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'promooffer/dismiss', ) 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.
| 80 81 82 83 84 85 86 87 88 89 90 91 | # File 'generated/google/apis/books_v1/service.rb', line 80 def get_bookshelf(user_id, shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'users/{userId}/bookshelves/{shelf}', ) 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.
| 337 338 339 340 341 342 343 344 345 346 | # File 'generated/google/apis/books_v1/service.rb', line 337 def get_familysharing_family_info(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'familysharing/getFamilyInfo', ) 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.
| 452 453 454 455 456 457 458 459 460 461 462 463 464 | # File 'generated/google/apis/books_v1/service.rb', line 452 def get_layer(volume_id, summary_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layersummary/{summaryId}', ) 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.
| 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 | # File 'generated/google/apis/books_v1/service.rb', line 554 def get_layer_annotation_data(volume_id, layer_id, annotation_data_id, content_version, allow_web_definitions: nil, h: nil, locale: nil, scale: nil, source: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/data/{annotationDataId}', ) 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.
| 680 681 682 683 684 685 686 687 688 689 690 691 692 693 | # File 'generated/google/apis/books_v1/service.rb', line 680 def get_layer_volume_annotation(volume_id, layer_id, annotation_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/annotations/{annotationId}', ) 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.
| 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 | # File 'generated/google/apis/books_v1/service.rb', line 1300 def get_my_library_bookshelf(shelf, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'mylibrary/bookshelves/{shelf}', ) 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.
| 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 | # File 'generated/google/apis/books_v1/service.rb', line 1506 def get_my_library_reading_position(volume_id, content_version: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'mylibrary/readingpositions/{volumeId}', ) 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.
| 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 | # File 'generated/google/apis/books_v1/service.rb', line 1595 def get_notification(notification_id, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'notification/get', ) 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
| 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 | # File 'generated/google/apis/books_v1/service.rb', line 1715 def get_personalizedstream(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'personalizedstream/get', ) 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
| 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 | # File 'generated/google/apis/books_v1/service.rb', line 1860 def get_promo_offer(android_id: nil, device: nil, manufacturer: nil, model: nil, product: nil, serial: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'promooffer/get', ) 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.
| 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 | # File 'generated/google/apis/books_v1/service.rb', line 1898 def get_series(series_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'series/get', ) 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.
| 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 | # File 'generated/google/apis/books_v1/service.rb', line 1935 def get_series_membership(series_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'series/membership/get', ) 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.
| 794 795 796 797 798 799 800 801 802 | # File 'generated/google/apis/books_v1/service.rb', line 794 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.
| 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 | # File 'generated/google/apis/books_v1/service.rb', line 1981 def get_volume(volume_id, country: nil, include_non_comics_series: nil, partner: nil, projection: nil, source: nil, user_library_consistent_read: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}', ) 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.
| 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 | # File 'generated/google/apis/books_v1/service.rb', line 1047 def insert_my_library_annotation(annotation_object = nil, annotation_id: nil, country: nil, show_only_summary_in_response: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/annotations', ) 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.
| 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 | # File 'generated/google/apis/books_v1/service.rb', line 2103 def list_associated_volumes(volume_id, association: nil, locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/associated', ) 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.
| 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 | # File 'generated/google/apis/books_v1/service.rb', line 161 def list_bookshelf_volumes(user_id, shelf, max_results: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'users/{userId}/bookshelves/{shelf}/volumes', ) 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.
| 117 118 119 120 121 122 123 124 125 126 127 | # File 'generated/google/apis/books_v1/service.rb', line 117 def list_bookshelves(user_id, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'users/{userId}/bookshelves', ) 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.
| 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 | # File 'generated/google/apis/books_v1/service.rb', line 626 def list_layer_annotation_data(volume_id, layer_id, content_version, annotation_data_id: nil, h: nil, locale: nil, max_results: nil, page_token: nil, scale: nil, source: nil, updated_max: nil, updated_min: nil, w: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}/data', ) 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.
| 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 | # File 'generated/google/apis/books_v1/service.rb', line 749 def list_layer_volume_annotations(volume_id, layer_id, content_version, end_offset: nil, end_position: nil, locale: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, start_offset: nil, start_position: nil, updated_max: nil, updated_min: nil, volume_annotations_version: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layers/{layerId}', ) 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.
| 496 497 498 499 500 501 502 503 504 505 506 507 508 509 | # File 'generated/google/apis/books_v1/service.rb', line 496 def list_layers(volume_id, content_version: nil, max_results: nil, page_token: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/{volumeId}/layersummary', ) 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.
| 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 | # File 'generated/google/apis/books_v1/service.rb', line 2154 def list_my_books(acquire_method: nil, country: nil, locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/mybooks', ) 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.
| 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 | # File 'generated/google/apis/books_v1/service.rb', line 1106 def list_my_library_annotations(content_version: nil, layer_id: nil, layer_ids: nil, max_results: nil, page_token: nil, show_deleted: nil, source: nil, updated_max: nil, updated_min: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'mylibrary/annotations', ) 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.
| 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 | # File 'generated/google/apis/books_v1/service.rb', line 1334 def list_my_library_bookshelves(source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'mylibrary/bookshelves', ) 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.
| 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 | # File 'generated/google/apis/books_v1/service.rb', line 1462 def list_my_library_volumes(shelf, country: nil, max_results: nil, projection: nil, q: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'mylibrary/bookshelves/{shelf}/volumes', ) 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
| 304 305 306 307 308 309 310 311 312 313 | # File 'generated/google/apis/books_v1/service.rb', line 304 def (cpksver, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'dictionary/listOfflineMetadata', ) 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.
| 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 | # File 'generated/google/apis/books_v1/service.rb', line 1630 def list_onboarding_categories(locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'onboarding/listCategories', ) 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.
| 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 | # File 'generated/google/apis/books_v1/service.rb', line 1672 def list_onboarding_category_volumes(category_id: nil, locale: nil, max_allowed_maturity_rating: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'onboarding/listCategoryVolumes', ) 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.
| 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 | # File 'generated/google/apis/books_v1/service.rb', line 2199 def list_recommended_volumes(locale: nil, max_allowed_maturity_rating: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/recommended', ) 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.
| 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 | # File 'generated/google/apis/books_v1/service.rb', line 2289 def list_user_uploaded_volumes(locale: nil, max_results: nil, processing_state: nil, source: nil, start_index: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes/useruploaded', ) 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.
| 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 | # File 'generated/google/apis/books_v1/service.rb', line 2047 def list_volumes(q, download: nil, filter: nil, lang_restrict: nil, library_restrict: nil, max_allowed_maturity_rating: nil, max_results: nil, order_by: nil, partner: nil, print_type: nil, projection: nil, show_preorders: nil, source: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'volumes', ) 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.
| 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 | # File 'generated/google/apis/books_v1/service.rb', line 1374 def move_my_library_volume(shelf, volume_id, volume_position, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/moveVolume', ) 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.
| 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 | # File 'generated/google/apis/books_v1/service.rb', line 2241 def rate_recommended_volume(, 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.
| 832 833 834 835 836 837 838 839 840 841 842 843 844 | # File 'generated/google/apis/books_v1/service.rb', line 832 def release_download_access(volume_ids, cpksver, locale: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'myconfig/releaseDownloadAccess', ) 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.
| 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 | # File 'generated/google/apis/books_v1/service.rb', line 1414 def remove_my_library_volume(shelf, volume_id, reason: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/bookshelves/{shelf}/removeVolume', ) 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.
| 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 | # File 'generated/google/apis/books_v1/service.rb', line 878 def request_access(source, volume_id, nonce, cpksver, license_types: nil, locale: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'myconfig/requestAccess', ) 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.
| 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 | # File 'generated/google/apis/books_v1/service.rb', line 1553 def set_my_library_reading_position(volume_id, , 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.
| 375 376 377 378 379 380 381 382 383 384 | # File 'generated/google/apis/books_v1/service.rb', line 375 def share_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'familysharing/share', ) 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.
| 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 | # File 'generated/google/apis/books_v1/service.rb', line 1150 def summarize_my_library_annotation(layer_ids, volume_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'mylibrary/annotations/summary', ) 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.
| 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 | # File 'generated/google/apis/books_v1/service.rb', line 930 def sync_volume_licenses(source, nonce, cpksver, features: nil, include_non_comics_series: nil, locale: nil, show_preorders: nil, volume_ids: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'myconfig/syncVolumeLicenses', ) 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.
| 413 414 415 416 417 418 419 420 421 422 | # File 'generated/google/apis/books_v1/service.rb', line 413 def unshare_familysharing(doc_id: nil, source: nil, volume_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'familysharing/unshare', ) 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
| 270 271 272 273 274 275 276 277 278 279 280 | # File 'generated/google/apis/books_v1/service.rb', line 270 def update_book(loading_resource_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, 'cloudloading/updateBook', ) 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.
| 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 | # File 'generated/google/apis/books_v1/service.rb', line 1187 def update_my_library_annotation(annotation_id, annotation_object = nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, 'mylibrary/annotations/{annotationId}', ) 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.
| 971 972 973 974 975 976 977 978 979 980 981 | # File 'generated/google/apis/books_v1/service.rb', line 971 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 |