Lists every Search Console property this credential can see, with the permission level it has on each. This is the first call to make when anything returns 403: an empty list means the identity was never added to any property, which is the usual state of a fresh service account. permissionLevel is what the credential may do: siteOwner (everything, including the Indexing API), siteFullUser (all data, no user management), siteRestrictedUser (most data), and siteUnverifiedUser — which means the property is listed but ownership was never proven, and every data call for it returns 403 until it is verified.

Returns one property and the permission level this credential has on it. Useful for settling which of the two spellings exists — "sc-domain:example.com" and "https://example.com/" are separate properties holding separate data.

Adds a property to Search Console. This does NOT verify ownership: unless the credential already owns the domain, the property lands as siteUnverifiedUser and every data call for it returns 403. To actually get a working property, use setup_site, which does this in the right order — get_verification_token, then the DNS record or HTML file, then verify_site, then this.

Removes a property from Search Console. Two-step: the first call returns a confirmation token, the second performs the removal.

Lists the sitemaps submitted for a property, each with when Google last downloaded it, how many URLs it holds per content type, and whether processing produced warnings or errors. To refresh a sitemap Google already knows, submit the same URL again — there is no separate update call, and submitting is idempotent. Google re-crawls on its own schedule; nothing can force it, and the ping endpoint that used to exist was removed in 2023.

Returns the full record for a single submitted sitemap: last submitted, last downloaded, warnings, errors, and the URL counts per content type. This is how to check whether a submission actually worked — errors appear here, never in the response to submit_sitemap.

Submits a sitemap URL, or resubmits one Google already knows. To refresh a sitemap Google already knows, submit the same URL again — there is no separate update call, and submitting is idempotent. Google re-crawls on its own schedule; nothing can force it, and the ping endpoint that used to exist was removed in 2023. The call succeeding means Google accepted the address, not that the sitemap is valid — it is fetched later, and any parse error shows up in get_sitemap minutes to hours afterwards.

Submits up to 50 sitemaps for one property in a single call, reporting success or failure per entry. The API has no batch method — this makes the calls one after another — but it saves a round trip per sitemap, which is what makes a large site practical. One failure does not stop the rest.

Removes a sitemap from the property. Two-step: the first call returns a confirmation token, the second performs the removal.

Clicks, impressions, CTR and average position from Google Search, grouped by any combination of dimensions. This is the whole of the Performance report, as an API.

Give a date range as either period ("last28days") or start_date and end_date. Data is finalised 2–3 days behind, and only the last 16 months are retained.

Two things about the numbers. Rows are capped at row_limit (default 100, maximum 25,000) and paged with start_row. And with the query dimension, Google withholds rare queries for anonymity, so the rows never sum to the property total — query without it when you need a true total.

Asks Google what it knows about one URL: whether it is indexed, when it was last crawled, which sitemaps reference it, the canonical Google chose versus the one declared, robots.txt and mobile-usability verdicts, and any rich-result problems. This is the API behind the URL Inspection tool in the Search Console interface.

It reports the indexed state, not a live fetch — a page changed an hour ago still shows what Google last saw. The URL Inspection API allows 2 000 calls per property per day and 600 per minute. That is a daily budget, not a rate limit — spending it blocks inspection for the rest of the day.

Inspects up to 20 URLs of one property in a single call, reporting a per-URL verdict. The API has no batch method — this makes the calls one after another — but it saves a round trip per URL. One failure does not stop the rest.

The result is condensed to the verdict fields; use inspect_url for the full report on a single URL. The URL Inspection API allows 2 000 calls per property per day and 600 per minute. That is a daily budget, not a rate limit — spending it blocks inspection for the rest of the day.

Lists every site this credential has verified ownership of, with the full owner list for each. This is a different list from list_sites: that one is Search Console properties, this one is proven ownership, and a site can be in either without being in the other. setup_site compares the two.

Returns one verified site and the email addresses of all its owners.

Returns the token that proves ownership of a site, and says exactly where to put it. Nothing is created and nothing is claimed by this call — it is safe to run against a domain you do not own, it just achieves nothing.

A domain property can only be proven by DNS. A URL-prefix property can use FILE or META here; ANALYTICS and TAG_MANAGER prove ownership through an existing Google product rather than a token, so they have no token to fetch and are only usable with verify_site directly.

Placing the token is a human step. Once it is in place, call verify_site.

Tells Google to check for the verification token and, if it finds it, records this credential as an owner. Run get_verification_token first and place the token — this call only checks, it does not place anything.

A failure here is almost always "not there yet" rather than "wrong": DNS records take minutes to an hour to propagate, and a freshly uploaded file may still be behind a CDN cache. Retrying later is the normal response.

Removes this credential from the owners of a site. Two-step: the first call returns a confirmation token, the second performs the removal.

Replaces the list of verified owners of a site. This is how a second person or a service account is granted ownership without placing a token of their own.

It REPLACES rather than adds: the list you pass becomes the complete owner list. Call get_verified_site first and send back the existing addresses plus the new one, or the others are removed. This server refuses a list that does not contain at least one address, because that is the shape of an accidental wipe.

Two-step: the first call returns a confirmation token, the second performs the change.

Returns when this credential last notified Google about a URL through the Indexing API, and what kind of notification it was. This reports the notification history only — it says nothing about whether the page is indexed. inspect_url answers that. The credential must be a verified owner of the property — Search Console user access is not enough, and the API answers 403 without saying which of the two is missing.

Tells Google through the Indexing API that a URL was updated or removed.

Google only acts on this for pages with JobPosting or BroadcastEvent structured data. For any other page the call succeeds, returns a timestamp, and changes nothing — it is not a way to get a normal page crawled sooner. Submit a sitemap for that.

The credential must be a verified owner of the property — Search Console user access is not enough, and the API answers 403 without saying which of the two is missing. The default quota is 200 URLs per day per project.

Works out where a property stands and says exactly what to do next.

Getting a working Search Console property takes four steps in one order — obtain a verification token, place it in DNS or on the page (a human step), verify ownership, add the property — and nothing in the API enforces that order. Calling add_site first succeeds and leaves a property that returns 403 for every piece of data, which looks like a permissions problem and is not.

This reads the current state and reports the next step, including the DNS record or meta tag to copy when that is what is missing. It changes nothing.