Mylibrary.bookshelves.Volumes: قائمة
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
للحصول على معلومات عن المجلدات على رف كتب.
جرِّب ذلك الآن.
الطلب
طلب HTTP
GET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes
المعلمات
اسم المَعلمة |
القيمة |
الوصف |
المَعلمات المطلوبة |
shelf |
string |
رقم تعريف أو اسم رفّ الكتب الذي يتم استرداد المجلدات له
|
المَعلمات الاختيارية |
maxResults |
unsigned integer |
الحد الأقصى لعدد النتائج المطلوب عرضها
|
projection |
string |
تستخدم لتقييد المعلومات التي يتم عرضها لمجموعة من الحقول المحددة.
القِيَم المقبولة هي:
- "
full ": يتضمّن جميع بيانات عدد الزيارات.
- "
lite ": تتضمّن مجموعة فرعية من الحقول في volumeInfo وaccessInfo.
|
q |
string |
سلسلة طلب البحث في النص الكامل في رف الكتب هذا.
|
showPreorders |
boolean |
يجب ضبط القيمة على "صحيح" لعرض الكتب المطلوبة مسبقًا. القيمة التلقائية هي false.
|
source |
string |
سلسلة لتحديد مصدر هذا الطلب
|
startIndex |
unsigned integer |
فهرس العنصر الأول الذي سيتم إرجاعه (يبدأ من 0)
|
نص الطلب
لا تقدِّم محتوى طلب باستخدام هذه الطريقة.
الرد
إذا كانت الاستجابة ناجحة، تعرض هذه الطريقة نص استجابة بالبنية التالية:
{
"kind": "books#volumes",
"totalItems": integer,
"items": [
volumes Resource
]
}
اسم الموقع |
القيمة |
الوصف |
ملاحظات |
kind |
string |
نوع المورد |
|
totalItems |
integer |
إجمالي عدد المجلدات التي تم العثور عليها قد يكون هذا أكبر من عدد المجلدات التي يتم عرضها في هذه الاستجابة إذا كانت النتائج مقسَّمة إلى صفحات. |
|
items[] |
list |
قائمة بالمجلدات |
|
جرِّبها
استخدِم أداة الاستكشاف أدناه لاستدعاء هذه الطريقة على البيانات المباشرة والاطّلاع على الاستجابة.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2024-11-08 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2024-11-08 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eRetrieves volume information for books on a specific bookshelf.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by search query, pre-orders, and selected fields.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of volumes with details like total items and individual volume resources.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination for handling large results.\u003c/p\u003e\n"],["\u003cp\u003eCan be tested using the provided interactive explorer.\u003c/p\u003e\n"]]],[],null,["# Mylibrary.bookshelves.volumes: list\n\nGets volume information for volumes on a bookshelf.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP Request\n\n```\nGET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes\n```\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|-----------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Required Parameters** |||\n| `shelf` | `string` | The bookshelf ID or name retrieve volumes for. |\n| **Optional Parameters** |||\n| `maxResults` | `unsigned integer` | Maximum number of results to return |\n| `projection` | `string` | Restrict information returned to a set of selected fields. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`full`\" - Includes all volume data. - \"`lite`\" - Includes a subset of fields in volumeInfo and accessInfo. |\n| `q` | `string` | Full-text search query string in this bookshelf. |\n| `showPreorders` | `boolean` | Set to true to show pre-ordered books. Defaults to false. |\n| `source` | `string` | String to identify the originator of this request. |\n| `startIndex` | `unsigned integer` | Index of the first element to return (starts at 0) |\n\n### Request Body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"kind\": \"books#volumes\",\n \"totalItems\": integer,\n \"items\": [\n volumes Resource\n ]\n}\n```\n\n| Property Name | Value | Description | Notes |\n|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `kind` | `string` | Resource type. | |\n| `totalItems` | `integer` | Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated. | |\n| `items[]` | `list` | A list of volumes. | |\n\nTry It!\n-------\n\n\nUse the explorer below to call this method on live data and see the response."]]