Search Volumes
google_books.search_volumes
ActionBusiness appsconnection required
Calls the Google Books API with the connection's credentials.
Search the Google Books catalogue for volumes.
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
8 fields, 1 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 |
|---|---|---|---|---|---|
query The search terms, in the Books search grammar: bare words, or a keyed term such as intitle:, inauthor: or isbn:9780451524935. | string | Yes | — | — | intitle:flowers inauthor:keyes |
filter Restrict the results to a category of volume, such as free ebooks or volumes with a full preview. | string | No | — | one of "ebooks", "free-ebooks", "full", "paid-ebooks", "partial" | — |
print_type Restrict the results to books, to magazines, or to all print types. | string | No | — | one of "ALL", "BOOKS", "MAGAZINES" | — |
projection How much of each volume to return: FULL is every field, LITE a subset of volumeInfo and accessInfo. | string | No | — | one of "FULL", "LITE" | — |
order_by Sort the results by relevance to the search terms, or newest first. | string | No | — | one of "relevance", "newest" | — |
lang_restrict Two-letter language code restricting the results to books in that language. | string | No | — | — | en |
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; Google's own ceiling is 40. | number | No | — | 0–40 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"lang_restrict": "en",
"query": "intitle:flowers inauthor:keyes"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
query The search terms that were sent. | 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,
"query": "",
"total_items": 0,
"volumes": [
{
"accessInfo": {
"viewability": ""
},
"id": "",
"volumeInfo": {
"authors": [],
"publishedDate": "",
"title": ""
}
}
]
}Related Google Books nodes
See Search 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.