音量

Volume 集合可用來搜尋或列出書架內容。這個集合是唯讀集合。

方法

下列方法適用於磁碟區的公開資料,且不需要進行驗證。
books.volumes.list
books.volumes.get

下列方法適用於「我的資料庫」私人磁碟區,且需要進行驗證。
books.mylibrary.bookshelf.volumes.list

取得
根據 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
  }
}
資源名稱 說明 Notes
kind string 磁碟區的資源類型。(採用 LITE 投影)。
id string 磁碟區的專屬 ID。(採用 LITE 投影)。
etag string 磁碟區資源的特定版本的不透明 ID。(在 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 等。
volumeInfo.industryIdentifiers[].identifier string 特定產業的識別碼。
volumeInfo.pageCount integer 網頁總數。
volumeInfo.dimensions object 此磁碟區的實體尺寸。
volumeInfo.dimensions.height string 此磁碟區的高度或長度 (公分)。
volumeInfo.dimensions.width string 此磁碟區的寬度 (公分)。
volumeInfo.dimensions.thickness string 此磁碟區的粗細 (公分)。
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 超大型圖片的圖片連結 (寬度約 1280 像素)。(在 LITE 投影中)
volumeInfo.language string 此磁碟區的最佳語言 (根據內容)。由兩個英文字母組成的 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 是否為試閱內容 (可加入「我的電子書」書架)。
saleInfo.listPrice object 建議零售價格。(在 LITE 投影中)
saleInfo.listPrice.amount double 以下列貨幣顯示的金額。(採用 LITE 投影)。
saleInfo.listPrice.currencyCode string 採用 ISO 4217 的三字母貨幣代碼。(採用 LITE 投影)。
saleInfo.retailPrice object 書籍的實際售價。除非價格或折扣與此數量相同,否則這會與建議的零售或定價相同。(在 LITE 投影中)
saleInfo.retailPrice.amount double 以下列貨幣顯示的金額。(採用 LITE 投影)。
saleInfo.retailPrice.currencyCode string 採用 ISO 4217 的三字母貨幣代碼。(採用 LITE 投影)。
accessInfo object 任何與閱讀或取得該磁碟區文字相關的磁碟區相關資訊。這些資訊可能因國家/地區而異 (書籍可能屬於某個國家/地區的公版著作,但在其他國家/地區 (例如另一個國家/地區除外)。
accessInfo.country string 存取資訊的有效國家/地區代碼 (由兩個英文字母組成 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 這個磁碟區是否可透過嵌入式 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 用於驗證的用戶端 Nonce。僅供下載和用戶端驗證。
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 包含搜尋查詢的文字片段。