Bookshelves.صفs: قائمة
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
لاسترداد المجلدات في رف كتب معيّن للمستخدم المحدّد.
جرِّب ذلك الآن.
الطلب
طلب HTTP
GET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes
المعلمات
اسم المَعلمة |
القيمة |
الوصف |
المَعلمات المطلوبة |
shelf |
string |
رقم تعريف رف الكتب لاسترداد المجلدات
|
userId |
string |
رقم تعريف المستخدم الذي سيتم استرداد مجلدات رف الكتب له.
|
المَعلمات الاختيارية |
maxResults |
unsigned integer |
الحد الأقصى لعدد النتائج المطلوب عرضها
|
showPreorders |
boolean |
اضبط هذا الخيار على "صحيح" لعرض الكتب التي تم طلبها مسبقًا. وتكون القيم التلقائية على "خطأ".
|
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 a list of books from a specific bookshelf belonging to a given user.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by parameters such as maximum results, pre-orders, and starting index for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes the total number of books found and a list of book details.\u003c/p\u003e\n"],["\u003cp\u003eYou can interactively try this method using the provided explorer to test it with live data.\u003c/p\u003e\n"]]],[],null,["# Bookshelves.volumes: list\n\nRetrieves volumes in a specific bookshelf for the specified user.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP Request\n\n```\nGET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes\n```\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|-----------------|--------------------|-----------------------------------------------------------|\n| **Required Parameters** |||\n| `shelf` | `string` | ID of bookshelf to retrieve volumes. |\n| `userId` | `string` | ID of user for whom to retrieve bookshelf volumes. |\n| **Optional Parameters** |||\n| `maxResults` | `unsigned integer` | Maximum number of results to return |\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."]]