REST Resource: urlNotifications

  • UrlNotification is the resource used for communicating URL updates and deletions to Google's Indexing API.

  • The UrlNotification object utilizes url, type, and notifyTime fields to provide details about web document events.

  • UrlNotificationType defines the specific event being communicated, such as URL updates (URL_UPDATED) or deletions (URL_DELETED).

  • The Indexing API provides methods for publishing URL notifications and retrieving web document metadata.

Resource: UrlNotification

UrlNotification is the resource used in all Indexing API calls. It describes one event in the life cycle of a Web Document.

JSON representation 
{
  "url": string,
  "type": enum(UrlNotificationType),
  "notifyTime": string
}
Fields
url

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.

type

enum(UrlNotificationType)

The URL life cycle event that Google is being notified about.

notifyTime

string (Timestamp format)

Creation timestamp for this notification. Users should not specify it, the field is ignored at the request time.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

UrlNotificationType

Specifies the different events that can happen to a given URL.

Enums
URL_NOTIFICATION_TYPE_UNSPECIFIED Unspecified.
URL_UPDATED The given URL (Web document) has been updated.
URL_DELETED The given URL (Web document) has been deleted.

Methods

getMetadata

 Gets metadata about a Web Document.

publish

 Notifies that a URL has been updated or deleted.