- JSON representation
- IndexStatusInspectionResult
- Verdict
- RobotsTxtState
- IndexingState
- PageFetchState
- CrawlingUserAgent
- AmpInspectionResult
- AmpIndexingState
- AmpIssue
- Severity
- MobileUsabilityInspectionResult
- MobileUsabilityIssue
- MobileUsabilityIssueType
- RichResultsInspectionResult
- DetectedItems
- Item
- RichResultsIssue
URL inspection result, including all inspection results.
JSON representation | |
---|---|
{ "inspectionResultLink": string, "indexStatusResult": { object ( |
Fields | |
---|---|
inspectionResultLink |
Link to Search Console URL inspection. |
indexStatusResult |
Result of the index status analysis. |
ampResult |
Result of the AMP analysis. Absent if the page is not an AMP page. |
mobileUsabilityResult |
Result of the Mobile usability analysis. |
richResultsResult |
Result of the Rich Results analysis. Absent if there are no rich results found. |
IndexStatusInspectionResult
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.
JSON representation | |
---|---|
{ "sitemap": [ string ], "referringUrls": [ string ], "verdict": enum ( |
Fields | |
---|---|
sitemap[] |
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. |
referringUrls[] |
URLs that link to the inspected URL, directly and indirectly. |
verdict |
High-level verdict about whether the URL is indexed. |
coverageState |
Could Google find and index the page. More details about page indexing appear in 'indexingState'. |
robotsTxtState |
Whether or not the page is blocked to Google by a robots.txt rule. |
indexingState |
Whether or not the page blocks indexing through a noindex rule. |
lastCrawlTime |
Last time this URL was crawled by Google using the primary crawler. Absent if the URL was never crawled successfully. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
pageFetchState |
Whether or not Google could retrieve the page from your server. Equivalent to "page fetch" in the URL inspection report. |
googleCanonical |
The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent. |
userCanonical |
The URL that your page or site declares as canonical. If you did not declare a canonical URL, this field is absent. |
crawledAs |
Primary crawler that was used by Google to crawl your site. |
Verdict
Verdict for an analysis.
Enums | |
---|---|
VERDICT_UNSPECIFIED |
Unknown verdict. |
PASS |
Equivalent to "Valid" for the page or item in Search Console. |
PARTIAL |
Reserved, no longer in use. |
FAIL |
Equivalent to "Error" or "Invalid" for the page or item in Search Console. |
NEUTRAL |
Equivalent to "Excluded" 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 |
Reserved, no longer in use. |
PageFetchState
Page fetch state.
Enums | |
---|---|
PAGE_FETCH_STATE_UNSPECIFIED |
Unknown fetch state. |
SUCCESSFUL |
Successful fetch. |
SOFT_404 |
Soft 404. |
BLOCKED_ROBOTS_TXT |
Blocked by robots.txt. |
NOT_FOUND |
Not found (404). |
ACCESS_DENIED |
Blocked due to unauthorized request (401). |
SERVER_ERROR |
Server error (5xx). |
REDIRECT_ERROR |
Redirection error. |
ACCESS_FORBIDDEN |
Blocked due to access forbidden (403). |
BLOCKED_4XX |
Blocked due to other 4xx issue (not 403, 404). |
INTERNAL_CRAWL_ERROR |
Internal error. |
INVALID_URL |
Invalid URL. |
CrawlingUserAgent
The user agent type used for the crawl. Absent if your site was not crawled successfully.
Enums | |
---|---|
CRAWLING_USER_AGENT_UNSPECIFIED |
Unknown user agent. |
DESKTOP |
Desktop user agent. |
MOBILE |
Mobile user agent. |
AmpInspectionResult
AMP inspection result of the page.
JSON representation | |
---|---|
{ "issues": [ { object ( |
Fields | |
---|---|
issues[] |
A list of zero or more AMP issues found for the inspected URL. |
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 |
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 |
Whether or not the page is blocked to Google by a robots.txt rule. |
indexingState |
Whether or not the page blocks indexing through a noindex rule. |
ampIndexStatusVerdict |
Index status of the AMP URL. |
lastCrawlTime |
Last time this AMP version was crawled by Google. Absent if the URL was never crawled successfully. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
pageFetchState |
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 ( |
Fields | |
---|---|
issueMessage |
Brief description of this issue. |
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 ( |
Fields | |
---|---|
issues[] |
A list of zero or more mobile-usability issues detected for this URL. |
verdict |
High-level mobile-usability inspection result for this URL. |
MobileUsabilityIssue
Mobile-usability issue.
JSON representation | |
---|---|
{ "issueType": enum ( |
Fields | |
---|---|
issueType |
Mobile-usability issue type. |
severity |
Not returned; reserved for future use. |
message |
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 |
Viewport 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 ( |
Fields | |
---|---|
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 |
High-level rich results inspection result for this URL. |
DetectedItems
Rich Results items grouped by type.
JSON representation | |
---|---|
{
"items": [
{
object ( |
Fields | |
---|---|
items[] |
List of Rich Results items. |
richResultType |
Rich Results type |
Item
A specific rich result found on the page.
JSON representation | |
---|---|
{
"issues": [
{
object ( |
Fields | |
---|---|
issues[] |
A list of zero or more rich result issues found for this instance. |
name |
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 ( |
Fields | |
---|---|
issueMessage |
Rich Results issue type. |
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. |