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

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.



4016
4017
4018
# File 'generated/google/apis/books_v1/classes.rb', line 4016

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

Instance Attribute Details

#allow_anon_loggingBoolean Also known as: allow_anon_logging?

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

Returns:

  • (Boolean)


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

def allow_anon_logging
  @allow_anon_logging
end

#authorsArray<String>

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

Returns:

  • (Array<String>)


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

def authors
  @authors
end

#average_ratingFloat

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

Returns:

  • (Float)


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

def average_rating
  @average_rating
end

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

Returns:

  • (String)


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

def canonical_volume_link
  @canonical_volume_link
end

#categoriesArray<String>

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

Returns:

  • (Array<String>)


3891
3892
3893
# File 'generated/google/apis/books_v1/classes.rb', line 3891

def categories
  @categories
end

#comics_contentBoolean Also known as: comics_content?

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

Returns:

  • (Boolean)


3896
3897
3898
# File 'generated/google/apis/books_v1/classes.rb', line 3896

def comics_content
  @comics_content
end

#content_versionString

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

Returns:

  • (String)


3903
3904
3905
# File 'generated/google/apis/books_v1/classes.rb', line 3903

def content_version
  @content_version
end

#descriptionString

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)


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

def description
  @description
end

#dimensionsGoogle::Apis::BooksV1::Volume::VolumeInfo::Dimensions

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



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

def dimensions
  @dimensions
end

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



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

def image_links
  @image_links
end

#industry_identifiersArray<Google::Apis::BooksV1::Volume::VolumeInfo::IndustryIdentifier>

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



3926
3927
3928
# File 'generated/google/apis/books_v1/classes.rb', line 3926

def industry_identifiers
  @industry_identifiers
end

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

Returns:

  • (String)


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

def info_link
  @info_link
end

#languageString

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)


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

def language
  @language
end

#main_categoryString

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)


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

def main_category
  @main_category
end

#maturity_ratingString

Corresponds to the JSON property maturityRating

Returns:

  • (String)


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

def maturity_rating
  @maturity_rating
end

#page_countFixnum

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

Returns:

  • (Fixnum)


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

def page_count
  @page_count
end

#panelization_summaryGoogle::Apis::BooksV1::Volume::VolumeInfo::PanelizationSummary

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



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

def panelization_summary
  @panelization_summary
end

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

Returns:

  • (String)


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

def preview_link
  @preview_link
end

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

Returns:

  • (String)


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

def print_type
  @print_type
end

#printed_page_countFixnum

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

Returns:

  • (Fixnum)


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

def printed_page_count
  @printed_page_count
end

#published_dateString

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

Returns:

  • (String)


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

def published_date
  @published_date
end

#publisherString

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

Returns:

  • (String)


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

def publisher
  @publisher
end

#ratings_countFixnum

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

Returns:

  • (Fixnum)


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

def ratings_count
  @ratings_count
end

#reading_modesGoogle::Apis::BooksV1::Volume::VolumeInfo::ReadingModes

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



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

def reading_modes
  @reading_modes
end

#sample_page_countFixnum

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

Returns:

  • (Fixnum)


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

def sample_page_count
  @sample_page_count
end

#series_infoGoogle::Apis::BooksV1::Volumeseriesinfo

Corresponds to the JSON property seriesInfo



4004
4005
4006
# File 'generated/google/apis/books_v1/classes.rb', line 4004

def series_info
  @series_info
end

#subtitleString

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

Returns:

  • (String)


4009
4010
4011
# File 'generated/google/apis/books_v1/classes.rb', line 4009

def subtitle
  @subtitle
end

#titleString

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

Returns:

  • (String)


4014
4015
4016
# File 'generated/google/apis/books_v1/classes.rb', line 4014

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
# File 'generated/google/apis/books_v1/classes.rb', line 4021

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