Bookshelves.volumes: lista
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recupera volumes em uma estante de livros específica para o usuário especificado.
Faça o teste agora.
Solicitação
Solicitação HTTP
GET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes
Parâmetros
Nome do parâmetro |
Valor |
Descrição |
Parâmetros obrigatórios |
shelf |
string |
ID da biblioteca para recuperar volumes.
|
userId |
string |
ID do usuário para quem os volumes da biblioteca serão recuperados.
|
Parâmetros opcionais |
maxResults |
unsigned integer |
Número máximo de resultados a serem retornados
|
showPreorders |
boolean |
Defina como "verdadeiro" para mostrar os livros encomendados. O padrão é "false".
|
source |
string |
String para identificar o originador da solicitação.
|
startIndex |
unsigned integer |
Índice do primeiro elemento a ser retornado (inicia em 0)
|
Corpo da solicitação
Não forneça um corpo de solicitação com este método.
Resposta
Se bem-sucedido, este método retornará um corpo de resposta com a seguinte estrutura:
{
"kind": "books#volumes",
"totalItems": integer,
"items": [
volumes Resource
]
}
Nome da propriedade |
Valor |
Descrição |
Notas |
kind |
string |
Tipo de recurso. |
|
totalItems |
integer |
Número total de volumes encontrados. Esse número pode ser maior do que o número de volumes retornados nesta resposta se os resultados foram paginados. |
|
items[] |
list |
Uma lista de volumes. |
|
Teste já!
Use o explorador abaixo para chamar esse método em dados ativos e conferir a resposta.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-11-08 UTC.
[null,null,["Última atualização 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."]]