1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
<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.sitemaps.html">sitemaps</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(siteUrl, feedpath)</a></code></p>
<p class="firstline">Deletes a sitemap from this site.</p>
<p class="toc_element">
<code><a href="#get">get(siteUrl, feedpath)</a></code></p>
<p class="firstline">Retrieves information about a specific sitemap.</p>
<p class="toc_element">
<code><a href="#list">list(siteUrl, sitemapIndex=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#submit">submit(siteUrl, feedpath)</a></code></p>
<p class="firstline">Submits a sitemap for a site.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(siteUrl, feedpath)</code>
<pre>Deletes a sitemap from this site.
Args:
siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
feedpath: string, The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(siteUrl, feedpath)</code>
<pre>Retrieves information about a specific sitemap.
Args:
siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
feedpath: string, The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml (required)
Returns:
An object of the form:
{ # Contains detailed information about a specific URL submitted as a sitemap.
"contents": [ # The various content types in the sitemap.
{ # Information about the various content types in the sitemap.
"indexed": "A String", # The number of URLs from the sitemap that were indexed (of the content type).
"submitted": "A String", # The number of URLs in the sitemap (of the content type).
"type": "A String", # The specific type of content in this sitemap. For example: web.
},
],
"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.
"isPending": True or False, # If true, the sitemap has not been processed.
"isSitemapsIndex": True or False, # If true, the sitemap is a collection of sitemaps.
"lastDownloaded": "A String", # Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
"lastSubmitted": "A String", # Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
"path": "A String", # The url of the sitemap.
"type": "A String", # The type of the sitemap. For example: rssFeed.
"warnings": "A String", # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(siteUrl, sitemapIndex=None)</code>
<pre>Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
Args:
siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
sitemapIndex: string, A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml
Returns:
An object of the form:
{ # List of sitemaps.
"sitemap": [ # Contains detailed information about a specific URL submitted as a sitemap.
{ # Contains detailed information about a specific URL submitted as a sitemap.
"contents": [ # The various content types in the sitemap.
{ # Information about the various content types in the sitemap.
"indexed": "A String", # The number of URLs from the sitemap that were indexed (of the content type).
"submitted": "A String", # The number of URLs in the sitemap (of the content type).
"type": "A String", # The specific type of content in this sitemap. For example: web.
},
],
"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.
"isPending": True or False, # If true, the sitemap has not been processed.
"isSitemapsIndex": True or False, # If true, the sitemap is a collection of sitemaps.
"lastDownloaded": "A String", # Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
"lastSubmitted": "A String", # Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
"path": "A String", # The url of the sitemap.
"type": "A String", # The type of the sitemap. For example: rssFeed.
"warnings": "A String", # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="submit">submit(siteUrl, feedpath)</code>
<pre>Submits a sitemap for a site.
Args:
siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
feedpath: string, The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml (required)
</pre>
</div>
</body></html>
|
