Home | History | Annotate | Download | only in dyn 
      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="webmasters_v3.html">Search Console API</a> . <a href="webmasters_v3.urlcrawlerrorssamples.html">urlcrawlerrorssamples</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#get">get(siteUrl, url, category, platform)</a></code></p>
     79 <p class="firstline">Retrieves details about crawl errors for a site's sample URL.</p>
     80 <p class="toc_element">
     81   <code><a href="#list">list(siteUrl, category, platform)</a></code></p>
     82 <p class="firstline">Lists a site's sample URLs for the specified crawl error category and platform.</p>
     83 <p class="toc_element">
     84   <code><a href="#markAsFixed">markAsFixed(siteUrl, url, category, platform)</a></code></p>
     85 <p class="firstline">Marks the provided site's sample URL as fixed, and removes it from the samples list.</p>
     86 <h3>Method Details</h3>
     87 <div class="method">
     88     <code class="details" id="get">get(siteUrl, url, category, platform)</code>
     89   <pre>Retrieves details about crawl errors for a site's sample URL.
     90 
     91 Args:
     92   siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
     93   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/pagenameon the site https://www.example.com/, the url value ispagename (required)
     94   category: string, The crawl error category. For example: authPermissions (required)
     95     Allowed values
     96       authPermissions - 
     97       flashContent - 
     98       manyToOneRedirect - 
     99       notFollowed - 
    100       notFound - 
    101       other - 
    102       roboted - 
    103       serverError - 
    104       soft404 - 
    105   platform: string, The user agent type (platform) that made the request. For example: web (required)
    106     Allowed values
    107       mobile - 
    108       smartphoneOnly - 
    109       web - 
    110 
    111 Returns:
    112   An object of the form:
    113 
    114     { # Contains information about specific crawl errors.
    115     "urlDetails": { # Additional details about the URL, set only when calling get(). # Additional details about the URL, set only when calling get().
    116       "containingSitemaps": [ # List of sitemaps pointing at this URL.
    117         "A String",
    118       ],
    119       "linkedFromUrls": [ # A sample set of URLs linking to this URL.
    120         "A String",
    121       ],
    122     },
    123     "first_detected": "A String", # The time the error was first detected, in RFC 3339 format.
    124     "pageUrl": "A String", # The URL of an error, relative to the site.
    125     "responseCode": 42, # The HTTP response code, if any.
    126     "last_crawled": "A String", # The time when the URL was last crawled, in RFC 3339 format.
    127   }</pre>
    128 </div>
    129 
    130 <div class="method">
    131     <code class="details" id="list">list(siteUrl, category, platform)</code>
    132   <pre>Lists a site's sample URLs for the specified crawl error category and platform.
    133 
    134 Args:
    135   siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
    136   category: string, The crawl error category. For example: authPermissions (required)
    137     Allowed values
    138       authPermissions - 
    139       flashContent - 
    140       manyToOneRedirect - 
    141       notFollowed - 
    142       notFound - 
    143       other - 
    144       roboted - 
    145       serverError - 
    146       soft404 - 
    147   platform: string, The user agent type (platform) that made the request. For example: web (required)
    148     Allowed values
    149       mobile - 
    150       smartphoneOnly - 
    151       web - 
    152 
    153 Returns:
    154   An object of the form:
    155 
    156     { # List of crawl error samples.
    157     "urlCrawlErrorSample": [ # Information about the sample URL and its crawl error.
    158       { # Contains information about specific crawl errors.
    159         "urlDetails": { # Additional details about the URL, set only when calling get(). # Additional details about the URL, set only when calling get().
    160           "containingSitemaps": [ # List of sitemaps pointing at this URL.
    161             "A String",
    162           ],
    163           "linkedFromUrls": [ # A sample set of URLs linking to this URL.
    164             "A String",
    165           ],
    166         },
    167         "first_detected": "A String", # The time the error was first detected, in RFC 3339 format.
    168         "pageUrl": "A String", # The URL of an error, relative to the site.
    169         "responseCode": 42, # The HTTP response code, if any.
    170         "last_crawled": "A String", # The time when the URL was last crawled, in RFC 3339 format.
    171       },
    172     ],
    173   }</pre>
    174 </div>
    175 
    176 <div class="method">
    177     <code class="details" id="markAsFixed">markAsFixed(siteUrl, url, category, platform)</code>
    178   <pre>Marks the provided site's sample URL as fixed, and removes it from the samples list.
    179 
    180 Args:
    181   siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
    182   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/pagenameon the site https://www.example.com/, the url value ispagename (required)
    183   category: string, The crawl error category. For example: authPermissions (required)
    184     Allowed values
    185       authPermissions - 
    186       flashContent - 
    187       manyToOneRedirect - 
    188       notFollowed - 
    189       notFound - 
    190       other - 
    191       roboted - 
    192       serverError - 
    193       soft404 - 
    194   platform: string, The user agent type (platform) that made the request. For example: web (required)
    195     Allowed values
    196       mobile - 
    197       smartphoneOnly - 
    198       web - 
    199 </pre>
    200 </div>
    201 
    202 </body></html>