Class: Google::Apis::BooksV1::Volume::AccessInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/books_v1/classes.rb,
generated/google/apis/books_v1/representations.rb,
generated/google/apis/books_v1/representations.rb

Overview

Any information about a volume related to reading or obtaining that volume text. This information can depend on country (books may be public domain in one country but not in another, e.g.).

Defined Under Namespace

Classes: Epub, Pdf

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AccessInfo

Returns a new instance of AccessInfo



2836
2837
2838
# File 'generated/google/apis/books_v1/classes.rb', line 2836

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access_view_statusString

Combines the access and viewability of this volume into a single status field for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or NONE. (In LITE projection.) Corresponds to the JSON property accessViewStatus

Returns:

  • (String)


2753
2754
2755
# File 'generated/google/apis/books_v1/classes.rb', line 2753

def access_view_status
  @access_view_status
end

#countryString

The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.) Corresponds to the JSON property country

Returns:

  • (String)


2759
2760
2761
# File 'generated/google/apis/books_v1/classes.rb', line 2759

def country
  @country
end

#download_accessGoogle::Apis::BooksV1::DownloadAccessRestriction

Information about a volume's download license access restrictions. Corresponds to the JSON property downloadAccess



2764
2765
2766
# File 'generated/google/apis/books_v1/classes.rb', line 2764

def download_access
  @download_access
end

URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive. Corresponds to the JSON property driveImportedContentLink

Returns:

  • (String)


2770
2771
2772
# File 'generated/google/apis/books_v1/classes.rb', line 2770

def drive_imported_content_link
  @drive_imported_content_link
end

#embeddableBoolean Also known as: embeddable?

Whether this volume can be embedded in a viewport using the Embedded Viewer API. Corresponds to the JSON property embeddable

Returns:

  • (Boolean)


2776
2777
2778
# File 'generated/google/apis/books_v1/classes.rb', line 2776

def embeddable
  @embeddable
end

#epubGoogle::Apis::BooksV1::Volume::AccessInfo::Epub

Information about epub content. (In LITE projection.) Corresponds to the JSON property epub



2782
2783
2784
# File 'generated/google/apis/books_v1/classes.rb', line 2782

def epub
  @epub
end

#explicit_offline_license_managementBoolean Also known as: explicit_offline_license_management?

Whether this volume requires that the client explicitly request offline download license rather than have it done automatically when loading the content, if the client supports it. Corresponds to the JSON property explicitOfflineLicenseManagement

Returns:

  • (Boolean)


2789
2790
2791
# File 'generated/google/apis/books_v1/classes.rb', line 2789

def explicit_offline_license_management
  @explicit_offline_license_management
end

#pdfGoogle::Apis::BooksV1::Volume::AccessInfo::Pdf

Information about pdf content. (In LITE projection.) Corresponds to the JSON property pdf



2795
2796
2797
# File 'generated/google/apis/books_v1/classes.rb', line 2795

def pdf
  @pdf
end

#public_domainBoolean Also known as: public_domain?

Whether or not this book is public domain in the country listed above. Corresponds to the JSON property publicDomain

Returns:

  • (Boolean)


2800
2801
2802
# File 'generated/google/apis/books_v1/classes.rb', line 2800

def public_domain
  @public_domain
end

#quote_sharing_allowedBoolean Also known as: quote_sharing_allowed?

Whether quote sharing is allowed for this volume. Corresponds to the JSON property quoteSharingAllowed

Returns:

  • (Boolean)


2806
2807
2808
# File 'generated/google/apis/books_v1/classes.rb', line 2806

def quote_sharing_allowed
  @quote_sharing_allowed
end

#text_to_speech_permissionString

Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED. Corresponds to the JSON property textToSpeechPermission

Returns:

  • (String)


2813
2814
2815
# File 'generated/google/apis/books_v1/classes.rb', line 2813

def text_to_speech_permission
  @text_to_speech_permission
end

#view_order_urlString

For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page. Corresponds to the JSON property viewOrderUrl

Returns:

  • (String)


2819
2820
2821
# File 'generated/google/apis/books_v1/classes.rb', line 2819

def view_order_url
  @view_order_url
end

#viewabilityString

The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES or UNKNOWN. This value depends on the country listed above. A value of PARTIAL means that the publisher has allowed some portion of the volume to be viewed publicly, without purchase. This can apply to eBooks as well as non-eBooks. Public domain books will always have a value of ALL_PAGES. Corresponds to the JSON property viewability

Returns:

  • (String)


2828
2829
2830
# File 'generated/google/apis/books_v1/classes.rb', line 2828

def viewability
  @viewability
end

URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes. Corresponds to the JSON property webReaderLink

Returns:

  • (String)


2834
2835
2836
# File 'generated/google/apis/books_v1/classes.rb', line 2834

def web_reader_link
  @web_reader_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
# File 'generated/google/apis/books_v1/classes.rb', line 2841

def update!(**args)
  @access_view_status = args[:access_view_status] if args.key?(:access_view_status)
  @country = args[:country] if args.key?(:country)
  @download_access = args[:download_access] if args.key?(:download_access)
  @drive_imported_content_link = args[:drive_imported_content_link] if args.key?(:drive_imported_content_link)
  @embeddable = args[:embeddable] if args.key?(:embeddable)
  @epub = args[:epub] if args.key?(:epub)
  @explicit_offline_license_management = args[:explicit_offline_license_management] if args.key?(:explicit_offline_license_management)
  @pdf = args[:pdf] if args.key?(:pdf)
  @public_domain = args[:public_domain] if args.key?(:public_domain)
  @quote_sharing_allowed = args[:quote_sharing_allowed] if args.key?(:quote_sharing_allowed)
  @text_to_speech_permission = args[:text_to_speech_permission] if args.key?(:text_to_speech_permission)
  @view_order_url = args[:view_order_url] if args.key?(:view_order_url)
  @viewability = args[:viewability] if args.key?(:viewability)
  @web_reader_link = args[:web_reader_link] if args.key?(:web_reader_link)
end