נפח

אוסף Volume משמש לביצוע חיפוש או לרישום התוכן של מדף ספרים. זהו אוסף לקריאה בלבד.

Methods

השיטות הבאות חלות על הנתונים הציבוריים לגבי נפחים, והן לא מחייבות אימות.
books.volumes.list
books.volumes.get

השיטה הבאה חלה על התצוגה הפרטית 'הספרייה שלי' של האוספים, והיא דורשת אימות.
books.mylibrary.bookshelves.volumes.list

get
אחזור של משאב נפח על סמך מזהה.
list
מבצע חיפוש ספרים.

ייצוגים של משאבים

כרך מייצג מידע שמערכת Google Books מארחת על ספר או על כתב עת. הוא מכיל מטא-נתונים, כמו שם ומחבר, וגם נתונים מותאמים אישית, כמו העובדה שהוא נרכש או לא. (שדות נפח שזמינים בתצוגה המפורטת 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 מזהה נפח ספציפי לתחום.
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 הדירוג הממוצע של הביקורות על הכרך הזה. (min = 1.0, max = 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 השפה הטובה ביותר לאוסף הזה (על סמך התוכן). זהו קוד 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 קוד המדינה בן שתי האותיות בתקן ISO_3166-1 שבו פרטי המכירה האלה תקפים. (בתצוגה של LITE).
saleInfo.saleability string האם הספר זמין למכירה או זמין בחינם בחנות Google eBookstore במדינה שצוינה למעלה. הערכים האפשריים הם FOR_SALE,‏ FREE,‏ NOT_FOR_SALE או FOR_PREORDER.
saleInfo.isEbook boolean אם הכרך הזה הוא ספר דיגיטלי או לא (אפשר להוסיף אותו למדף 'ספרי ה-eBooks שלי').
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. הערך הזה תלוי במדינה שצוינה למעלה. הערך 'חלקי' מציין שהבעלים של התוכן הדיגיטלי איפשר לצפות בחלק מהתוכן באופן ציבורי, ללא צורך ברכישה. המדיניות הזו חלה גם על ספרים דיגיטליים וגם על ספרים שאינם דיגיטליים. ספרים בתחום הציבורי תמיד יקבלו את הערך 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 חותמת הזמן של מועד השינוי האחרון של הכרך הזה על ידי פעולת משתמש, כמו עדכון מיקום הקריאה, רכישת כרך או כתיבת ביקורת. (פורמט תאריך-שעה UTC של RFC 3339).
userInfo.isPreordered boolean האם המשתמש המאומת ששלח את הבקשה הזמין מראש את הכרך הזה. (בתצוגה של LITE).
saleInfo.onSaleDate datetime התאריך שבו הספר זמין למכירה.
accessInfo.textToSpeechPermission string אם מותר להשתמש בהמרת טקסט לדיבור (TTS) בנפח הזה. הערכים האפשריים הם 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 מזהה אפליקציית הלקוח לאימות. גישה להורדה ואימות לקוח בלבד.
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 קטע טקסט שמכיל את שאילתה החיפוש.