Show / Hide Table of Contents

Class Volume.UserInfoData

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

Inheritance
object
Volume.UserInfoData
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Books.v1.Data
Assembly: Google.Apis.Books.v1.dll
Syntax
public class Volume.UserInfoData

Properties

AcquiredTime

Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.

Declaration
[JsonProperty("acquiredTime")]
public virtual string AcquiredTime { get; set; }
Property Value
Type Description
string

AcquisitionType

How this volume was acquired.

Declaration
[JsonProperty("acquisitionType")]
public virtual int? AcquisitionType { get; set; }
Property Value
Type Description
int?

Copy

Copy/Paste accounting information.

Declaration
[JsonProperty("copy")]
public virtual Volume.UserInfoData.CopyData Copy { get; set; }
Property Value
Type Description
Volume.UserInfoData.CopyData

EntitlementType

Whether this volume is purchased, sample, pd download etc.

Declaration
[JsonProperty("entitlementType")]
public virtual int? EntitlementType { get; set; }
Property Value
Type Description
int?

FamilySharing

Information on the ability to share with the family.

Declaration
[JsonProperty("familySharing")]
public virtual Volume.UserInfoData.FamilySharingData FamilySharing { get; set; }
Property Value
Type Description
Volume.UserInfoData.FamilySharingData

IsFamilySharedFromUser

Whether or not the user shared this volume with the family.

Declaration
[JsonProperty("isFamilySharedFromUser")]
public virtual bool? IsFamilySharedFromUser { get; set; }
Property Value
Type Description
bool?

IsFamilySharedToUser

Whether or not the user received this volume through family sharing.

Declaration
[JsonProperty("isFamilySharedToUser")]
public virtual bool? IsFamilySharedToUser { get; set; }
Property Value
Type Description
bool?

IsFamilySharingAllowed

Deprecated: Replaced by familySharing.

Declaration
[JsonProperty("isFamilySharingAllowed")]
public virtual bool? IsFamilySharingAllowed { get; set; }
Property Value
Type Description
bool?

IsFamilySharingDisabledByFop

Deprecated: Replaced by familySharing.

Declaration
[JsonProperty("isFamilySharingDisabledByFop")]
public virtual bool? IsFamilySharingDisabledByFop { get; set; }
Property Value
Type Description
bool?

IsInMyBooks

Whether or not this volume is currently in "my books."

Declaration
[JsonProperty("isInMyBooks")]
public virtual bool? IsInMyBooks { get; set; }
Property Value
Type Description
bool?

IsPreordered

Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)

Declaration
[JsonProperty("isPreordered")]
public virtual bool? IsPreordered { get; set; }
Property Value
Type Description
bool?

IsPurchased

Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)

Declaration
[JsonProperty("isPurchased")]
public virtual bool? IsPurchased { get; set; }
Property Value
Type Description
bool?

IsUploaded

Whether or not this volume was user uploaded.

Declaration
[JsonProperty("isUploaded")]
public virtual bool? IsUploaded { get; set; }
Property Value
Type Description
bool?

ReadingPosition

The user's current reading position in the volume, if one is available. (In LITE projection.)

Declaration
[JsonProperty("readingPosition")]
public virtual ReadingPosition ReadingPosition { get; set; }
Property Value
Type Description
ReadingPosition

RentalPeriod

Period during this book is/was a valid rental.

Declaration
[JsonProperty("rentalPeriod")]
public virtual Volume.UserInfoData.RentalPeriodData RentalPeriod { get; set; }
Property Value
Type Description
Volume.UserInfoData.RentalPeriodData

RentalState

Whether this book is an active or an expired rental.

Declaration
[JsonProperty("rentalState")]
public virtual string RentalState { get; set; }
Property Value
Type Description
string

Review

This user's review of this volume, if one exists.

Declaration
[JsonProperty("review")]
public virtual Review Review { get; set; }
Property Value
Type Description
Review

Updated

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).

Declaration
[JsonProperty("updated")]
public virtual string Updated { get; set; }
Property Value
Type Description
string

UserUploadedVolumeInfo

Declaration
[JsonProperty("userUploadedVolumeInfo")]
public virtual Volume.UserInfoData.UserUploadedVolumeInfoData UserUploadedVolumeInfo { get; set; }
Property Value
Type Description
Volume.UserInfoData.UserUploadedVolumeInfoData
In this article
Back to top Generated by DocFX