Class: Google::Apis::BooksV1::Volume::VolumeInfo

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

General volume information.

Defined Under Namespace

Classes: Dimensions, ImageLinks, IndustryIdentifier, PanelizationSummary

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) ⇒ VolumeInfo

Returns a new instance of VolumeInfo



3775
3776
3777
 
# File 'generated/google/apis/books_v1/classes.rb', line 3775

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

Instance Attribute Details

#allow_anon_logging ⇒ Boolean Also known as: allow_anon_logging?

Whether anonymous logging should be allowed. Corresponds to the JSON property allowAnonLogging

Returns:

  • (Boolean) 


3635
3636
3637
 
# File 'generated/google/apis/books_v1/classes.rb', line 3635

def allow_anon_logging
  @allow_anon_logging
end

#authors ⇒ Array<String>

The names of the authors and/or editors for this volume. (In LITE projection) Corresponds to the JSON property authors

Returns:

  • (Array<String>) 


3641
3642
3643
 
# File 'generated/google/apis/books_v1/classes.rb', line 3641

def authors
  @authors
end

#average_rating ⇒ Float

The mean review rating for this volume. (min = 1.0, max = 5.0) Corresponds to the JSON property averageRating

Returns:

  • (Float) 


3646
3647
3648
 
# File 'generated/google/apis/books_v1/classes.rb', line 3646

def average_rating
  @average_rating
end

#canonical_volume_link ⇒ String

Canonical URL for a volume. (In LITE projection.) Corresponds to the JSON property canonicalVolumeLink

Returns:

  • (String) 


3651
3652
3653
 
# File 'generated/google/apis/books_v1/classes.rb', line 3651

def canonical_volume_link
  @canonical_volume_link
end

#categories ⇒ Array<String>

A list of subject categories, such as "Fiction", "Suspense", etc. Corresponds to the JSON property categories

Returns:

  • (Array<String>) 


3656
3657
3658
 
# File 'generated/google/apis/books_v1/classes.rb', line 3656

def categories
  @categories
end

#content_version ⇒ String

An identifier for the version of the volume content (text & images). (In LITE projection) Corresponds to the JSON property contentVersion

Returns:

  • (String) 


3662
3663
3664
 
# File 'generated/google/apis/books_v1/classes.rb', line 3662

def content_version
  @content_version
end

#description ⇒ String

A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.) Corresponds to the JSON property description

Returns:

  • (String) 


3669
3670
3671
 
# File 'generated/google/apis/books_v1/classes.rb', line 3669

def description
  @description
end

#dimensions ⇒ Google::Apis::BooksV1::Volume::VolumeInfo::Dimensions

Physical dimensions of this volume. Corresponds to the JSON property dimensions

Returns:



3674
3675
3676
 
# File 'generated/google/apis/books_v1/classes.rb', line 3674

def dimensions
  @dimensions
end

#image_links ⇒ Google::Apis::BooksV1::Volume::VolumeInfo::ImageLinks

A list of image links for all the sizes that are available. (In LITE projection.) Corresponds to the JSON property imageLinks

Returns:



3680
3681
3682
 
# File 'generated/google/apis/books_v1/classes.rb', line 3680

def image_links
  @image_links
end

#industry_identifiers ⇒ Array<Google::Apis::BooksV1::Volume::VolumeInfo::IndustryIdentifier>

Industry standard identifiers for this volume. Corresponds to the JSON property industryIdentifiers

Returns:



3685
3686
3687
 
# File 'generated/google/apis/books_v1/classes.rb', line 3685

def industry_identifiers
  @industry_identifiers
end

#info_link ⇒ String

URL to view information about this volume on the Google Books site. (In LITE projection) Corresponds to the JSON property infoLink

Returns:

  • (String) 


3691
3692
3693
 
# File 'generated/google/apis/books_v1/classes.rb', line 3691

def info_link
  @info_link
end

#language ⇒ String

Best language for this volume (based on content). It is the two-letter ISO 639- 1 code such as 'fr', 'en', etc. Corresponds to the JSON property language

Returns:

  • (String) 


3697
3698
3699
 
# File 'generated/google/apis/books_v1/classes.rb', line 3697

def language
  @language
end

#main_category ⇒ String

The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight. Corresponds to the JSON property mainCategory

Returns:

  • (String) 


3703
3704
3705
 
# File 'generated/google/apis/books_v1/classes.rb', line 3703

def main_category
  @main_category
end

#maturity_rating ⇒ String

Corresponds to the JSON property maturityRating

Returns:

  • (String) 


3708
3709
3710
 
# File 'generated/google/apis/books_v1/classes.rb', line 3708

def maturity_rating
  @maturity_rating
end

#page_count ⇒ Fixnum

Total number of pages as per publisher metadata. Corresponds to the JSON property pageCount

Returns:

  • (Fixnum) 


3713
3714
3715
 
# File 'generated/google/apis/books_v1/classes.rb', line 3713

def page_count
  @page_count
end

#panelization_summary ⇒ Google::Apis::BooksV1::Volume::VolumeInfo::PanelizationSummary

A top-level summary of the panelization info in this volume. Corresponds to the JSON property panelizationSummary

