Bookshelves.volumes: רשימה
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
אחזור כרכים במדף ספרים ספציפי של המשתמש שצוין.
רוצים לנסות?
בקשה
בקשת HTTP
GET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes
פרמטרים
| שם פרמטר |
ערך |
תיאור |
| פרמטרים נדרשים |
shelf |
string |
המזהה של מדף הספרים לאחזור כרכים.
|
userId |
string |
מזהה המשתמש שעבורו יש לאחזר את נפחי האחסון של המדפים.
|
| פרמטרים אופציונליים |
maxResults |
unsigned integer |
המספר המקסימלי של תוצאות להחזרה
|
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 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."]]
