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 |
ボリュームのリスト。 |
|
試してみる
以下のエクスプローラを使用してライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-11-08 UTC。
[[["わかりやすい","easyToUnderstand","thumb-up"],["問題の解決に役立った","solvedMyProblem","thumb-up"],["その他","otherUp","thumb-up"]],[["必要な情報がない","missingTheInformationINeed","thumb-down"],["複雑すぎる / 手順が多すぎる","tooComplicatedTooManySteps","thumb-down"],["最新ではない","outOfDate","thumb-down"],["翻訳に関する問題","translationIssue","thumb-down"],["サンプル / コードに問題がある","samplesCodeIssue","thumb-down"],["その他","otherDown","thumb-down"]],["最終更新日 2024-11-08 UTC。"],[[["\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."]]