נפח: רשימה
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
מבצע חיפוש ספר.
רוצים לנסות עכשיו?
בקשה
בקשת HTTP
GET https://www.googleapis.com/books/v1/volumes?q={search terms}
פרמטרים
| שם פרמטר |
ערך |
תיאור |
| פרמטרים נדרשים |
q |
string |
מחרוזת של שאילתת חיפוש טקסט מלא.
|
| פרמטרים אופציונליים |
download |
string |
הגבלת נפח האחסון לפי זמינות ההורדה.
הערכים הקבילים הם:
- "
epub" – כל הכרכים עם קובץ EPUB.
|
filter |
string |
סינון של תוצאות חיפוש.
הערכים הקבילים הם:
- '
ebooks' – כל הספרים הדיגיטליים של Google.
- '
free-ebooks' – ספר אלקטרוני של Google עם ניראות מלאה של הטקסט בכל נפח.
- '
full' – הציבור יכול לראות את הטקסט המלא של הכרך.
- '
paid-ebooks' – ספר אלקטרוני של Google עם מחיר.
- "
partial" – הציבור יכול לראות חלקי טקסט.
|
langRestrict |
string |
הגבלת התוצאות לספרים עם קוד השפה הזה.
|
libraryRestrict |
string |
להגביל את החיפוש לספרייה של המשתמש הזה.
הערכים הקבילים הם:
- '
my-library' – הגבלה לספריית המשתמש, כל מדף.
- '
no-restrict' – לא להגביל על סמך הספרייה של המשתמש.
|
maxResults |
unsigned integer |
המספר המקסימלי של תוצאות להחזרה.
הערכים הקבילים הם 0 עד 40, כולל.
|
orderBy |
string |
ממיינים את תוצאות החיפוש.
הערכים הקבילים הם:
- '
newest' – הפרסום האחרון.
- '
relevance' – רלוונטיות למונחי החיפוש.
|
partner |
string |
הגבלה של תוצאות מזהה השותף ומיתוג שלהן.
|
printType |
string |
הגבל לספרים או לכתבי עת.
הערכים הקבילים הם:
- '
all' – כל סוגי התוכן של נפח.
- '
books' – רק ספרים.
- "
magazines" - רק כתבי עת.
|
projection |
string |
הגבלת המידע המוחזר לקבוצה של שדות נבחרים.
הערכים הקבילים הם:
- '
full' – כולל את כל נתוני הנפח.
- '
lite' – כולל קבוצת משנה של שדות ב-volumeInfo וב-accessInfo.
|
showPreorders |
boolean |
יש להגדיר את הערך כ-True כדי להציג ספרים שזמינים להזמנה מראש. ברירת המחדל היא false.
|
source |
string |
מחרוזת שמזהה את מבצע הבקשה.
|
startIndex |
unsigned integer |
האינדקס של התוצאה הראשונה להחזרה (מתחיל ב-0)
|
גוף הבקשה
אין לספק גוף בקשה בשיטה הזו.
תשובה
אם הפעולה בוצעה ללא שגיאות, ה-method מחזיר גוף תגובה עם המבנה הבא:
{
"kind": "books#volumes",
"items": [
volume Resource
],
"totalItems": (value)
}
| שם הנכס |
ערך |
תיאור |
הערות |
kind |
string |
סוג המשאב. |
|
items[] |
list |
רשימה של כרכים. |
|
totalItems |
integer |
המספר הכולל של הכרכים שנמצאו. אם התוצאות חולקו לדפים, המספר הזה עשוי להיות גדול ממספר האוספים שמוחזרים בתגובה הזו. |
|
רוצה לנסות?
אפשר להשתמש בניתוח שבהמשך כדי להפעיל את השיטה הזו בנתונים בזמן אמת ולראות את התגובה.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-11-08 (שעון UTC).
[null,null,["עדכון אחרון: 2024-11-08 (שעון UTC)."],[[["\u003cp\u003eSearches for books based on a provided query string.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by criteria such as availability, format, language, and publication type.\u003c/p\u003e\n"],["\u003cp\u003eOffers control over the number of results, sorting order, and specific data fields returned.\u003c/p\u003e\n"],["\u003cp\u003eCan be used to retrieve information about books, including volume details and access options.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to handle large result sets.\u003c/p\u003e\n"]]],[],null,["# Volume: list\n\nPerforms a book search.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP Request\n\n GET https://www.googleapis.com/books/v1/volumes?q={search terms}\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|-------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Required Parameters** |||\n| `q` | `string` | Full-text search query string. |\n| **Optional Parameters** |||\n| `download` | `string` | Restrict to volumes by download availability. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`epub`\" - All volumes with epub. |\n| `filter` | `string` | Filter search results. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`ebooks`\" - All Google eBooks. - \"`free-ebooks`\" - Google eBook with full volume text viewability. - \"`full`\" - Public can view entire volume text. - \"`paid-ebooks`\" - Google eBook with a price. - \"`partial`\" - Public able to see parts of text. |\n| `langRestrict` | `string` | Restrict results to books with this language code. |\n| `libraryRestrict` | `string` | Restrict search to this user's library. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`my-library`\" - Restrict to the user's library, any shelf. - \"`no-restrict`\" - Do not restrict based on user's library. |\n| `maxResults` | `unsigned integer` | Maximum number of results to return. Acceptable values are `0` to `40`, inclusive. |\n| `orderBy` | `string` | Sort search results. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`newest`\" - Most recently published. - \"`relevance`\" - Relevance to search terms. |\n| `partner` | `string` | Restrict and brand results for partner ID. |\n| `printType` | `string` | Restrict to books or magazines. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`all`\" - All volume content types. - \"`books`\" - Just books. - \"`magazines`\" - Just magazines. |\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| `showPreorders` | `boolean` | Set to true to show books available for preorder. Defaults to false. |\n| `source` | `string` | String to identify the originator of this request. |\n| `startIndex` | `unsigned integer` | Index of the first result 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 {\n \"kind\": \"books#volumes\",\n \"items\": [\n volume Resource\n ],\n \"totalItems\": (value)\n }\n\n| Property Name | Value | Description | Notes |\n|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `kind` | `string` | Resource type. | |\n| `items[]` | `list` | A list of volumes. | |\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\nTry It!\n-------\n\n\nUse the explorer below to call this method on live data and see the response."]]
