Volume
コレクションは、本棚のコンテンツの検索や一覧表示に使用されます。このコレクションは読み取り専用のコレクションです。Methods
ボリュームに関する公開データには、認証なしで以下の方法を適用できます。
books.volumes.listbooks.volumes.get
ボリュームのプライベートな「マイライブラリ」ビューに以下のメソッドを適用し、認証が必要です。
books.mylibrary.bookshelf.volumes.list- get
- ID に基づいて Volume リソースを取得します。
- list
- 書籍検索を実行します。
リソース表現
巻は、Google ブックスで書籍や雑誌についてホストする情報を表します。これには、タイトルや著者などのメタデータの他に、購入の有無などのカスタマイズされたデータが含まれます。(LITE プロジェクションで使用できる Volume フィールドを以下に示します)。
{ "kind": "books#volume", "id": string, "etag": string, "selfLink": string, "volumeInfo": { "title": string, "subtitle": string, "authors": [ string ], "publisher": string, "publishedDate": string, "description": string, "industryIdentifiers": [ { "type": string, "identifier": string } ], "pageCount": integer, "dimensions": { "height": string, "width": string, "thickness": string }, "printType": string, "mainCategory": string, "categories": [ string ], "averageRating": double, "ratingsCount": integer, "contentVersion": string, "imageLinks": { "smallThumbnail": string, "thumbnail": string, "small": string, "medium": string, "large": string, "extraLarge": string }, "language": string, "previewLink": string, "infoLink": string, "canonicalVolumeLink": string }, "userInfo": { "review": mylibrary.reviews Resource, "readingPosition": mylibrary.readingpositions Resource, "isPurchased": boolean, "isPreordered": boolean, "updated": datetime }, "saleInfo": { "country": string, "saleability": string, "onSaleDate": datetime, "isEbook": boolean, "listPrice": { "amount": double, "currencyCode": string }, "retailPrice": { "amount": double, "currencyCode": string }, "buyLink": string }, "accessInfo": { "country": string, "viewability": string, "embeddable": boolean, "publicDomain": boolean, "textToSpeechPermission": string, "epub": { "isAvailable": boolean, "downloadLink": string, "acsTokenLink": string }, "pdf": { "isAvailable": boolean, "downloadLink": string, "acsTokenLink": string }, "webReaderLink": string, "accessViewStatus": string, "downloadAccess": { "kind": "books#downloadAccessRestriction", "volumeId": string, "restricted": boolean, "deviceAllowed": boolean, "justAcquired": boolean, "maxDownloadDevices": integer, "downloadsAcquired": integer, "nonce": string, "source": string, "reasonCode": string, "message": string, "signature": string } }, "searchInfo": { "textSnippet": string } }
プロパティ名 | 値 | 説明 | 備考 |
---|---|---|---|
kind |
string |
ボリュームのリソースタイプ。(LITE プロジェクションで) | |
id |
string |
ボリュームの一意の識別子。(LITE プロジェクションで) | |
etag |
string |
特定のバージョンのボリューム リソースの不透明識別子。(LITE プロジェクションで) | |
selfLink |
string |
このリソースの URL。(LITE プロジェクションで) | |
volumeInfo |
object |
一般的な音量情報。 | |
volumeInfo.title |
string |
ボリュームのタイトル。(LITE プロジェクションで) | |
volumeInfo.subtitle |
string |
ボリュームのサブタイトル。(LITE プロジェクションで) | |
volumeInfo.authors[] |
list |
この巻の著者や編集者の名前。(LITE プロジェクションで) | |
volumeInfo.publisher |
string |
このボリュームのパブリッシャー。(LITE プロジェクションで) | |
volumeInfo.publishedDate |
string |
公開日。(LITE プロジェクションで) | |
volumeInfo.description |
string |
ボリュームの概要。説明のテキストは HTML フォーマットで、b、i、br タグなどの単純な書式設定要素が含まれます。(LITE 予測) | |
volumeInfo.industryIdentifiers[] |
list |
このボリュームの業界標準識別子。 | |
volumeInfo.industryIdentifiers[].type |
string |
識別子のタイプ。有効な値は ISBN_10、ISBN_13、ISSN などです。 | |
volumeInfo.industryIdentifiers[].identifier |
string |
業界固有のボリューム識別子。 | |
volumeInfo.pageCount |
integer |
ページの総数。 | |
volumeInfo.dimensions |
object |
このボリュームの物理的なサイズ。 | |
volumeInfo.dimensions.height |
string |
この体高(cm) | |
volumeInfo.dimensions.width |
string |
この体積の幅(cm)。 | |
volumeInfo.dimensions.thickness |
string |
この体積の太さ(cm)。 | |
volumeInfo.printType |
string |
このボリュームのパブリケーションのタイプ。有効な値は BOOK または MAGAZINE です。 | |
volumeInfo.categories[] |
list |
分類のリスト(「フィクション」、「サスペンス」など)。 | |
volumeInfo.averageRating |
double |
このボリュームの平均レビュー評価。(最小値 = 1.0、最大値 = 5.0)。 | |
volumeInfo.ratingsCount |
integer |
このボリュームのクチコミ評価の数。 | |
volumeInfo.contentVersion |
string |
ボリューム コンテンツ(テキストと画像)のバージョン ID。(LITE プロジェクションで) | |
volumeInfo.imageLinks |
object |
利用可能なすべてのサイズの画像リンクのリスト。(LITE 予測) | |
volumeInfo.imageLinks.thumbnail |
string |
サムネイルのサイズ(幅 128 ピクセル以下)の画像リンク。(LITE 予測) | |
volumeInfo.imageLinks.small |
string |
小さいサイズ(幅 300 ピクセル以下)の画像リンク。(LITE 予測) | |
volumeInfo.imageLinks.medium |
string |
中程度のサイズ(幅 575 ピクセル以下)の画像リンク。(LITE 予測) | |
volumeInfo.imageLinks.large |
string |
大きいサイズ(幅 800 ピクセル以下)の画像リンク(LITE 予測) | |
volumeInfo.imageLinks.smallThumbnail |
string |
サムネイルのサイズが小さい(幅が 80 ピクセル以下)画像リンク。(LITE 予測) | |
volumeInfo.imageLinks.extraLarge |
string |
特大サイズの画像リンク(幅 1,280 ピクセル以下)。(LITE 予測) | |
volumeInfo.language |
string |
このボリュームにとって最適な言語(コンテンツに基づく)。これは 2 文字の ISO 639-1 コードです(「fr」や「en」など)。 | |
volumeInfo.mainCategory |
string |
このボリュームが属するメインカテゴリ。返されたカテゴリの中で最も重みが高いカテゴリリストの中で、カテゴリとなります。 | |
volumeInfo.previewLink |
string |
この巻を Google ブックス サイトでプレビューするための URL。 | |
userInfo |
object |
このボリュームに関連するユーザー固有の情報。(ユーザーが最後に閲覧したページ、この書籍を購入したかどうかなど) | |
userInfo.review |
nested object |
このボリュームに関するユーザーのレビュー(存在する場合)。 | |
userInfo.readingPosition |
readingPosition Resource |
ボリューム内のユーザーの現在の読み取り位置(ある場合)。(LITE プロジェクションで) | |
userInfo.isPurchased |
boolean |
このボリュームがリクエストを行った認証済みユーザーによって購入されたかどうか。(LITE プロジェクションで) | |
saleInfo |
object |
電子書籍ストアや購入可能性に関する書籍に関する情報。この情報は、リクエストの送信元の国によって異なります(書籍が販売されない国もあります)。 | |
saleInfo.country |
string |
この販売情報が有効である ISO_3166-1 形式の 2 文字の国コード。(LITE プロジェクションで) | |
saleInfo.saleability |
string |
この書籍が上記の国の Google 電子書籍ストアで販売されているか、無料で提供されるか。有効な値は FOR_SALE、FREE、NOT_FOR_SALE、FOR_PREORDER です。 | |
saleInfo.isEbook |
boolean |
この巻が電子書籍であるかどうか([マイ電子書籍] セクションに追加可能) | |
saleInfo.listPrice |
object |
推奨小売価格。(LITE 予測) | |
saleInfo.listPrice.amount |
double |
以下の通貨の金額。(LITE プロジェクションで) | |
saleInfo.listPrice.currencyCode |
string |
ISO 4217、3 文字の通貨コード。(LITE プロジェクションで) | |
saleInfo.retailPrice |
object |
書籍の実際の販売価格。これは、このボリュームに特典や割引がある場合を除き、提案価格または正規価格と同じです。(LITE 予測) | |
saleInfo.retailPrice.amount |
double |
以下の通貨の金額。(LITE プロジェクションで) | |
saleInfo.retailPrice.currencyCode |
string |
ISO 4217、3 文字の通貨コード。(LITE プロジェクションで) | |
saleInfo.buyLink |
string |
この書籍を Google ブックスのサイトで購入するための URL です。(LITE 予測) | |
accessInfo |
object |
そのボリュームのテキストの読み取りまたは取得に関連する、ボリュームに関する情報。この情報は国によって異なります(書籍はある国ではパブリック ドメインになっているが、別の国では公開されていないなど)。 | |
accessInfo.country |
string |
このアクセス情報が有効である ISO_3166-1 形式の 2 文字の国コード。(LITE プロジェクションで) | |
accessInfo.viewability |
string |
ボリュームの読み取りアクセス権。有効な値は PARTIAL、ALL_PAGES、NO_PAGES、UNKNOWN です。この値は上記の国によって異なります。PARTIAL の値は、パブリッシャーが購入なしでボリュームの一部を一般公開することを許可していることを意味します。これは、電子書籍だけでなく、電子書籍でも同様です。パブリック ドメインの書籍の場合、値は常に ALL_PAGES になります。 | |
accessInfo.epub |
object |
ePub コンテンツに関する情報。(LITE 予測) | |
accessInfo.epub.downloadLink |
string |
epub をダウンロードする URL。(LITE プロジェクションで) | |
accessInfo.epub.acsTokenLink |
string |
ePub ダウンロード用の ACS トークンを取得するための URL。(LITE プロジェクションで) | |
accessInfo.pdf |
object |
PDF コンテンツに関する情報。(LITE 予測) | |
accessInfo.pdf.downloadLink |
string |
PDF をダウンロードする URL。(LITE プロジェクションで) | |
accessInfo.pdf.acsTokenLink |
string |
PDF ダウンロード用の ACS トークンを取得するための URL。(LITE プロジェクションで) | |
accessInfo.accessViewStatus |
string |
このボリュームへのアクセス権と視認性を、このユーザーの 1 つのステータス フィールドにまとめることができます。値は FULL_PURCHASED、FULL_PUBLIC_DOMAIN、SAMPLE、NONE のいずれかです。(LITE プロジェクションで) | |
accessInfo.embeddable |
boolean |
Embedded Viewer API を使用してこのボリュームをビューポートに埋め込むことができるかどうか。 | |
accessInfo.publicDomain |
boolean |
この書籍が上記の国のパブリック ドメインであるかどうか。 | |
|
string |
この巻に関する情報の URL を Google ブックス サイトに表示する URL。(LITE プロジェクションで) | |
userInfo.updated |
datetime |
このボリュームがユーザー アクション(読み取り位置の更新、ボリュームの購入、レビューの書き込みなど)によって最後に変更されたときのタイムスタンプ。(RFC 3339 UTC 日時形式)。 | |
volumeInfo.canonicalVolumeLink |
string |
ボリュームの正規 URL。(LITE プロジェクションで) | |
userInfo.isPreordered |
boolean |
リクエストを行った認証済みユーザーが、このボリュームを予約購入したかどうか。(LITE プロジェクションで) | |
saleInfo.onSaleDate |
datetime |
この書籍を販売できる日付。 | |
accessInfo.textToSpeechPermission |
string |
このボリュームでテキスト読み上げを許可するかどうかを指定します。値は ALLOWED、ALLOWED_FOR_ACCESSIBILITY、NOT_ALLOWED のいずれかです。 | |
accessInfo.epub.isAvailable |
boolean |
フローテキストの ePub はパブリック ドメインとして、または購入可能なものとして入手可能(LITE プロジェクションで) | |
accessInfo.pdf.isAvailable |
boolean |
スキャン画像 PDF をパブリック ドメインまたは購入可能な形式で入手可能(LITE プロジェクションで) | |
accessInfo.webReaderLink |
string |
この巻を Google ブックス サイトで読むための URL。リンクにより、ユーザーが視認範囲外のボリュームを読み取ることができなくなります。 | |
accessInfo.downloadAccess |
nested object |
ボリュームのダウンロード ライセンスのアクセス制限に関する情報。 | |
accessInfo.downloadAccess.kind |
string |
リソースのタイプ。 | |
accessInfo.downloadAccess.volumeId |
string |
このエントリが適用されるボリュームを示します。 | |
accessInfo.downloadAccess.restricted |
boolean |
このボリュームにダウンロードのアクセス制限があるかどうか。 | |
accessInfo.downloadAccess.deviceAllowed |
boolean |
制限されている場合、このアクセスが許可されているかどうか(ユーザー、デバイス、ボリューム)。 | |
accessInfo.downloadAccess.justAcquired |
boolean |
deviceAllowed の場合、このリクエストでアクセス権が取得されたかどうか。 | |
accessInfo.downloadAccess.maxDownloadDevices |
integer |
制限されている場合、このボリュームのコンテンツ ダウンロード ライセンスの最大数。 | |
accessInfo.downloadAccess.downloadsAcquired |
integer |
制限されている場合は、すでに取得しているコンテンツ ダウンロード ライセンスの数(ライセンスを取得している場合はリクエスト元のクライアントを含む)。 | |
accessInfo.downloadAccess.nonce |
string |
確認のためにクライアントのノンス。ダウンロード アクセスとクライアントの確認のみ。 | |
accessInfo.downloadAccess.source |
string |
確認用のクライアント アプリ識別子。ダウンロード アクセスとクライアントの確認のみ。 | |
accessInfo.downloadAccess.reasonCode |
string |
エラー/警告の理由コード。コードは今後追加される可能性があります。0 OK 100 ACCESS_DENIED_PUBLISHER_LIMIT 101 ACCESS_DENIED_LIMIT 200 WARNING_USED_last_ACCESS | |
accessInfo.downloadAccess.message |
string |
エラー/警告メッセージ。 | |
accessInfo.downloadAccess.signature |
string |
レスポンスの署名。 | |
searchInfo |
object |
この巻に関連する検索結果情報。 | |
searchInfo.textSnippet |
string |
検索クエリを含むテキスト スニペット。 |