ボリューム

Volume コレクションは、書棚のコンテンツの検索や一覧表示に使用されます。このコレクションは読み取り専用コレクションです。

メソッド

次のメソッドは、ボリュームに関する公開データに適用され、認証は必要ありません。
books.volumes.list
books.volumes.get

次のメソッドは、ボリュームの非公開の [マイ ライブラリ] ビューに適用され、認証が必要です。
books.mylibrary.bookshelves.volumes.list

get
ID に基づいてボリューム リソースを取得します。
list
書籍の検索を実行します。

リソースの表記方法

ボリュームは、Google ブックスがホストする書籍または雑誌に関する情報を表します。タイトルや著者などのメタデータと、購入済みかどうかなどのパーソナライズされたデータが含まれます。（LITE 投影で使用できるボリューム フィールドは下記に記載されています）。

{
  "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 予測）
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、OTHER です。
volumeInfo.industryIdentifiers[].identifier string 業界固有のボリューム ID。
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 ボリューム コンテンツ（テキストと画像）のバージョンの識別子。（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 このボリュームが属するメインのカテゴリ。重みが最も高いカテゴリが、以下に返されるカテゴリリストに含まれます。
userInfo object このボリュームに関連するユーザー固有の情報。（例: ユーザーが最後に読んだページ、この書籍を購入したかどうか）
userInfo.review nested object このユーザーによるこの巻のクチコミ（存在する場合）。
userInfo.readingPosition readingPosition Resource ユーザーが現在読んでいる巻の位置（ある場合）。（LITE 予測）。
userInfo.isPurchased boolean リクエストを行った認証済みユーザーがこのボリュームを購入したかどうか。（LITE 予測）。
saleInfo object 電子書籍ストアや購入の可否に関連する書籍に関する情報。この情報はリクエスト元の国によって異なります（国によっては書籍が販売されていない場合があります）。
saleInfo.country string この販売情報の有効な 2 文字の ISO_3166-1 国コード。（LITE 予測）。
saleInfo.saleability string この書籍が上記の国で Google 電子書籍ストアで販売されているか、無料提供されているかどうか。有効な値は、FOR_SALE、FREE、NOT_FOR_SALE、FOR_PREORDER です。
saleInfo.isEbook boolean この巻が電子書籍かどうか（[マイ e ブックス] 本棚に追加できます）。
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 予測）。
accessInfo object ボリュームのテキストの読み取りや取得に関連するボリュームに関する情報。この情報は国によって異なる場合があります（書籍がパブリック ドメインである国とそうでない国など）。
accessInfo.country string このアクセス情報が有効である 2 文字の ISO_3166-1 国コード。（LITE 図法）。
accessInfo.viewability string ボリュームの読み取りアクセス。有効な値は、PARTIAL、ALL_PAGES、NO_PAGES、UNKNOWN です。この値は、上記の国によって異なります。PARTIAL の値は、パブリッシャーが巻の一部を購入せずに一般公開することを許可していることを意味します。これは、電子書籍だけでなく、電子書籍以外の書籍にも適用されます。パブリック ドメインの書籍の値は常に ALL_PAGES です。
accessInfo.epub object epub コンテンツに関する情報。（LITE 図法）
accessInfo.pdf object PDF コンテンツに関する情報。（LITE 投影）
accessInfo.accessViewStatus string このボリュームのアクセスと視認性が、このユーザーの単一のステータス フィールドに統合されます。値は、FULL_PURCHASED、FULL_PUBLIC_DOMAIN、SAMPLE、NONE のいずれかです。（LITE 予測）。
accessInfo.embeddable boolean Embedded Viewer API を使用して、このボリュームをビューポートに埋め込むことができるかどうか。
accessInfo.publicDomain boolean この書籍が上記の国でパブリック ドメインであるかどうか。
userInfo.updated datetime 閲覧位置の更新、ボリュームの購入、レビューの投稿など、ユーザー操作によってこの巻が最後に変更されたときのタイムスタンプ。（RFC 3339 UTC 日時形式）。
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.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 検証用のクライアント アプリ ID。ダウンロード アクセスとクライアント検証のみ。
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 検索クエリを含むテキスト スニペット。