ボリューム: list
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
書籍の検索を実行します。実習をご覧ください。
リクエスト
HTTP リクエスト
GET https://www.googleapis.com/books/v1/volumes?q={search terms}
パラメータ
パラメータ名 |
値 |
説明 |
必須パラメータ |
q |
string |
全文検索クエリ文字列。
|
オプション パラメータ |
download |
string |
ダウンロードの可用性によってボリュームを制限します。
有効な値は次のとおりです。
|
filter |
string |
検索結果を絞り込む。
有効な値は次のとおりです。
- 「
ebooks 」- Google のすべての電子書籍。
- 「
free-ebooks 」 - 全文の視認性が高い Google 電子書籍。
- 「
full 」 - 一般公開ユーザーはボリューム テキスト全体を閲覧できます。
- 「
paid-ebooks 」 - 価格が設定された Google 電子書籍。
- 「
partial 」- 一般ユーザーはテキストの一部を閲覧できます。
|
langRestrict |
string |
この言語コードの書籍に結果を制限します。
|
libraryRestrict |
string |
検索をこのユーザーのライブラリに制限します。
有効な値は次のとおりです。
- 「
my-library 」- ユーザーのライブラリ、任意のセクションに制限します。
- 「
no-restrict 」- ユーザーのライブラリに基づいて制限しない。
|
maxResults |
unsigned integer |
返される結果の最大数。
有効な値は 0 ~40 です。 |
orderBy |
string |
検索結果を並べ替える。
有効な値は次のとおりです。
- 「
newest 」 - 最後に公開されたもの。
- 「
relevance 」 - 検索語句との関連性。
|
partner |
string |
パートナー ID の結果を制限してブランド化します。
|
printType |
string |
書籍または雑誌に制限します。
有効な値は次のとおりです。
- 「
all 」- すべてのボリューム コンテンツ タイプ。
- 「
books 」- 書籍のみ。
- 「
magazines 」- 雑誌のみ。
|
projection |
string |
選択した一連のフィールドに返される情報を制限します。
有効な値は次のとおりです。
- 「
full 」 - すべてのボリュームデータが含まれます。
- 「
lite 」- volumeInfo と accessInfo のフィールドのサブセットが含まれます。
|
showPreorders |
boolean |
予約購入可能な書籍を表示するには、true に設定します。デフォルトは false です。
|
source |
string |
このリクエストの送信元を識別する文字列。
|
startIndex |
unsigned integer |
返される最初の結果のインデックス(0 から始まる)
|
リクエストの本文
このメソッドをリクエストの本文に含めないでください。
レスポンス
成功すると、このメソッドは次の構造を含むレスポンスの本文を返します。
{
"kind": "books#volumes",
"items": [
volume Resource
],
"totalItems": (value)
}
プロパティ名 |
値 |
説明 |
注意点 |
kind |
string |
リソースのタイプ。 |
|
items[] |
list |
ボリュームのリスト。 |
|
totalItems |
integer |
検出されたボリュームの合計数。結果がページ分割されている場合、この値はレスポンスで返されるボリュームの数より大きくなることがあります。 |
|
試してみる
以下のエクスプローラを使用して、ライブデータでこのメソッドを呼び出し、レスポンスを確認します。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-11-08 UTC。
[null,null,["最終更新日 2024-11-08 UTC。"],[[["\u003cp\u003eSearches for books based on a provided query string.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by criteria such as availability, format, language, and publication type.\u003c/p\u003e\n"],["\u003cp\u003eOffers control over the number of results, sorting order, and specific data fields returned.\u003c/p\u003e\n"],["\u003cp\u003eCan be used to retrieve information about books, including volume details and access options.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to handle large result sets.\u003c/p\u003e\n"]]],[],null,["# Volume: list\n\nPerforms a book search.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP Request\n\n GET https://www.googleapis.com/books/v1/volumes?q={search terms}\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|-------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Required Parameters** |||\n| `q` | `string` | Full-text search query string. |\n| **Optional Parameters** |||\n| `download` | `string` | Restrict to volumes by download availability. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`epub`\" - All volumes with epub. |\n| `filter` | `string` | Filter search results. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`ebooks`\" - All Google eBooks. - \"`free-ebooks`\" - Google eBook with full volume text viewability. - \"`full`\" - Public can view entire volume text. - \"`paid-ebooks`\" - Google eBook with a price. - \"`partial`\" - Public able to see parts of text. |\n| `langRestrict` | `string` | Restrict results to books with this language code. |\n| `libraryRestrict` | `string` | Restrict search to this user's library. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`my-library`\" - Restrict to the user's library, any shelf. - \"`no-restrict`\" - Do not restrict based on user's library. |\n| `maxResults` | `unsigned integer` | Maximum number of results to return. Acceptable values are `0` to `40`, inclusive. |\n| `orderBy` | `string` | Sort search results. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`newest`\" - Most recently published. - \"`relevance`\" - Relevance to search terms. |\n| `partner` | `string` | Restrict and brand results for partner ID. |\n| `printType` | `string` | Restrict to books or magazines. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`all`\" - All volume content types. - \"`books`\" - Just books. - \"`magazines`\" - Just magazines. |\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| `showPreorders` | `boolean` | Set to true to show books available for preorder. Defaults to false. |\n| `source` | `string` | String to identify the originator of this request. |\n| `startIndex` | `unsigned integer` | Index of the first result 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 {\n \"kind\": \"books#volumes\",\n \"items\": [\n volume Resource\n ],\n \"totalItems\": (value)\n }\n\n| Property Name | Value | Description | Notes |\n|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `kind` | `string` | Resource type. | |\n| `items[]` | `list` | A list of volumes. | |\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\nTry It!\n-------\n\n\nUse the explorer below to call this method on live data and see the response."]]