音量

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

メソッド

以下の方法は、ボリュームに関する一般公開データに適用され、認証を必要としません。
books.volumes.list
books.volumes.get

以下の方法は、ボリュームの非公開の「マイライブラリ」ビューに適用され、認証を必要とします。
books.mylibrary.bookshelves.volumes.list

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

リソースの表記方法

Volume は、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 投影）
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 このボリュームの業界標準の ID。
volumeInfo.industryIdentifiers[].type string ID タイプ。有効な値は 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 この巻に最適な言語（コンテンツに基づく）。これは、「fr」や「en」などの 2 文字の ISO 639-1 コードです。
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 e ブックストアで、この書籍が販売または無料で提供されているかどうか。有効な値は 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 3 文字の通貨コード（ISO 4217）。（LITE 図法）。
saleInfo.retailPrice object 書籍の実際の販売価格。このボリュームに対する特典や割引がある場合を除き、これは希望小売価格や正規価格と同じです。（LITE 図法）
saleInfo.retailPrice.amount double 下記の通貨での金額。（LITE 図法）。
saleInfo.retailPrice.currencyCode string 3 文字の通貨コード（ISO 4217）。（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 このボリュームのアクセス権と視認性を、このユーザーの 1 つのステータス フィールドに統合します。値は、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 検証用のクライアント アプリの識別子。ダウンロード アクセスとクライアント検証のみ。
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 検索クエリを含むテキスト スニペット。