Bookshelves.volumes:list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
為指定的使用者擷取特定書架中的磁碟區。
立即試用。
要求
HTTP 要求
GET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes
參數
參數名稱 |
值 |
說明 |
必要參數 |
shelf |
string |
要擷取書籍的書櫃 ID。 |
userId |
string |
要擷取書櫃書籍的使用者 ID。 |
選用參數 |
maxResults |
unsigned integer |
要傳回的結果數上限
|
showPreorders |
boolean |
如要顯示預購的書籍,請設為 true。預設值為 false。
|
source |
string |
用於識別此要求來源的字串。 |
startIndex |
unsigned integer |
要傳回的第一個元素的索引 (從 0 開始) |
要求主體
請勿使用這個方法提供請求主體。
回應
如果成功的話,這個方法會傳回回應內文,其結構如下:
{
"kind": "books#volumes",
"totalItems": integer,
"items": [
volumes Resource
]
}
資源名稱 |
值 |
說明 |
附註 |
kind |
string |
資源類型。 |
|
totalItems |
integer |
找到的音量總數。如果結果已分頁,這個值可能會大於這個回應中傳回的磁碟區數量。 |
|
items[] |
list |
卷冊清單。 |
|
歡迎試用!
您可以使用下方的檔案總管,針對即時資料呼叫這個方法,然後查看回應。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-11-08 (世界標準時間)。
[null,null,["上次更新時間:2024-11-08 (世界標準時間)。"],[[["\u003cp\u003eRetrieves a list of books from a specific bookshelf belonging to a given user.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by parameters such as maximum results, pre-orders, and starting index for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes the total number of books found and a list of book details.\u003c/p\u003e\n"],["\u003cp\u003eYou can interactively try this method using the provided explorer to test it with live data.\u003c/p\u003e\n"]]],[],null,["# Bookshelves.volumes: list\n\nRetrieves volumes in a specific bookshelf for the specified user.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP Request\n\n```\nGET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes\n```\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|-----------------|--------------------|-----------------------------------------------------------|\n| **Required Parameters** |||\n| `shelf` | `string` | ID of bookshelf to retrieve volumes. |\n| `userId` | `string` | ID of user for whom to retrieve bookshelf volumes. |\n| **Optional Parameters** |||\n| `maxResults` | `unsigned integer` | Maximum number of results to return |\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."]]