قفسه کتاب.جلد: فهرست
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
جلدها را در یک قفسه کتاب خاص برای کاربر مشخص شده بازیابی می کند. اکنون آن را امتحان کنید .
درخواست کنید
درخواست HTTP
GET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes
پارامترها
| نام پارامتر | ارزش | توضیحات |
|---|
| پارامترهای مورد نیاز |
shelf | string | شناسه قفسه کتاب برای بازیابی جلدها. |
userId | string | شناسه کاربری که جلدهای قفسه کتاب برای او بازیابی شود. |
| پارامترهای اختیاری |
maxResults | unsigned integer | حداکثر تعداد نتایج برای بازگشت |
showPreorders | boolean | برای نمایش کتاب‌های پیش‌سفارش‌شده روی true تنظیم کنید. پیش فرض به نادرست. |
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 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2024-11-15 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2024-11-15 بهوقت ساعت هماهنگ جهانی."],[[["\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."]]
