Mylibrary.bookshelves.volumes:list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
获取书架上图书的卷信息。
立即试用。
请求
HTTP 请求
GET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes
参数
参数名称 |
值 |
说明 |
必需参数 |
shelf |
string |
要检索图书的书架 ID 或名称。
|
可选参数 |
maxResults |
unsigned integer |
返回的结果数上限
|
projection |
string |
限制返回给一组选定字段的信息。
可接受的值包括:
- “
full ”- 包括所有音量数据。
- “
lite ”- 包含 volumeInfo 和 accessInfo 中的部分字段。
|
q |
string |
此书架中的全文搜索查询字符串。
|
showPreorders |
boolean |
设为 true 可显示预订的图书。默认值为 false。
|
source |
string |
用于标识此请求发起者的字符串。
|
startIndex |
unsigned integer |
要返回的第一个元素的索引(从 0 开始)
|
请求正文
使用此方法时请勿提供请求正文。
响应
如果成功,此方法将返回以下结构的响应正文:
{
"kind": "books#volumes",
"totalItems": integer,
"items": [
volumes Resource
]
}
属性名称 |
值 |
说明 |
备注 |
kind |
string |
资源类型。 |
|
totalItems |
integer |
找到的卷总数。如果结果已分页,此值可能会大于此响应中返回的卷数。 |
|
items[] |
list |
卷列表。 |
|
试试看!
使用下面的 Explorer 对实际数据调用此方法,然后查看响应。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-11-08。
[null,null,["最后更新时间 (UTC):2024-11-08。"],[[["\u003cp\u003eRetrieves volume information for books on a specific bookshelf.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by search query, pre-orders, and selected fields.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of volumes with details like total items and individual volume resources.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination for handling large results.\u003c/p\u003e\n"],["\u003cp\u003eCan be tested using the provided interactive explorer.\u003c/p\u003e\n"]]],[],null,["# Mylibrary.bookshelves.volumes: list\n\nGets volume information for volumes on a bookshelf.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP Request\n\n```\nGET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes\n```\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|-----------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Required Parameters** |||\n| `shelf` | `string` | The bookshelf ID or name retrieve volumes for. |\n| **Optional Parameters** |||\n| `maxResults` | `unsigned integer` | Maximum number of results to return |\n| `projection` | `string` | Restrict information returned to a set of selected fields. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`full`\" - Includes all volume data. - \"`lite`\" - Includes a subset of fields in volumeInfo and accessInfo. |\n| `q` | `string` | Full-text search query string in this bookshelf. |\n| `showPreorders` | `boolean` | Set to true to show pre-ordered books. Defaults to false. |\n| `source` | `string` | String to identify the originator of this request. |\n| `startIndex` | `unsigned integer` | Index of the first element to return (starts at 0) |\n\n### Request Body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"kind\": \"books#volumes\",\n \"totalItems\": integer,\n \"items\": [\n volumes Resource\n ]\n}\n```\n\n| Property Name | Value | Description | Notes |\n|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `kind` | `string` | Resource type. | |\n| `totalItems` | `integer` | Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated. | |\n| `items[]` | `list` | A list of volumes. | |\n\nTry It!\n-------\n\n\nUse the explorer below to call this method on live data and see the response."]]