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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#getMetadata">getMetadata(url=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets metadata about a Web Document. This method can _only_ be used to query URLs that were previously seen in successful Indexing API notifications. Includes the latest `UrlNotification` received via this API.</p> 83<p class="toc_element"> 84 <code><a href="#publish">publish(body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Notifies that a URL has been updated or deleted.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="close">close()</code> 89 <pre>Close httplib2 connections.</pre> 90</div> 91 92<div class="method"> 93 <code class="details" id="getMetadata">getMetadata(url=None, x__xgafv=None)</code> 94 <pre>Gets metadata about a Web Document. This method can _only_ be used to query URLs that were previously seen in successful Indexing API notifications. Includes the latest `UrlNotification` received via this API. 95 96Args: 97 url: string, URL that is being queried. 98 x__xgafv: string, V1 error format. 99 Allowed values 100 1 - v1 error format 101 2 - v2 error format 102 103Returns: 104 An object of the form: 105 106 { # Summary of the most recent Indexing API notifications successfully received, for a given URL. 107 "latestRemove": { # `UrlNotification` is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document. # Latest notification received with type `URL_REMOVED`. 108 "notifyTime": "A String", # Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time. 109 "type": "A String", # The URL life cycle event that Google is being notified about. 110 "url": "A String", # The object of this notification. The URL must be owned by the publisher of this notification and, in case of `URL_UPDATED` notifications, it _must_ be crawlable by Google. 111 }, 112 "latestUpdate": { # `UrlNotification` is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document. # Latest notification received with type `URL_UPDATED`. 113 "notifyTime": "A String", # Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time. 114 "type": "A String", # The URL life cycle event that Google is being notified about. 115 "url": "A String", # The object of this notification. The URL must be owned by the publisher of this notification and, in case of `URL_UPDATED` notifications, it _must_ be crawlable by Google. 116 }, 117 "url": "A String", # URL to which this metadata refers. 118}</pre> 119</div> 120 121<div class="method"> 122 <code class="details" id="publish">publish(body=None, x__xgafv=None)</code> 123 <pre>Notifies that a URL has been updated or deleted. 124 125Args: 126 body: object, The request body. 127 The object takes the form of: 128 129{ # `UrlNotification` is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document. 130 "notifyTime": "A String", # Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time. 131 "type": "A String", # The URL life cycle event that Google is being notified about. 132 "url": "A String", # The object of this notification. The URL must be owned by the publisher of this notification and, in case of `URL_UPDATED` notifications, it _must_ be crawlable by Google. 133} 134 135 x__xgafv: string, V1 error format. 136 Allowed values 137 1 - v1 error format 138 2 - v2 error format 139 140Returns: 141 An object of the form: 142 143 { # Output for PublishUrlNotification 144 "urlNotificationMetadata": { # Summary of the most recent Indexing API notifications successfully received, for a given URL. # Description of the notification events received for this URL. 145 "latestRemove": { # `UrlNotification` is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document. # Latest notification received with type `URL_REMOVED`. 146 "notifyTime": "A String", # Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time. 147 "type": "A String", # The URL life cycle event that Google is being notified about. 148 "url": "A String", # The object of this notification. The URL must be owned by the publisher of this notification and, in case of `URL_UPDATED` notifications, it _must_ be crawlable by Google. 149 }, 150 "latestUpdate": { # `UrlNotification` is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document. # Latest notification received with type `URL_UPDATED`. 151 "notifyTime": "A String", # Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time. 152 "type": "A String", # The URL life cycle event that Google is being notified about. 153 "url": "A String", # The object of this notification. The URL must be owned by the publisher of this notification and, in case of `URL_UPDATED` notifications, it _must_ be crawlable by Google. 154 }, 155 "url": "A String", # URL to which this metadata refers. 156 }, 157}</pre> 158</div> 159 160</body></html>