class Google::Apis::BooksV1::Volume::UserInfo

User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)

Attributes

acquired_time[RW]

Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc. Corresponds to the JSON property `acquiredTime` @return [String]

acquisition_type[RW]

How this volume was acquired. Corresponds to the JSON property `acquisitionType` @return [Fixnum]

copy[RW]

Copy/Paste accounting information. Corresponds to the JSON property `copy` @return [Google::Apis::BooksV1::Volume::UserInfo::Copy]

entitlement_type[RW]

Whether this volume is purchased, sample, pd download etc. Corresponds to the JSON property `entitlementType` @return [Fixnum]

family_sharing[RW]

Information on the ability to share with the family. Corresponds to the JSON property `familySharing` @return [Google::Apis::BooksV1::Volume::UserInfo::FamilySharing]

is_family_shared_from_user[RW]

Whether or not the user shared this volume with the family. Corresponds to the JSON property `isFamilySharedFromUser` @return [Boolean]

is_family_shared_from_user?[RW]

Whether or not the user shared this volume with the family. Corresponds to the JSON property `isFamilySharedFromUser` @return [Boolean]

is_family_shared_to_user[RW]

Whether or not the user received this volume through family sharing. Corresponds to the JSON property `isFamilySharedToUser` @return [Boolean]

is_family_shared_to_user?[RW]

Whether or not the user received this volume through family sharing. Corresponds to the JSON property `isFamilySharedToUser` @return [Boolean]

is_family_sharing_allowed[RW]

Deprecated: Replaced by familySharing. Corresponds to the JSON property `isFamilySharingAllowed` @return [Boolean]

is_family_sharing_allowed?[RW]

Deprecated: Replaced by familySharing. Corresponds to the JSON property `isFamilySharingAllowed` @return [Boolean]

is_family_sharing_disabled_by_fop[RW]

Deprecated: Replaced by familySharing. Corresponds to the JSON property `isFamilySharingDisabledByFop` @return [Boolean]

is_family_sharing_disabled_by_fop?[RW]

Deprecated: Replaced by familySharing. Corresponds to the JSON property `isFamilySharingDisabledByFop` @return [Boolean]

is_in_my_books[RW]

Whether or not this volume is currently in “my books.” Corresponds to the JSON property `isInMyBooks` @return [Boolean]

is_in_my_books?[RW]

Whether or not this volume is currently in “my books.” Corresponds to the JSON property `isInMyBooks` @return [Boolean]

is_preordered[RW]

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]

is_preordered?[RW]

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]

is_purchased[RW]

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]

is_purchased?[RW]

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]

is_uploaded[RW]

Whether or not this volume was user uploaded. Corresponds to the JSON property `isUploaded` @return [Boolean]

is_uploaded?[RW]

Whether or not this volume was user uploaded. Corresponds to the JSON property `isUploaded` @return [Boolean]

reading_position[RW]

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]

rental_period[RW]

Period during this book is/was a valid rental. Corresponds to the JSON property `rentalPeriod` @return [Google::Apis::BooksV1::Volume::UserInfo::RentalPeriod]

rental_state[RW]

Whether this book is an active or an expired rental. Corresponds to the JSON property `rentalState` @return [String]

review[RW]

This user's review of this volume, if one exists. Corresponds to the JSON property `review` @return [Google::Apis::BooksV1::Review]

updated[RW]

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 [String]

user_uploaded_volume_info[RW]

Corresponds to the JSON property `userUploadedVolumeInfo` @return [Google::Apis::BooksV1::Volume::UserInfo::UserUploadedVolumeInfo]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/books_v1/classes.rb, line 3702
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/books_v1/classes.rb, line 3707
def update!(**args)
  @acquired_time = args[:acquired_time] if args.key?(:acquired_time)
  @acquisition_type = args[:acquisition_type] if args.key?(:acquisition_type)
  @copy = args[:copy] if args.key?(:copy)
  @entitlement_type = args[:entitlement_type] if args.key?(:entitlement_type)
  @family_sharing = args[:family_sharing] if args.key?(:family_sharing)
  @is_family_shared_from_user = args[:is_family_shared_from_user] if args.key?(:is_family_shared_from_user)
  @is_family_shared_to_user = args[:is_family_shared_to_user] if args.key?(:is_family_shared_to_user)
  @is_family_sharing_allowed = args[:is_family_sharing_allowed] if args.key?(:is_family_sharing_allowed)
  @is_family_sharing_disabled_by_fop = args[:is_family_sharing_disabled_by_fop] if args.key?(:is_family_sharing_disabled_by_fop)
  @is_in_my_books = args[:is_in_my_books] if args.key?(:is_in_my_books)
  @is_preordered = args[:is_preordered] if args.key?(:is_preordered)
  @is_purchased = args[:is_purchased] if args.key?(:is_purchased)
  @is_uploaded = args[:is_uploaded] if args.key?(:is_uploaded)
  @reading_position = args[:reading_position] if args.key?(:reading_position)
  @rental_period = args[:rental_period] if args.key?(:rental_period)
  @rental_state = args[:rental_state] if args.key?(:rental_state)
  @review = args[:review] if args.key?(:review)
  @updated = args[:updated] if args.key?(:updated)
  @user_uploaded_volume_info = args[:user_uploaded_volume_info] if args.key?(:user_uploaded_volume_info)
end