Mylibrary.bookshelves.volumes: lista
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recebe informações de volume para volumes em um estante.
Faça o teste agora.
Solicitação
Solicitação HTTP
GET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes
Parâmetros
Nome do parâmetro |
Valor |
Descrição |
Parâmetros obrigatórios |
shelf |
string |
O ID ou nome da biblioteca para a qual os volumes serão recuperados.
|
Parâmetros opcionais |
maxResults |
unsigned integer |
Número máximo de resultados a serem retornados
|
projection |
string |
Restringe informações retornadas a um conjunto de campos selecionados.
Os valores aceitáveis são:
- "
full ": inclui todos os dados de volume.
- "
lite ": inclui um subconjunto de campos em volumeInfo e accessInfo.
|
q |
string |
String de consulta de pesquisa de texto completo nesta biblioteca.
|
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 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."]]