'An experimental API for testing the mobile-friendliness of a URL'

UrlInspectionResult

Stay organized with collections Save and categorize content based on your preferences.

URL inspection result. The returned object can include information about all types of URLs, including AMP, mobile, and rich results. If a specific test result does not apply, for example if the URL is not an AMP, the property will not be present.

JSON representation 
{
  "inspectionResultLink": string,
  "indexStatusResult": {
    object (IndexStatusInspectionResult)
  },
  "ampResult": {
    object (AmpInspectionResult)
  },
  "mobileUsabilityResult": {
    object (MobileUsabilityInspectionResult)
  },
  "richResultsResult": {
    object (RichResultsInspectionResult)
  }
}
Fields
indexStatusResult

object (IndexStatusInspectionResult)

Result of the index status analysis.
ampResult

object (AmpInspectionResult)

Result of the AMP analysis. Absent if the page is not an AMP page.
mobileUsabilityResult

object (MobileUsabilityInspectionResult)

Result of the Mobile usability analysis.
richResultsResult

object (RichResultsInspectionResult)

Result of the Rich Results analysis. Absent if there are no rich results found.

IndexStatusInspectionResult

Results of page inspection. For more information, see the Index coverage report documentation.

JSON representation 
{
  "sitemap": [
    string
  ],
  "referringUrls": [
    string
  ],
  "verdict": enum (Verdict),
  "coverageState": string,
  "robotsTxtState": enum (RobotsTxtState),
  "indexingState": enum (IndexingState),
  "lastCrawlTime": string,
  "pageFetchState": string,
  "googleCanonical": string,
  "userCanonical": string
}
Fields
sitemap[]

string

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.
referringUrls[]

string

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

enum (Verdict)

High-level verdict about whether the URL is indexed.
coverageState

string

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

enum (RobotsTxtState)

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

enum (IndexingState)

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

string (Timestamp format)

Last time this URL was crawled by Google using the primary crawler.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
pageFetchState

string

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

string

The URL of the page that Google selected as canonical.
userCanonical

string

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

Verdict

Verdict for an analysis.

Enums
VERDICT_UNSPECIFIED Unknown verdict.
PASS Equivalent to "Valid" for the page or item in Search Console.
PARTIAL Equivalent to "Valid with warnings" for the page or item in Search Console
FAIL Equivalent to Error or Invalid for the page or item in Search Console.

RobotsTxtState

The result of the robots.txt check.

Enums
ROBOTS_TXT_STATE_UNSPECIFIED Unknown robots.txt state, typically because the page wasn't fetched or found, or because robots.txt itself couldn't be reached.
ALLOWED Crawl allowed by robots.txt
DISALLOWED Crawl blocked by robots.txt

IndexingState

Indexing status of the URL.

Enums
INDEXING_STATE_UNSPECIFIED Unknown indexing status.
INDEXING_ALLOWED Indexing allowed.
BLOCKED_BY_META_TAG Indexing not allowed, 'noindex' detected in 'robots' meta tag
BLOCKED_BY_HTTP_HEADER Indexing not allowed, 'noindex' detected in 'X-Robots-Tag' http header
BLOCKED_BY_ROBOTS_TXT Indexing not allowed, 'noindex' detected in robots.txt.

AmpInspectionResult

AMP inspection result of the page.

JSON representation 
{
  "issues": [
    {
      object (AmpIssue)
    }
  ],
  "verdict": enum (Verdict),
  "ampUrl": string,
  "robotsTxtState": enum (RobotsTxtState),
  "indexingState": enum (AmpIndexingState),
  "ampIndexStatusVerdict": enum (Verdict),
  "lastCrawlTime": string,
  "pageFetch": string
}
Fields
issues[]

object (AmpIssue)

A list of zero or more AMP issues found for the inspected URL.
verdict

enum (Verdict)

The status of the most severe error on the page. If a page has both warnings and errors, the page status is error. Error status means the page cannot be shown in Search results.
ampUrl

string

URL of the AMP that was inspected. If the submitted URL is a desktop page that refers to an AMP version, the AMP version will be inspected.
robotsTxtState

enum (RobotsTxtState)

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

