Mylibrary.bookshelves.volumes: list
Stay organized with collections
Save and categorize content based on your preferences.
Gets volume information for volumes on a bookshelf.
Try it now.
Request
HTTP Request
GET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes
Parameters
| Parameter Name |
Value |
Description |
| Required Parameters |
shelf |
string |
The bookshelf ID or name retrieve volumes for.
|
| Optional Parameters |
maxResults |
unsigned integer |
Maximum number of results to return
|
projection |
string |
Restrict information returned to a set of selected fields.
Acceptable values are:
- "
full" - Includes all volume data.
- "
lite" - Includes a subset of fields in volumeInfo and accessInfo.
|
q |
string |
Full-text search query string in this bookshelf.
|
showPreorders |
boolean |
Set to true to show pre-ordered books. Defaults to false.
|
source |
string |
String to identify the originator of this request.
|
startIndex |
unsigned integer |
Index of the first element to return (starts at 0)
|
Request Body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{
"kind": "books#volumes",
"totalItems": integer,
"items": [
volumes Resource
]
}
| Property Name |
Value |
Description |
Notes |
kind |
string |
Resource type. |
|
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. |
|
items[] |
list |
A list of volumes. |
|
Try It!
Use the explorer below to call this method on live data and see the response.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-06-26 UTC.
[null,null,["Last updated 2024-06-26 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."]]