Volume
集合用于执行搜索或列出书架的内容。此集合是只读集合。方法
以下方法适用于关于卷的公开数据,不需要进行身份验证。
books.volumes.list
资源表示
Volume 表示 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 |
卷的资源类型。(在 LITE 投影中。) | |
id |
string |
卷的唯一标识符。(在 LITE 投影中。) | |
etag |
string |
卷资源特定版本的不透明标识符。(在 LITE 投影中) | |
selfLink |
string |
指向此资源的网址。(在 LITE 投影中。) | |
volumeInfo |
object |
一般卷信息。 | |
volumeInfo.title |
string |
卷标题。(在 LITE 投影中。) | |
volumeInfo.subtitle |
string |
音量副标题。(在 LITE 投影中。) | |
volumeInfo.authors[] |
list |
此卷的作者和/或编辑者姓名。(在 LITE 投影中) | |
volumeInfo.publisher |
string |
此卷的发布商。(在 LITE 投影中。) | |
volumeInfo.publishedDate |
string |
发布日期。(在 LITE 投影中。) | |
volumeInfo.description |
string |
卷的概要。说明的文字采用 HTML 格式,并且包含简单的格式元素,例如 b、i 和 br 标记。(在 LITE 投影中) | |
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 |
卷内容版本的标识符(文本和图片)。(在 LITE 投影中) | |
volumeInfo.imageLinks |
object |
所有可用尺寸的图片链接列表。(在 LITE 投影中) | |
volumeInfo.imageLinks.thumbnail |
string |
缩略图大小的链接(宽度约为 128 像素)。(在 LITE 投影中) | |
volumeInfo.imageLinks.small |
string |
小尺寸图片(宽度约为 300 像素)的图片链接。(在 LITE 投影中) | |
volumeInfo.imageLinks.medium |
string |
中等尺寸的图片链接(宽度约为 575 像素)。(在 LITE 投影中) | |
volumeInfo.imageLinks.large |
string |
图片较大(宽度约为 800 像素)。(在 LITE 投影中) | |
volumeInfo.imageLinks.smallThumbnail |
string |
小尺寸图片(宽度约为 80 像素)的图片链接。(在 LITE 投影中) | |
volumeInfo.imageLinks.extraLarge |
string |
超大图片(宽度约为 1280 像素)的图片链接。(在 LITE 投影中) | |
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 |
卷中用户的当前阅读位置(如果有)。(在 LITE 投影中。) | |
userInfo.isPurchased |
boolean |
发出请求的经过身份验证的用户是否购买了此卷。(在 LITE 投影中。) | |
saleInfo |
object |
与电子书存储区和/或可购买内容相关的任何图书信息。具体信息取决于发出请求的国家/地区(即图书在某些国家/地区可能无法销售)。 | |
saleInfo.country |
string |
该销售信息适用的两个字母的 ISO_3166-1 国家/地区代码。(在 LITE 投影中。) | |
saleInfo.saleability |
string |
图书在上述国家/地区的 Google 电子书商店中是否可供销售或免费提供。可能的值包括 FOR_SALE、FREE、NOT_FOR_SALE 或 FOR_PREORDER。 | |
saleInfo.isEbook |
boolean |
此卷是否是电子书(可添加到“我的电子书”书架中)。 | |
saleInfo.listPrice |
object |
建议零售价格。(在 LITE 投影中) | |
saleInfo.listPrice.amount |
double |
金额(以下方列出的币种表示)。(在 LITE 投影中。) | |
saleInfo.listPrice.currencyCode |
string |
ISO 4217,由三个字母组成的货币代码。(在 LITE 投影中。) | |
saleInfo.retailPrice |
object |
相关图书的实际售价。这与建议零售或定价相同,除非有针对此类商品的优惠或折扣。(在 LITE 投影中) | |
saleInfo.retailPrice.amount |
double |
金额(以下方列出的币种表示)。(在 LITE 投影中。) | |
saleInfo.retailPrice.currencyCode |
string |
ISO 4217,由三个字母组成的货币代码。(在 LITE 投影中。) | |
saleInfo.buyLink |
string |
在 Google 图书网站上购买此书的网址。(在 LITE 投影中) | |
accessInfo |
object |
与读取或获取该卷文本相关的任何卷的信息。具体信息可能因国家/地区而异(比如,图书在某个国家/地区属于公共领域,但在另一个国家/地区却不行,例如图书)。 | |
accessInfo.country |
string |
此访问权限信息适用的两个字母的 ISO_3166-1 国家/地区代码。(在 LITE 投影中。) | |
accessInfo.viewability |
string |
拥有卷的读取权限。可能的值包括 PARTIAL、ALL_PAGES、NO_PAGES 或 UNKNOWN。此值取决于上面列出的国家/地区。值 PARTIAL 表示发布商允许在不付费的情况下公开浏览部分卷。这适用于电子书和非电子书。公共领域的图书始终包含“ALL_PAGES”值。 | |
accessInfo.epub |
object |
ePub 内容的相关信息。(在 LITE 投影中) | |
accessInfo.epub.downloadLink |
string |
下载 epub 文件的网址。(在 LITE 投影中。) | |
accessInfo.epub.acsTokenLink |
string |
用于检索 epub 下载信息的 ACS 令牌的网址。(在 LITE 投影中。) | |
accessInfo.pdf |
object |
与 PDF 内容相关的信息。(在 LITE 投影中) | |
accessInfo.pdf.downloadLink |
string |
下载 PDF 的网址。(在 LITE 投影中。) | |
accessInfo.pdf.acsTokenLink |
string |
用于检索 PDF 下载的 ACS 令牌的网址。(在 LITE 投影中。) | |
accessInfo.accessViewStatus |
string |
将此卷的访问和可见度合并到该用户的单个状态字段中。值可以为 FULL_PURCHASED、FULL_PUBLIC_DOMAIN、SAMPLE 或 NONE。(在 LITE 投影中。) | |
accessInfo.embeddable |
boolean |
是否可以使用 Embed Viewer API 将此卷嵌入视口中。 | |
accessInfo.publicDomain |
boolean |
此图书在上方列出的国家/地区是否属于公共领域。 | |
|
string |
用于查看 Google 图书网站上此卷的相关信息的网址。(在 LITE 投影中) | |
userInfo.updated |
datetime |
上次用户操作(例如阅读位置更新、数量购买或撰写评价)修改此卷的时间戳。(RFC 3339 世界协调时间 (UTC) 日期时间格式)。 | |
volumeInfo.canonicalVolumeLink |
string |
卷的规范网址。(在 LITE 投影中。) | |
userInfo.isPreordered |
boolean |
经过身份验证的请求用户是否预订了此卷。(在 LITE 投影中。) | |
saleInfo.onSaleDate |
datetime |
此图书上架销售的日期。 | |
accessInfo.textToSpeechPermission |
string |
此卷是否允许使用文字转语音。值可以是 ALLOWED、ALLOWED_FOR_ACCESSIBILITY 或 NOT_ALLOWED。 | |
accessInfo.epub.isAvailable |
boolean |
采用 flowing text epub 文件的形式,可作为公共领域或可供购买。(在 LITE 投影中。) | |
accessInfo.pdf.isAvailable |
boolean |
扫描版 pdf 图片,属于公共领域或可供购买。(在 LITE 投影中。) | |
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 OK 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 |
包含搜索查询的文本代码段。 |