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 | برای نمایش کتاب‌های پیش‌سفارش‌شده روی 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 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."]]
