مجلد

يتم استخدام مجموعة Volume لإجراء بحث أو إدراج محتوى رف كتب. هذه المجموعة هي مجموعة للقراءة فقط.

الطُرق

تنطبق الطرق التالية على البيانات العامة حول وحدات التخزين ولا تتطلب المصادقة.
books.volumes.list
books.volumes.get

تنطبق الطريقة التالية على طريقة عرض "مكتبتي" الخاصة للمجلدات وتتطلب مصادقة.
books.mylibrary.bookshelves.volumes.list

الحصول
يسترد مورد الحجم بناءً على رقم التعريف.
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 معرّف الحجم الخاص بمجال العمل.
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 رمز البلد المكوّن من حرفين وفقًا لمعيار 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 لتحديد ما إذا كان يمكن تضمين هذا المجلد في إطار عرض باستخدام واجهة برمجة تطبيقات العارض المضمّن.
accessInfo.publicDomain boolean لتحديد ما إذا كان هذا الكتاب ضمن النطاق العام في البلد المذكور أعلاه أم لا.
userInfo.updated datetime الطابع الزمني للوقت الذي تم فيه تعديل هذا المجلد آخر مرة بواسطة إجراء المستخدم، مثل تحديث موضع القراءة أو شراء حجم أو كتابة مراجعة. (تنسيق التاريخ RFC 3339 بالتوقيت العالمي المنسق).
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 في حال السماح باستخدام الجهاز، ما إذا كان قد تم الحصول على حق الوصول للتو من خلال هذا الطلب.
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 مقتطف نصي يحتوي على طلب البحث.