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, ReadingModes

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VolumeInfo

Returns a new instance of VolumeInfo.



4000
4001
4002
 
# File 'generated/google/apis/books_v1/classes.rb', line 4000

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) 


3854
3855
3856
 
# File 'generated/google/apis/books_v1/classes.rb', line 3854

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


3860
3861
3862
 
# File 'generated/google/apis/books_v1/classes.rb', line 3860

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) 


3865
3866
3867
 
# File 'generated/google/apis/books_v1/classes.rb', line 3865

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) 


3870
3871
3872
 
# File 'generated/google/apis/books_v1/classes.rb', line 3870

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


3875
3876
3877
 
# File 'generated/google/apis/books_v1/classes.rb', line 3875

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) 


3880
3881
3882
 
# File 'generated/google/apis/books_v1/classes.rb', line 3880

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) 


3887
3888
3889
 
# File 'generated/google/apis/books_v1/classes.rb', line 3887

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) 


3894
3895
3896
 
# File 'generated/google/apis/books_v1/classes.rb', line 3894

def description
  @description
end

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

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

Returns:



3899
3900
3901
 
# File 'generated/google/apis/books_v1/classes.rb', line 3899

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:



3905
3906
3907
 
# File 'generated/google/apis/books_v1/classes.rb', line 3905

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:



3910
3911
3912
 
# File 'generated/google/apis/books_v1/classes.rb', line 3910

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) 


3916
3917
3918
 
# File 'generated/google/apis/books_v1/classes.rb', line 3916

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) 


3922
3923
3924
 
# File 'generated/google/apis/books_v1/classes.rb', line 3922

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) 


3928
3929
3930
 
# File 'generated/google/apis/books_v1/classes.rb', line 3928

def main_category
  @main_category
end

#maturity_rating ⇒ String

Corresponds to the JSON property maturityRating

Returns:

  • (String) 


3933
3934
3935
 
# File 'generated/google/apis/books_v1/classes.rb', line 3933

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) 


3938
3939
3940
 
# File 'generated/google/apis/books_v1/classes.rb', line 3938

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:



3943
3944
3945
 
# File 'generated/google/apis/books_v1/classes.rb', line 3943

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) 


3948
3949
3950
 
# File 'generated/google/apis/books_v1/classes.rb', line 3948

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) 


3953
3954
3955
 
# File 'generated/google/apis/books_v1/classes.rb', line 3953

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) 


3958
3959
3960
 
# File 'generated/google/apis/books_v1/classes.rb', line 3958

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) 


3963
3964
3965
 
# File 'generated/google/apis/books_v1/classes.rb', line 3963

def published_date
  @published_date
end

#publisher ⇒ String

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

Returns:

  • (String) 


3968
3969
3970
 
# File 'generated/google/apis/books_v1/classes.rb', line 3968

def publisher
  @publisher
end

#ratings_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3973
3974
3975
 
# File 'generated/google/apis/books_v1/classes.rb', line 3973

def ratings_count
  @ratings_count
end

#reading_modes ⇒ Google::Apis::BooksV1::Volume::VolumeInfo::ReadingModes

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

Returns:



3978
3979
3980
 
# File 'generated/google/apis/books_v1/classes.rb', line 3978

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) 


3983
3984
3985
 
# File 'generated/google/apis/books_v1/classes.rb', line 3983

def sample_page_count
  @sample_page_count
end

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

Corresponds to the JSON property seriesInfo

Returns:



3988
3989
3990
 
# File 'generated/google/apis/books_v1/classes.rb', line 3988

def series_info
  @series_info
end

#subtitle ⇒ String

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

Returns:

  • (String) 


3993
3994
3995
 
# File 'generated/google/apis/books_v1/classes.rb', line 3993

def subtitle
  @subtitle
end

#title ⇒ String

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

Returns:

  • (String) 


3998
3999
4000
 
# File 'generated/google/apis/books_v1/classes.rb', line 3998

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
 
# File 'generated/google/apis/books_v1/classes.rb', line 4005

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