chore: update docs/dyn (#1106)
diff --git a/docs/dyn/books_v1.myconfig.html b/docs/dyn/books_v1.myconfig.html
index 76ead1f..a818718 100644
--- a/docs/dyn/books_v1.myconfig.html
+++ b/docs/dyn/books_v1.myconfig.html
@@ -87,7 +87,7 @@
<code><a href="#requestAccess">requestAccess(cpksver, nonce, source, volumeId, locale=None, licenseTypes=None, x__xgafv=None)</a></code></p>
<p class="firstline">Request concurrent and download access restrictions.</p>
<p class="toc_element">
- <code><a href="#syncVolumeLicenses">syncVolumeLicenses(cpksver, nonce, source, volumeIds=None, showPreorders=None, features=None, includeNonComicsSeries=None, locale=None, x__xgafv=None)</a></code></p>
+ <code><a href="#syncVolumeLicenses">syncVolumeLicenses(cpksver, nonce, source, showPreorders=None, features=None, volumeIds=None, locale=None, includeNonComicsSeries=None, x__xgafv=None)</a></code></p>
<p class="firstline">Request downloaded content access for specified volumes on the My eBooks shelf.</p>
<p class="toc_element">
<code><a href="#updateUserSettings">updateUserSettings(body=None, x__xgafv=None)</a></code></p>
@@ -113,29 +113,29 @@
An object of the form:
{
- "notesExport": { # User settings in sub-objects, each for different purposes.
- "folderName": "A String",
- "isEnabled": True or False,
- },
- "notification": {
- "matchMyInterests": {
- "opted_state": "A String",
+ "kind": "A String", # Resource type.
+ "notesExport": { # User settings in sub-objects, each for different purposes.
+ "isEnabled": True or False,
+ "folderName": "A String",
},
- "priceDrop": {
- "opted_state": "A String",
+ "notification": {
+ "matchMyInterests": {
+ "opted_state": "A String",
+ },
+ "moreFromAuthors": {
+ "opted_state": "A String",
+ },
+ "moreFromSeries": {
+ "opted_state": "A String",
+ },
+ "rewardExpirations": {
+ "opted_state": "A String",
+ },
+ "priceDrop": {
+ "opted_state": "A String",
+ },
},
- "moreFromAuthors": {
- "opted_state": "A String",
- },
- "moreFromSeries": {
- "opted_state": "A String",
- },
- "rewardExpirations": {
- "opted_state": "A String",
- },
- },
- "kind": "A String", # Resource type.
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -159,18 +159,18 @@
"kind": "A String", # Resource type.
"downloadAccessList": [ # A list of download access responses.
{
- "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
- "kind": "A String", # Resource type.
- "reasonCode": "A String", # 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
- "message": "A String", # Error/warning message.
- "source": "A String", # Client app identifier for verification. Download access and client-validation only.
- "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
- "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
- "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
- "volumeId": "A String", # Identifies the volume for which this entry applies.
- "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
- "signature": "A String", # Response signature.
"restricted": True or False, # Whether this volume has any download access restrictions.
+ "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
+ "message": "A String", # Error/warning message.
+ "signature": "A String", # Response signature.
+ "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
+ "source": "A String", # Client app identifier for verification. Download access and client-validation only.
+ "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
+ "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
+ "reasonCode": "A String", # 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
+ "kind": "A String", # Resource type.
+ "volumeId": "A String", # Identifies the volume for which this entry applies.
+ "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
},
],
}</pre>
@@ -201,53 +201,53 @@
An object of the form:
{
- "downloadAccess": { # A download access response.
- "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
- "kind": "A String", # Resource type.
- "reasonCode": "A String", # 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
- "message": "A String", # Error/warning message.
- "source": "A String", # Client app identifier for verification. Download access and client-validation only.
- "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
- "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
- "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
- "volumeId": "A String", # Identifies the volume for which this entry applies.
- "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
- "signature": "A String", # Response signature.
- "restricted": True or False, # Whether this volume has any download access restrictions.
- },
+ "kind": "A String", # Resource type.
"concurrentAccess": { # A concurrent access response.
- "signature": "A String", # Response signature.
- "kind": "A String", # Resource type.
- "maxConcurrentDevices": 42, # The maximum number of concurrent access licenses for this volume.
+ "message": "A String", # Error/warning message.
"volumeId": "A String", # Identifies the volume for which this entry applies.
+ "restricted": True or False, # Whether this volume has any concurrent access restrictions.
+ "maxConcurrentDevices": 42, # The maximum number of concurrent access licenses for this volume.
+ "timeWindowSeconds": 42, # Time in seconds for license auto-expiration.
+ "kind": "A String", # Resource type.
+ "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
+ "source": "A String", # Client app identifier for verification. Download access and client-validation only.
+ "signature": "A String", # Response signature.
"reasonCode": "A String", # Error/warning reason code.
"deviceAllowed": True or False, # Whether access is granted for this (user, device, volume).
- "timeWindowSeconds": 42, # Time in seconds for license auto-expiration.
- "restricted": True or False, # Whether this volume has any concurrent access restrictions.
- "message": "A String", # Error/warning message.
- "source": "A String", # Client app identifier for verification. Download access and client-validation only.
- "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
},
- "kind": "A String", # Resource type.
+ "downloadAccess": { # A download access response.
+ "restricted": True or False, # Whether this volume has any download access restrictions.
+ "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
+ "message": "A String", # Error/warning message.
+ "signature": "A String", # Response signature.
+ "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
+ "source": "A String", # Client app identifier for verification. Download access and client-validation only.
+ "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
+ "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
+ "reasonCode": "A String", # 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
+ "kind": "A String", # Resource type.
+ "volumeId": "A String", # Identifies the volume for which this entry applies.
+ "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="syncVolumeLicenses">syncVolumeLicenses(cpksver, nonce, source, volumeIds=None, showPreorders=None, features=None, includeNonComicsSeries=None, locale=None, x__xgafv=None)</code>
+ <code class="details" id="syncVolumeLicenses">syncVolumeLicenses(cpksver, nonce, source, showPreorders=None, features=None, volumeIds=None, locale=None, includeNonComicsSeries=None, x__xgafv=None)</code>
<pre>Request downloaded content access for specified volumes on the My eBooks shelf.
Args:
cpksver: string, The device/version ID from which to release the restriction. (required)
nonce: string, The client nonce value. (required)
source: string, String to identify the originator of this request. (required)
- volumeIds: string, The volume(s) to request download restrictions for. (repeated)
showPreorders: boolean, Set to true to show pre-ordered books. Defaults to false.
features: string, List of features supported by the client, i.e., 'RENTALS' (repeated)
Allowed values
FEATURES_UNDEFINED -
RENTALS - Client supports rentals.
- includeNonComicsSeries: boolean, Set to true to include non-comics series. Defaults to false.
+ volumeIds: string, The volume(s) to request download restrictions for. (repeated)
locale: string, ISO-639-1, ISO-3166-1 codes for message localization, i.e. en_US.
+ includeNonComicsSeries: boolean, Set to true to include non-comics series. Defaults to false.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -257,61 +257,217 @@
An object of the form:
{
+ "kind": "A String", # Resource type.
"items": [ # A list of volumes.
{
- "accessInfo": { # 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.).
- "publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
- "downloadAccess": { # Information about a volume's download license access restrictions.
- "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
+ "id": "A String", # Unique identifier for a volume. (In LITE projection.)
+ "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
+ "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
+ "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
+ "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
+ "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
+ "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
+ "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
+ "copy": { # Copy/Paste accounting information.
+ "updated": "A String",
+ "remainingCharacterCount": 42,
+ "limitType": "A String",
+ "allowedCharacterCount": 42,
+ },
+ "userUploadedVolumeInfo": {
+ "processingState": "A String",
+ },
+ "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
+ "isUploaded": True or False, # Whether or not this volume was user uploaded.
+ "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
+ "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
+ "rentalPeriod": { # Period during this book is/was a valid rental.
+ "endUtcSec": "A String",
+ "startUtcSec": "A String",
+ },
+ "acquisitionType": 42, # How this volume was acquired.
+ "familySharing": { # Information on the ability to share with the family.
+ "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
+ "familyRole": "A String", # The role of the user in the family.
+ "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
+ },
+ "updated": "A String", # 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).
+ "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
+ "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
+ "gbImagePosition": "A String", # Position in a volume for image-based content.
+ "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
+ "gbTextPosition": "A String", # Position in a volume for text-based content.
+ "volumeId": "A String", # Volume id associated with this reading position.
+ "kind": "A String", # Resource type for a reading position.
+ "pdfPosition": "A String", # Position in a PDF file.
+ },
+ "rentalState": "A String", # Whether this book is an active or an expired rental.
+ "review": { # This user's review of this volume, if one exists.
+ "content": "A String", # Review text.
+ "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
+ "extraDescription": "A String", # Extra text about the source of the review.
+ "description": "A String", # Name of the source.
+ "url": "A String", # URL of the source of the review.
+ },
+ "volumeId": "A String", # Volume that this review is for.
+ "author": { # Author of this review.
+ "displayName": "A String", # Name of this person.
+ },
+ "kind": "A String", # Resource type for a review.
+ "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
+ "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
+ "title": "A String", # Title for this review.
+ "date": "A String", # Date of this review.
+ "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
+ },
+ },
+ "kind": "A String", # Resource type for a volume. (In LITE projection.)
+ "etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
+ "selfLink": "A String", # URL to this resource. (In LITE projection.)
+ "layerInfo": { # What layers exist in this volume and high level information about them.
+ "layers": [ # A layer should appear here if and only if the layer exists for this book.
+ {
+ "volumeAnnotationsVersion": "A String", # 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.
+ "layerId": "A String", # The layer id of this layer (e.g. "geo").
+ },
+ ],
+ },
+ "volumeInfo": { # General volume information.
+ "previewLink": "A String", # URL to preview this volume on the Google Books site.
+ "seriesInfo": {
+ "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
+ "volumeSeries": [
+ {
+ "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
+ {
+ "issueDisplayNumber": "A String",
+ "issueOrderNumber": 42,
+ },
+ ],
+ "seriesId": "A String", # The series id.
+ "orderNumber": 42, # The book order number in the series.
+ "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
+ },
+ ],
+ "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
"kind": "A String", # Resource type.
- "reasonCode": "A String", # 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
- "message": "A String", # Error/warning message.
- "source": "A String", # Client app identifier for verification. Download access and client-validation only.
- "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
- "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
- "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
- "volumeId": "A String", # Identifies the volume for which this entry applies.
- "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
- "signature": "A String", # Response signature.
- "restricted": True or False, # Whether this volume has any download access restrictions.
},
- "pdf": { # Information about pdf content. (In LITE projection.)
- "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
- "downloadLink": "A String", # URL to download pdf. (In LITE projection.)
- "acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
+ "dimensions": { # Physical dimensions of this volume.
+ "height": "A String", # Height or length of this volume (in cm).
+ "thickness": "A String", # Thickness of this volume (in cm).
+ "width": "A String", # Width of this volume (in cm).
},
- "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
- "epub": { # Information about epub content. (In LITE projection.)
- "downloadLink": "A String", # URL to download epub. (In LITE projection.)
- "acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
- "isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
+ "title": "A String", # Volume title. (In LITE projection.)
+ "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
+ "pageCount": 42, # Total number of pages as per publisher metadata.
+ "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
+ "A String",
+ ],
+ "readingModes": { # The reading modes available for this volume.
+ "image": True or False,
+ "text": True or False,
},
- "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
- "country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
- "embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
- "viewability": "A String", # 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.
- "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
- "explicitOfflineLicenseManagement": True or False, # 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.
- "webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
- "textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
- "accessViewStatus": "A String", # 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.)
+ "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
+ "publishedDate": "A String", # Date of publication. (In LITE projection.)
+ "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
+ "maturityRating": "A String",
+ "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
+ "subtitle": "A String", # Volume subtitle. (In LITE projection.)
+ "comicsContent": True or False, # Whether the volume has comics content.
+ "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
+ "ratingsCount": 42, # The number of review ratings for this volume.
+ "panelizationSummary": { # A top-level summary of the panelization info in this volume.
+ "imageBubbleVersion": "A String",
+ "epubBubbleVersion": "A String",
+ "containsEpubBubbles": True or False,
+ "containsImageBubbles": True or False,
+ },
+ "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
+ "publisher": "A String", # Publisher of this volume. (In LITE projection.)
+ "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
+ "industryIdentifiers": [ # Industry standard identifiers for this volume.
+ {
+ "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
+ "identifier": "A String", # Industry specific volume identifier.
+ },
+ ],
+ "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
+ "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
+ "A String",
+ ],
+ "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
+ "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
+ "imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
+ "medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
+ "smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
+ "large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
+ "extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
+ "small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
+ "thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
+ },
+ "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
},
"recommendedInfo": { # Recommendation related information for this volume.
"explanation": "A String", # A text explaining why this volume is recommended.
},
+ "accessInfo": { # 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.).
+ "viewability": "A String", # 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.
+ "publicDomain": True or False, # Whether or not this book is public domain in the country listed above.
+ "accessViewStatus": "A String", # 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.)
+ "textToSpeechPermission": "A String", # Whether text-to-speech is permitted for this volume. Values can be ALLOWED, ALLOWED_FOR_ACCESSIBILITY, or NOT_ALLOWED.
+ "viewOrderUrl": "A String", # For ordered but not yet processed orders, we give a URL that can be used to go to the appropriate Google Wallet page.
+ "embeddable": True or False, # Whether this volume can be embedded in a viewport using the Embedded Viewer API.
+ "pdf": { # Information about pdf content. (In LITE projection.)
+ "isAvailable": True or False, # Is a scanned image pdf available either as public domain or for purchase. (In LITE projection.)
+ "acsTokenLink": "A String", # URL to retrieve ACS token for pdf download. (In LITE projection.)
+ "downloadLink": "A String", # URL to download pdf. (In LITE projection.)
+ },
+ "country": "A String", # The two-letter ISO_3166-1 country code for which this access information is valid. (In LITE projection.)
+ "explicitOfflineLicenseManagement": True or False, # 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.
+ "epub": { # Information about epub content. (In LITE projection.)
+ "acsTokenLink": "A String", # URL to retrieve ACS token for epub download. (In LITE projection.)
+ "isAvailable": True or False, # Is a flowing text epub available either as public domain or for purchase. (In LITE projection.)
+ "downloadLink": "A String", # URL to download epub. (In LITE projection.)
+ },
+ "downloadAccess": { # Information about a volume's download license access restrictions.
+ "restricted": True or False, # Whether this volume has any download access restrictions.
+ "downloadsAcquired": 42, # If restricted, the number of content download licenses already acquired (including the requesting client, if licensed).
+ "message": "A String", # Error/warning message.
+ "signature": "A String", # Response signature.
+ "nonce": "A String", # Client nonce for verification. Download access and client-validation only.
+ "source": "A String", # Client app identifier for verification. Download access and client-validation only.
+ "justAcquired": True or False, # If deviceAllowed, whether access was just acquired with this request.
+ "maxDownloadDevices": 42, # If restricted, the maximum number of content download licenses for this volume.
+ "reasonCode": "A String", # 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
+ "kind": "A String", # Resource type.
+ "volumeId": "A String", # Identifies the volume for which this entry applies.
+ "deviceAllowed": True or False, # If restricted, whether access is granted for this (user, device, volume).
+ },
+ "quoteSharingAllowed": True or False, # Whether quote sharing is allowed for this volume.
+ "webReaderLink": "A String", # URL to read this volume on the Google Books site. Link will not allow users to read non-viewable volumes.
+ "driveImportedContentLink": "A String", # URL to the Google Drive viewer if this volume is uploaded by the user by selecting the file from Google Drive.
+ },
"saleInfo": { # 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).
+ "country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
+ "isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
+ "retailPrice": { # 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.)
+ "amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
+ "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
+ },
+ "onSaleDate": "A String", # The date on which this book is available for sale.
"saleability": "A String", # 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.
+ "buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
"offers": [ # Offers available for this volume (sales and rentals).
{
- "listPrice": { # Offer list (=undiscounted) price in Micros.
- "currencyCode": "A String",
- "amountInMicros": 3.14,
- },
- "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
"giftable": True or False, # Indicates whether the offer is giftable.
+ "finskyOfferType": 42, # The finsky offer type (e.g., PURCHASE=0 RENTAL=3)
"retailPrice": { # Offer retail (=discounted) price in Micros
- "currencyCode": "A String",
"amountInMicros": 3.14,
+ "currencyCode": "A String",
+ },
+ "listPrice": { # Offer list (=undiscounted) price in Micros.
+ "amountInMicros": 3.14,
+ "currencyCode": "A String",
},
"rentalDuration": { # The rental duration (for rental offers only).
"unit": "A String",
@@ -319,173 +475,17 @@
},
},
],
- "isEbook": True or False, # Whether or not this volume is an eBook (can be added to the My eBooks shelf).
"listPrice": { # Suggested retail price. (In LITE projection.)
"currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
"amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
},
- "country": "A String", # The two-letter ISO_3166-1 country code for which this sale information is valid. (In LITE projection.)
- "buyLink": "A String", # URL to purchase this volume on the Google Books site. (In LITE projection)
- "retailPrice": { # 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.)
- "amount": 3.14, # Amount in the currency listed below. (In LITE projection.)
- "currencyCode": "A String", # An ISO 4217, three-letter currency code. (In LITE projection.)
- },
- "onSaleDate": "A String", # The date on which this book is available for sale.
- },
- "etag": "A String", # Opaque identifier for a specific version of a volume resource. (In LITE projection)
- "userInfo": { # User specific information related to this volume. (e.g. page this user last read or whether they purchased this book)
- "rentalState": "A String", # Whether this book is an active or an expired rental.
- "isPreordered": True or False, # Whether or not this volume was pre-ordered by the authenticated user making the request. (In LITE projection.)
- "isUploaded": True or False, # Whether or not this volume was user uploaded.
- "copy": { # Copy/Paste accounting information.
- "remainingCharacterCount": 42,
- "updated": "A String",
- "limitType": "A String",
- "allowedCharacterCount": 42,
- },
- "isPurchased": True or False, # Whether or not this volume was purchased by the authenticated user making the request. (In LITE projection.)
- "review": { # This user's review of this volume, if one exists.
- "volumeId": "A String", # Volume that this review is for.
- "fullTextUrl": "A String", # URL for the full review text, for reviews gathered from the web.
- "date": "A String", # Date of this review.
- "title": "A String", # Title for this review.
- "type": "A String", # Source type for this review. Possible values are EDITORIAL, WEB_USER or GOOGLE_USER.
- "source": { # Information regarding the source of this review, when the review is not from a Google Books user.
- "description": "A String", # Name of the source.
- "extraDescription": "A String", # Extra text about the source of the review.
- "url": "A String", # URL of the source of the review.
- },
- "kind": "A String", # Resource type for a review.
- "content": "A String", # Review text.
- "rating": "A String", # Star rating for this review. Possible values are ONE, TWO, THREE, FOUR, FIVE or NOT_RATED.
- "author": { # Author of this review.
- "displayName": "A String", # Name of this person.
- },
- },
- "isFamilySharingDisabledByFop": True or False, # Deprecated: Replaced by familySharing.
- "familySharing": { # Information on the ability to share with the family.
- "familyRole": "A String", # The role of the user in the family.
- "isSharingDisabledByFop": True or False, # Whether or not sharing this volume is temporarily disabled due to issues with the Family Wallet.
- "isSharingAllowed": True or False, # Whether or not this volume can be shared with the family by the user. This includes sharing eligibility of both the volume and the user. If the value is true, the user can initiate a family sharing action.
- },
- "userUploadedVolumeInfo": {
- "processingState": "A String",
- },
- "isFamilySharingAllowed": True or False, # Deprecated: Replaced by familySharing.
- "updated": "A String", # 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).
- "isFamilySharedToUser": True or False, # Whether or not the user received this volume through family sharing.
- "isFamilySharedFromUser": True or False, # Whether or not the user shared this volume with the family.
- "entitlementType": 42, # Whether this volume is purchased, sample, pd download etc.
- "acquiredTime": "A String", # Timestamp when this volume was acquired by the user. (RFC 3339 UTC date-time format) Acquiring includes purchase, user upload, receiving family sharing, etc.
- "rentalPeriod": { # Period during this book is/was a valid rental.
- "startUtcSec": "A String",
- "endUtcSec": "A String",
- },
- "acquisitionType": 42, # How this volume was acquired.
- "isInMyBooks": True or False, # Whether or not this volume is currently in "my books."
- "readingPosition": { # The user's current reading position in the volume, if one is available. (In LITE projection.)
- "kind": "A String", # Resource type for a reading position.
- "pdfPosition": "A String", # Position in a PDF file.
- "gbTextPosition": "A String", # Position in a volume for text-based content.
- "volumeId": "A String", # Volume id associated with this reading position.
- "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
- "gbImagePosition": "A String", # Position in a volume for image-based content.
- "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
- },
- },
- "selfLink": "A String", # URL to this resource. (In LITE projection.)
- "id": "A String", # Unique identifier for a volume. (In LITE projection.)
- "volumeInfo": { # General volume information.
- "samplePageCount": 42, # Total number of sample pages as per publisher metadata.
- "publisher": "A String", # Publisher of this volume. (In LITE projection.)
- "printedPageCount": 42, # Total number of printed pages in generated pdf representation.
- "pageCount": 42, # Total number of pages as per publisher metadata.
- "panelizationSummary": { # A top-level summary of the panelization info in this volume.
- "containsEpubBubbles": True or False,
- "epubBubbleVersion": "A String",
- "imageBubbleVersion": "A String",
- "containsImageBubbles": True or False,
- },
- "description": "A String", # A synopsis of the volume. The text of the description is formatted in HTML and includes simple formatting elements, such as b, i, and br tags. (In LITE projection.)
- "authors": [ # The names of the authors and/or editors for this volume. (In LITE projection)
- "A String",
- ],
- "mainCategory": "A String", # The main category to which this volume belongs. It will be the category from the categories list returned below that has the highest weight.
- "dimensions": { # Physical dimensions of this volume.
- "width": "A String", # Width of this volume (in cm).
- "thickness": "A String", # Thickness of this volume (in cm).
- "height": "A String", # Height or length of this volume (in cm).
- },
- "industryIdentifiers": [ # Industry standard identifiers for this volume.
- {
- "identifier": "A String", # Industry specific volume identifier.
- "type": "A String", # Identifier type. Possible values are ISBN_10, ISBN_13, ISSN and OTHER.
- },
- ],
- "infoLink": "A String", # URL to view information about this volume on the Google Books site. (In LITE projection)
- "categories": [ # A list of subject categories, such as "Fiction", "Suspense", etc.
- "A String",
- ],
- "allowAnonLogging": True or False, # Whether anonymous logging should be allowed.
- "imageLinks": { # A list of image links for all the sizes that are available. (In LITE projection.)
- "large": "A String", # Image link for large size (width of ~800 pixels). (In LITE projection)
- "medium": "A String", # Image link for medium size (width of ~575 pixels). (In LITE projection)
- "smallThumbnail": "A String", # Image link for small thumbnail size (width of ~80 pixels). (In LITE projection)
- "thumbnail": "A String", # Image link for thumbnail size (width of ~128 pixels). (In LITE projection)
- "extraLarge": "A String", # Image link for extra large size (width of ~1280 pixels). (In LITE projection)
- "small": "A String", # Image link for small size (width of ~300 pixels). (In LITE projection)
- },
- "seriesInfo": {
- "kind": "A String", # Resource type.
- "volumeSeries": [
- {
- "issue": [ # List of issues. Applicable only for Collection Edition and Omnibus.
- {
- "issueOrderNumber": 42,
- "issueDisplayNumber": "A String",
- },
- ],
- "seriesBookType": "A String", # The book type in the context of series. Examples - Single Issue, Collection Edition, etc.
- "seriesId": "A String", # The series id.
- "orderNumber": 42, # The book order number in the series.
- },
- ],
- "bookDisplayNumber": "A String", # The display number string. This should be used only for display purposes and the actual sequence should be inferred from the below orderNumber.
- "shortSeriesBookTitle": "A String", # Short book title in the context of the series.
- },
- "title": "A String", # Volume title. (In LITE projection.)
- "language": "A String", # Best language for this volume (based on content). It is the two-letter ISO 639-1 code such as 'fr', 'en', etc.
- "subtitle": "A String", # Volume subtitle. (In LITE projection.)
- "printType": "A String", # Type of publication of this volume. Possible values are BOOK or MAGAZINE.
- "maturityRating": "A String",
- "canonicalVolumeLink": "A String", # Canonical URL for a volume. (In LITE projection.)
- "comicsContent": True or False, # Whether the volume has comics content.
- "readingModes": { # The reading modes available for this volume.
- "text": True or False,
- "image": True or False,
- },
- "contentVersion": "A String", # An identifier for the version of the volume content (text & images). (In LITE projection)
- "averageRating": 3.14, # The mean review rating for this volume. (min = 1.0, max = 5.0)
- "publishedDate": "A String", # Date of publication. (In LITE projection.)
- "ratingsCount": 42, # The number of review ratings for this volume.
- "previewLink": "A String", # URL to preview this volume on the Google Books site.
},
"searchInfo": { # Search result information related to this volume.
"textSnippet": "A String", # A text snippet containing the search query.
},
- "kind": "A String", # Resource type for a volume. (In LITE projection.)
- "layerInfo": { # What layers exist in this volume and high level information about them.
- "layers": [ # A layer should appear here if and only if the layer exists for this book.
- {
- "layerId": "A String", # The layer id of this layer (e.g. "geo").
- "volumeAnnotationsVersion": "A String", # 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.
- },
- ],
- },
},
],
"totalItems": 42, # Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated.
- "kind": "A String", # Resource type.
}</pre>
</div>
@@ -498,50 +498,15 @@
The object takes the form of:
{
- "notesExport": { # User settings in sub-objects, each for different purposes.
- "folderName": "A String",
- "isEnabled": True or False,
- },
- "notification": {
- "matchMyInterests": {
- "opted_state": "A String",
- },
- "priceDrop": {
- "opted_state": "A String",
- },
- "moreFromAuthors": {
- "opted_state": "A String",
- },
- "moreFromSeries": {
- "opted_state": "A String",
- },
- "rewardExpirations": {
- "opted_state": "A String",
- },
- },
- "kind": "A String", # Resource type.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
+ "kind": "A String", # Resource type.
"notesExport": { # User settings in sub-objects, each for different purposes.
- "folderName": "A String",
"isEnabled": True or False,
+ "folderName": "A String",
},
"notification": {
"matchMyInterests": {
"opted_state": "A String",
},
- "priceDrop": {
- "opted_state": "A String",
- },
"moreFromAuthors": {
"opted_state": "A String",
},
@@ -551,9 +516,44 @@
"rewardExpirations": {
"opted_state": "A String",
},
+ "priceDrop": {
+ "opted_state": "A String",
+ },
},
- "kind": "A String", # Resource type.
- }</pre>
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "A String", # Resource type.
+ "notesExport": { # User settings in sub-objects, each for different purposes.
+ "isEnabled": True or False,
+ "folderName": "A String",
+ },
+ "notification": {
+ "matchMyInterests": {
+ "opted_state": "A String",
+ },
+ "moreFromAuthors": {
+ "opted_state": "A String",
+ },
+ "moreFromSeries": {
+ "opted_state": "A String",
+ },
+ "rewardExpirations": {
+ "opted_state": "A String",
+ },
+ "priceDrop": {
+ "opted_state": "A String",
+ },
+ },
+ }</pre>
</div>
</body></html>
\ No newline at end of file