Blame - docs/dyn/indexing_v3.urlNotifications.html - platform/external/python/google-api-python-client

blob: d4c1e6517ca85173a35c2e17667ca0682225a323 [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -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="indexing_v3.html">Indexing API</a> . <a href="indexing_v3.urlNotifications.html">urlNotifications</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#getMetadata">getMetadata(url=None, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Gets metadata about a Web Document. This method can _only_ be used to query</p>
				80	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	81	<code><a href="#publish">publish(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Notifies that a URL has been updated or deleted.</p>
				83	<h3>Method Details</h3>
				84	<div class="method">
				85	<code class="details" id="getMetadata">getMetadata(url=None, x__xgafv=None)</code>
				86	<pre>Gets metadata about a Web Document. This method can _only_ be used to query
				87	URLs that were previously seen in successful Indexing API notifications.
				88	Includes the latest `UrlNotification` received via this API.
				89
				90	Args:
				91	url: string, URL that is being queried.
				92	x__xgafv: string, V1 error format.
				93	Allowed values
				94	1 - v1 error format
				95	2 - v2 error format
				96
				97	Returns:
				98	An object of the form:
				99
				100	{ # Summary of the most recent Indexing API notifications successfully received,
				101	# for a given URL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	102	"url": "A String", # URL to which this metadata refers.
				103	"latestRemove": { # `UrlNotification` is the resource used in all Indexing API calls. # Latest notification received with type `URL_REMOVED`.
				104	# It describes one event in the life cycle of a Web Document.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	105	"type": "A String", # The URL life cycle event that Google is being notified about.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	106	"url": "A String", # The object of this notification. The URL must be owned by the publisher
				107	# of this notification and, in case of `URL_UPDATED` notifications, it _must_
				108	# be crawlable by Google.
				109	"notifyTime": "A String", # Creation timestamp for this notification.
				110	# Users should _not_ specify it, the field is ignored at the request time.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	111	},
				112	"latestUpdate": { # `UrlNotification` is the resource used in all Indexing API calls. # Latest notification received with type `URL_UPDATED`.
				113	# It describes one event in the life cycle of a Web Document.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	114	"type": "A String", # The URL life cycle event that Google is being notified about.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	115	"url": "A String", # The object of this notification. The URL must be owned by the publisher
				116	# of this notification and, in case of `URL_UPDATED` notifications, it _must_
				117	# be crawlable by Google.
				118	"notifyTime": "A String", # Creation timestamp for this notification.
				119	# Users should _not_ specify it, the field is ignored at the request time.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	120	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	121	}</pre>
				122	</div>
				123
				124	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	125	<code class="details" id="publish">publish(body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	126	<pre>Notifies that a URL has been updated or deleted.
				127
				128	Args:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	129	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	130	The object takes the form of:
				131
				132	{ # `UrlNotification` is the resource used in all Indexing API calls.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	133	# It describes one event in the life cycle of a Web Document.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	134	"type": "A String", # The URL life cycle event that Google is being notified about.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	135	"url": "A String", # The object of this notification. The URL must be owned by the publisher
				136	# of this notification and, in case of `URL_UPDATED` notifications, it _must_
				137	# be crawlable by Google.
				138	"notifyTime": "A String", # Creation timestamp for this notification.
				139	# Users should _not_ specify it, the field is ignored at the request time.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	140	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	141
				142	x__xgafv: string, V1 error format.
				143	Allowed values
				144	1 - v1 error format
				145	2 - v2 error format
				146
				147	Returns:
				148	An object of the form:
				149
				150	{ # Output for PublishUrlNotification
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	151	"urlNotificationMetadata": { # Summary of the most recent Indexing API notifications successfully received, # Description of the notification events received for this URL.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	152	# for a given URL.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	153	"url": "A String", # URL to which this metadata refers.
				154	"latestRemove": { # `UrlNotification` is the resource used in all Indexing API calls. # Latest notification received with type `URL_REMOVED`.
				155	# It describes one event in the life cycle of a Web Document.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	156	"type": "A String", # The URL life cycle event that Google is being notified about.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	157	"url": "A String", # The object of this notification. The URL must be owned by the publisher
				158	# of this notification and, in case of `URL_UPDATED` notifications, it _must_
				159	# be crawlable by Google.
				160	"notifyTime": "A String", # Creation timestamp for this notification.
				161	# Users should _not_ specify it, the field is ignored at the request time.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	162	},
				163	"latestUpdate": { # `UrlNotification` is the resource used in all Indexing API calls. # Latest notification received with type `URL_UPDATED`.
				164	# It describes one event in the life cycle of a Web Document.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	165	"type": "A String", # The URL life cycle event that Google is being notified about.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	166	"url": "A String", # The object of this notification. The URL must be owned by the publisher
				167	# of this notification and, in case of `URL_UPDATED` notifications, it _must_
				168	# be crawlable by Google.
				169	"notifyTime": "A String", # Creation timestamp for this notification.
				170	# Users should _not_ specify it, the field is ignored at the request time.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	171	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	172	},
				173	}</pre>
				174	</div>
				175
				176	</body></html>