google_api_books v0.13.0 GoogleApi.Books.V1.Model.VolumeAccessInfo View Source

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.).

Attributes

  • accessViewStatus (type: String.t, default: nil) - 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.)
  • country (type: String.t, default: nil) - The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
  • downloadAccess (type: GoogleApi.Books.V1.Model.DownloadAccessRestriction.t, default: nil) - Information about a volume's download license access restrictions.
  • driveImportedContentLink (type: String.t, default: nil) - URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
  • embeddable (type: boolean(), default: nil) - Whether this volume can be embedded in a viewport using the Embedded Viewer API.
  • epub (type: GoogleApi.Books.V1.Model.VolumeAccessInfoEpub.t, default: nil) - Information about epub content. (In LITE projection.)
  • explicitOfflineLicenseManagement (type: boolean(), default: nil) - 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 (type: GoogleApi.Books.V1.Model.VolumeAccessInfoPdf.t, default: nil) - Information about pdf content. (In LITE projection.)
  • publicDomain (type: boolean(), default: nil) - Whether or not this book is public domain in the country listed above.
  • quoteSharingAllowed (type: boolean(), default: nil) - Whether quote sharing is allowed for this volume.
  • textToSpeechPermission (type: String.t, default: nil) - Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
  • viewOrderUrl (type: String.t, default: nil) - For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
  • viewability (type: String.t, default: nil) - 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.
  • webReaderLink (type: String.t, default: nil) - URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.Books.V1.Model.VolumeAccessInfo{
  accessViewStatus: String.t(),
  country: String.t(),
  downloadAccess: GoogleApi.Books.V1.Model.DownloadAccessRestriction.t(),
  driveImportedContentLink: String.t(),
  embeddable: boolean(),
  epub: GoogleApi.Books.V1.Model.VolumeAccessInfoEpub.t(),
  explicitOfflineLicenseManagement: boolean(),
  pdf: GoogleApi.Books.V1.Model.VolumeAccessInfoPdf.t(),
  publicDomain: boolean(),
  quoteSharingAllowed: boolean(),
  textToSpeechPermission: String.t(),
  viewOrderUrl: String.t(),
  viewability: String.t(),
  webReaderLink: String.t()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.