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


3625
3626
3627
# File 'generated/google/apis/books_v1/classes.rb', line 3625

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


3485
3486
3487
# File 'generated/google/apis/books_v1/classes.rb', line 3485

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


3491
3492
3493
# File 'generated/google/apis/books_v1/classes.rb', line 3491

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


3496
3497
3498
# File 'generated/google/apis/books_v1/classes.rb', line 3496

def average_rating
  @average_rating
end

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


3501
3502
3503
# File 'generated/google/apis/books_v1/classes.rb', line 3501

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


3506
3507
3508
# File 'generated/google/apis/books_v1/classes.rb', line 3506

def categories
  @categories
end

#content_versionString

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


3512
3513
3514
# File 'generated/google/apis/books_v1/classes.rb', line 3512

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


3519
3520
3521
# File 'generated/google/apis/books_v1/classes.rb', line 3519

def description
  @description
end

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

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


3524
3525
3526
# File 'generated/google/apis/books_v1/classes.rb', line 3524

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


3530
3531
3532
# File 'generated/google/apis/books_v1/classes.rb', line 3530

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


3535
3536
3537
# File 'generated/google/apis/books_v1/classes.rb', line 3535

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


3541
3542
3543
# File 'generated/google/apis/books_v1/classes.rb', line 3541

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


3547
3548
3549
# File 'generated/google/apis/books_v1/classes.rb', line 3547

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


3553
3554
3555
# File 'generated/google/apis/books_v1/classes.rb', line 3553

def main_category
  @main_category
end

#maturity_ratingString

Corresponds to the JSON property maturityRating


3558
3559
3560
# File 'generated/google/apis/books_v1/classes.rb', line 3558

def maturity_rating
  @maturity_rating
end

#page_countFixnum

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


3563
3564
3565
# File 'generated/google/apis/books_v1/classes.rb', line 3563

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


3568
3569
3570
# File 'generated/google/apis/books_v1/classes.rb', line 3568

def panelization_summary
  @panelization_summary
end

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


3573
3574
3575
# File 'generated/google/apis/books_v1/classes.rb', line 3573

def preview_link
  @preview_link
end

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


3578
3579
3580
# File 'generated/google/apis/books_v1/classes.rb', line 3578

def print_type
  @print_type
end

#printed_page_countFixnum

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


3583
3584
3585
# File 'generated/google/apis/books_v1/classes.rb', line 3583

def printed_page_count
  @printed_page_count
end

#published_dateString

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


3588
3589
3590
# File 'generated/google/apis/books_v1/classes.rb', line 3588

def published_date
  @published_date
end

#publisherString

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


3593
3594
3595
# File 'generated/google/apis/books_v1/classes.rb', line 3593

def publisher
  @publisher
end

#ratings_countFixnum

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


3598
3599
3600
# File 'generated/google/apis/books_v1/classes.rb', line 3598

def ratings_count
  @ratings_count
end

#reading_modesObject

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


3603
3604
3605
# File 'generated/google/apis/books_v1/classes.rb', line 3603

def reading_modes
  @reading_modes
end

#sample_page_countFixnum

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


3608
3609
3610
# File 'generated/google/apis/books_v1/classes.rb', line 3608

def sample_page_count
  @sample_page_count
end

#series_infoGoogle::Apis::BooksV1::Volumeseriesinfo

Corresponds to the JSON property seriesInfo


3613
3614
3615
# File 'generated/google/apis/books_v1/classes.rb', line 3613

def series_info
  @series_info
end

#subtitleString

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


3618
3619
3620
# File 'generated/google/apis/books_v1/classes.rb', line 3618

def subtitle
  @subtitle
end

#titleString

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


3623
3624
3625
# File 'generated/google/apis/books_v1/classes.rb', line 3623

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
# File 'generated/google/apis/books_v1/classes.rb', line 3630

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