Skip to main content

Google Search Console

Read search performance, indexing status and sitemaps for your Search Console sites.

Connect it with: Sign in (OAuth). Google Search Console's own documentation: https://developers.google.com/webmaster-tools/v1/sites/list.

What agents can do​

Connect Google Search Console so the agents working your tasks can reach it. With it connected, they can:

  • List the sites (URL-prefix and Domain properties) the connected account can see, and its permission on each.
  • Query search analytics: queries, pages, countries and devices with clicks, impressions, CTR and average position.
  • Inspect a URL to see whether Google has indexed it, its canonical and its last crawl.
  • List submitted sitemaps and their errors after a release changes the site's structure.

Before you start​

  • A Google account that is a user (Full or Restricted) or owner of each Search Console property agents should read (Search Console > Settings > Users and permissions).
  • The site verified in Search Console. An unverified property returns no data.
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with Google Search Console​

This is the quickest way in: you sign in to Google Search Console and approve what Jaah asks for. You never copy a key.

  1. In Jaah, open Secrets and select New.
  2. Search for Google Search Console and select its card.
  3. Give the secret a name you will recognize, such as the account or workspace it reaches, and choose who can use it (see Who can use it).
  4. Select Connect Google Search Console. Google Search Console's sign-in window opens.
  5. Sign in to Google Search Console if asked, check the access listed, and approve it.
  6. You land back in Jaah on the new secret, which reads Connected once its test passes.

If the button reads Jaah app not configured, this Jaah has no app registered at Google Search Console yet. Use your own OAuth app until it does (see Use your own OAuth app).

Scopes Jaah requests​

Jaah asks Google Search Console for these scopes, and no others. A scope marked optional is a checkbox on the Connect screen: untick it and agents simply cannot do that part.

ScopeWhy Jaah asks for itRequired
https://www.googleapis.com/auth/webmasters.readonlyRead your sites' search queries, clicks, impressions, index coverage and sitemaps. Read only: agents cannot submit sitemaps or remove URLsYes

Connect with an API key​

Google Search Console has no API key option in Jaah: connect with the sign-in above.

Use your own OAuth app​

Register your own OAuth app at Google Search Console when your company requires apps it controls, or before this Jaah has an app registered there.

  1. Create an OAuth app in Google Search Console's developer console, https://console.cloud.google.com/auth/clients (Google Search Console's documentation).
  2. Set its redirect URI to https://app.jaah.ai/api/credentials/connect/callback (on your own Jaah, its console address followed by /api/credentials/connect/callback).
  3. Give it the scopes in Scopes Jaah requests.
  4. Copy its client ID and client secret.
  5. In Jaah, start a new Google Search Console secret, select Use your own OAuth app, paste both values and select Connect Google Search Console.

The client secret is stored with the connection, encrypted, like any other secret value.

Test the connection​

Select Test on the secret. Jaah calls Google Search Console's API once (GET https://www.googleapis.com/webmasters/v3/sites) with the stored values, and shows who it answered as, or which value Google Search Console refused and the status it answered. Jaah also tests automatically when you save or reconnect.

The last result and its time stay on the secret's page, so you can see whether it still works without testing again.

Who can use it​

Every secret has an owner, and the owner decides who can use it:

  • Personal — only your own tasks can use it. This is the default.
  • Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
  • Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.

More on owners and access: How secrets work.

Use it in an agent session​

An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:

  • org/<name> for an organization secret,
  • projects/<project>/<name> for one attached to a project,
  • me/<name> for your personal one.

A signed-in connection hands the agent a live access_token, with access_token_expires_at. Jaah refreshes it before it expires, so an agent never handles a refresh token.

Tell the agent in your task description which secret to use, for example “use the Google Search Console secret org/google-search-console”.

Manage, rotate or disconnect​

Everything is on the secret's page under Secrets:

  • Reconnect: when Google Search Console ends the grant (a password change, a revoked app, an expired refresh), the secret shows Needs reconnect. Select Reconnect and sign in again; agents get the new token on their next call.
  • Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Google Search Console's side too, remove Jaah's access in your Google Account > Security > Your connections to third-party apps & services (myaccount.google.com/connections).

Limitations​

  • Read only: agents cannot submit sitemaps, request indexing or remove URLs, because the connection asks for the read-only scope.
  • Search performance data covers the last 16 months and usually lags two to three days.
  • URL Inspection is limited by Google to about 2,000 calls per day per property.
  • Agents can do only what the connected Google Search Console account and its granted scopes allow.

Troubleshooting​

Test says Google Search Console rejected the access token (401)

The grant was revoked or the Google password changed. Select Reconnect and approve again.

Test says Connected to Google Search Console - credentials accepted, with no site named

The connected account is not a user of any property. In Search Console open Settings > Users and permissions on the property, select Add user, and add that account.

An agent's query for https://example.com returns 403 for a Domain property

A Domain property is addressed as sc-domain:example.com, not as a URL. Tell the agent to use the siteUrl exactly as the Test or the site list shows it.

Still stuck? Select Test and read the result: it names the value Google Search Console refused and the status it answered.

FAQ​

Does this connect Google Analytics too?

No. Google Analytics is a separate integration with its own scope.

Can an agent fix indexing problems?

It can find them and tell you which pages and why, but the read-only scope stops it from requesting indexing; you do that in Search Console.

Can Jaah or an admin see the key or token?

No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.

Can I connect more than one Google Search Console account?

Yes. Add one secret per account, each with its own name, and tell the agent which one to use.