| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 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.sitemaps.html">sitemaps</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="#delete">delete(siteUrl, feedpath, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes a sitemap from this site.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(siteUrl, feedpath, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Retrieves information about a specific sitemap.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(siteUrl, sitemapIndex=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline"> Lists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request).</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#submit">submit(siteUrl, feedpath, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Submits a sitemap for a site.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| 94 | <code class="details" id="close">close()</code> |
| 95 | <pre>Close httplib2 connections.</pre> |
| 96 | </div> |
| 97 | |
| 98 | <div class="method"> |
| 99 | <code class="details" id="delete">delete(siteUrl, feedpath, x__xgafv=None)</code> |
| 100 | <pre>Deletes a sitemap from this site. |
| 101 | |
| 102 | Args: |
| 103 | siteUrl: string, The site's URL, including protocol. For example: `http://www.example.com/`. (required) |
| 104 | feedpath: string, The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`. (required) |
| 105 | x__xgafv: string, V1 error format. |
| 106 | Allowed values |
| 107 | 1 - v1 error format |
| 108 | 2 - v2 error format |
| 109 | </pre> |
| 110 | </div> |
| 111 | |
| 112 | <div class="method"> |
| 113 | <code class="details" id="get">get(siteUrl, feedpath, x__xgafv=None)</code> |
| 114 | <pre>Retrieves information about a specific sitemap. |
| 115 | |
| 116 | Args: |
| 117 | siteUrl: string, The site's URL, including protocol. For example: `http://www.example.com/`. (required) |
| 118 | feedpath: string, The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`. (required) |
| 119 | x__xgafv: string, V1 error format. |
| 120 | Allowed values |
| 121 | 1 - v1 error format |
| 122 | 2 - v2 error format |
| 123 | |
| 124 | Returns: |
| 125 | An object of the form: |
| 126 | |
| 127 | { # Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 128 | "contents": [ # The various content types in the sitemap. |
| 129 | { # Information about the various content types in the sitemap. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 130 | "indexed": "A String", # *Deprecated; do not use.* |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 131 | "submitted": "A String", # The number of URLs in the sitemap (of the content type). |
| 132 | "type": "A String", # The specific type of content in this sitemap. For example: `web`. |
| 133 | }, |
| 134 | ], |
| 135 | "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. |
| 136 | "isPending": True or False, # If true, the sitemap has not been processed. |
| 137 | "isSitemapsIndex": True or False, # If true, the sitemap is a collection of sitemaps. |
| 138 | "lastDownloaded": "A String", # Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd). |
| 139 | "lastSubmitted": "A String", # Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd). |
| 140 | "path": "A String", # The url of the sitemap. |
| 141 | "type": "A String", # The type of the sitemap. For example: `rssFeed`. |
| 142 | "warnings": "A String", # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps. |
| 143 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 144 | </div> |
| 145 | |
| 146 | <div class="method"> |
| 147 | <code class="details" id="list">list(siteUrl, sitemapIndex=None, x__xgafv=None)</code> |
| 148 | <pre> Lists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the request). |
| 149 | |
| 150 | Args: |
| 151 | siteUrl: string, The site's URL, including protocol. For example: `http://www.example.com/`. (required) |
| 152 | sitemapIndex: string, A URL of a site's sitemap index. For example: `http://www.example.com/sitemapindex.xml`. |
| 153 | x__xgafv: string, V1 error format. |
| 154 | Allowed values |
| 155 | 1 - v1 error format |
| 156 | 2 - v2 error format |
| 157 | |
| 158 | Returns: |
| 159 | An object of the form: |
| 160 | |
| 161 | { # List of sitemaps. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 162 | "sitemap": [ # Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184). |
| 163 | { # Contains detailed information about a specific URL submitted as a [sitemap](https://support.google.com/webmasters/answer/156184). |
| 164 | "contents": [ # The various content types in the sitemap. |
| 165 | { # Information about the various content types in the sitemap. |
| yoshi-code-bot | 2da5ed1 | 2021-09-07 00:20:27 -0700 | [diff] [blame] | 166 | "indexed": "A String", # *Deprecated; do not use.* |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 167 | "submitted": "A String", # The number of URLs in the sitemap (of the content type). |
| 168 | "type": "A String", # The specific type of content in this sitemap. For example: `web`. |
| 169 | }, |
| 170 | ], |
| 171 | "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. |
| 172 | "isPending": True or False, # If true, the sitemap has not been processed. |
| 173 | "isSitemapsIndex": True or False, # If true, the sitemap is a collection of sitemaps. |
| 174 | "lastDownloaded": "A String", # Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd). |
| 175 | "lastSubmitted": "A String", # Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd). |
| 176 | "path": "A String", # The url of the sitemap. |
| 177 | "type": "A String", # The type of the sitemap. For example: `rssFeed`. |
| 178 | "warnings": "A String", # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps. |
| 179 | }, |
| 180 | ], |
| 181 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 182 | </div> |
| 183 | |
| 184 | <div class="method"> |
| 185 | <code class="details" id="submit">submit(siteUrl, feedpath, x__xgafv=None)</code> |
| 186 | <pre>Submits a sitemap for a site. |
| 187 | |
| 188 | Args: |
| 189 | siteUrl: string, The site's URL, including protocol. For example: `http://www.example.com/`. (required) |
| 190 | feedpath: string, The URL of the actual sitemap. For example: `http://www.example.com/sitemap.xml`. (required) |
| 191 | x__xgafv: string, V1 error format. |
| 192 | Allowed values |
| 193 | 1 - v1 error format |
| 194 | 2 - v2 error format |
| 195 | </pre> |
| 196 | </div> |
| 197 | |
| 198 | </body></html> |