Web Search Indexing API . urlNotifications

Instance Methods

close()

Close httplib2 connections.

getMetadata(url=None, x__xgafv=None)

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.

publish(body=None, x__xgafv=None)

Notifies that a URL has been updated or deleted.

Method Details

close()
Close httplib2 connections.
getMetadata(url=None, x__xgafv=None)
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.

Args:
  url: string, URL that is being queried.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Summary of the most recent Indexing API notifications successfully received, for a given URL.
  "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`.
    "notifyTime": "A String", # Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time.
    "type": "A String", # The URL life cycle event that Google is being notified about.
    "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.
  },
  "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`.
    "notifyTime": "A String", # Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time.
    "type": "A String", # The URL life cycle event that Google is being notified about.
    "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.
  },
  "url": "A String", # URL to which this metadata refers.
}
publish(body=None, x__xgafv=None)
Notifies that a URL has been updated or deleted.

Args:
  body: object, The request body.
    The object takes the form of:

{ # `UrlNotification` is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document.
  "notifyTime": "A String", # Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time.
  "type": "A String", # The URL life cycle event that Google is being notified about.
  "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.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Output for PublishUrlNotification
  "urlNotificationMetadata": { # Summary of the most recent Indexing API notifications successfully received, for a given URL. # Description of the notification events received for this URL.
    "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`.
      "notifyTime": "A String", # Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time.
      "type": "A String", # The URL life cycle event that Google is being notified about.
      "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.
    },
    "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`.
      "notifyTime": "A String", # Creation timestamp for this notification. Users should _not_ specify it, the field is ignored at the request time.
      "type": "A String", # The URL life cycle event that Google is being notified about.
      "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.
    },
    "url": "A String", # URL to which this metadata refers.
  },
}