Mylibrary.bookshelves.volumes: lista
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Pobiera informacje o tomach na półce.
Wypróbuj
Żądanie
Żądanie HTTP
GET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes
Parametry
Nazwa parametru |
Wartość |
Opis |
Parametry wymagane |
shelf |
string |
Identyfikator lub nazwa półki, z której mają zostać pobrane książki.
|
Parametry opcjonalne |
maxResults |
unsigned integer |
Maksymalna liczba wyników do zwrócenia
|
projection |
string |
Ograniczenie zwracania informacji do zbioru wybranych pól.
Akceptowane wartości:
- „
full ” – obejmuje wszystkie dane o wolumenie.
- „
lite ” – zawiera podzbiór pól z volumeInfo i accessInfo.
|
q |
string |
Ciąg znaków zapytania wyszukiwania pełnotekstowego na tej półce.
|
showPreorders |
boolean |
Ustaw na Prawda, aby wyświetlać książki zamówione w przedsprzedaży. Wartość domyślna to fałsz.
|
source |
string |
Ciąg tekstowy identyfikujący źródło tego żądania.
|
startIndex |
unsigned integer |
Indeks pierwszego elementu do zwrócenia (rozpoczyna się od 0)
|
Treść żądania
W przypadku tej metody nie podawaj treści żądania.
Odpowiedź
Jeśli operacja się uda, metoda zwróci odpowiedź o następującej strukturze:
{
"kind": "books#volumes",
"totalItems": integer,
"items": [
volumes Resource
]
}
Nazwa właściwości |
Wartość |
Opis |
Uwagi |
kind |
string |
Typ zasobu. |
|
totalItems |
integer |
Łączna liczba znalezionych woluminów. Jeśli wyniki zostały podzielone na strony, może być ich więcej niż zwróconych w tej odpowiedzi. |
|
items[] |
list |
lista tomów; |
|
Wypróbuj
Aby wywołać tę metodę na danych na żywo i zobaczyć odpowiedź, użyj eksploratora poniżej.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2024-11-08 UTC.
[null,null,["Ostatnia aktualizacja: 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."]]