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 |
ボリュームのリスト。 |
|
試してみる
以下のエクスプローラを使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-11-08 UTC。
[null,null,["最終更新日 2024-11-08 UTC。"],[[["\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."]]