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 "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2024-11-15 UTC.
[null,null,["Последнее обновление: 2024-11-15 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."]]