Skip to content

Commit ae9b18d

Browse files
feat(searchconsole): update the api
#### searchconsole:v1 The following keys were added: - schemas.AmpInspectionResult (Total Keys: 11) - schemas.AmpIssue (Total Keys: 4) - schemas.DetectedItems (Total Keys: 5) - schemas.IndexStatusInspectionResult (Total Keys: 14) - schemas.Item (Total Keys: 5) - schemas.MobileUsabilityInspectionResult (Total Keys: 5) - schemas.MobileUsabilityIssue (Total Keys: 5) - schemas.RichResultsInspectionResult (Total Keys: 5) - schemas.RichResultsIssue (Total Keys: 4)
1 parent 8611034 commit ae9b18d

File tree

4 files changed

+812
-1
lines changed

4 files changed

+812
-1
lines changed

docs/dyn/searchconsole_v1.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,11 @@ <h2>Instance Methods</h2>
8989
</p>
9090
<p class="firstline">Returns the sites Resource.</p>
9191

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

0 commit comments

Comments
 (0)