Class: Google::Apis::BooksV1::Volume::VolumeInfo
- Inherits:
-
Object
- Object
- Google::Apis::BooksV1::Volume::VolumeInfo
- 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
-
#allow_anon_logging ⇒ Boolean
(also: #allow_anon_logging?)
Whether anonymous logging should be allowed.
-
#authors ⇒ Array<String>
The names of the authors and/or editors for this volume.
-
#average_rating ⇒ Float
The mean review rating for this volume.
-
#canonical_volume_link ⇒ String
Canonical URL for a volume.
-
#categories ⇒ Array<String>
A list of subject categories, such as "Fiction", "Suspense", etc.
-
#content_version ⇒ String
An identifier for the version of the volume content (text & images).
-
#description ⇒ String
A synopsis of the volume.
-
#dimensions ⇒ Google::Apis::BooksV1::Volume::VolumeInfo::Dimensions
Physical dimensions of this volume.
-
#image_links ⇒ Google::Apis::BooksV1::Volume::VolumeInfo::ImageLinks
A list of image links for all the sizes that are available.
-
#industry_identifiers ⇒ Array<Google::Apis::BooksV1::Volume::VolumeInfo::IndustryIdentifier>
Industry standard identifiers for this volume.
-
#info_link ⇒ String
URL to view information about this volume on the Google Books site.
-
#language ⇒ String
Best language for this volume (based on content).
-
#main_category ⇒ String
The main category to which this volume belongs.
-
#maturity_rating ⇒ String
Corresponds to the JSON property
maturityRating
. -
#page_count ⇒ Fixnum
Total number of pages as per publisher metadata.
-
#panelization_summary ⇒ Google::Apis::BooksV1::Volume::VolumeInfo::PanelizationSummary
A top-level summary of the panelization info in this volume.
-
#preview_link ⇒ String
URL to preview this volume on the Google Books site.
-
#print_type ⇒ String
Type of publication of this volume.
-
#printed_page_count ⇒ Fixnum
Total number of printed pages in generated pdf representation.
-
#published_date ⇒ String
Date of publication.
-
#publisher ⇒ String
Publisher of this volume.
-
#ratings_count ⇒ Fixnum
The number of review ratings for this volume.
-
#reading_modes ⇒ Object
The reading modes available for this volume.
-
#sample_page_count ⇒ Fixnum
Total number of sample pages as per publisher metadata.
-
#series_info ⇒ Google::Apis::BooksV1::Volumeseriesinfo
Corresponds to the JSON property
seriesInfo
. -
#subtitle ⇒ String
Volume subtitle.
-
#title ⇒ String
Volume title.
Instance Method Summary collapse
-
#initialize(**args) ⇒ VolumeInfo
constructor
A new instance of VolumeInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ VolumeInfo
Returns a new instance of VolumeInfo.
3624 3625 3626 |
# File 'generated/google/apis/books_v1/classes.rb', line 3624 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
3484 3485 3486 |
# File 'generated/google/apis/books_v1/classes.rb', line 3484 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
3490 3491 3492 |
# File 'generated/google/apis/books_v1/classes.rb', line 3490 def @authors end |
#average_rating ⇒ Float
The mean review rating for this volume. (min = 1.0, max = 5.0)
Corresponds to the JSON property averageRating
3495 3496 3497 |
# File 'generated/google/apis/books_v1/classes.rb', line 3495 def @average_rating end |
#canonical_volume_link ⇒ String
Canonical URL for a volume. (In LITE projection.)
Corresponds to the JSON property canonicalVolumeLink
3500 3501 3502 |
# File 'generated/google/apis/books_v1/classes.rb', line 3500 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
3505 3506 3507 |
# File 'generated/google/apis/books_v1/classes.rb', line 3505 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
3511 3512 3513 |
# File 'generated/google/apis/books_v1/classes.rb', line 3511 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
3518 3519 3520 |
# File 'generated/google/apis/books_v1/classes.rb', line 3518 def description @description end |
#dimensions ⇒ Google::Apis::BooksV1::Volume::VolumeInfo::Dimensions
Physical dimensions of this volume.
Corresponds to the JSON property dimensions
3523 3524 3525 |
# File 'generated/google/apis/books_v1/classes.rb', line 3523 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
3529 3530 3531 |
# File 'generated/google/apis/books_v1/classes.rb', line 3529 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
3534 3535 3536 |
# File 'generated/google/apis/books_v1/classes.rb', line 3534 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
3540 3541 3542 |
# File 'generated/google/apis/books_v1/classes.rb', line 3540 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
3546 3547 3548 |
# File 'generated/google/apis/books_v1/classes.rb', line 3546 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
3552 3553 3554 |
# File 'generated/google/apis/books_v1/classes.rb', line 3552 def main_category @main_category end |
#maturity_rating ⇒ String
Corresponds to the JSON property maturityRating
3557 3558 3559 |
# File 'generated/google/apis/books_v1/classes.rb', line 3557 def @maturity_rating end |
#page_count ⇒ Fixnum
Total number of pages as per publisher metadata.
Corresponds to the JSON property pageCount
3562 3563 3564 |
# File 'generated/google/apis/books_v1/classes.rb', line 3562 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
3567 3568 3569 |
# File 'generated/google/apis/books_v1/classes.rb', line 3567 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
3572 3573 3574 |
# File 'generated/google/apis/books_v1/classes.rb', line 3572 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
3577 3578 3579 |
# File 'generated/google/apis/books_v1/classes.rb', line 3577 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
3582 3583 3584 |
# File 'generated/google/apis/books_v1/classes.rb', line 3582 def printed_page_count @printed_page_count end |
#published_date ⇒ String
Date of publication. (In LITE projection.)
Corresponds to the JSON property publishedDate
3587 3588 3589 |
# File 'generated/google/apis/books_v1/classes.rb', line 3587 def published_date @published_date end |
#publisher ⇒ String
Publisher of this volume. (In LITE projection.)
Corresponds to the JSON property publisher
3592 3593 3594 |
# File 'generated/google/apis/books_v1/classes.rb', line 3592 def publisher @publisher end |
#ratings_count ⇒ Fixnum
The number of review ratings for this volume.
Corresponds to the JSON property ratingsCount
3597 3598 3599 |
# File 'generated/google/apis/books_v1/classes.rb', line 3597 def @ratings_count end |
#reading_modes ⇒ Object
The reading modes available for this volume.
Corresponds to the JSON property readingModes
3602 3603 3604 |
# File 'generated/google/apis/books_v1/classes.rb', line 3602 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
3607 3608 3609 |
# File 'generated/google/apis/books_v1/classes.rb', line 3607 def sample_page_count @sample_page_count end |
#series_info ⇒ Google::Apis::BooksV1::Volumeseriesinfo
Corresponds to the JSON property seriesInfo
3612 3613 3614 |
# File 'generated/google/apis/books_v1/classes.rb', line 3612 def series_info @series_info end |
#subtitle ⇒ String
Volume subtitle. (In LITE projection.)
Corresponds to the JSON property subtitle
3617 3618 3619 |
# File 'generated/google/apis/books_v1/classes.rb', line 3617 def subtitle @subtitle end |
#title ⇒ String
Volume title. (In LITE projection.)
Corresponds to the JSON property title
3622 3623 3624 |
# File 'generated/google/apis/books_v1/classes.rb', line 3622 def title @title end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3629 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 |
# File 'generated/google/apis/books_v1/classes.rb', line 3629 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 |