chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
google-api-ruby-client/generated/google/apis/books_v1/classes.rb

3516 lines
130 KiB
Ruby
Raw Blame History

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module BooksV1
#
class Annotation
include Google::Apis::Core::Hashable
# Anchor text after excerpt. For requests, if the user bookmarked a screen that
# has no flowing text on it, then this field should be empty.
# Corresponds to the JSON property `afterSelectedText`
# @return [String]
attr_accessor :after_selected_text
# Anchor text before excerpt. For requests, if the user bookmarked a screen that
# has no flowing text on it, then this field should be empty.
# Corresponds to the JSON property `beforeSelectedText`
# @return [String]
attr_accessor :before_selected_text
# Selection ranges sent from the client.
# Corresponds to the JSON property `clientVersionRanges`
# @return [Google::Apis::BooksV1::Annotation::ClientVersionRanges]
attr_accessor :client_version_ranges
# Timestamp for the created time of this annotation.
# Corresponds to the JSON property `created`
# @return [DateTime]
attr_accessor :created
# Selection ranges for the most recent content version.
# Corresponds to the JSON property `currentVersionRanges`
# @return [Google::Apis::BooksV1::Annotation::CurrentVersionRanges]
attr_accessor :current_version_ranges
# User-created data for this annotation.
# Corresponds to the JSON property `data`
# @return [String]
attr_accessor :data
# Indicates that this annotation is deleted.
# Corresponds to the JSON property `deleted`
# @return [Boolean]
attr_accessor :deleted
alias_method :deleted?, :deleted
# The highlight style for this annotation.
# Corresponds to the JSON property `highlightStyle`
# @return [String]
attr_accessor :highlight_style
# Id of this annotation, in the form of a GUID.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The layer this annotation is for.
# Corresponds to the JSON property `layerId`
# @return [String]
attr_accessor :layer_id
#
# Corresponds to the JSON property `layerSummary`
# @return [Google::Apis::BooksV1::Annotation::LayerSummary]
attr_accessor :layer_summary
# Pages that this annotation spans.
# Corresponds to the JSON property `pageIds`
# @return [Array<String>]
attr_accessor :page_ids
# Excerpt from the volume.
# Corresponds to the JSON property `selectedText`
# @return [String]
attr_accessor :selected_text
# URL to this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Timestamp for the last time this annotation was modified.
# Corresponds to the JSON property `updated`
# @return [DateTime]
attr_accessor :updated
# The volume that this annotation belongs to.
# Corresponds to the JSON property `volumeId`
# @return [String]
attr_accessor :volume_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@after_selected_text = args[:after_selected_text] unless args[:after_selected_text].nil?
@before_selected_text = args[:before_selected_text] unless args[:before_selected_text].nil?
@client_version_ranges = args[:client_version_ranges] unless args[:client_version_ranges].nil?
@created = args[:created] unless args[:created].nil?
@current_version_ranges = args[:current_version_ranges] unless args[:current_version_ranges].nil?
@data = args[:data] unless args[:data].nil?
@deleted = args[:deleted] unless args[:deleted].nil?
@highlight_style = args[:highlight_style] unless args[:highlight_style].nil?
@id = args[:id] unless args[:id].nil?
@kind = args[:kind] unless args[:kind].nil?
@layer_id = args[:layer_id] unless args[:layer_id].nil?
@layer_summary = args[:layer_summary] unless args[:layer_summary].nil?
@page_ids = args[:page_ids] unless args[:page_ids].nil?
@selected_text = args[:selected_text] unless args[:selected_text].nil?
@self_link = args[:self_link] unless args[:self_link].nil?
@updated = args[:updated] unless args[:updated].nil?
@volume_id = args[:volume_id] unless args[:volume_id].nil?
end
# Selection ranges sent from the client.
class ClientVersionRanges
include Google::Apis::Core::Hashable
# Range in CFI format for this annotation sent by client.
# Corresponds to the JSON property `cfiRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :cfi_range
# Content version the client sent in.
# Corresponds to the JSON property `contentVersion`
# @return [String]
attr_accessor :content_version
# Range in GB image format for this annotation sent by client.
# Corresponds to the JSON property `gbImageRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :gb_image_range
# Range in GB text format for this annotation sent by client.
# Corresponds to the JSON property `gbTextRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :gb_text_range
# Range in image CFI format for this annotation sent by client.
# Corresponds to the JSON property `imageCfiRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :image_cfi_range
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cfi_range = args[:cfi_range] unless args[:cfi_range].nil?
@content_version = args[:content_version] unless args[:content_version].nil?
@gb_image_range = args[:gb_image_range] unless args[:gb_image_range].nil?
@gb_text_range = args[:gb_text_range] unless args[:gb_text_range].nil?
@image_cfi_range = args[:image_cfi_range] unless args[:image_cfi_range].nil?
end
end
# Selection ranges for the most recent content version.
class CurrentVersionRanges
include Google::Apis::Core::Hashable
# Range in CFI format for this annotation for version above.
# Corresponds to the JSON property `cfiRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :cfi_range
# Content version applicable to ranges below.
# Corresponds to the JSON property `contentVersion`
# @return [String]
attr_accessor :content_version
# Range in GB image format for this annotation for version above.
# Corresponds to the JSON property `gbImageRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :gb_image_range
# Range in GB text format for this annotation for version above.
# Corresponds to the JSON property `gbTextRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :gb_text_range
# Range in image CFI format for this annotation for version above.
# Corresponds to the JSON property `imageCfiRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :image_cfi_range
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cfi_range = args[:cfi_range] unless args[:cfi_range].nil?
@content_version = args[:content_version] unless args[:content_version].nil?
@gb_image_range = args[:gb_image_range] unless args[:gb_image_range].nil?
@gb_text_range = args[:gb_text_range] unless args[:gb_text_range].nil?
@image_cfi_range = args[:image_cfi_range] unless args[:image_cfi_range].nil?
end
end
#
class LayerSummary
include Google::Apis::Core::Hashable
# Maximum allowed characters on this layer, especially for the "copy" layer.
# Corresponds to the JSON property `allowedCharacterCount`
# @return [Fixnum]
attr_accessor :allowed_character_count
# Type of limitation on this layer. "limited" or "unlimited" for the "copy"
# layer.
# Corresponds to the JSON property `limitType`
# @return [String]
attr_accessor :limit_type
# Remaining allowed characters on this layer, especially for the "copy" layer.
# Corresponds to the JSON property `remainingCharacterCount`
# @return [Fixnum]
attr_accessor :remaining_character_count
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allowed_character_count = args[:allowed_character_count] unless args[:allowed_character_count].nil?
@limit_type = args[:limit_type] unless args[:limit_type].nil?
@remaining_character_count = args[:remaining_character_count] unless args[:remaining_character_count].nil?
end
end
end
#
class AnnotationData
include Google::Apis::Core::Hashable
# The type of annotation this data is for.
# Corresponds to the JSON property `annotationType`
# @return [String]
attr_accessor :annotation_type
#
# Corresponds to the JSON property `data`
# @return [Object]
attr_accessor :data
# Base64 encoded data for this annotation data.
# Corresponds to the JSON property `encoded_data`
# @return [String]
attr_accessor :encoded_data
# Unique id for this annotation data.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Resource Type
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The Layer id for this data. *
# Corresponds to the JSON property `layerId`
# @return [String]
attr_accessor :layer_id
# URL for this resource. *
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Timestamp for the last time this data was updated. (RFC 3339 UTC date-time
# format).
# Corresponds to the JSON property `updated`
# @return [DateTime]
attr_accessor :updated
# The volume id for this data. *
# Corresponds to the JSON property `volumeId`
# @return [String]
attr_accessor :volume_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@annotation_type = args[:annotation_type] unless args[:annotation_type].nil?
@data = args[:data] unless args[:data].nil?
@encoded_data = args[:encoded_data] unless args[:encoded_data].nil?
@id = args[:id] unless args[:id].nil?
@kind = args[:kind] unless args[:kind].nil?
@layer_id = args[:layer_id] unless args[:layer_id].nil?
@self_link = args[:self_link] unless args[:self_link].nil?
@updated = args[:updated] unless args[:updated].nil?
@volume_id = args[:volume_id] unless args[:volume_id].nil?
end
end
#
class Annotations
include Google::Apis::Core::Hashable
# A list of annotations.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::Annotation>]
attr_accessor :items
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Token to pass in for pagination for the next page. This will not be present if
# this request does not have more results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# Total number of annotations found. This may be greater than the number of
# notes returned in this response if results have been paginated.
# Corresponds to the JSON property `totalItems`
# @return [Fixnum]
attr_accessor :total_items
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] unless args[:items].nil?
@kind = args[:kind] unless args[:kind].nil?
@next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
@total_items = args[:total_items] unless args[:total_items].nil?
end
end
#
class AnnotationsSummary
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
#
# Corresponds to the JSON property `layers`
# @return [Array<Google::Apis::BooksV1::AnnotationsSummary::Layer>]
attr_accessor :layers
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kind = args[:kind] unless args[:kind].nil?
@layers = args[:layers] unless args[:layers].nil?
end
#
class Layer
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `allowedCharacterCount`
# @return [Fixnum]
attr_accessor :allowed_character_count
#
# Corresponds to the JSON property `layerId`
# @return [String]
attr_accessor :layer_id
#
# Corresponds to the JSON property `limitType`
# @return [String]
attr_accessor :limit_type
#
# Corresponds to the JSON property `remainingCharacterCount`
# @return [Fixnum]
attr_accessor :remaining_character_count
#
# Corresponds to the JSON property `updated`
# @return [DateTime]
attr_accessor :updated
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allowed_character_count = args[:allowed_character_count] unless args[:allowed_character_count].nil?
@layer_id = args[:layer_id] unless args[:layer_id].nil?
@limit_type = args[:limit_type] unless args[:limit_type].nil?
@remaining_character_count = args[:remaining_character_count] unless args[:remaining_character_count].nil?
@updated = args[:updated] unless args[:updated].nil?
end
end
end
#
class AnnotationsData
include Google::Apis::Core::Hashable
# A list of Annotation Data.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::AnnotationData>]
attr_accessor :items
# Resource type
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Token to pass in for pagination for the next page. This will not be present if
# this request does not have more results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The total number of volume annotations found.
# Corresponds to the JSON property `totalItems`
# @return [Fixnum]
attr_accessor :total_items
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] unless args[:items].nil?
@kind = args[:kind] unless args[:kind].nil?
@next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
@total_items = args[:total_items] unless args[:total_items].nil?
end
end
#
class AnnotatinsRange
include Google::Apis::Core::Hashable
# The offset from the ending position.
# Corresponds to the JSON property `endOffset`
# @return [String]
attr_accessor :end_offset
# The ending position for the range.
# Corresponds to the JSON property `endPosition`
# @return [String]
attr_accessor :end_position
# The offset from the starting position.
# Corresponds to the JSON property `startOffset`
# @return [String]
attr_accessor :start_offset
# The starting position for the range.
# Corresponds to the JSON property `startPosition`
# @return [String]
attr_accessor :start_position
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@end_offset = args[:end_offset] unless args[:end_offset].nil?
@end_position = args[:end_position] unless args[:end_position].nil?
@start_offset = args[:start_offset] unless args[:start_offset].nil?
@start_position = args[:start_position] unless args[:start_position].nil?
end
end
#
class LoadingResource
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `author`
# @return [String]
attr_accessor :author
#
# Corresponds to the JSON property `processingState`
# @return [String]
attr_accessor :processing_state
#
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
#
# Corresponds to the JSON property `volumeId`
# @return [String]
attr_accessor :volume_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@author = args[:author] unless args[:author].nil?
@processing_state = args[:processing_state] unless args[:processing_state].nil?
@title = args[:title] unless args[:title].nil?
@volume_id = args[:volume_id] unless args[:volume_id].nil?
end
end
#
class RateRecommendedVolumeResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `consistency_token`
# @return [String]
attr_accessor :consistency_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@consistency_token = args[:consistency_token] unless args[:consistency_token].nil?
end
end
#
class Bookshelf
include Google::Apis::Core::Hashable
# Whether this bookshelf is PUBLIC or PRIVATE.
# Corresponds to the JSON property `access`
# @return [String]
attr_accessor :access
# Created time for this bookshelf (formatted UTC timestamp with millisecond
# resolution).
# Corresponds to the JSON property `created`
# @return [DateTime]
attr_accessor :created
# Description of this bookshelf.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Id of this bookshelf, only unique by user.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# Resource type for bookshelf metadata.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# URL to this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Title of this bookshelf.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# Last modified time of this bookshelf (formatted UTC timestamp with millisecond
# resolution).
# Corresponds to the JSON property `updated`
# @return [DateTime]
attr_accessor :updated
# Number of volumes in this bookshelf.
# Corresponds to the JSON property `volumeCount`
# @return [Fixnum]
attr_accessor :volume_count
# Last time a volume was added or removed from this bookshelf (formatted UTC
# timestamp with millisecond resolution).
# Corresponds to the JSON property `volumesLastUpdated`
# @return [DateTime]
attr_accessor :volumes_last_updated
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@access = args[:access] unless args[:access].nil?
@created = args[:created] unless args[:created].nil?
@description = args[:description] unless args[:description].nil?
@id = args[:id] unless args[:id].nil?
@kind = args[:kind] unless args[:kind].nil?
@self_link = args[:self_link] unless args[:self_link].nil?
@title = args[:title] unless args[:title].nil?
@updated = args[:updated] unless args[:updated].nil?
@volume_count = args[:volume_count] unless args[:volume_count].nil?
@volumes_last_updated = args[:volumes_last_updated] unless args[:volumes_last_updated].nil?
end
end
#
class Bookshelves
include Google::Apis::Core::Hashable
# A list of bookshelves.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::Bookshelf>]
attr_accessor :items
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] unless args[:items].nil?
@kind = args[:kind] unless args[:kind].nil?
end
end
#
class Category
include Google::Apis::Core::Hashable
# A list of onboarding categories.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::Category::Item>]
attr_accessor :items
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] unless args[:items].nil?
@kind = args[:kind] unless args[:kind].nil?
end
#
class Item
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `badgeUrl`
# @return [String]
attr_accessor :badge_url
#
# Corresponds to the JSON property `categoryId`
# @return [String]
attr_accessor :category_id
#
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@badge_url = args[:badge_url] unless args[:badge_url].nil?
@category_id = args[:category_id] unless args[:category_id].nil?
@name = args[:name] unless args[:name].nil?
end
end
end
#
class ConcurrentAccessRestriction
include Google::Apis::Core::Hashable
# Whether access is granted for this (user, device, volume).
# Corresponds to the JSON property `deviceAllowed`
# @return [Boolean]
attr_accessor :device_allowed
alias_method :device_allowed?, :device_allowed
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The maximum number of concurrent access licenses for this volume.
# Corresponds to the JSON property `maxConcurrentDevices`
# @return [Fixnum]
attr_accessor :max_concurrent_devices
# Error/warning message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
# Client nonce for verification. Download access and client-validation only.
# Corresponds to the JSON property `nonce`
# @return [String]
attr_accessor :nonce
# Error/warning reason code.
# Corresponds to the JSON property `reasonCode`
# @return [String]
attr_accessor :reason_code
# Whether this volume has any concurrent access restrictions.
# Corresponds to the JSON property `restricted`
# @return [Boolean]
attr_accessor :restricted
alias_method :restricted?, :restricted
# Response signature.
# Corresponds to the JSON property `signature`
# @return [String]
attr_accessor :signature
# Client app identifier for verification. Download access and client-validation
# only.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
# Time in seconds for license auto-expiration.
# Corresponds to the JSON property `timeWindowSeconds`
# @return [Fixnum]
attr_accessor :time_window_seconds
# Identifies the volume for which this entry applies.
# Corresponds to the JSON property `volumeId`
# @return [String]
attr_accessor :volume_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@device_allowed = args[:device_allowed] unless args[:device_allowed].nil?
@kind = args[:kind] unless args[:kind].nil?
@max_concurrent_devices = args[:max_concurrent_devices] unless args[:max_concurrent_devices].nil?
@message = args[:message] unless args[:message].nil?
@nonce = args[:nonce] unless args[:nonce].nil?
@reason_code = args[:reason_code] unless args[:reason_code].nil?
@restricted = args[:restricted] unless args[:restricted].nil?
@signature = args[:signature] unless args[:signature].nil?
@source = args[:source] unless args[:source].nil?
@time_window_seconds = args[:time_window_seconds] unless args[:time_window_seconds].nil?
@volume_id = args[:volume_id] unless args[:volume_id].nil?
end
end
#
class DictLayerData
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `common`
# @return [Google::Apis::BooksV1::DictLayerData::Common]
attr_accessor :common
#
# Corresponds to the JSON property `dict`
# @return [Google::Apis::BooksV1::DictLayerData::Dict]
attr_accessor :dict
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@common = args[:common] unless args[:common].nil?
@dict = args[:dict] unless args[:dict].nil?
@kind = args[:kind] unless args[:kind].nil?
end
#
class Common
include Google::Apis::Core::Hashable
# The display title and localized canonical name to use when searching for this
# entity on Google search.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@title = args[:title] unless args[:title].nil?
end
end
#
class Dict
include Google::Apis::Core::Hashable
# The source, url and attribution for this dictionary data.
# Corresponds to the JSON property `source`
# @return [Google::Apis::BooksV1::DictLayerData::Dict::Source]
attr_accessor :source
#
# Corresponds to the JSON property `words`
# @return [Array<Google::Apis::BooksV1::DictLayerData::Dict::Word>]
attr_accessor :words
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@source = args[:source] unless args[:source].nil?
@words = args[:words] unless args[:words].nil?
end
# The source, url and attribution for this dictionary data.
class Source
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `attribution`
# @return [String]
attr_accessor :attribution
#
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attribution = args[:attribution] unless args[:attribution].nil?
@url = args[:url] unless args[:url].nil?
end
end
#
class Word
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `derivatives`
# @return [Array<Google::Apis::BooksV1::DictLayerData::Dict::Word::Derivative>]
attr_accessor :derivatives
#
# Corresponds to the JSON property `examples`
# @return [Array<Google::Apis::BooksV1::DictLayerData::Dict::Word::Example>]
attr_accessor :examples
#
# Corresponds to the JSON property `senses`
# @return [Array<Google::Apis::BooksV1::DictLayerData::Dict::Word::Sense>]
attr_accessor :senses
# The words with different meanings but not related words, e.g. "go" (game) and "
# go" (verb).
# Corresponds to the JSON property `source`
# @return [Google::Apis::BooksV1::DictLayerData::Dict::Word::Source]
attr_accessor :source
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@derivatives = args[:derivatives] unless args[:derivatives].nil?
@examples = args[:examples] unless args[:examples].nil?
@senses = args[:senses] unless args[:senses].nil?
@source = args[:source] unless args[:source].nil?
end
#
class Derivative
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `source`
# @return [Google::Apis::BooksV1::DictLayerData::Dict::Word::Derivative::Source]
attr_accessor :source
#
# Corresponds to the JSON property `text`
# @return [String]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@source = args[:source] unless args[:source].nil?
@text = args[:text] unless args[:text].nil?
end
#
class Source
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `attribution`
# @return [String]
attr_accessor :attribution
#
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attribution = args[:attribution] unless args[:attribution].nil?
@url = args[:url] unless args[:url].nil?
end
end
end
#
class Example
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `source`
# @return [Google::Apis::BooksV1::DictLayerData::Dict::Word::Example::Source]
attr_accessor :source
#
# Corresponds to the JSON property `text`
# @return [String]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@source = args[:source] unless args[:source].nil?
@text = args[:text] unless args[:text].nil?
end
#
class Source
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `attribution`
# @return [String]
attr_accessor :attribution
#
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attribution = args[:attribution] unless args[:attribution].nil?
@url = args[:url] unless args[:url].nil?
end
end
end
#
class Sense
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `conjugations`
# @return [Array<Google::Apis::BooksV1::DictLayerData::Dict::Word::Sense::Conjugation>]
attr_accessor :conjugations
#
# Corresponds to the JSON property `definitions`
# @return [Array<Google::Apis::BooksV1::DictLayerData::Dict::Word::Sense::Definition>]
attr_accessor :definitions
#
# Corresponds to the JSON property `partOfSpeech`
# @return [String]
attr_accessor :part_of_speech
#
# Corresponds to the JSON property `pronunciation`
# @return [String]
attr_accessor :pronunciation
#
# Corresponds to the JSON property `pronunciationUrl`
# @return [String]
attr_accessor :pronunciation_url
#
# Corresponds to the JSON property `source`
# @return [Google::Apis::BooksV1::DictLayerData::Dict::Word::Sense::Source]
attr_accessor :source
#
# Corresponds to the JSON property `syllabification`
# @return [String]
attr_accessor :syllabification
#
# Corresponds to the JSON property `synonyms`
# @return [Array<Google::Apis::BooksV1::DictLayerData::Dict::Word::Sense::Synonym>]
attr_accessor :synonyms
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@conjugations = args[:conjugations] unless args[:conjugations].nil?
@definitions = args[:definitions] unless args[:definitions].nil?
@part_of_speech = args[:part_of_speech] unless args[:part_of_speech].nil?
@pronunciation = args[:pronunciation] unless args[:pronunciation].nil?
@pronunciation_url = args[:pronunciation_url] unless args[:pronunciation_url].nil?
@source = args[:source] unless args[:source].nil?
@syllabification = args[:syllabification] unless args[:syllabification].nil?
@synonyms = args[:synonyms] unless args[:synonyms].nil?
end
#
class Conjugation
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
#
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] unless args[:type].nil?
@value = args[:value] unless args[:value].nil?
end
end
#
class Definition
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `definition`
# @return [String]
attr_accessor :definition
#
# Corresponds to the JSON property `examples`
# @return [Array<Google::Apis::BooksV1::DictLayerData::Dict::Word::Sense::Definition::Example>]
attr_accessor :examples
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@definition = args[:definition] unless args[:definition].nil?
@examples = args[:examples] unless args[:examples].nil?
end
#
class Example
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `source`
# @return [Google::Apis::BooksV1::DictLayerData::Dict::Word::Sense::Definition::Example::Source]
attr_accessor :source
#
# Corresponds to the JSON property `text`
# @return [String]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@source = args[:source] unless args[:source].nil?
@text = args[:text] unless args[:text].nil?
end
#
class Source
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `attribution`
# @return [String]
attr_accessor :attribution
#
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attribution = args[:attribution] unless args[:attribution].nil?
@url = args[:url] unless args[:url].nil?
end
end
end
end
#
class Source
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `attribution`
# @return [String]
attr_accessor :attribution
#
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attribution = args[:attribution] unless args[:attribution].nil?
@url = args[:url] unless args[:url].nil?
end
end
#
class Synonym
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `source`
# @return [Google::Apis::BooksV1::DictLayerData::Dict::Word::Sense::Synonym::Source]
attr_accessor :source
#
# Corresponds to the JSON property `text`
# @return [String]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@source = args[:source] unless args[:source].nil?
@text = args[:text] unless args[:text].nil?
end
#
class Source
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `attribution`
# @return [String]
attr_accessor :attribution
#
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attribution = args[:attribution] unless args[:attribution].nil?
@url = args[:url] unless args[:url].nil?
end
end
end
end
# The words with different meanings but not related words, e.g. "go" (game) and "
# go" (verb).
class Source
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `attribution`
# @return [String]
attr_accessor :attribution
#
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attribution = args[:attribution] unless args[:attribution].nil?
@url = args[:url] unless args[:url].nil?
end
end
end
end
end
#
class DownloadAccessRestriction
include Google::Apis::Core::Hashable
# If restricted, whether access is granted for this (user, device, volume).
# Corresponds to the JSON property `deviceAllowed`
# @return [Boolean]
attr_accessor :device_allowed
alias_method :device_allowed?, :device_allowed
# If restricted, the number of content download licenses already acquired (
# including the requesting client, if licensed).
# Corresponds to the JSON property `downloadsAcquired`
# @return [Fixnum]
attr_accessor :downloads_acquired
# If deviceAllowed, whether access was just acquired with this request.
# Corresponds to the JSON property `justAcquired`
# @return [Boolean]
attr_accessor :just_acquired
alias_method :just_acquired?, :just_acquired
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# If restricted, the maximum number of content download licenses for this volume.
# Corresponds to the JSON property `maxDownloadDevices`
# @return [Fixnum]
attr_accessor :max_download_devices
# Error/warning message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
# Client nonce for verification. Download access and client-validation only.
# Corresponds to the JSON property `nonce`
# @return [String]
attr_accessor :nonce
# Error/warning reason code. Additional codes may be added in the future. 0 OK
# 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200
# WARNING_USED_LAST_ACCESS
# Corresponds to the JSON property `reasonCode`
# @return [String]
attr_accessor :reason_code
# Whether this volume has any download access restrictions.
# Corresponds to the JSON property `restricted`
# @return [Boolean]
attr_accessor :restricted
alias_method :restricted?, :restricted
# Response signature.
# Corresponds to the JSON property `signature`
# @return [String]
attr_accessor :signature
# Client app identifier for verification. Download access and client-validation
# only.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
# Identifies the volume for which this entry applies.
# Corresponds to the JSON property `volumeId`
# @return [String]
attr_accessor :volume_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@device_allowed = args[:device_allowed] unless args[:device_allowed].nil?
@downloads_acquired = args[:downloads_acquired] unless args[:downloads_acquired].nil?
@just_acquired = args[:just_acquired] unless args[:just_acquired].nil?
@kind = args[:kind] unless args[:kind].nil?
@max_download_devices = args[:max_download_devices] unless args[:max_download_devices].nil?
@message = args[:message] unless args[:message].nil?
@nonce = args[:nonce] unless args[:nonce].nil?
@reason_code = args[:reason_code] unless args[:reason_code].nil?
@restricted = args[:restricted] unless args[:restricted].nil?
@signature = args[:signature] unless args[:signature].nil?
@source = args[:source] unless args[:source].nil?
@volume_id = args[:volume_id] unless args[:volume_id].nil?
end
end
#
class DownloadAccesses
include Google::Apis::Core::Hashable
# A list of download access responses.
# Corresponds to the JSON property `downloadAccessList`
# @return [Array<Google::Apis::BooksV1::DownloadAccessRestriction>]
attr_accessor :download_access_list
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@download_access_list = args[:download_access_list] unless args[:download_access_list].nil?
@kind = args[:kind] unless args[:kind].nil?
end
end
#
class GeoLayerData
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `common`
# @return [Google::Apis::BooksV1::GeoLayerData::Common]
attr_accessor :common
#
# Corresponds to the JSON property `geo`
# @return [Google::Apis::BooksV1::GeoLayerData::Geo]
attr_accessor :geo
#
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@common = args[:common] unless args[:common].nil?
@geo = args[:geo] unless args[:geo].nil?
@kind = args[:kind] unless args[:kind].nil?
end
#
class Common
include Google::Apis::Core::Hashable
# The language of the information url and description.
# Corresponds to the JSON property `lang`
# @return [String]
attr_accessor :lang
# The URL for the preview image information.
# Corresponds to the JSON property `previewImageUrl`
# @return [String]
attr_accessor :preview_image_url
# The description for this location.
# Corresponds to the JSON property `snippet`
# @return [String]
attr_accessor :snippet
# The URL for information for this location. Ex: wikipedia link.
# Corresponds to the JSON property `snippetUrl`
# @return [String]
attr_accessor :snippet_url
# The display title and localized canonical name to use when searching for this
# entity on Google search.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@lang = args[:lang] unless args[:lang].nil?
@preview_image_url = args[:preview_image_url] unless args[:preview_image_url].nil?
@snippet = args[:snippet] unless args[:snippet].nil?
@snippet_url = args[:snippet_url] unless args[:snippet_url].nil?
@title = args[:title] unless args[:title].nil?
end
end
#
class Geo
include Google::Apis::Core::Hashable
# The boundary of the location as a set of loops containing pairs of latitude,
# longitude coordinates.
# Corresponds to the JSON property `boundary`
# @return [Array<Array<Google::Apis::BooksV1::GeoLayerData::Geo::Boundary>>]
attr_accessor :boundary
# The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER
# Corresponds to the JSON property `cachePolicy`
# @return [String]
attr_accessor :cache_policy
# The country code of the location.
# Corresponds to the JSON property `countryCode`
# @return [String]
attr_accessor :country_code
# The latitude of the location.
# Corresponds to the JSON property `latitude`
# @return [Float]
attr_accessor :latitude
# The longitude of the location.
# Corresponds to the JSON property `longitude`
# @return [Float]
attr_accessor :longitude
# The type of map that should be used for this location. EX: HYBRID, ROADMAP,
# SATELLITE, TERRAIN
# Corresponds to the JSON property `mapType`
# @return [String]
attr_accessor :map_type
# The viewport for showing this location. This is a latitude, longitude
# rectangle.
# Corresponds to the JSON property `viewport`
# @return [Google::Apis::BooksV1::GeoLayerData::Geo::Viewport]
attr_accessor :viewport
# The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom
# level, in which the entire world can be seen on one map) to 21+ (down to
# individual buildings). See: https://developers.google.com/maps/documentation/
# staticmaps/#Zoomlevels
# Corresponds to the JSON property `zoom`
# @return [Fixnum]
attr_accessor :zoom
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@boundary = args[:boundary] unless args[:boundary].nil?
@cache_policy = args[:cache_policy] unless args[:cache_policy].nil?
@country_code = args[:country_code] unless args[:country_code].nil?
@latitude = args[:latitude] unless args[:latitude].nil?
@longitude = args[:longitude] unless args[:longitude].nil?
@map_type = args[:map_type] unless args[:map_type].nil?
@viewport = args[:viewport] unless args[:viewport].nil?
@zoom = args[:zoom] unless args[:zoom].nil?
end
#
class Boundary
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `latitude`
# @return [Fixnum]
attr_accessor :latitude
#
# Corresponds to the JSON property `longitude`
# @return [Fixnum]
attr_accessor :longitude
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@latitude = args[:latitude] unless args[:latitude].nil?
@longitude = args[:longitude] unless args[:longitude].nil?
end
end
# The viewport for showing this location. This is a latitude, longitude
# rectangle.
class Viewport
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `hi`
# @return [Google::Apis::BooksV1::GeoLayerData::Geo::Viewport::Hi]
attr_accessor :hi
#
# Corresponds to the JSON property `lo`
# @return [Google::Apis::BooksV1::GeoLayerData::Geo::Viewport::Lo]
attr_accessor :lo
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@hi = args[:hi] unless args[:hi].nil?
@lo = args[:lo] unless args[:lo].nil?
end
#
class Hi
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `latitude`
# @return [Float]
attr_accessor :latitude
#
# Corresponds to the JSON property `longitude`
# @return [Float]
attr_accessor :longitude
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@latitude = args[:latitude] unless args[:latitude].nil?
@longitude = args[:longitude] unless args[:longitude].nil?
end
end
#
class Lo
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `latitude`
# @return [Float]
attr_accessor :latitude
#
# Corresponds to the JSON property `longitude`
# @return [Float]
attr_accessor :longitude
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@latitude = args[:latitude] unless args[:latitude].nil?
@longitude = args[:longitude] unless args[:longitude].nil?
end
end
end
end
end
#
class LayerSummaries
include Google::Apis::Core::Hashable
# A list of layer summary items.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::LayerSummary>]
attr_accessor :items
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The total number of layer summaries found.
# Corresponds to the JSON property `totalItems`
# @return [Fixnum]
attr_accessor :total_items
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] unless args[:items].nil?
@kind = args[:kind] unless args[:kind].nil?
@total_items = args[:total_items] unless args[:total_items].nil?
end
end
#
class LayerSummary
include Google::Apis::Core::Hashable
# The number of annotations for this layer.
# Corresponds to the JSON property `annotationCount`
# @return [Fixnum]
attr_accessor :annotation_count
# The list of annotation types contained for this layer.
# Corresponds to the JSON property `annotationTypes`
# @return [Array<String>]
attr_accessor :annotation_types
# Link to get data for this annotation.
# Corresponds to the JSON property `annotationsDataLink`
# @return [String]
attr_accessor :annotations_data_link
# The link to get the annotations for this layer.
# Corresponds to the JSON property `annotationsLink`
# @return [String]
attr_accessor :annotations_link
# The content version this resource is for.
# Corresponds to the JSON property `contentVersion`
# @return [String]
attr_accessor :content_version
# The number of data items for this layer.
# Corresponds to the JSON property `dataCount`
# @return [Fixnum]
attr_accessor :data_count
# Unique id of this layer summary.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Resource Type
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The layer id for this summary.
# Corresponds to the JSON property `layerId`
# @return [String]
attr_accessor :layer_id
# URL to this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC
# date-time format).
# Corresponds to the JSON property `updated`
# @return [DateTime]
attr_accessor :updated
# The current version of this layer's volume annotations. Note that this version
# applies only to the data in the books.layers.volumeAnnotations.* responses.
# The actual annotation data is versioned separately.
# Corresponds to the JSON property `volumeAnnotationsVersion`
# @return [String]
attr_accessor :volume_annotations_version
# The volume id this resource is for.
# Corresponds to the JSON property `volumeId`
# @return [String]
attr_accessor :volume_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@annotation_count = args[:annotation_count] unless args[:annotation_count].nil?
@annotation_types = args[:annotation_types] unless args[:annotation_types].nil?
@annotations_data_link = args[:annotations_data_link] unless args[:annotations_data_link].nil?
@annotations_link = args[:annotations_link] unless args[:annotations_link].nil?
@content_version = args[:content_version] unless args[:content_version].nil?
@data_count = args[:data_count] unless args[:data_count].nil?
@id = args[:id] unless args[:id].nil?
@kind = args[:kind] unless args[:kind].nil?
@layer_id = args[:layer_id] unless args[:layer_id].nil?
@self_link = args[:self_link] unless args[:self_link].nil?
@updated = args[:updated] unless args[:updated].nil?
@volume_annotations_version = args[:volume_annotations_version] unless args[:volume_annotations_version].nil?
@volume_id = args[:volume_id] unless args[:volume_id].nil?
end
end
#
class Metadata
include Google::Apis::Core::Hashable
# A list of offline dictionary metadata.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::Metadata::Item>]
attr_accessor :items
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] unless args[:items].nil?
@kind = args[:kind] unless args[:kind].nil?
end
#
class Item
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `download_url`
# @return [String]
attr_accessor :download_url
#
# Corresponds to the JSON property `encrypted_key`
# @return [String]
attr_accessor :encrypted_key
#
# Corresponds to the JSON property `language`
# @return [String]
attr_accessor :language
#
# Corresponds to the JSON property `size`
# @return [String]
attr_accessor :size
#
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@download_url = args[:download_url] unless args[:download_url].nil?
@encrypted_key = args[:encrypted_key] unless args[:encrypted_key].nil?
@language = args[:language] unless args[:language].nil?
@size = args[:size] unless args[:size].nil?
@version = args[:version] unless args[:version].nil?
end
end
end
#
class Offers
include Google::Apis::Core::Hashable
# A list of offers.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::Offers::Item>]
attr_accessor :items
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] unless args[:items].nil?
@kind = args[:kind] unless args[:kind].nil?
end
#
class Item
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `artUrl`
# @return [String]
attr_accessor :art_url
#
# Corresponds to the JSON property `gservicesKey`
# @return [String]
attr_accessor :gservices_key
#
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
#
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::Offers::Item::Item>]
attr_accessor :items
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@art_url = args[:art_url] unless args[:art_url].nil?
@gservices_key = args[:gservices_key] unless args[:gservices_key].nil?
@id = args[:id] unless args[:id].nil?
@items = args[:items] unless args[:items].nil?
end
#
class Item
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `author`
# @return [String]
attr_accessor :author
#
# Corresponds to the JSON property `canonicalVolumeLink`
# @return [String]
attr_accessor :canonical_volume_link
#
# Corresponds to the JSON property `coverUrl`
# @return [String]
attr_accessor :cover_url
#
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
#
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
#
# Corresponds to the JSON property `volumeId`
# @return [String]
attr_accessor :volume_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@author = args[:author] unless args[:author].nil?
@canonical_volume_link = args[:canonical_volume_link] unless args[:canonical_volume_link].nil?
@cover_url = args[:cover_url] unless args[:cover_url].nil?
@description = args[:description] unless args[:description].nil?
@title = args[:title] unless args[:title].nil?
@volume_id = args[:volume_id] unless args[:volume_id].nil?
end
end
end
end
#
class ReadingPosition
include Google::Apis::Core::Hashable
# Position in an EPUB as a CFI.
# Corresponds to the JSON property `epubCfiPosition`
# @return [String]
attr_accessor :epub_cfi_position
# Position in a volume for image-based content.
# Corresponds to the JSON property `gbImagePosition`
# @return [String]
attr_accessor :gb_image_position
# Position in a volume for text-based content.
# Corresponds to the JSON property `gbTextPosition`
# @return [String]
attr_accessor :gb_text_position
# Resource type for a reading position.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Position in a PDF file.
# Corresponds to the JSON property `pdfPosition`
# @return [String]
attr_accessor :pdf_position
# Timestamp when this reading position was last updated (formatted UTC timestamp
# with millisecond resolution).
# Corresponds to the JSON property `updated`
# @return [DateTime]
attr_accessor :updated
# Volume id associated with this reading position.
# Corresponds to the JSON property `volumeId`
# @return [String]
attr_accessor :volume_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@epub_cfi_position = args[:epub_cfi_position] unless args[:epub_cfi_position].nil?
@gb_image_position = args[:gb_image_position] unless args[:gb_image_position].nil?
@gb_text_position = args[:gb_text_position] unless args[:gb_text_position].nil?
@kind = args[:kind] unless args[:kind].nil?
@pdf_position = args[:pdf_position] unless args[:pdf_position].nil?
@updated = args[:updated] unless args[:updated].nil?
@volume_id = args[:volume_id] unless args[:volume_id].nil?
end
end
#
class RequestAccess
include Google::Apis::Core::Hashable
# A concurrent access response.
# Corresponds to the JSON property `concurrentAccess`
# @return [Google::Apis::BooksV1::ConcurrentAccessRestriction]
attr_accessor :concurrent_access
# A download access response.
# Corresponds to the JSON property `downloadAccess`
# @return [Google::Apis::BooksV1::DownloadAccessRestriction]
attr_accessor :download_access
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@concurrent_access = args[:concurrent_access] unless args[:concurrent_access].nil?
@download_access = args[:download_access] unless args[:download_access].nil?
@kind = args[:kind] unless args[:kind].nil?
end
end
#
class Review
include Google::Apis::Core::Hashable
# Author of this review.
# Corresponds to the JSON property `author`
# @return [Google::Apis::BooksV1::Review::Author]
attr_accessor :author
# Review text.
# Corresponds to the JSON property `content`
# @return [String]
attr_accessor :content
# Date of this review.
# Corresponds to the JSON property `date`
# @return [String]
attr_accessor :date
# URL for the full review text, for reviews gathered from the web.
# Corresponds to the JSON property `fullTextUrl`
# @return [String]
attr_accessor :full_text_url
# Resource type for a review.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE
# or NOT_RATED.
# Corresponds to the JSON property `rating`
# @return [String]
attr_accessor :rating
# Information regarding the source of this review, when the review is not from a
# Google Books user.
# Corresponds to the JSON property `source`
# @return [Google::Apis::BooksV1::Review::Source]
attr_accessor :source
# Title for this review.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# Source type for this review. Possible values are EDITORIAL, WEB_USER or
# GOOGLE_USER.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# Volume that this review is for.
# Corresponds to the JSON property `volumeId`
# @return [String]
attr_accessor :volume_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@author = args[:author] unless args[:author].nil?
@content = args[:content] unless args[:content].nil?
@date = args[:date] unless args[:date].nil?
@full_text_url = args[:full_text_url] unless args[:full_text_url].nil?
@kind = args[:kind] unless args[:kind].nil?
@rating = args[:rating] unless args[:rating].nil?
@source = args[:source] unless args[:source].nil?
@title = args[:title] unless args[:title].nil?
@type = args[:type] unless args[:type].nil?
@volume_id = args[:volume_id] unless args[:volume_id].nil?
end
# Author of this review.
class Author
include Google::Apis::Core::Hashable
# Name of this person.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] unless args[:display_name].nil?
end
end
# Information regarding the source of this review, when the review is not from a
# Google Books user.
class Source
include Google::Apis::Core::Hashable
# Name of the source.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Extra text about the source of the review.
# Corresponds to the JSON property `extraDescription`
# @return [String]
attr_accessor :extra_description
# URL of the source of the review.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] unless args[:description].nil?
@extra_description = args[:extra_description] unless args[:extra_description].nil?
@url = args[:url] unless args[:url].nil?
end
end
end
#
class UserSettings
include Google::Apis::Core::Hashable
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# User settings in sub-objects, each for different purposes.
# Corresponds to the JSON property `notesExport`
# @return [Google::Apis::BooksV1::UserSettings::NotesExport]
attr_accessor :notes_export
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kind = args[:kind] unless args[:kind].nil?
@notes_export = args[:notes_export] unless args[:notes_export].nil?
end
# User settings in sub-objects, each for different purposes.
class NotesExport
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `folderName`
# @return [String]
attr_accessor :folder_name
#
# Corresponds to the JSON property `isEnabled`
# @return [Boolean]
attr_accessor :is_enabled
alias_method :is_enabled?, :is_enabled
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@folder_name = args[:folder_name] unless args[:folder_name].nil?
@is_enabled = args[:is_enabled] unless args[:is_enabled].nil?
end
end
end
#
class Volume
include Google::Apis::Core::Hashable
# Any information about a volume related to reading or obtaining that volume
# text. This information can depend on country (books may be public domain in
# one country but not in another, e.g.).
# Corresponds to the JSON property `accessInfo`
# @return [Google::Apis::BooksV1::Volume::AccessInfo]
attr_accessor :access_info
# Opaque identifier for a specific version of a volume resource. (In LITE
# projection)
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# Unique identifier for a volume. (In LITE projection.)
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Resource type for a volume. (In LITE projection.)
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# What layers exist in this volume and high level information about them.
# Corresponds to the JSON property `layerInfo`
# @return [Google::Apis::BooksV1::Volume::LayerInfo]
attr_accessor :layer_info
# Recommendation related information for this volume.
# Corresponds to the JSON property `recommendedInfo`
# @return [Google::Apis::BooksV1::Volume::RecommendedInfo]
attr_accessor :recommended_info
# Any information about a volume related to the eBookstore and/or
# purchaseability. This information can depend on the country where the request
# originates from (i.e. books may not be for sale in certain countries).
# Corresponds to the JSON property `saleInfo`
# @return [Google::Apis::BooksV1::Volume::SaleInfo]
attr_accessor :sale_info
# Search result information related to this volume.
# Corresponds to the JSON property `searchInfo`
# @return [Google::Apis::BooksV1::Volume::SearchInfo]
attr_accessor :search_info
# URL to this resource. (In LITE projection.)
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# User specific information related to this volume. (e.g. page this user last
# read or whether they purchased this book)
# Corresponds to the JSON property `userInfo`
# @return [Google::Apis::BooksV1::Volume::UserInfo]
attr_accessor :user_info
# General volume information.
# Corresponds to the JSON property `volumeInfo`
# @return [Google::Apis::BooksV1::Volume::VolumeInfo]
attr_accessor :volume_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@access_info = args[:access_info] unless args[:access_info].nil?
@etag = args[:etag] unless args[:etag].nil?
@id = args[:id] unless args[:id].nil?
@kind = args[:kind] unless args[:kind].nil?
@layer_info = args[:layer_info] unless args[:layer_info].nil?
@recommended_info = args[:recommended_info] unless args[:recommended_info].nil?
@sale_info = args[:sale_info] unless args[:sale_info].nil?
@search_info = args[:search_info] unless args[:search_info].nil?
@self_link = args[:self_link] unless args[:self_link].nil?
@user_info = args[:user_info] unless args[:user_info].nil?
@volume_info = args[:volume_info] unless args[:volume_info].nil?
end
# Any information about a volume related to reading or obtaining that volume
# text. This information can depend on country (books may be public domain in
# one country but not in another, e.g.).
class AccessInfo
include Google::Apis::Core::Hashable
# Combines the access and viewability of this volume into a single status field
# for this user. Values can be FULL_PURCHASED, FULL_PUBLIC_DOMAIN, SAMPLE or
# NONE. (In LITE projection.)
# Corresponds to the JSON property `accessViewStatus`
# @return [String]
attr_accessor :access_view_status
# The two-letter ISO_3166-1 country code for which this access information is
# valid. (In LITE projection.)
# Corresponds to the JSON property `country`
# @return [String]
attr_accessor :country
# Information about a volume's download license access restrictions.
# Corresponds to the JSON property `downloadAccess`
# @return [Google::Apis::BooksV1::DownloadAccessRestriction]
attr_accessor :download_access
# URL to the Google Drive viewer if this volume is uploaded by the user by
# selecting the file from Google Drive.
# Corresponds to the JSON property `driveImportedContentLink`
# @return [String]
attr_accessor :drive_imported_content_link
# Whether this volume can be embedded in a viewport using the Embedded Viewer
# API.
# Corresponds to the JSON property `embeddable`
# @return [Boolean]
attr_accessor :embeddable
alias_method :embeddable?, :embeddable
# Information about epub content. (In LITE projection.)
# Corresponds to the JSON property `epub`
# @return [Google::Apis::BooksV1::Volume::AccessInfo::Epub]
attr_accessor :epub
# Whether this volume requires that the client explicitly request offline
# download license rather than have it done automatically when loading the
# content, if the client supports it.
# Corresponds to the JSON property `explicitOfflineLicenseManagement`
# @return [Boolean]
attr_accessor :explicit_offline_license_management
alias_method :explicit_offline_license_management?, :explicit_offline_license_management
# Information about pdf content. (In LITE projection.)
# Corresponds to the JSON property `pdf`
# @return [Google::Apis::BooksV1::Volume::AccessInfo::Pdf]
attr_accessor :pdf
# Whether or not this book is public domain in the country listed above.
# Corresponds to the JSON property `publicDomain`
# @return [Boolean]
attr_accessor :public_domain
alias_method :public_domain?, :public_domain
# Whether quote sharing is allowed for this volume.
# Corresponds to the JSON property `quoteSharingAllowed`
# @return [Boolean]
attr_accessor :quote_sharing_allowed
alias_method :quote_sharing_allowed?, :quote_sharing_allowed
# Whether text-to-speech is permitted for this volume. Values can be ALLOWED,
# ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
# Corresponds to the JSON property `textToSpeechPermission`
# @return [String]
attr_accessor :text_to_speech_permission
# For ordered but not yet processed orders, we give a URL that can be used to go
# to the appropriate Google Wallet page.
# Corresponds to the JSON property `viewOrderUrl`
# @return [String]
attr_accessor :view_order_url
# The read access of a volume. Possible values are PARTIAL, ALL_PAGES, NO_PAGES
# or UNKNOWN. This value depends on the country listed above. A value of PARTIAL
# means that the publisher has allowed some portion of the volume to be viewed
# publicly, without purchase. This can apply to eBooks as well as non-eBooks.
# Public domain books will always have a value of ALL_PAGES.
# Corresponds to the JSON property `viewability`
# @return [String]
attr_accessor :viewability
# URL to read this volume on the Google Books site. Link will not allow users to
# read non-viewable volumes.
# Corresponds to the JSON property `webReaderLink`
# @return [String]
attr_accessor :web_reader_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@access_view_status = args[:access_view_status] unless args[:access_view_status].nil?
@country = args[:country] unless args[:country].nil?
@download_access = args[:download_access] unless args[:download_access].nil?
@drive_imported_content_link = args[:drive_imported_content_link] unless args[:drive_imported_content_link].nil?
@embeddable = args[:embeddable] unless args[:embeddable].nil?
@epub = args[:epub] unless args[:epub].nil?
@explicit_offline_license_management = args[:explicit_offline_license_management] unless args[:explicit_offline_license_management].nil?
@pdf = args[:pdf] unless args[:pdf].nil?
@public_domain = args[:public_domain] unless args[:public_domain].nil?
@quote_sharing_allowed = args[:quote_sharing_allowed] unless args[:quote_sharing_allowed].nil?
@text_to_speech_permission = args[:text_to_speech_permission] unless args[:text_to_speech_permission].nil?
@view_order_url = args[:view_order_url] unless args[:view_order_url].nil?
@viewability = args[:viewability] unless args[:viewability].nil?
@web_reader_link = args[:web_reader_link] unless args[:web_reader_link].nil?
end
# Information about epub content. (In LITE projection.)
class Epub
include Google::Apis::Core::Hashable
# URL to retrieve ACS token for epub download. (In LITE projection.)
# Corresponds to the JSON property `acsTokenLink`
# @return [String]
attr_accessor :acs_token_link
# URL to download epub. (In LITE projection.)
# Corresponds to the JSON property `downloadLink`
# @return [String]
attr_accessor :download_link
# Is a flowing text epub available either as public domain or for purchase. (In
# LITE projection.)
# Corresponds to the JSON property `isAvailable`
# @return [Boolean]
attr_accessor :is_available
alias_method :is_available?, :is_available
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@acs_token_link = args[:acs_token_link] unless args[:acs_token_link].nil?
@download_link = args[:download_link] unless args[:download_link].nil?
@is_available = args[:is_available] unless args[:is_available].nil?
end
end
# Information about pdf content. (In LITE projection.)
class Pdf
include Google::Apis::Core::Hashable
# URL to retrieve ACS token for pdf download. (In LITE projection.)
# Corresponds to the JSON property `acsTokenLink`
# @return [String]
attr_accessor :acs_token_link
# URL to download pdf. (In LITE projection.)
# Corresponds to the JSON property `downloadLink`
# @return [String]
attr_accessor :download_link
# Is a scanned image pdf available either as public domain or for purchase. (In
# LITE projection.)
# Corresponds to the JSON property `isAvailable`
# @return [Boolean]
attr_accessor :is_available
alias_method :is_available?, :is_available
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@acs_token_link = args[:acs_token_link] unless args[:acs_token_link].nil?
@download_link = args[:download_link] unless args[:download_link].nil?
@is_available = args[:is_available] unless args[:is_available].nil?
end
end
end
# What layers exist in this volume and high level information about them.
class LayerInfo
include Google::Apis::Core::Hashable
# A layer should appear here if and only if the layer exists for this book.
# Corresponds to the JSON property `layers`
# @return [Array<Google::Apis::BooksV1::Volume::LayerInfo::Layer>]
attr_accessor :layers
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@layers = args[:layers] unless args[:layers].nil?
end
#
class Layer
include Google::Apis::Core::Hashable
# The layer id of this layer (e.g. "geo").
# Corresponds to the JSON property `layerId`
# @return [String]
attr_accessor :layer_id
# The current version of this layer's volume annotations. Note that this version
# applies only to the data in the books.layers.volumeAnnotations.* responses.
# The actual annotation data is versioned separately.
# Corresponds to the JSON property `volumeAnnotationsVersion`
# @return [String]
attr_accessor :volume_annotations_version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@layer_id = args[:layer_id] unless args[:layer_id].nil?
@volume_annotations_version = args[:volume_annotations_version] unless args[:volume_annotations_version].nil?
end
end
end
# Recommendation related information for this volume.
class RecommendedInfo
include Google::Apis::Core::Hashable
# A text explaining why this volume is recommended.
# Corresponds to the JSON property `explanation`
# @return [String]
attr_accessor :explanation
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@explanation = args[:explanation] unless args[:explanation].nil?
end
end
# Any information about a volume related to the eBookstore and/or
# purchaseability. This information can depend on the country where the request
# originates from (i.e. books may not be for sale in certain countries).
class SaleInfo
include Google::Apis::Core::Hashable
# URL to purchase this volume on the Google Books site. (In LITE projection)
# Corresponds to the JSON property `buyLink`
# @return [String]
attr_accessor :buy_link
# The two-letter ISO_3166-1 country code for which this sale information is
# valid. (In LITE projection.)
# Corresponds to the JSON property `country`
# @return [String]
attr_accessor :country
# Whether or not this volume is an eBook (can be added to the My eBooks shelf).
# Corresponds to the JSON property `isEbook`
# @return [Boolean]
attr_accessor :is_ebook
alias_method :is_ebook?, :is_ebook
# Suggested retail price. (In LITE projection.)
# Corresponds to the JSON property `listPrice`
# @return [Google::Apis::BooksV1::Volume::SaleInfo::ListPrice]
attr_accessor :list_price
# Offers available for this volume (sales and rentals).
# Corresponds to the JSON property `offers`
# @return [Array<Google::Apis::BooksV1::Volume::SaleInfo::Offer>]
attr_accessor :offers
# The date on which this book is available for sale.
# Corresponds to the JSON property `onSaleDate`
# @return [DateTime]
attr_accessor :on_sale_date
# The actual selling price of the book. This is the same as the suggested retail
# or list price unless there are offers or discounts on this volume. (In LITE
# projection.)
# Corresponds to the JSON property `retailPrice`
# @return [Google::Apis::BooksV1::Volume::SaleInfo::RetailPrice]
attr_accessor :retail_price
# Whether or not this book is available for sale or offered for free in the
# Google eBookstore for the country listed above. Possible values are FOR_SALE,
# FOR_RENTAL_ONLY, FOR_SALE_AND_RENTAL, FREE, NOT_FOR_SALE, or FOR_PREORDER.
# Corresponds to the JSON property `saleability`
# @return [String]
attr_accessor :saleability
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@buy_link = args[:buy_link] unless args[:buy_link].nil?
@country = args[:country] unless args[:country].nil?
@is_ebook = args[:is_ebook] unless args[:is_ebook].nil?
@list_price = args[:list_price] unless args[:list_price].nil?
@offers = args[:offers] unless args[:offers].nil?
@on_sale_date = args[:on_sale_date] unless args[:on_sale_date].nil?
@retail_price = args[:retail_price] unless args[:retail_price].nil?
@saleability = args[:saleability] unless args[:saleability].nil?
end
# Suggested retail price. (In LITE projection.)
class ListPrice
include Google::Apis::Core::Hashable
# Amount in the currency listed below. (In LITE projection.)
# Corresponds to the JSON property `amount`
# @return [Float]
attr_accessor :amount
# An ISO 4217, three-letter currency code. (In LITE projection.)
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@amount = args[:amount] unless args[:amount].nil?
@currency_code = args[:currency_code] unless args[:currency_code].nil?
end
end
#
class Offer
include Google::Apis::Core::Hashable
# The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
# Corresponds to the JSON property `finskyOfferType`
# @return [Fixnum]
attr_accessor :finsky_offer_type
# Offer list (=undiscounted) price in Micros.
# Corresponds to the JSON property `listPrice`
# @return [Google::Apis::BooksV1::Volume::SaleInfo::Offer::ListPrice]
attr_accessor :list_price
# The rental duration (for rental offers only).
# Corresponds to the JSON property `rentalDuration`
# @return [Google::Apis::BooksV1::Volume::SaleInfo::Offer::RentalDuration]
attr_accessor :rental_duration
# Offer retail (=discounted) price in Micros
# Corresponds to the JSON property `retailPrice`
# @return [Google::Apis::BooksV1::Volume::SaleInfo::Offer::RetailPrice]
attr_accessor :retail_price
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@finsky_offer_type = args[:finsky_offer_type] unless args[:finsky_offer_type].nil?
@list_price = args[:list_price] unless args[:list_price].nil?
@rental_duration = args[:rental_duration] unless args[:rental_duration].nil?
@retail_price = args[:retail_price] unless args[:retail_price].nil?
end
# Offer list (=undiscounted) price in Micros.
class ListPrice
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `amountInMicros`
# @return [Float]
attr_accessor :amount_in_micros
#
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@amount_in_micros = args[:amount_in_micros] unless args[:amount_in_micros].nil?
@currency_code = args[:currency_code] unless args[:currency_code].nil?
end
end
# The rental duration (for rental offers only).
class RentalDuration
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `count`
# @return [Float]
attr_accessor :count
#
# Corresponds to the JSON property `unit`
# @return [String]
attr_accessor :unit
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@count = args[:count] unless args[:count].nil?
@unit = args[:unit] unless args[:unit].nil?
end
end
# Offer retail (=discounted) price in Micros
class RetailPrice
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `amountInMicros`
# @return [Float]
attr_accessor :amount_in_micros
#
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@amount_in_micros = args[:amount_in_micros] unless args[:amount_in_micros].nil?
@currency_code = args[:currency_code] unless args[:currency_code].nil?
end
end
end
# The actual selling price of the book. This is the same as the suggested retail
# or list price unless there are offers or discounts on this volume. (In LITE
# projection.)
class RetailPrice
include Google::Apis::Core::Hashable
# Amount in the currency listed below. (In LITE projection.)
# Corresponds to the JSON property `amount`
# @return [Float]
attr_accessor :amount
# An ISO 4217, three-letter currency code. (In LITE projection.)
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@amount = args[:amount] unless args[:amount].nil?
@currency_code = args[:currency_code] unless args[:currency_code].nil?
end
end
end
# Search result information related to this volume.
class SearchInfo
include Google::Apis::Core::Hashable
# A text snippet containing the search query.
# Corresponds to the JSON property `textSnippet`
# @return [String]
attr_accessor :text_snippet
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@text_snippet = args[:text_snippet] unless args[:text_snippet].nil?
end
end
# User specific information related to this volume. (e.g. page this user last
# read or whether they purchased this book)
class UserInfo
include Google::Apis::Core::Hashable
# Copy/Paste accounting information.
# Corresponds to the JSON property `copy`
# @return [Google::Apis::BooksV1::Volume::UserInfo::Copy]
attr_accessor :copy
# Whether or not this volume is currently in "my books."
# Corresponds to the JSON property `isInMyBooks`
# @return [Boolean]
attr_accessor :is_in_my_books
alias_method :is_in_my_books?, :is_in_my_books
# Whether or not this volume was pre-ordered by the authenticated user making
# the request. (In LITE projection.)
# Corresponds to the JSON property `isPreordered`
# @return [Boolean]
attr_accessor :is_preordered
alias_method :is_preordered?, :is_preordered
# Whether or not this volume was purchased by the authenticated user making the
# request. (In LITE projection.)
# Corresponds to the JSON property `isPurchased`
# @return [Boolean]
attr_accessor :is_purchased
alias_method :is_purchased?, :is_purchased
# Whether or not this volume was user uploaded.
# Corresponds to the JSON property `isUploaded`
# @return [Boolean]
attr_accessor :is_uploaded
alias_method :is_uploaded?, :is_uploaded
# The user's current reading position in the volume, if one is available. (In
# LITE projection.)
# Corresponds to the JSON property `readingPosition`
# @return [Google::Apis::BooksV1::ReadingPosition]
attr_accessor :reading_position
# Period during this book is/was a valid rental.
# Corresponds to the JSON property `rentalPeriod`
# @return [Google::Apis::BooksV1::Volume::UserInfo::RentalPeriod]
attr_accessor :rental_period
# Whether this book is an active or an expired rental.
# Corresponds to the JSON property `rentalState`
# @return [String]
attr_accessor :rental_state
# This user's review of this volume, if one exists.
# Corresponds to the JSON property `review`
# @return [Google::Apis::BooksV1::Review]
attr_accessor :review
# Timestamp when this volume was last modified by a user action, such as a
# reading position update, volume purchase or writing a review. (RFC 3339 UTC
# date-time format).
# Corresponds to the JSON property `updated`
# @return [DateTime]
attr_accessor :updated
#
# Corresponds to the JSON property `userUploadedVolumeInfo`
# @return [Google::Apis::BooksV1::Volume::UserInfo::UserUploadedVolumeInfo]
attr_accessor :user_uploaded_volume_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@copy = args[:copy] unless args[:copy].nil?
@is_in_my_books = args[:is_in_my_books] unless args[:is_in_my_books].nil?
@is_preordered = args[:is_preordered] unless args[:is_preordered].nil?
@is_purchased = args[:is_purchased] unless args[:is_purchased].nil?
@is_uploaded = args[:is_uploaded] unless args[:is_uploaded].nil?
@reading_position = args[:reading_position] unless args[:reading_position].nil?
@rental_period = args[:rental_period] unless args[:rental_period].nil?
@rental_state = args[:rental_state] unless args[:rental_state].nil?
@review = args[:review] unless args[:review].nil?
@updated = args[:updated] unless args[:updated].nil?
@user_uploaded_volume_info = args[:user_uploaded_volume_info] unless args[:user_uploaded_volume_info].nil?
end
# Copy/Paste accounting information.
class Copy
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `allowedCharacterCount`
# @return [Fixnum]
attr_accessor :allowed_character_count
#
# Corresponds to the JSON property `limitType`
# @return [String]
attr_accessor :limit_type
#
# Corresponds to the JSON property `remainingCharacterCount`
# @return [Fixnum]
attr_accessor :remaining_character_count
#
# Corresponds to the JSON property `updated`
# @return [DateTime]
attr_accessor :updated
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allowed_character_count = args[:allowed_character_count] unless args[:allowed_character_count].nil?
@limit_type = args[:limit_type] unless args[:limit_type].nil?
@remaining_character_count = args[:remaining_character_count] unless args[:remaining_character_count].nil?
@updated = args[:updated] unless args[:updated].nil?
end
end
# Period during this book is/was a valid rental.
class RentalPeriod
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `endUtcSec`
# @return [String]
attr_accessor :end_utc_sec
#
# Corresponds to the JSON property `startUtcSec`
# @return [String]
attr_accessor :start_utc_sec
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@end_utc_sec = args[:end_utc_sec] unless args[:end_utc_sec].nil?
@start_utc_sec = args[:start_utc_sec] unless args[:start_utc_sec].nil?
end
end
#
class UserUploadedVolumeInfo
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `processingState`
# @return [String]
attr_accessor :processing_state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@processing_state = args[:processing_state] unless args[:processing_state].nil?
end
end
end
# General volume information.
class VolumeInfo
include Google::Apis::Core::Hashable
# Whether anonymous logging should be allowed.
# Corresponds to the JSON property `allowAnonLogging`
# @return [Boolean]
attr_accessor :allow_anon_logging
alias_method :allow_anon_logging?, :allow_anon_logging
# The names of the authors and/or editors for this volume. (In LITE projection)
# Corresponds to the JSON property `authors`
# @return [Array<String>]
attr_accessor :authors
# The mean review rating for this volume. (min = 1.0, max = 5.0)
# Corresponds to the JSON property `averageRating`
# @return [Float]
attr_accessor :average_rating
# Canonical URL for a volume. (In LITE projection.)
# Corresponds to the JSON property `canonicalVolumeLink`
# @return [String]
attr_accessor :canonical_volume_link
# A list of subject categories, such as "Fiction", "Suspense", etc.
# Corresponds to the JSON property `categories`
# @return [Array<String>]
attr_accessor :categories
# An identifier for the version of the volume content (text & images). (In LITE
# projection)
# Corresponds to the JSON property `contentVersion`
# @return [String]
attr_accessor :content_version
# 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`
# @return [String]
attr_accessor :description
# Physical dimensions of this volume.
# Corresponds to the JSON property `dimensions`
# @return [Google::Apis::BooksV1::Volume::VolumeInfo::Dimensions]
attr_accessor :dimensions
# A list of image links for all the sizes that are available. (In LITE
# projection.)
# Corresponds to the JSON property `imageLinks`
# @return [Google::Apis::BooksV1::Volume::VolumeInfo::ImageLinks]
attr_accessor :image_links
# Industry standard identifiers for this volume.
# Corresponds to the JSON property `industryIdentifiers`
# @return [Array<Google::Apis::BooksV1::Volume::VolumeInfo::IndustryIdentifier>]
attr_accessor :industry_identifiers
# URL to view information about this volume on the Google Books site. (In LITE
# projection)
# Corresponds to the JSON property `infoLink`
# @return [String]
attr_accessor :info_link
# 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`
# @return [String]
attr_accessor :language
# 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`
# @return [String]
attr_accessor :main_category
#
# Corresponds to the JSON property `maturityRating`
# @return [String]
attr_accessor :maturity_rating
# Total number of pages as per publisher metadata.
# Corresponds to the JSON property `pageCount`
# @return [Fixnum]
attr_accessor :page_count
# URL to preview this volume on the Google Books site.
# Corresponds to the JSON property `previewLink`
# @return [String]
attr_accessor :preview_link
# Type of publication of this volume. Possible values are BOOK or MAGAZINE.
# Corresponds to the JSON property `printType`
# @return [String]
attr_accessor :print_type
# Total number of printed pages in generated pdf representation.
# Corresponds to the JSON property `printedPageCount`
# @return [Fixnum]
attr_accessor :printed_page_count
# Date of publication. (In LITE projection.)
# Corresponds to the JSON property `publishedDate`
# @return [String]
attr_accessor :published_date
# Publisher of this volume. (In LITE projection.)
# Corresponds to the JSON property `publisher`
# @return [String]
attr_accessor :publisher
# The number of review ratings for this volume.
# Corresponds to the JSON property `ratingsCount`
# @return [Fixnum]
attr_accessor :ratings_count
# The reading modes available for this volume.
# Corresponds to the JSON property `readingModes`
# @return [Object]
attr_accessor :reading_modes
# Total number of sample pages as per publisher metadata.
# Corresponds to the JSON property `samplePageCount`
# @return [Fixnum]
attr_accessor :sample_page_count
# Volume subtitle. (In LITE projection.)
# Corresponds to the JSON property `subtitle`
# @return [String]
attr_accessor :subtitle
# Volume title. (In LITE projection.)
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_anon_logging = args[:allow_anon_logging] unless args[:allow_anon_logging].nil?
@authors = args[:authors] unless args[:authors].nil?
@average_rating = args[:average_rating] unless args[:average_rating].nil?
@canonical_volume_link = args[:canonical_volume_link] unless args[:canonical_volume_link].nil?
@categories = args[:categories] unless args[:categories].nil?
@content_version = args[:content_version] unless args[:content_version].nil?
@description = args[:description] unless args[:description].nil?
@dimensions = args[:dimensions] unless args[:dimensions].nil?
@image_links = args[:image_links] unless args[:image_links].nil?
@industry_identifiers = args[:industry_identifiers] unless args[:industry_identifiers].nil?
@info_link = args[:info_link] unless args[:info_link].nil?
@language = args[:language] unless args[:language].nil?
@main_category = args[:main_category] unless args[:main_category].nil?
@maturity_rating = args[:maturity_rating] unless args[:maturity_rating].nil?
@page_count = args[:page_count] unless args[:page_count].nil?
@preview_link = args[:preview_link] unless args[:preview_link].nil?
@print_type = args[:print_type] unless args[:print_type].nil?
@printed_page_count = args[:printed_page_count] unless args[:printed_page_count].nil?
@published_date = args[:published_date] unless args[:published_date].nil?
@publisher = args[:publisher] unless args[:publisher].nil?
@ratings_count = args[:ratings_count] unless args[:ratings_count].nil?
@reading_modes = args[:reading_modes] unless args[:reading_modes].nil?
@sample_page_count = args[:sample_page_count] unless args[:sample_page_count].nil?
@subtitle = args[:subtitle] unless args[:subtitle].nil?
@title = args[:title] unless args[:title].nil?
end
# Physical dimensions of this volume.
class Dimensions
include Google::Apis::Core::Hashable
# Height or length of this volume (in cm).
# Corresponds to the JSON property `height`
# @return [String]
attr_accessor :height
# Thickness of this volume (in cm).
# Corresponds to the JSON property `thickness`
# @return [String]
attr_accessor :thickness
# Width of this volume (in cm).
# Corresponds to the JSON property `width`
# @return [String]
attr_accessor :width
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@height = args[:height] unless args[:height].nil?
@thickness = args[:thickness] unless args[:thickness].nil?
@width = args[:width] unless args[:width].nil?
end
end
# A list of image links for all the sizes that are available. (In LITE
# projection.)
class ImageLinks
include Google::Apis::Core::Hashable
# Image link for extra large size (width of ~1280 pixels). (In LITE projection)
# Corresponds to the JSON property `extraLarge`
# @return [String]
attr_accessor :extra_large
# Image link for large size (width of ~800 pixels). (In LITE projection)
# Corresponds to the JSON property `large`
# @return [String]
attr_accessor :large
# Image link for medium size (width of ~575 pixels). (In LITE projection)
# Corresponds to the JSON property `medium`
# @return [String]
attr_accessor :medium
# Image link for small size (width of ~300 pixels). (In LITE projection)
# Corresponds to the JSON property `small`
# @return [String]
attr_accessor :small
# Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
# Corresponds to the JSON property `smallThumbnail`
# @return [String]
attr_accessor :small_thumbnail
# Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
# Corresponds to the JSON property `thumbnail`
# @return [String]
attr_accessor :thumbnail
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@extra_large = args[:extra_large] unless args[:extra_large].nil?
@large = args[:large] unless args[:large].nil?
@medium = args[:medium] unless args[:medium].nil?
@small = args[:small] unless args[:small].nil?
@small_thumbnail = args[:small_thumbnail] unless args[:small_thumbnail].nil?
@thumbnail = args[:thumbnail] unless args[:thumbnail].nil?
end
end
#
class IndustryIdentifier
include Google::Apis::Core::Hashable
# Industry specific volume identifier.
# Corresponds to the JSON property `identifier`
# @return [String]
attr_accessor :identifier
# Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@identifier = args[:identifier] unless args[:identifier].nil?
@type = args[:type] unless args[:type].nil?
end
end
end
end
#
class Volume2
include Google::Apis::Core::Hashable
# A list of volumes.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::Volume>]
attr_accessor :items
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
#
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] unless args[:items].nil?
@kind = args[:kind] unless args[:kind].nil?
@next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
end
end
#
class VolumeAnnotation
include Google::Apis::Core::Hashable
# The annotation data id for this volume annotation.
# Corresponds to the JSON property `annotationDataId`
# @return [String]
attr_accessor :annotation_data_id
# Link to get data for this annotation.
# Corresponds to the JSON property `annotationDataLink`
# @return [String]
attr_accessor :annotation_data_link
# The type of annotation this is.
# Corresponds to the JSON property `annotationType`
# @return [String]
attr_accessor :annotation_type
# The content ranges to identify the selected text.
# Corresponds to the JSON property `contentRanges`
# @return [Google::Apis::BooksV1::VolumeAnnotation::ContentRanges]
attr_accessor :content_ranges
# Data for this annotation.
# Corresponds to the JSON property `data`
# @return [String]
attr_accessor :data
# Indicates that this annotation is deleted.
# Corresponds to the JSON property `deleted`
# @return [Boolean]
attr_accessor :deleted
alias_method :deleted?, :deleted
# Unique id of this volume annotation.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Resource Type
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The Layer this annotation is for.
# Corresponds to the JSON property `layerId`
# @return [String]
attr_accessor :layer_id
# Pages the annotation spans.
# Corresponds to the JSON property `pageIds`
# @return [Array<String>]
attr_accessor :page_ids
# Excerpt from the volume.
# Corresponds to the JSON property `selectedText`
# @return [String]
attr_accessor :selected_text
# URL to this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Timestamp for the last time this anntoation was updated. (RFC 3339 UTC date-
# time format).
# Corresponds to the JSON property `updated`
# @return [DateTime]
attr_accessor :updated
# The Volume this annotation is for.
# Corresponds to the JSON property `volumeId`
# @return [String]
attr_accessor :volume_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@annotation_data_id = args[:annotation_data_id] unless args[:annotation_data_id].nil?
@annotation_data_link = args[:annotation_data_link] unless args[:annotation_data_link].nil?
@annotation_type = args[:annotation_type] unless args[:annotation_type].nil?
@content_ranges = args[:content_ranges] unless args[:content_ranges].nil?
@data = args[:data] unless args[:data].nil?
@deleted = args[:deleted] unless args[:deleted].nil?
@id = args[:id] unless args[:id].nil?
@kind = args[:kind] unless args[:kind].nil?
@layer_id = args[:layer_id] unless args[:layer_id].nil?
@page_ids = args[:page_ids] unless args[:page_ids].nil?
@selected_text = args[:selected_text] unless args[:selected_text].nil?
@self_link = args[:self_link] unless args[:self_link].nil?
@updated = args[:updated] unless args[:updated].nil?
@volume_id = args[:volume_id] unless args[:volume_id].nil?
end
# The content ranges to identify the selected text.
class ContentRanges
include Google::Apis::Core::Hashable
# Range in CFI format for this annotation for version above.
# Corresponds to the JSON property `cfiRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :cfi_range
# Content version applicable to ranges below.
# Corresponds to the JSON property `contentVersion`
# @return [String]
attr_accessor :content_version
# Range in GB image format for this annotation for version above.
# Corresponds to the JSON property `gbImageRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :gb_image_range
# Range in GB text format for this annotation for version above.
# Corresponds to the JSON property `gbTextRange`
# @return [Google::Apis::BooksV1::AnnotatinsRange]
attr_accessor :gb_text_range
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cfi_range = args[:cfi_range] unless args[:cfi_range].nil?
@content_version = args[:content_version] unless args[:content_version].nil?
@gb_image_range = args[:gb_image_range] unless args[:gb_image_range].nil?
@gb_text_range = args[:gb_text_range] unless args[:gb_text_range].nil?
end
end
end
#
class Volumeannotations
include Google::Apis::Core::Hashable
# A list of volume annotations.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::VolumeAnnotation>]
attr_accessor :items
# Resource type
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Token to pass in for pagination for the next page. This will not be present if
# this request does not have more results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The total number of volume annotations found.
# Corresponds to the JSON property `totalItems`
# @return [Fixnum]
attr_accessor :total_items
# The version string for all of the volume annotations in this layer (not just
# the ones in this response). Note: the version string doesn't apply to the
# annotation data, just the information in this response (e.g. the location of
# annotations in the book).
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] unless args[:items].nil?
@kind = args[:kind] unless args[:kind].nil?
@next_page_token = args[:next_page_token] unless args[:next_page_token].nil?
@total_items = args[:total_items] unless args[:total_items].nil?
@version = args[:version] unless args[:version].nil?
end
end
#
class Volumes
include Google::Apis::Core::Hashable
# A list of volumes.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::BooksV1::Volume>]
attr_accessor :items
# Resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Total number of volumes found. This might be greater than the number of
# volumes returned in this response if results have been paginated.
# Corresponds to the JSON property `totalItems`
# @return [Fixnum]
attr_accessor :total_items
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] unless args[:items].nil?
@kind = args[:kind] unless args[:kind].nil?
@total_items = args[:total_items] unless args[:total_items].nil?
end
end
end
end
end
Reference in New Issue View Git Blame Copy Permalink