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 כדי להציג ספרים שהוזמנו מראש. ברירת המחדל היא false.
|
source |
string |
מחרוזת לזיהוי יוזם הבקשה.
|
startIndex |
unsigned integer |
האינדקס של הרכיב הראשון להחזרה (מתחיל ב-0)
|
גוף הבקשה
אין לציין גוף בקשה בשיטה הזו.
תשובה
אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר גוף תגובה עם המבנה הבא:
{
"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 (שעון UTC).
[null,null,["עדכון אחרון: 2024-11-08 (שעון UTC)."],[[["\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."]]
