Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / indexing_v3.urlNotifications.html
blob: 639ef8f4f106bd8215122a85c02f4b411ac3b7c9 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]1<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
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">
81 <code><a href="#publish">publish(body, x__xgafv=None)</a></code></p>
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
87URLs that were previously seen in successful Indexing API notifications.
88Includes the latest `UrlNotification` received via this API.
89
90Args:
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
97Returns:
98 An object of the form:
99
100 { # Summary of the most recent Indexing API notifications successfully received,
101 # for a given URL.
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.
105 "url": "A String", # The object of this notification. The URL must be owned by the publisher
106 # of this notification and, in case of `URL_UPDATED` notifications, it _must_
107 # be crawlable by Google.
108 "notifyTime": "A String", # Creation timestamp for this notification.
109 # Users should _not_ specify it, the field is ignored at the request time.
110 "type": "A String", # The URL life cycle event that Google is being notified about.
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.
114 "url": "A String", # The object of this notification. The URL must be owned by the publisher
115 # of this notification and, in case of `URL_UPDATED` notifications, it _must_
116 # be crawlable by Google.
117 "notifyTime": "A String", # Creation timestamp for this notification.
118 # Users should _not_ specify it, the field is ignored at the request time.
119 "type": "A String", # The URL life cycle event that Google is being notified about.
120 },
121 }</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="publish">publish(body, x__xgafv=None)</code>
126 <pre>Notifies that a URL has been updated or deleted.
127
128Args:
129 body: object, The request body. (required)
130 The object takes the form of:
131
132{ # `UrlNotification` is the resource used in all Indexing API calls.
133 # It describes one event in the life cycle of a Web Document.
134 "url": "A String", # The object of this notification. The URL must be owned by the publisher
135 # of this notification and, in case of `URL_UPDATED` notifications, it _must_
136 # be crawlable by Google.
137 "notifyTime": "A String", # Creation timestamp for this notification.
138 # Users should _not_ specify it, the field is ignored at the request time.
139 "type": "A String", # The URL life cycle event that Google is being notified about.
140}
141
142 x__xgafv: string, V1 error format.
143 Allowed values
144 1 - v1 error format
145 2 - v2 error format
146
147Returns:
148 An object of the form:
149
150 { # Output for PublishUrlNotification
151 "urlNotificationMetadata": { # Summary of the most recent Indexing API notifications successfully received, # Description of the notification events received for this URL.
152 # for a given URL.
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.
156 "url": "A String", # The object of this notification. The URL must be owned by the publisher
157 # of this notification and, in case of `URL_UPDATED` notifications, it _must_
158 # be crawlable by Google.
159 "notifyTime": "A String", # Creation timestamp for this notification.
160 # Users should _not_ specify it, the field is ignored at the request time.
161 "type": "A String", # The URL life cycle event that Google is being notified about.
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.
165 "url": "A String", # The object of this notification. The URL must be owned by the publisher
166 # of this notification and, in case of `URL_UPDATED` notifications, it _must_
167 # be crawlable by Google.
168 "notifyTime": "A String", # Creation timestamp for this notification.
169 # Users should _not_ specify it, the field is ignored at the request time.
170 "type": "A String", # The URL life cycle event that Google is being notified about.
171 },
172 },
173 }</pre>
174</div>
175
176</body></html>