enum (AmpIndexingState)

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

enum (Verdict)

Index status of the AMP URL.
lastCrawlTime

string (Timestamp format)

Last time this AMP version was crawled by Google.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
pageFetch

string

Whether or not Google could fetch the AMP.

AmpIndexingState

Indexing status of the AMP URL.

Enums
AMP_INDEXING_STATE_UNSPECIFIED Unknown indexing status.
AMP_INDEXING_ALLOWED Indexing allowed.
BLOCKED_DUE_TO_NOINDEX Indexing not allowed, 'noindex' detected.
BLOCKED_DUE_TO_EXPIRED_UNAVAILABLE_AFTER Indexing not allowed, 'unavailable_after' date expired.

AmpIssue

AMP issue.

JSON representation 
{
  "issueMessage": string,
  "severity": enum (Severity)
}
Fields
issueMessage

string

Brief description of this issue.
severity

enum (Severity)

Severity of this issue: WARNING, or ERROR

Severity

Common template for issue severity

Enums
SEVERITY_UNSPECIFIED Unknown severity.
WARNING Warning.
ERROR Error.

MobileUsabilityInspectionResult

Mobile-usability inspection results.

JSON representation 
{
  "issues": [
    {
      object (MobileUsabilityIssue)
    }
  ],
  "verdict": enum (Verdict)
}
Fields
issues[]

object (MobileUsabilityIssue)

A list of zero or more mobile-usability issues detected for this URL.
verdict

enum (Verdict)

High-level mobile-usability inspection result for this URL.

MobileUsabilityIssue

Mobile-usability issue.

JSON representation 
{
  "issueType": enum (MobileUsabilityIssueType),
  "severity": enum (Severity),
  "message": string
}
Fields
issueType

enum (MobileUsabilityIssueType)

Mobile-usability issue type.
severity

enum (Severity)

Not returned; reserved for future use.
message

string

Additional information regarding the issue.

MobileUsabilityIssueType

The mobile usability issue type that was encountered.

Enums
MOBILE_USABILITY_ISSUE_TYPE_UNSPECIFIED Unknown issue. Sorry, we don't have any description for the rule that was broken.
USES_INCOMPATIBLE_PLUGINS Plugins incompatible with mobile devices are being used. Learn more.
CONFIGURE_VIEWPORT Viewsport is not specified using the meta viewport tag. Learn more.
FIXED_WIDTH_VIEWPORT Viewport defined to a fixed width. Learn more.
SIZE_CONTENT_TO_VIEWPORT Content not sized to viewport. Learn more.
USE_LEGIBLE_FONT_SIZES Font size is too small for easy reading on a small screen. Learn More.
TAP_TARGETS_TOO_CLOSE Touch elements are too close to each other. Learn more.

RichResultsInspectionResult

Rich-Results inspection result, including any rich results found at this URL.

JSON representation 
{
  "detectedItems": [
    {
      object (DetectedItems)
    }
  ],
  "verdict": enum (Verdict)
}
Fields
detectedItems[]

object (DetectedItems)

A list of zero or more rich results detected on this page. Rich results that cannot even be parsed due to syntactic issues will not be listed here.
verdict

enum (Verdict)

High-level rich results inspection result for this URL.

DetectedItems

Rich Results items grouped by type.

JSON representation 
{
  "items": [
    {
      object (Item)
    }
  ],
  "richResultType": string
}
Fields
items[]

object (Item)

List of Rich Results items.
richResultType

string

Rich Results type

Item

A specific rich result found on the page.

JSON representation 
{
  "issues": [
    {
      object (RichResultsIssue)
    }
  ],
  "name": string
}
Fields
issues[]

object (RichResultsIssue)

A list of zero or more rich result issues found for this instance.
name

string

The user-provided name of this item.

RichResultsIssue

Severity and status of a single issue affecting a single rich result instance on a page.

JSON representation 
{
  "issueMessage": string,
  "severity": enum (Severity)
}
Fields
issueMessage

string

Rich Results issue type.
severity

enum (Severity)

Severity of this issue: WARNING, or ERROR. Items with an issue of status ERROR cannot appear with rich result features in Google Search results.