IndexStatusInspectionResult

import type { IndexStatusInspectionResult } from "https://googleapis.deno.dev/v1/searchconsole:v1.ts";

Results of index status inspection for either the live page or the version in Google's index, depending on whether you requested a live inspection or not. For more information, see the Index coverage report documentation.

interface IndexStatusInspectionResult {

coverageState?: string;

crawledAs?: "CRAWLING_USER_AGENT_UNSPECIFIED" | "DESKTOP" | "MOBILE";

googleCanonical?: string;

indexingState?:

| "INDEXING_STATE_UNSPECIFIED"

| "INDEXING_ALLOWED"

| "BLOCKED_BY_META_TAG"

| "BLOCKED_BY_HTTP_HEADER"

| "BLOCKED_BY_ROBOTS_TXT";

lastCrawlTime?: Date;

pageFetchState?:

| "PAGE_FETCH_STATE_UNSPECIFIED"

| "SUCCESSFUL"

| "SOFT_404"

| "BLOCKED_ROBOTS_TXT"

| "NOT_FOUND"

| "ACCESS_DENIED"

| "SERVER_ERROR"

| "REDIRECT_ERROR"

| "ACCESS_FORBIDDEN"

| "BLOCKED_4XX"

| "INTERNAL_CRAWL_ERROR"

| "INVALID_URL";

referringUrls?: string[];

robotsTxtState?: "ROBOTS_TXT_STATE_UNSPECIFIED" | "ALLOWED" | "DISALLOWED";

sitemap?: string[];

userCanonical?: string;

verdict?:

| "VERDICT_UNSPECIFIED"

| "PASS"

| "PARTIAL"

| "FAIL"

| "NEUTRAL";

}

§Properties

coverageState?: string

[src]

Could Google find and index the page. More details about page indexing appear in 'indexing_state'.

crawledAs?: "CRAWLING_USER_AGENT_UNSPECIFIED" | "DESKTOP" | "MOBILE"

[src]

Primary crawler that was used by Google to crawl your site.

googleCanonical?: string

[src]

The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent.

indexingState?: "INDEXING_STATE_UNSPECIFIED" | "INDEXING_ALLOWED" | "BLOCKED_BY_META_TAG" | "BLOCKED_BY_HTTP_HEADER" | "BLOCKED_BY_ROBOTS_TXT"

[src]

Whether or not the page blocks indexing through a noindex rule.

lastCrawlTime?: Date

[src]

Last time this URL was crawled by Google using the primary crawler. Absent if the URL was never crawled successfully.

[src]

Whether or not Google could retrieve the page from your server. Equivalent to "page fetch" in the URL inspection report.

referringUrls?: string[]

[src]

URLs that link to the inspected URL, directly and indirectly.

robotsTxtState?: "ROBOTS_TXT_STATE_UNSPECIFIED" | "ALLOWED" | "DISALLOWED"

[src]

Whether or not the page is blocked to Google by a robots.txt rule.

sitemap?: string[]

[src]

Any sitemaps that this URL was listed in, as known by Google. Not guaranteed to be an exhaustive list, especially if Google did not discover this URL through a sitemap. Absent if no sitemaps were found.

userCanonical?: string

[src]

The URL that your page or site declares as canonical. If you did not declare a canonical URL, this field is absent.

verdict?: "VERDICT_UNSPECIFIED" | "PASS" | "PARTIAL" | "FAIL" | "NEUTRAL"

[src]

High level verdict about whether the URL is indexed (indexed status), or can be indexed (live inspection).