Returns:



3718
3719
3720
 
# File 'generated/google/apis/books_v1/classes.rb', line 3718

def panelization_summary
  @panelization_summary
end

#preview_link ⇒ String

URL to preview this volume on the Google Books site. Corresponds to the JSON property previewLink

Returns:

  • (String) 


3723
3724
3725
 
# File 'generated/google/apis/books_v1/classes.rb', line 3723

def preview_link
  @preview_link
end

#print_type ⇒ String

Type of publication of this volume. Possible values are BOOK or MAGAZINE. Corresponds to the JSON property printType

Returns:

  • (String) 


3728
3729
3730
 
# File 'generated/google/apis/books_v1/classes.rb', line 3728

def print_type
  @print_type
end

#printed_page_count ⇒ Fixnum

Total number of printed pages in generated pdf representation. Corresponds to the JSON property printedPageCount

Returns:

  • (Fixnum) 


3733
3734
3735
 
# File 'generated/google/apis/books_v1/classes.rb', line 3733

def printed_page_count
  @printed_page_count
end

#published_date ⇒ String

Date of publication. (In LITE projection.) Corresponds to the JSON property publishedDate

Returns:

  • (String) 


3738
3739
3740
 
# File 'generated/google/apis/books_v1/classes.rb', line 3738

def published_date
  @published_date
end

#publisher ⇒ String

Publisher of this volume. (In LITE projection.) Corresponds to the JSON property publisher

Returns:

  • (String) 


3743
3744
3745
 
# File 'generated/google/apis/books_v1/classes.rb', line 3743

def publisher
  @publisher
end

#ratings_count ⇒ Fixnum

The number of review ratings for this volume. Corresponds to the JSON property ratingsCount

Returns:

  • (Fixnum) 


3748
3749
3750
 
# File 'generated/google/apis/books_v1/classes.rb', line 3748

def ratings_count
  @ratings_count
end

#reading_modes ⇒ Object

The reading modes available for this volume. Corresponds to the JSON property readingModes

Returns:

  • (Object) 


3753
3754
3755
 
# File 'generated/google/apis/books_v1/classes.rb', line 3753

def reading_modes
  @reading_modes
end

#sample_page_count ⇒ Fixnum

Total number of sample pages as per publisher metadata. Corresponds to the JSON property samplePageCount

Returns:

  • (Fixnum) 


3758
3759
3760
 
# File 'generated/google/apis/books_v1/classes.rb', line 3758

def sample_page_count
  @sample_page_count
end

#series_info ⇒ Google::Apis::BooksV1::Volumeseriesinfo

Corresponds to the JSON property seriesInfo

Returns:



3763
3764
3765
 
# File 'generated/google/apis/books_v1/classes.rb', line 3763

def series_info
  @series_info
end

#subtitle ⇒ String

Volume subtitle. (In LITE projection.) Corresponds to the JSON property subtitle

Returns:

  • (String) 


3768
3769
3770
 
# File 'generated/google/apis/books_v1/classes.rb', line 3768

def subtitle
  @subtitle
end

#title ⇒ String

Volume title. (In LITE projection.) Corresponds to the JSON property title

Returns:

  • (String) 


3773
3774
3775
 
# File 'generated/google/apis/books_v1/classes.rb', line 3773

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
 
# File 'generated/google/apis/books_v1/classes.rb', line 3780

def update!(**args)
  @allow_anon_logging = args[:allow_anon_logging] if args.key?(:allow_anon_logging)
  @authors = args[:authors] if args.key?(:authors)
  @average_rating = args[:average_rating] if args.key?(:average_rating)
  @canonical_volume_link = args[:canonical_volume_link] if args.key?(:canonical_volume_link)
  @categories = args[:categories] if args.key?(:categories)
  @content_version = args[:content_version] if args.key?(:content_version)
  @description = args[:description] if args.key?(:description)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @image_links = args[:image_links] if args.key?(:image_links)
  @industry_identifiers = args[:industry_identifiers] if args.key?(:industry_identifiers)
  @info_link = args[:info_link] if args.key?(:info_link)
  @language = args[:language] if args.key?(:language)
  @main_category = args[:main_category] if args.key?(:main_category)
  @maturity_rating = args[:maturity_rating] if args.key?(:maturity_rating)
  @page_count = args[:page_count] if args.key?(:page_count)
  @panelization_summary = args[:panelization_summary] if args.key?(:panelization_summary)
  @preview_link = args[:preview_link] if args.key?(:preview_link)
  @print_type = args[:print_type] if args.key?(:print_type)
  @printed_page_count = args[:printed_page_count] if args.key?(:printed_page_count)
  @published_date = args[:published_date] if args.key?(:published_date)
  @publisher = args[:publisher] if args.key?(:publisher)
  @ratings_count = args[:ratings_count] if args.key?(:ratings_count)
  @reading_modes = args[:reading_modes] if args.key?(:reading_modes)
  @sample_page_count = args[:sample_page_count] if args.key?(:sample_page_count)
  @series_info = args[:series_info] if args.key?(:series_info)
  @subtitle = args[:subtitle] if args.key?(:subtitle)
  @title = args[:title] if args.key?(:title)
end