Bookétagères.volumes: liste
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Récupère les volumes d'une bibliothèque spécifique pour l'utilisateur spécifié.
Essayer maintenant
Requête
Requête HTTP
GET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes
Paramètres
Nom du paramètre |
Valeur |
Description |
Paramètres obligatoires |
shelf |
string |
ID de la bibliothèque pour récupérer les volumes.
|
userId |
string |
ID de l'utilisateur pour lequel récupérer les volumes de la bibliothèque.
|
Paramètres facultatifs |
maxResults |
unsigned integer |
Nombre maximal de résultats à renvoyer
|
showPreorders |
boolean |
Définissez cette valeur sur "True" pour afficher les livres précommandés. Valeur par défaut : "false".
|
source |
string |
Chaîne permettant d'identifier l'auteur de cette requête.
|
startIndex |
unsigned integer |
Index du premier élément à renvoyer (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 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."]]