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



2962
2963
2964
 
# File 'generated/google/apis/books_v1/classes.rb', line 2962

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

Returns:

  • (String) 


2879
2880
2881
 
# File 'generated/google/apis/books_v1/classes.rb', line 2879

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

Returns:

  • (String) 


2885
2886
2887
 
# File 'generated/google/apis/books_v1/classes.rb', line 2885

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

Returns:



2890
2891
2892
 
# File 'generated/google/apis/books_v1/classes.rb', line 2890

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

Returns:

  • (String) 


2896
2897
2898
 
# File 'generated/google/apis/books_v1/classes.rb', line 2896

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

Returns:

  • (Boolean) 


2902
2903
2904
 
# File 'generated/google/apis/books_v1/classes.rb', line 2902

def embeddable
  @embeddable
end

#epub ⇒ Google::Apis::BooksV1::Volume::AccessInfo::Epub

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

Returns:



2908
2909
2910
 
# File 'generated/google/apis/books_v1/classes.rb', line 2908

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

Returns:

  • (Boolean) 


2915
2916
2917
 
# File 'generated/google/apis/books_v1/classes.rb', line 2915

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

Returns:



2921
2922
2923
 
# File 'generated/google/apis/books_v1/classes.rb', line 2921

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

Returns:

  • (Boolean) 


2926
2927
2928
 
# File 'generated/google/apis/books_v1/classes.rb', line 2926

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

Returns:

  • (Boolean) 


2932
2933
2934
 
# File 'generated/google/apis/books_v1/classes.rb', line 2932

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

Returns:

  • (String) 


2939
2940
2941
 
# File 'generated/google/apis/books_v1/classes.rb', line 2939

def text_to_speech_permission
  @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

Returns:

  • (String) 


2945
2946
2947
 
# File 'generated/google/apis/books_v1/classes.rb', line 2945

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

Returns:

  • (String) 


2954
2955
2956
 
# File 'generated/google/apis/books_v1/classes.rb', line 2954

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

Returns:

  • (String) 


2960
2961
2962
 
# File 'generated/google/apis/books_v1/classes.rb', line 2960

def web_reader_link
  @web_reader_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
 
# File 'generated/google/apis/books_v1/classes.rb', line 2967

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