Class: Google::Apis::BooksV1::Volume::AccessInfo
- Inherits:
-
Object
- Object
- Google::Apis::BooksV1::Volume::AccessInfo
- 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
Instance Attribute Summary collapse
-
#access_view_status ⇒ String
Combines the access and viewability of this volume into a single status field for this user.
-
#country ⇒ String
The two-letter ISO_3166-1 country code for which this access information is valid.
-
#download_access ⇒ Google::Apis::BooksV1::DownloadAccessRestriction
Information about a volume's download license access restrictions.
-
#drive_imported_content_link ⇒ String
URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
-
#embeddable ⇒ Boolean
(also: #embeddable?)
Whether this volume can be embedded in a viewport using the Embedded Viewer API.
-
#epub ⇒ Google::Apis::BooksV1::Volume::AccessInfo::Epub
Information about epub content.
-
#explicit_offline_license_management ⇒ Boolean
(also: #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.
-
#pdf ⇒ Google::Apis::BooksV1::Volume::AccessInfo::Pdf
Information about pdf content.
-
#public_domain ⇒ Boolean
(also: #public_domain?)
Whether or not this book is public domain in the country listed above.
-
#quote_sharing_allowed ⇒ Boolean
(also: #quote_sharing_allowed?)
Whether quote sharing is allowed for this volume.
-
#text_to_speech_permission ⇒ String
Whether text-to-speech is permitted for this volume.
-
#view_order_url ⇒ String
For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
-
#viewability ⇒ String
The read access of a volume.
-
#web_reader_link ⇒ String
URL to read this volume on the Google Books site.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AccessInfo
constructor
A new instance of AccessInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ AccessInfo
Returns a new instance of AccessInfo.
2804 2805 2806 |
# File 'generated/google/apis/books_v1/classes.rb', line 2804 def initialize(**args) update!(**args) end |
Instance Attribute Details
#access_view_status ⇒ String
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
2721 2722 2723 |
# File 'generated/google/apis/books_v1/classes.rb', line 2721 def access_view_status @access_view_status end |
#country ⇒ String
The two-letter ISO_3166-1 country code for which this access information is
valid. (In LITE projection.)
Corresponds to the JSON property country
2727 2728 2729 |
# File 'generated/google/apis/books_v1/classes.rb', line 2727 def country @country end |
#download_access ⇒ Google::Apis::BooksV1::DownloadAccessRestriction
Information about a volume's download license access restrictions.
Corresponds to the JSON property downloadAccess
2732 2733 2734 |
# File 'generated/google/apis/books_v1/classes.rb', line 2732 def download_access @download_access end |
#drive_imported_content_link ⇒ String
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
2738 2739 2740 |
# File 'generated/google/apis/books_v1/classes.rb', line 2738 def drive_imported_content_link @drive_imported_content_link end |
#embeddable ⇒ Boolean Also known as: embeddable?
Whether this volume can be embedded in a viewport using the Embedded Viewer
API.
Corresponds to the JSON property embeddable
2744 2745 2746 |
# File 'generated/google/apis/books_v1/classes.rb', line 2744 def @embeddable end |
#epub ⇒ Google::Apis::BooksV1::Volume::AccessInfo::Epub
Information about epub content. (In LITE projection.)
Corresponds to the JSON property epub
2750 2751 2752 |
# File 'generated/google/apis/books_v1/classes.rb', line 2750 def epub @epub end |
#explicit_offline_license_management ⇒ Boolean 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
2757 2758 2759 |
# File 'generated/google/apis/books_v1/classes.rb', line 2757 def explicit_offline_license_management @explicit_offline_license_management end |
#pdf ⇒ Google::Apis::BooksV1::Volume::AccessInfo::Pdf
Information about pdf content. (In LITE projection.)
Corresponds to the JSON property pdf
2763 2764 2765 |
# File 'generated/google/apis/books_v1/classes.rb', line 2763 def pdf @pdf end |
#public_domain ⇒ Boolean Also known as: public_domain?
Whether or not this book is public domain in the country listed above.
Corresponds to the JSON property publicDomain
2768 2769 2770 |
# File 'generated/google/apis/books_v1/classes.rb', line 2768 def public_domain @public_domain end |
#quote_sharing_allowed ⇒ Boolean Also known as: quote_sharing_allowed?
Whether quote sharing is allowed for this volume.
Corresponds to the JSON property quoteSharingAllowed
2774 2775 2776 |
# File 'generated/google/apis/books_v1/classes.rb', line 2774 def quote_sharing_allowed @quote_sharing_allowed end |
#text_to_speech_permission ⇒ String
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
2781 2782 2783 |
# File 'generated/google/apis/books_v1/classes.rb', line 2781 def @text_to_speech_permission end |
#view_order_url ⇒ String
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
2787 2788 2789 |
# File 'generated/google/apis/books_v1/classes.rb', line 2787 def view_order_url @view_order_url end |
#viewability ⇒ String
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
2796 2797 2798 |
# File 'generated/google/apis/books_v1/classes.rb', line 2796 def viewability @viewability end |
#web_reader_link ⇒ String
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
2802 2803 2804 |
# File 'generated/google/apis/books_v1/classes.rb', line 2802 def web_reader_link @web_reader_link end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 |
# File 'generated/google/apis/books_v1/classes.rb', line 2809 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 |