List Bookshelf Volumes
google_books.list_bookshelf_volumes
ActionBusiness appsconnection required
Calls the Google Books API with the connection's credentials.
List the volumes on a user's public bookshelf.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Google Books
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- base_url, country
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
user_id The Google user id whose public bookshelves are being read. | string | Yes | — | — | 114611430599992560860 |
shelf The bookshelf's id, as returned by a bookshelf listing (Google's built-in shelves are numbered, e.g. 3 for 'Reading now'). | string | Yes | — | — | 3 |
start_index Index of the first result to return; the first result is index 0. | number | No | — | ≥ 0 | — |
max_results Maximum number of volumes to return in one call. | number | No | — | ≥ 0 | — |
show_preorders Include books that are available for pre-order but not yet released. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"shelf": "3",
"show_preorders": false,
"user_id": "114611430599992560860"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
user_id The user whose shelf was read. | string | — |
shelf The shelf that was read. | string | — |
volumes The volumes Google returned. | array | — |
volumes[].id The volume's Google Books id. | string | — |
volumes[].volumeInfo.title The volume's title. | string | — |
volumes[].volumeInfo.authors The volume's authors. | array | — |
volumes[].volumeInfo.publishedDate The volume's publication date. | string | — |
volumes[].accessInfo.viewability How much of the volume can be read. | string | — |
count How many volumes are in this response. | number | — |
total_items Google's own count of everything that matched. | number | — |
{
"count": 0,
"shelf": "",
"total_items": 0,
"user_id": "",
"volumes": [
{
"accessInfo": {
"viewability": ""
},
"id": "",
"volumeInfo": {
"authors": [],
"publishedDate": "",
"title": ""
}
}
]
}Related Google Books nodes
See List Bookshelf Volumes run in a workflow.
In a technical demo we add the Google Books connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.