Skip to content

Commit dd49464

Browse files
authored
chore: regens API reference docs (#889)
1 parent 3bf2781 commit dd49464

File tree

1,338 files changed

+581807
-312369
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,338 files changed

+581807
-312369
lines changed

describe.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@
3838
from googleapiclient.discovery import build_from_document
3939
from googleapiclient.discovery import UnknownApiNameOrVersion
4040
from googleapiclient.http import build_http
41+
from googleapiclient.errors import HttpError
42+
4143
import uritemplate
4244

4345
CSS = """<style>
@@ -389,6 +391,9 @@ def document_api(name, version):
389391
except UnknownApiNameOrVersion as e:
390392
print("Warning: {} {} found but could not be built.".format(name, version))
391393
return
394+
except HttpError as e:
395+
print("Warning: {} {} returned {}.".format(name, version, e))
396+
return
392397

393398
http = build_http()
394399
response, content = http.request(

docs/dyn/abusiveexperiencereport_v1.sites.html

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -76,21 +76,17 @@ <h1><a href="abusiveexperiencereport_v1.html">Abusive Experience Report API</a>
7676
<h2>Instance Methods</h2>
7777
<p class="toc_element">
7878
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79-
<p class="firstline">Gets a summary of the abusive experience rating of a site.</p>
79+
<p class="firstline">Gets a site's Abusive Experience Report summary.</p>
8080
<h3>Method Details</h3>
8181
<div class="method">
8282
<code class="details" id="get">get(name, x__xgafv=None)</code>
83-
<pre>Gets a summary of the abusive experience rating of a site.
83+
<pre>Gets a site's Abusive Experience Report summary.
8484

8585
Args:
86-
name: string, The required site name. This is the site property whose abusive
87-
experiences have been reviewed, and it must be URL-encoded. For example,
88-
sites/https%3A%2F%2Fwww.google.com. The server will return an error of
89-
BAD_REQUEST if this field is not filled in. Note that if the site property
90-
is not yet verified in Search Console, the reportUrl field
91-
returned by the API will lead to the verification page, prompting the user
92-
to go through that process before they can gain access to the Abusive
93-
Experience Report. (required)
86+
name: string, Required. The name of the site whose summary to get, e.g.
87+
`sites/http%3A%2F%2Fwww.google.com%2F`.
88+
89+
Format: `sites/{site}` (required)
9490
x__xgafv: string, V1 error format.
9591
Allowed values
9692
1 - v1 error format
@@ -100,13 +96,27 @@ <h3>Method Details</h3>
10096
An object of the form:
10197

10298
{ # Response message for GetSiteSummary.
103-
"lastChangeTime": "A String", # The last time that the site changed status.
104-
"abusiveStatus": "A String", # The status of the site reviewed for the abusive experiences.
105-
"reportUrl": "A String", # A link that leads to a full abusive experience report.
99+
"lastChangeTime": "A String", # The time at which the site's status last changed.
100+
"reviewedSite": "A String", # The name of the reviewed site, e.g. `google.com`.
101+
"abusiveStatus": "A String", # The site's Abusive Experience Report status.
102+
"reportUrl": "A String", # A link to the full Abusive Experience Report for the site.
103+
#
104+
# Not set in
105+
# ViolatingSitesResponse.
106+
#
107+
# Note that you must complete the [Search Console verification
108+
# process](https://support.google.com/webmasters/answer/9008080) for the site
109+
# before you can access the full report.
106110
"underReview": True or False, # Whether the site is currently under review.
107-
"enforcementTime": "A String", # The date on which enforcement begins.
108-
"filterStatus": "A String", # The abusive experience enforcement status of the site.
109-
"reviewedSite": "A String", # The name of the site reviewed.
111+
"enforcementTime": "A String", # The time at which
112+
# [enforcement](https://support.google.com/webtools/answer/7538608) against
113+
# the site began or will begin.
114+
#
115+
# Not set when the
116+
# filter_status
117+
# is OFF.
118+
"filterStatus": "A String", # The site's [enforcement
119+
# status](https://support.google.com/webtools/answer/7538608).
110120
}</pre>
111121
</div>
112122

docs/dyn/abusiveexperiencereport_v1.violatingSites.html

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ <h1><a href="abusiveexperiencereport_v1.html">Abusive Experience Report API</a>
7676
<h2>Instance Methods</h2>
7777
<p class="toc_element">
7878
<code><a href="#list">list(x__xgafv=None)</a></code></p>
79-
<p class="firstline">Lists sites with Abusive Experience Report statuses of "Failing".</p>
79+
<p class="firstline">Lists sites that are failing in the Abusive Experience Report.</p>
8080
<h3>Method Details</h3>
8181
<div class="method">
8282
<code class="details" id="list">list(x__xgafv=None)</code>
83-
<pre>Lists sites with Abusive Experience Report statuses of "Failing".
83+
<pre>Lists sites that are failing in the Abusive Experience Report.
8484

8585
Args:
8686
x__xgafv: string, V1 error format.
@@ -92,15 +92,29 @@ <h3>Method Details</h3>
9292
An object of the form:
9393

9494
{ # Response message for ListViolatingSites.
95-
"violatingSites": [ # A list of summaries of violating sites.
95+
"violatingSites": [ # The list of violating sites.
9696
{ # Response message for GetSiteSummary.
97-
"lastChangeTime": "A String", # The last time that the site changed status.
98-
"abusiveStatus": "A String", # The status of the site reviewed for the abusive experiences.
99-
"reportUrl": "A String", # A link that leads to a full abusive experience report.
97+
"lastChangeTime": "A String", # The time at which the site's status last changed.
98+
"reviewedSite": "A String", # The name of the reviewed site, e.g. `google.com`.
99+
"abusiveStatus": "A String", # The site's Abusive Experience Report status.
100+
"reportUrl": "A String", # A link to the full Abusive Experience Report for the site.
101+
#
102+
# Not set in
103+
# ViolatingSitesResponse.
104+
#
105+
# Note that you must complete the [Search Console verification
106+
# process](https://support.google.com/webmasters/answer/9008080) for the site
107+
# before you can access the full report.
100108
"underReview": True or False, # Whether the site is currently under review.
101-
"enforcementTime": "A String", # The date on which enforcement begins.
102-
"filterStatus": "A String", # The abusive experience enforcement status of the site.
103-
"reviewedSite": "A String", # The name of the site reviewed.
109+
"enforcementTime": "A String", # The time at which
110+
# [enforcement](https://support.google.com/webtools/answer/7538608) against
111+
# the site began or will begin.
112+
#
113+
# Not set when the
114+
# filter_status
115+
# is OFF.
116+
"filterStatus": "A String", # The site's [enforcement
117+
# status](https://support.google.com/webtools/answer/7538608).
104118
},
105119
],
106120
}</pre>

docs/dyn/acceleratedmobilepageurl_v1.ampUrls.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,16 @@
7575
<h1><a href="acceleratedmobilepageurl_v1.html">Accelerated Mobile Pages (AMP) URL API</a> . <a href="acceleratedmobilepageurl_v1.ampUrls.html">ampUrls</a></h1>
7676
<h2>Instance Methods</h2>
7777
<p class="toc_element">
78-
<code><a href="#batchGet">batchGet(body, x__xgafv=None)</a></code></p>
78+
<code><a href="#batchGet">batchGet(body=None, x__xgafv=None)</a></code></p>
7979
<p class="firstline">Returns AMP URL(s) and equivalent</p>
8080
<h3>Method Details</h3>
8181
<div class="method">
82-
<code class="details" id="batchGet">batchGet(body, x__xgafv=None)</code>
82+
<code class="details" id="batchGet">batchGet(body=None, x__xgafv=None)</code>
8383
<pre>Returns AMP URL(s) and equivalent
8484
[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).
8585

8686
Args:
87-
body: object, The request body. (required)
87+
body: object, The request body.
8888
The object takes the form of:
8989

9090
{ # AMP URL request for a batch of URLs.

0 commit comments

Comments
 (0)