1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="searchconsole_v1.html">Google Search Console API</a> . <a href="searchconsole_v1.urlInspection.html">urlInspection</a> . <a href="searchconsole_v1.urlInspection.index.html">index</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#inspect">inspect(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Index inspection.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="inspect">inspect(body=None, x__xgafv=None)</code>
<pre>Index inspection.
Args:
body: object, The request body.
The object takes the form of:
{ # Index inspection request.
"inspectionUrl": "A String", # Required. URL to inspect. Must be under the property specified in "site_url".
"languageCode": "A String", # Optional. An [IETF BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language code representing the requested language for translated issue messages, e.g. "en-US", "or "de-CH". Default value is "en-US".
"siteUrl": "A String", # Required. The URL of the property as defined in Search Console. **Examples:** `http://www.example.com/` for a URL-prefix property, or `sc-domain:example.com` for a Domain property.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Index-Status inspection response.
"inspectionResult": { # URL inspection result, including all inspection results. # URL inspection results.
"ampResult": { # AMP inspection result of the live page or the current information from Google's index, depending on whether you requested a live inspection or not. # Result of the AMP analysis. Absent if the page is not an AMP page.
"ampIndexStatusVerdict": "A String", # Index status of the AMP URL.
"ampUrl": "A 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.
"indexingState": "A String", # Whether or not the page blocks indexing through a noindex rule.
"issues": [ # A list of zero or more AMP issues found for the inspected URL.
{ # AMP issue.
"issueMessage": "A String", # Brief description of this issue.
"severity": "A String", # Severity of this issue: WARNING or ERROR.
},
],
"lastCrawlTime": "A String", # Last time this AMP version was crawled by Google. Absent if the URL was never crawled successfully.
"pageFetchState": "A String", # Whether or not Google could fetch the AMP.
"robotsTxtState": "A String", # Whether or not the page is blocked to Google by a robots.txt rule.
"verdict": "A String", # 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.
},
"indexStatusResult": { # 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](https://support.google.com/webmasters/answer/7440203). # Result of the index status analysis.
"coverageState": "A String", # Could Google find and index the page. More details about page indexing appear in 'indexing_state'.
"crawledAs": "A String", # Primary crawler that was used by Google to crawl your site.
"googleCanonical": "A String", # The URL of the page that Google selected as canonical. If the page was not indexed, this field is absent.
"indexingState": "A String", # Whether or not the page blocks indexing through a noindex rule.
"lastCrawlTime": "A String", # Last time this URL was crawled by Google using the [primary crawler](https://support.google.com/webmasters/answer/7440203#primary_crawler). Absent if the URL was never crawled successfully.
"pageFetchState": "A String", # Whether or not Google could retrieve the page from your server. Equivalent to ["page fetch"](https://support.google.com/webmasters/answer/9012289#index_coverage) in the URL inspection report.
"referringUrls": [ # URLs that link to the inspected URL, directly and indirectly.
"A String",
],
"robotsTxtState": "A String", # Whether or not the page is blocked to Google by a robots.txt rule.
"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.
"A String",
],
"userCanonical": "A String", # The URL that your page or site [declares as canonical](https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-canonical). If you did not declare a canonical URL, this field is absent.
"verdict": "A String", # High level verdict about whether the URL *is* indexed (indexed status), or *can be* indexed (live inspection).
},
"inspectionResultLink": "A String", # Link to Search Console URL inspection.
"mobileUsabilityResult": { # Mobile-usability inspection results. # Result of the Mobile usability analysis.
"issues": [ # A list of zero or more mobile-usability issues detected for this URL.
{ # Mobile-usability issue.
"issueType": "A String", # Mobile-usability issue type.
"message": "A String", # Additional information regarding the issue.
"severity": "A String", # Not returned; reserved for future use.
},
],
"verdict": "A String", # High-level mobile-usability inspection result for this URL.
},
"richResultsResult": { # Rich-Results inspection result, including any rich results found at this URL. # Result of the Rich Results analysis. Absent if there are no rich results found.
"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.
{ # Rich Results items grouped by type.
"items": [ # List of Rich Results items.
{ # A specific rich result found on the page.
"issues": [ # A list of zero or more rich result issues found for this instance.
{ # Severity and status of a single issue affecting a single rich result instance on a page.
"issueMessage": "A String", # Rich Results issue type.
"severity": "A String", # Severity of this issue: WARNING, or ERROR. Items with an issue of status ERROR cannot appear with rich result features in Google Search results.
},
],
"name": "A String", # The user-provided name of this item.
},
],
"richResultType": "A String", # Rich Results type
},
],
"verdict": "A String", # High-level rich results inspection result for this URL.
},
},
}</pre>
</div>
</body></html>
|
