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.



3814
3815
3816
 
# File 'generated/google/apis/books_v1/classes.rb', line 3814

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) 


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

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


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

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) 


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

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) 


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

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


3689
3690
3691
 
# File 'generated/google/apis/books_v1/classes.rb', line 3689

def categories
  @categories
end

#comics_content ⇒ Boolean Also known as: comics_content?

Whether the volume has comics content. Corresponds to the JSON property comicsContent

Returns:

  • (Boolean) 


3694
3695
3696
 
# File 'generated/google/apis/books_v1/classes.rb', line 3694

def comics_content
  @comics_content
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) 


3701
3702
3703
 
# File 'generated/google/apis/books_v1/classes.rb', line 3701

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) 


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

def description
  @description
end

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

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

Returns:



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

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:



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

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:



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

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) 


3730
3731
3732
 
# File 'generated/google/apis/books_v1/classes.rb', line 3730

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) 


3736
3737
3738
 
# File 'generated/google/apis/books_v1/classes.rb', line 3736

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) 


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

def main_category
  @main_category
end

#maturity_rating ⇒ String

Corresponds to the JSON property maturityRating

Returns:

  • (String) 


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

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) 


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

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:



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

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) 


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

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) 


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

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) 


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

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) 


3777
3778
3779
 
# File 'generated/google/apis/books_v1/classes.rb', line 3777

def published_date
  @published_date
end

#publisher ⇒ String

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

Returns:

  • (String) 


3782
3783
3784
 
# File 'generated/google/apis/books_v1/classes.rb', line 3782

def publisher
  @publisher
end

#ratings_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3787
3788
3789
 
# File 'generated/google/apis/books_v1/classes.rb', line 3787

def ratings_count
  @ratings_count
end

#reading_modes ⇒ Object

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

Returns:

  • (Object) 


3792
3793
3794
 
# File 'generated/google/apis/books_v1/classes.rb', line 3792

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) 


3797
3798
3799
 
# File 'generated/google/apis/books_v1/classes.rb', line 3797

def sample_page_count
  @sample_page_count
end

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

Corresponds to the JSON property seriesInfo

Returns:



3802
3803
3804
 
# File 'generated/google/apis/books_v1/classes.rb', line 3802

def series_info
  @series_info
end

#subtitle ⇒ String

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

Returns:

  • (String) 


3807
3808
3809
 
# File 'generated/google/apis/books_v1/classes.rb', line 3807

def subtitle
  @subtitle
end

#title ⇒ String

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

Returns:

  • (String) 


3812
3813
3814
 
# File 'generated/google/apis/books_v1/classes.rb', line 3812

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
 
# File 'generated/google/apis/books_v1/classes.rb', line 3819

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)
  @comics_content = args[:comics_content] if args.key?(:comics_content)
  @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