Volume
集合用于执行搜索或列出书架中的内容。此集合是只读集合。方法
以下方法适用于有关卷的公开数据,且无需身份验证。
books.volumes.list
资源表示法
卷代表 Google 图书托管的图书或杂志的相关信息。它包含元数据(例如标题和作者)以及个性化数据(例如是否已购买)。(下文列出了 LITE 投影中可用的音量字段)。
{ "kind": "books#volume", "id": string, "etag": string, "selfLink": string, "volumeInfo": { "title": string, "subtitle": string, "authors": [ string ], "publisher": string, "publishedDate": string, "description": string, "industryIdentifiers": [ { "type": string, "identifier": string } ], "pageCount": integer, "dimensions": { "height": string, "width": string, "thickness": string }, "printType": string, "mainCategory": string, "categories": [ string ], "averageRating": double, "ratingsCount": integer, "contentVersion": string, "imageLinks": { "smallThumbnail": string, "thumbnail": string, "small": string, "medium": string, "large": string, "extraLarge": string }, "language": string, "previewLink": string, "infoLink": string, "canonicalVolumeLink": string }, "userInfo": { "review": mylibrary.reviews Resource, "readingPosition": mylibrary.readingpositions Resource, "isPurchased": boolean, "isPreordered": boolean, "updated": datetime }, "saleInfo": { "country": string, "saleability": string, "onSaleDate": datetime, "isEbook": boolean, "listPrice": { "amount": double, "currencyCode": string }, "retailPrice": { "amount": double, "currencyCode": string }, "buyLink": string }, "accessInfo": { "country": string, "viewability": string, "embeddable": boolean, "publicDomain": boolean, "textToSpeechPermission": string, "epub": { "isAvailable": boolean, "downloadLink": string, "acsTokenLink": string }, "pdf": { "isAvailable": boolean, "downloadLink": string, "acsTokenLink": string }, "webReaderLink": string, "accessViewStatus": string, "downloadAccess": { "kind": "books#downloadAccessRestriction", "volumeId": string, "restricted": boolean, "deviceAllowed": boolean, "justAcquired": boolean, "maxDownloadDevices": integer, "downloadsAcquired": integer, "nonce": string, "source": string, "reasonCode": string, "message": string, "signature": string } }, "searchInfo": { "textSnippet": string } }
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
kind |
string |
卷的资源类型。(采用精简版投影)。 | |
id |
string |
卷的唯一标识符。(采用精简版投影)。 | |
etag |
string |
特定版本的卷资源的不透明标识符。(在精简投影模式下) | |
selfLink |
string |
此资源的网址。(采用精简版投影)。 | |
volumeInfo |
object |
一般音量信息。 | |
volumeInfo.title |
string |
卷名。(采用精简版投影)。 | |
volumeInfo.subtitle |
string |
卷副标题。(采用精简版投影)。 | |
volumeInfo.authors[] |
list |
本卷的作者和/或编辑者的姓名。(在精简投影模式下) | |
volumeInfo.publisher |
string |
此卷的出版商。(采用精简版投影)。 | |
volumeInfo.publishedDate |
string |
发布日期。(采用精简版投影)。 | |
volumeInfo.description |
string |
卷的摘要。说明文本采用 HTML 格式,并包含简单的格式元素,例如 b、i 和 br 标记。(在精简版投影中) | |
volumeInfo.industryIdentifiers[] |
list |
此卷的业界标准标识符。 | |
volumeInfo.industryIdentifiers[].type |
string |
标识符类型。可能的值包括 ISBN_10、ISBN_13、ISSN 和 OTHER。 | |
volumeInfo.industryIdentifiers[].identifier |
string |
特定行业的卷标识符。 | |
volumeInfo.pageCount |
integer |
网页总数。 | |
volumeInfo.dimensions |
object |
此卷的实际尺寸。 | |
volumeInfo.dimensions.height |
string |
此卷的高度或长度(以厘米为单位)。 | |
volumeInfo.dimensions.width |
string |
此卷的宽度(以厘米为单位)。 | |
volumeInfo.dimensions.thickness |
string |
此卷厚度(以厘米为单位)。 | |
volumeInfo.printType |
string |
此卷的出版类型。可能的值为 BOOK 或 MAGAZINE。 | |
volumeInfo.categories[] |
list |
主题类别列表,例如“小说”“悬疑”等。 | |
volumeInfo.averageRating |
double |
此卷的平均评分。(最小值 = 1.0,最大值 = 5.0) | |
volumeInfo.ratingsCount |
integer |
此卷的评价数量。 | |
volumeInfo.contentVersion |
string |
卷内容(文字和图片)版本的标识符。(在精简投影模式下) | |
volumeInfo.imageLinks |
object |
所有可用尺寸的图片链接列表。(在精简版投影中) | |
volumeInfo.imageLinks.thumbnail |
string |
缩略图大小的图片链接(宽度约为 128 像素)。(在精简版投影中) | |
volumeInfo.imageLinks.small |
string |
小尺寸(宽度约为 300 像素)的图片链接。(在精简版投影中) | |
volumeInfo.imageLinks.medium |
string |
中等尺寸(宽度约为 575 像素)的图片链接。(在精简版投影中) | |
volumeInfo.imageLinks.large |
string |
大尺寸图片链接(宽度约为 800 像素)。(在精简版投影中) | |
volumeInfo.imageLinks.smallThumbnail |
string |
适用于小尺寸缩略图(宽度约为 80 像素)的图片链接。(在精简版投影中) | |
volumeInfo.imageLinks.extraLarge |
string |
超大尺寸(宽度约为 1280 像素)的图片链接。(在精简版投影中) | |
volumeInfo.language |
string |
此卷的最佳语言(基于内容)。它是 ISO 639-1 双字母代码,例如“fr”“en”等。 | |
volumeInfo.mainCategory |
string |
此卷书所属的主要类别。它将是下方返回的类别列表中权重最高的类别。 | |
volumeInfo.previewLink |
string |
在 Google 图书网站上预览此卷的网址。 | |
userInfo |
object |
与此卷相关的用户专用信息。(例如,用户上次阅读的页面或他们是否购买了此图书) | |
userInfo.review |
nested object |
此用户对此卷的评价(如果有)。 | |
userInfo.readingPosition |
readingPosition Resource |
用户在图书中的当前阅读位置(如果有)。(采用精简版投影)。 | |
userInfo.isPurchased |
boolean |
发出请求的经过身份验证的用户是否购买了此音频内容。(采用精简版投影)。 | |
saleInfo |
object |
与电子书商店和/或购买情况相关的图书的任何信息。此信息可能取决于请求的来源国家/地区(例如,图书可能未在某些国家/地区销售)。 | |
saleInfo.country |
string |
此促销信息适用的 ISO_3166-1 双字母国家/地区代码。(采用精简版投影)。 | |
saleInfo.saleability |
string |
此图书是否在上述国家/地区的 Google 电子书商店中以售或免费提供。可能的值为 FOR_SALE、FREE、NOT_FOR_SALE 或 FOR_PREORDER。 | |
saleInfo.isEbook |
boolean |
此卷是否为电子书(可添加到“我的电子书”书架)。 | |
saleInfo.listPrice |
object |
建议零售价。(在精简版投影中) | |
saleInfo.listPrice.amount |
double |
金额(以下列币种表示)。(采用精简版投影)。 | |
saleInfo.listPrice.currencyCode |
string |
符合 ISO 4217 标准、由 3 个字母组成的货币代码。(采用精简版投影)。 | |
saleInfo.retailPrice |
object |
图书的实际销售价格。除非此批量有优惠或折扣,否则此价格与建议零售价或定价相同。(在精简版投影中) | |
saleInfo.retailPrice.amount |
double |
金额(以下列币种表示)。(采用精简版投影)。 | |
saleInfo.retailPrice.currencyCode |
string |
符合 ISO 4217 标准、由 3 个字母组成的货币代码。(采用精简版投影)。 | |
saleInfo.buyLink |
string |
在 Google 图书网站上购买此卷的网址。(在精简版投影中) | |
accessInfo |
object |
与阅读或获取相应卷文本相关的任何卷信息。此类信息可能因国家/地区而异(例如,某本图书在某个国家/地区属于公共领域,但在另一个国家/地区则不属于公共领域)。 | |
accessInfo.country |
string |
此访问权限信息适用的 ISO_3166-1 国家/地区代码(由两个字母组成)。(采用精简版投影)。 | |
accessInfo.viewability |
string |
对卷的读取权限。可能的值为 PARTIAL、ALL_PAGES、NO_PAGES 或 UNKNOWN。此值取决于上方列出的国家/地区。如果值为 PARTIAL,则表示发布商允许用户在无需购买的情况下公开观看部分内容。这适用于电子书和非电子书。公共领域图书的值始终为 ALL_PAGES。 | |
accessInfo.epub |
object |
ePub 内容的相关信息。(在精简版投影中) | |
accessInfo.epub.downloadLink |
string |
用于下载 ePub 的网址。(采用精简版投影)。 | |
accessInfo.epub.acsTokenLink |
string |
用于检索 ACS 令牌以下载 ePub 的网址。(采用精简版投影)。 | |
accessInfo.pdf |
object |
PDF 内容的相关信息。(在精简版投影中) | |
accessInfo.pdf.downloadLink |
string |
用于下载 PDF 的网址。(采用精简版投影)。 | |
accessInfo.pdf.acsTokenLink |
string |
用于检索 ACS 令牌以下载 PDF 文件的网址。(采用精简版投影)。 | |
accessInfo.accessViewStatus |
string |
将此卷的访问权限和可见度合并到此用户的单个状态字段中。值可以是 FULL_PURCHASED、FULL_PUBLIC_DOMAIN、SAMPLE 或 NONE。(采用精简版投影)。 | |
accessInfo.embeddable |
boolean |
此卷是否可以使用 Embedded Viewer API 嵌入到视口中。 | |
accessInfo.publicDomain |
boolean |
此图书在上述国家/地区是否属于公共领域图书。 | |
|
string |
用于在 Google 图书网站上查看此卷信息的网址。(在精简投影模式下) | |
userInfo.updated |
datetime |
此卷次上次因用户操作(例如更新阅读位置、购买卷次或撰写评价)而被修改的时间戳。(RFC 3339 UTC 日期时间格式)。 | |
volumeInfo.canonicalVolumeLink |
string |
卷的规范网址。(采用精简版投影)。 | |
userInfo.isPreordered |
boolean |
发出请求的经过身份验证的用户是否预订了此卷。(采用精简版投影)。 | |
saleInfo.onSaleDate |
datetime |
此图书的上架销售日期。 | |
accessInfo.textToSpeechPermission |
string |
是否允许对此音频使用文字转语音功能。值可以是 ALLOWED、ALLOWED_FOR_ACCESSIBILITY 或 NOT_ALLOWED。 | |
accessInfo.epub.isAvailable |
boolean |
灵活格式文本 epub 是作为公共领域资源还是可供购买的资源提供的。(采用精简版投影)。 | |
accessInfo.pdf.isAvailable |
boolean |
扫描的图片 PDF 是作为公共领域资源提供还是可供购买。(采用精简版投影)。 | |
accessInfo.webReaderLink |
string |
用于在 Google 图书网站上阅读此卷的网址。链接不允许用户阅读无法观看的卷。 | |
accessInfo.downloadAccess |
nested object |
有关某个卷的下载许可访问权限限制的信息。 | |
accessInfo.downloadAccess.kind |
string |
资源类型。 | |
accessInfo.downloadAccess.volumeId |
string |
标识此条目适用的卷。 | |
accessInfo.downloadAccess.restricted |
boolean |
此卷是否存在任何下载访问权限限制。 | |
accessInfo.downloadAccess.deviceAllowed |
boolean |
如果受限,则表示是否已为此(用户、设备、卷)授予访问权限。 | |
accessInfo.downloadAccess.justAcquired |
boolean |
如果 deviceAllowed,则表示是否刚刚通过此请求获得了访问权限。 | |
accessInfo.downloadAccess.maxDownloadDevices |
integer |
如果受限,则为此卷的内容下载许可数量上限。 | |
accessInfo.downloadAccess.downloadsAcquired |
integer |
如果受限,则表示已获取的内容下载许可数量(包括请求方客户端,如果已获得许可)。 | |
accessInfo.downloadAccess.nonce |
string |
用于验证的客户端 Nonce。仅限下载权限和客户端验证。 | |
accessInfo.downloadAccess.source |
string |
用于验证的客户端应用标识符。仅限下载权限和客户端验证。 | |
accessInfo.downloadAccess.reasonCode |
string |
错误/警告原因代码。我们日后可能会添加其他代码。0 正常 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_LAST_ACCESS | |
accessInfo.downloadAccess.message |
string |
错误/警告消息。 | |
accessInfo.downloadAccess.signature |
string |
响应签名。 | |
searchInfo |
object |
与此卷相关的搜索结果信息。 | |
searchInfo.textSnippet |
string |
包含搜索查询的文本摘要。 |