Indexing API . urlNotifications

Instance Methods

getMetadata(url=None, x__xgafv=None)

Gets metadata about a Web Document. This method can _only_ be used to query

publish(body, x__xgafv=None)

Notifies that a URL has been updated or deleted.

Method Details

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.
    "url": "A String", # URL to which this metadata refers.
    "latestRemove": { # `UrlNotification` is the resource used in all Indexing API calls. # Latest notification received with type `URL_REMOVED`.
        # It describes one event in the life cycle of a Web Document.
      "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.
      "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.
    },
    "latestUpdate": { # `UrlNotification` is the resource used in all Indexing API calls. # Latest notification received with type `URL_UPDATED`.
        # It describes one event in the life cycle of a Web Document.
      "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.
      "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.
    },
  }
publish(body, x__xgafv=None)
Notifies that a URL has been updated or deleted.

Args:
  body: object, The request body. (required)
    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.
  "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.
  "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.
}

  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, # Description of the notification events received for this URL.
        # for a given URL.
      "url": "A String", # URL to which this metadata refers.
      "latestRemove": { # `UrlNotification` is the resource used in all Indexing API calls. # Latest notification received with type `URL_REMOVED`.
          # It describes one event in the life cycle of a Web Document.
        "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.
        "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.
      },
      "latestUpdate": { # `UrlNotification` is the resource used in all Indexing API calls. # Latest notification received with type `URL_UPDATED`.
          # It describes one event in the life cycle of a Web Document.
        "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.
        "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.
      },
    },
  }