Mylibrary.bookBooks.volumes: liste
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Obtient des informations sur les volumes d'une bibliothèque.
Essayer maintenant
Requête
Requête HTTP
GET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes
Paramètres
Nom du paramètre |
Valeur |
Description |
Paramètres obligatoires |
shelf |
string |
ID ou nom d'étagère pour lesquels récupérer les volumes.
|
Paramètres facultatifs |
maxResults |
unsigned integer |
Nombre maximal de résultats à renvoyer
|
projection |
string |
Limitez les informations renvoyées à un ensemble de champs sélectionnés.
Les valeurs possibles sont les suivantes :
- "
full " : inclut toutes les données de volume.
- "
lite " : inclut un sous-ensemble de champs dans volumeInfo et accessInfo.
|
q |
string |
Chaîne de requête de recherche en texte intégral dans cette bibliothèque.
|
showPreorders |
boolean |
Définissez ce paramètre sur "true" pour afficher les livres précommandés. Valeur par défaut : "false".
|
source |
string |
Chaîne permettant d'identifier l'auteur de la requête.
|
startIndex |
unsigned integer |
Index du premier élément à afficher (commence à 0)
|
Corps de la requête
Ne spécifiez pas de corps de requête pour cette méthode.
Réponse
Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :
{
"kind": "books#volumes",
"totalItems": integer,
"items": [
volumes Resource
]
}
Nom de la propriété |
Valeur |
Description |
Remarques |
kind |
string |
Type de ressource. |
|
totalItems |
integer |
Nombre total de volumes trouvés. Ce nombre peut être supérieur au nombre de volumes renvoyés dans cette réponse si les résultats ont été paginés. |
|
items[] |
list |
Liste des volumes. |
|
Essayez-la !
Utilisez l'explorateur ci-dessous pour appeler cette méthode sur des données réelles et obtenir la réponse.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2024/11/08 (UTC).
[null,null,["Dernière mise à jour le 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."]]