Blame - docs/dyn/webmasters_v3.sitemaps.html - platform/external/python/google-api-python-client

blob: eb71f38d8ed0a10fcb5b684791331a02908c8e4a [file] [log] [blame]

Craig Citro	0e5b9bf	2014-10-15 10:26:14 -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
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	75	<h1><a href="webmasters_v3.html">Search Console API</a> . <a href="webmasters_v3.sitemaps.html">sitemaps</a></h1>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	81	<code><a href="#delete">delete(siteUrl, feedpath)</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)</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)</a></code></p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	88	<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 Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	89	<p class="toc_element">
				90	<code><a href="#submit">submit(siteUrl, feedpath)</a></code></p>
				91	<p class="firstline">Submits a sitemap for a site.</p>
				92	<h3>Method Details</h3>
				93	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	94	<code class="details" id="close">close()</code>
				95	<pre>Close httplib2 connections.</pre>
				96	</div>
				97
				98	<div class="method">
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	99	<code class="details" id="delete">delete(siteUrl, feedpath)</code>
				100	<pre>Deletes a sitemap from this site.
				101
				102	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	103	siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	104	feedpath: string, The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml (required)
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	105	</pre>
				106	</div>
				107
				108	<div class="method">
				109	<code class="details" id="get">get(siteUrl, feedpath)</code>
				110	<pre>Retrieves information about a specific sitemap.
				111
				112	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	113	siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	114	feedpath: string, The URL of the actual sitemap. For example: http://www.example.com/sitemap.xml (required)
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	115
				116	Returns:
				117	An object of the form:
				118
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	119	{ # Contains detailed information about a specific URL submitted as a sitemap.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	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	"submitted": "A String", # The number of URLs in the sitemap (of the content type).
				124	"type": "A String", # The specific type of content in this sitemap. For example: web.
				125	},
				126	],
				127	"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.
				128	"isPending": True or False, # If true, the sitemap has not been processed.
				129	"isSitemapsIndex": True or False, # If true, the sitemap is a collection of sitemaps.
				130	"lastDownloaded": "A String", # Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
				131	"lastSubmitted": "A String", # Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
				132	"path": "A String", # The url of the sitemap.
				133	"type": "A String", # The type of the sitemap. For example: rssFeed.
				134	"warnings": "A String", # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
				135	}</pre>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	136	</div>
				137
				138	<div class="method">
				139	<code class="details" id="list">list(siteUrl, sitemapIndex=None)</code>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	140	<pre>Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	141
				142	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	143	siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
				144	sitemapIndex: string, A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	145
				146	Returns:
				147	An object of the form:
				148
				149	{ # List of sitemaps.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	150	"sitemap": [ # Contains detailed information about a specific URL submitted as a sitemap.
				151	{ # Contains detailed information about a specific URL submitted as a sitemap.
				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	"submitted": "A String", # The number of URLs in the sitemap (of the content type).
				156	"type": "A String", # The specific type of content in this sitemap. For example: web.
				157	},
				158	],
				159	"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.
				160	"isPending": True or False, # If true, the sitemap has not been processed.
				161	"isSitemapsIndex": True or False, # If true, the sitemap is a collection of sitemaps.
				162	"lastDownloaded": "A String", # Date & time in which this sitemap was last downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
				163	"lastSubmitted": "A String", # Date & time in which this sitemap was submitted. Date format is in RFC 3339 format (yyyy-mm-dd).
				164	"path": "A String", # The url of the sitemap.
				165	"type": "A String", # The type of the sitemap. For example: rssFeed.
				166	"warnings": "A String", # Number of warnings for the sitemap. These are generally non-critical issues with URLs in the sitemaps.
				167	},
				168	],
				169	}</pre>
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	170	</div>
				171
				172	<div class="method">
				173	<code class="details" id="submit">submit(siteUrl, feedpath)</code>
				174	<pre>Submits a sitemap for a site.
				175
				176	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	177	siteUrl: string, The site's URL, including protocol. For example: http://www.example.com/ (required)
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	178	feedpath: string, The URL of the sitemap to add. For example: http://www.example.com/sitemap.xml (required)
Craig Citro	0e5b9bf	2014-10-15 10:26:14 -0700	[diff] [blame]	179	</pre>
				180	</div>
				181
				182	</body></html>