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.sitemaps.html">sitemaps</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#delete">delete(siteUrl, feedpath)</a></code></p>
     79 <p class="firstline">Deletes a sitemap from this site.</p>
     80 <p class="toc_element">
     81   <code><a href="#get">get(siteUrl, feedpath)</a></code></p>
     82 <p class="firstline">Retrieves information about a specific sitemap.</p>
     83 <p class="toc_element">
     84   <code><a href="#list">list(siteUrl, sitemapIndex=None)</a></code></p>
     85 <p class="firstline">Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).</p>
     86 <p class="toc_element">
     87   <code><a href="#submit">submit(siteUrl, feedpath)</a></code></p>
     88 <p class="firstline">Submits a sitemap for a site.</p>
     89 <h3>Method Details</h3>
     90 <div class="method">
     91     <code class="details" id="delete">delete(siteUrl, feedpath)</code>
     92   <pre>Deletes a sitemap from this site.
     93 
     94 Args:
     95   siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
     96   feedpath: string, The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml (required)
     97 </pre>
     98 </div>
     99 
    100 <div class="method">
    101     <code class="details" id="get">get(siteUrl, feedpath)</code>
    102   <pre>Retrieves information about a specific sitemap.
    103 
    104 Args:
    105   siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
    106   feedpath: string, The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml (required)
    107 
    108 Returns:
    109   An object of the form:
    110 
    111     { # Contains detailed information about a specific URL submitted as a sitemap.
    112     "errors": "A String", # Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
    113     "warnings": "A String", # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
    114     "isPending": True or False, # If true, the sitemap has not been processed.
    115     "lastSubmitted": "A String", # Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
    116     "isSitemapsIndex": True or False, # If true, the sitemap is a collection of sitemaps.
    117     "lastDownloaded": "A String", # Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
    118     "path": "A String", # The url of the sitemap.
    119     "type": "A String", # The type of the sitemap. For example: rssFeed.
    120     "contents": [ # The various content types in the sitemap.
    121       { # Information about the various content types in the sitemap.
    122         "indexed": "A String", # The number of URLs from the sitemap that were indexed (of the content type).
    123         "type": "A String", # The specific type of content in this sitemap. For example: web.
    124         "submitted": "A String", # The number of URLs in the sitemap (of the content type).
    125       },
    126     ],
    127   }</pre>
    128 </div>
    129 
    130 <div class="method">
    131     <code class="details" id="list">list(siteUrl, sitemapIndex=None)</code>
    132   <pre>Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
    133 
    134 Args:
    135   siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
    136   sitemapIndex: string, A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml
    137 
    138 Returns:
    139   An object of the form:
    140 
    141     { # List of sitemaps.
    142     "sitemap": [ # Contains detailed information about a specific URL submitted as a sitemap.
    143       { # Contains detailed information about a specific URL submitted as a sitemap.
    144         "errors": "A String", # Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
    145         "warnings": "A String", # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
    146         "isPending": True or False, # If true, the sitemap has not been processed.
    147         "lastSubmitted": "A String", # Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
    148         "isSitemapsIndex": True or False, # If true, the sitemap is a collection of sitemaps.
    149         "lastDownloaded": "A String", # Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
    150         "path": "A String", # The url of the sitemap.
    151         "type": "A String", # The type of the sitemap. For example: rssFeed.
    152         "contents": [ # The various content types in the sitemap.
    153           { # Information about the various content types in the sitemap.
    154             "indexed": "A String", # The number of URLs from the sitemap that were indexed (of the content type).
    155             "type": "A String", # The specific type of content in this sitemap. For example: web.
    156             "submitted": "A String", # The number of URLs in the sitemap (of the content type).
    157           },
    158         ],
    159       },
    160     ],
    161   }</pre>
    162 </div>
    163 
    164 <div class="method">
    165     <code class="details" id="submit">submit(siteUrl, feedpath)</code>
    166   <pre>Submits a sitemap for a site.
    167 
    168 Args:
    169   siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
    170   feedpath: string, The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml (required)
    171 </pre>
    172 </div>
    173 
    174 </body></html>