Custom Search
Custom Search has 1 operations in gum's generated catalog. Start with search when you know the task, use describe to inspect request fields and scopes, then dispatch through the command that matches the operation risk class.
| Count | Value |
|---|---|
| Family | Search and media |
| Operations | 1 |
| Risk classes | 1 read |
| Auth strategies | 1 api_key |
Start here
gum search "custom search"
gum describe customsearch.cse.list
gum read customsearch.cse.list --args '{"fields":"id"}' --output jsonAuth
Auth strategies in this service: 1 api_key. Authenticate the strategy used by the operation you plan to call.
API key
- In Google Cloud, enable Custom Search API.
- Create an API key. Restrict it to the API and to the hosts or referrers that should use it.
- Store the key in gum:
printf '%s' "$GOOGLE_API_KEY" | gum auth use-api-key --stdin- Verify with a read operation:
gum describe customsearch.cse.list
gum read customsearch.cse.list --args '{"fields":"id"}' --output jsonService setup notes: Custom Search auth guide.
Operations
| Operation | Risk | Auth | Summary |
|---|---|---|---|
customsearch.cse.list |
read |
api_key |
Run a Custom Search query (q) against a programmable search engine (cx). Returns web results; supports num, start, searchType=image, siteSearch, etc. |
Next
- Use API workflows for search, describe, invoke, and error handling.
- Use Auth guides for service-specific Google setup.
- Use Command index for CLI flags and generated help.