Indexing

Indexing has 2 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.

Start here

gum search "indexing"
gum describe indexing.urlNotifications.getMetadata
gum read indexing.urlNotifications.getMetadata --args '{"fields":"id"}' --output json

For write-class operations, gum requires the write command and an explicit write gate:

gum describe indexing.urlNotifications.publish
gum write indexing.urlNotifications.publish --allow-write --args '{"fields":"id"}'

Auth

Auth strategies in this service: 2 byo_oauth. Authenticate the strategy used by the operation you plan to call.

Bring-your-own OAuth

1. In Google Cloud, enable Indexing API.
2. Configure the OAuth consent screen. Add your Google account as a test user when the app is still in testing mode.
3. Create an OAuth client ID with application type Desktop app.
4. Add the scopes this service needs to the consent screen.
5. Store the client in gum:

printf '%s' "$GOOGLE_OAUTH_CLIENT_SECRET" \
  | gum auth use-oauth-client --client-id "$GOOGLE_OAUTH_CLIENT_ID" --secret-stdin

1. Authorize this service:

gum login --service indexing

1. Verify the grant before dispatch:

gum auth status --scopes indexing
gum describe indexing.urlNotifications.getMetadata

Scopes used by these operations:

• https://www.googleapis.com/auth/indexing

Service setup notes: Indexing auth guide.

Operations

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.