<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="webmasters_v3.html">Search Console API</a> . <a href="webmasters_v3.urlcrawlerrorssamples.html">urlcrawlerrorssamples</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(siteUrl, url, category, platform)</a></code></p>
<p class="firstline">Retrieves details about crawl errors for a site's sample URL.</p>
<p class="toc_element">
<code><a href="#list">list(siteUrl, category, platform)</a></code></p>
<p class="firstline">Lists a site's sample URLs for the specified crawl error category and platform.</p>
<p class="toc_element">
<code><a href="#markAsFixed">markAsFixed(siteUrl, url, category, platform)</a></code></p>
<p class="firstline">Marks the provided site's sample URL as fixed, and removes it from the samples list.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(siteUrl, url, category, platform)</code>
<pre>Retrieves details about crawl errors for a site's sample URL.
Args:
siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
url: string, The relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename (required)
category: string, The crawl error category. For example: authPermissions (required)
Allowed values
authPermissions -
flashContent -
manyToOneRedirect -
notFollowed -
notFound -
other -
roboted -
serverError -
soft404 -
platform: string, The user agent type (platform) that made the request. For example: web (required)
Allowed values
mobile -
smartphoneOnly -
web -
Returns:
An object of the form:
{ # Contains information about specific crawl errors.
"urlDetails": { # Additional details about the URL, set only when calling get(). # Additional details about the URL, set only when calling get().
"containingSitemaps": [ # List of sitemaps pointing at this URL.
"A String",
],
"linkedFromUrls": [ # A sample set of URLs linking to this URL.
"A String",
],
},
"first_detected": "A String", # The time the error was first detected, in RFC 3339 format.
"pageUrl": "A String", # The URL of an error, relative to the site.
"responseCode": 42, # The HTTP response code, if any.
"last_crawled": "A String", # The time when the URL was last crawled, in RFC 3339 format.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(siteUrl, category, platform)</code>
<pre>Lists a site's sample URLs for the specified crawl error category and platform.
Args:
siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
category: string, The crawl error category. For example: authPermissions (required)
Allowed values
authPermissions -
flashContent -
manyToOneRedirect -
notFollowed -
notFound -
other -
roboted -
serverError -
soft404 -
platform: string, The user agent type (platform) that made the request. For example: web (required)
Allowed values
mobile -
smartphoneOnly -
web -
Returns:
An object of the form:
{ # List of crawl error samples.
"urlCrawlErrorSample": [ # Information about the sample URL and its crawl error.
{ # Contains information about specific crawl errors.
"urlDetails": { # Additional details about the URL, set only when calling get(). # Additional details about the URL, set only when calling get().
"containingSitemaps": [ # List of sitemaps pointing at this URL.
"A String",
],
"linkedFromUrls": [ # A sample set of URLs linking to this URL.
"A String",
],
},
"first_detected": "A String", # The time the error was first detected, in RFC 3339 format.
"pageUrl": "A String", # The URL of an error, relative to the site.
"responseCode": 42, # The HTTP response code, if any.
"last_crawled": "A String", # The time when the URL was last crawled, in RFC 3339 format.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="markAsFixed">markAsFixed(siteUrl, url, category, platform)</code>
<pre>Marks the provided site's sample URL as fixed, and removes it from the samples list.
Args:
siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
url: string, The relative path (without the site) of the sample URL. It must be one of the URLs returned by list(). For example, for the URL https://www.example.com/pagename on the site https://www.example.com/, the url value is pagename (required)
category: string, The crawl error category. For example: authPermissions (required)
Allowed values
authPermissions -
flashContent -
manyToOneRedirect -
notFollowed -
notFound -
other -
roboted -
serverError -
soft404 -
platform: string, The user agent type (platform) that made the request. For example: web (required)
Allowed values
mobile -
smartphoneOnly -
web -
</pre>
</div>
</body></html>