blob: 9fc13cfcc4e8609b103b84e6cd67e1070b6c25c7 [file] [log] [blame]
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080075<h1><a href="webmasters_v3.html">Search Console API</a> . <a href="webmasters_v3.sitemaps.html">sitemaps</a></h1>
Craig Citro0e5b9bf2014-10-15 10:26:14 -070076<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>
Takashi Matsuo06694102015-09-11 13:55:40 -070085<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>
Craig Citro0e5b9bf2014-10-15 10:26:14 -070086<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
94Args:
Bu Sun Kim65020912020-05-20 12:08:20 -070095 siteUrl: string, The site&#x27;s URL, including protocol. For example: http://www.example.com/ (required)
Takashi Matsuo06694102015-09-11 13:55:40 -070096 feedpath: string, The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -070097</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
104Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700105 siteUrl: string, The site&#x27;s URL, including protocol. For example: http://www.example.com/ (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700106 feedpath: string, The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700107
108Returns:
109 An object of the form:
110
Takashi Matsuo06694102015-09-11 13:55:40 -0700111 { # Contains detailed information about a specific URL submitted as a sitemap.
Bu Sun Kim65020912020-05-20 12:08:20 -0700112 &quot;contents&quot;: [ # The various content types in the sitemap.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700113 { # Information about the various content types in the sitemap.
Bu Sun Kim65020912020-05-20 12:08:20 -0700114 &quot;indexed&quot;: &quot;A String&quot;, # The number of URLs from the sitemap that were indexed (of the content type).
115 &quot;submitted&quot;: &quot;A String&quot;, # The number of URLs in the sitemap (of the content type).
116 &quot;type&quot;: &quot;A String&quot;, # The specific type of content in this sitemap. For example: web.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700117 },
118 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700119 &quot;errors&quot;: &quot;A String&quot;, # Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
120 &quot;isPending&quot;: True or False, # If true, the sitemap has not been processed.
121 &quot;isSitemapsIndex&quot;: True or False, # If true, the sitemap is a collection of sitemaps.
122 &quot;lastDownloaded&quot;: &quot;A String&quot;, # Date &amp; time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
123 &quot;lastSubmitted&quot;: &quot;A String&quot;, # Date &amp; time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
124 &quot;path&quot;: &quot;A String&quot;, # The url of the sitemap.
125 &quot;type&quot;: &quot;A String&quot;, # The type of the sitemap. For example: rssFeed.
126 &quot;warnings&quot;: &quot;A String&quot;, # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700127 }</pre>
128</div>
129
130<div class="method">
131 <code class="details" id="list">list(siteUrl, sitemapIndex=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700132 <pre>Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700133
134Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700135 siteUrl: string, The site&#x27;s URL, including protocol. For example: http://www.example.com/ (required)
136 sitemapIndex: string, A URL of a site&#x27;s sitemap index. For example: http://www.example.com/sitemapindex.xml
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700137
138Returns:
139 An object of the form:
140
141 { # List of sitemaps.
Bu Sun Kim65020912020-05-20 12:08:20 -0700142 &quot;sitemap&quot;: [ # Contains detailed information about a specific URL submitted as a sitemap.
Takashi Matsuo06694102015-09-11 13:55:40 -0700143 { # Contains detailed information about a specific URL submitted as a sitemap.
Bu Sun Kim65020912020-05-20 12:08:20 -0700144 &quot;contents&quot;: [ # The various content types in the sitemap.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700145 { # Information about the various content types in the sitemap.
Bu Sun Kim65020912020-05-20 12:08:20 -0700146 &quot;indexed&quot;: &quot;A String&quot;, # The number of URLs from the sitemap that were indexed (of the content type).
147 &quot;submitted&quot;: &quot;A String&quot;, # The number of URLs in the sitemap (of the content type).
148 &quot;type&quot;: &quot;A String&quot;, # The specific type of content in this sitemap. For example: web.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700149 },
150 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700151 &quot;errors&quot;: &quot;A String&quot;, # Number of errors in the sitemap. These are issues with the sitemap itself that need to be fixed before it can be processed correctly.
152 &quot;isPending&quot;: True or False, # If true, the sitemap has not been processed.
153 &quot;isSitemapsIndex&quot;: True or False, # If true, the sitemap is a collection of sitemaps.
154 &quot;lastDownloaded&quot;: &quot;A String&quot;, # Date &amp; time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
155 &quot;lastSubmitted&quot;: &quot;A String&quot;, # Date &amp; time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
156 &quot;path&quot;: &quot;A String&quot;, # The url of the sitemap.
157 &quot;type&quot;: &quot;A String&quot;, # The type of the sitemap. For example: rssFeed.
158 &quot;warnings&quot;: &quot;A String&quot;, # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700159 },
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
168Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700169 siteUrl: string, The site&#x27;s URL, including protocol. For example: http://www.example.com/ (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700170 feedpath: string, The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700171</pre>
172</div>
173
174</body></html>