Mylibrary.book estanterías.volumes: lista
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Obtiene información sobre el volumen de los volúmenes en una estantería.
Pruébalo ahora.
Solicitud
Solicitud HTTP
GET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes
Parámetros
Nombre del parámetro |
Valor |
Descripción |
Parámetros obligatorios |
shelf |
string |
Es el ID o el nombre de la biblioteca para la que se recuperan los volúmenes.
|
Parámetros opcionales |
maxResults |
unsigned integer |
Cantidad máxima de resultados que se mostrarán
|
projection |
string |
Restringe la información que se devuelve a un conjunto de campos seleccionados.
Los valores aceptables son los siguientes:
- "
full ": Incluye todos los datos de volumen.
- "
lite ": Incluye un subconjunto de campos en volumeInfo y accessInfo.
|
q |
string |
Cadena de consulta de búsqueda en el texto completo en esta biblioteca.
|
showPreorders |
boolean |
Establece este valor en verdadero para mostrar los libros que se pidieron por adelantado. La configuración predeterminada es "false".
|
source |
string |
Cadena para identificar al autor de esta solicitud.
|
startIndex |
unsigned integer |
Índice del primer elemento que se va a mostrar (comienza en 0)
|
Cuerpo de la solicitud
No proporciones un cuerpo de la solicitud con este método.
Respuesta
Si se aplica correctamente, este método muestra un cuerpo de respuesta con la siguiente estructura:
{
"kind": "books#volumes",
"totalItems": integer,
"items": [
volumes Resource
]
}
Nombre de la propiedad |
Valor |
Descripción |
Notas |
kind |
string |
Tipo de recurso. |
|
totalItems |
integer |
Cantidad total de volúmenes encontrados. Si los resultados se paginaron, esta cantidad puede ser mayor que la cantidad de volúmenes que se muestran en esta respuesta. |
|
items[] |
list |
Una lista de volúmenes. |
|
Pruébalo
Usa el explorador que aparece a continuación para llamar a este método en los datos en tiempo real y ver la respuesta.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2024-11-08 (UTC)
[null,null,["Última actualización: 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."]]