# Package google.indexing.v3

## Index

- `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.UrlService` (interface)
- `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.GetUrlNotificationMetadataRequest` (message)
- `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.PublishUrlNotificationRequest` (message)
- `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.PublishUrlNotificationResponse` (message)
- `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.UrlNotification` (message)
- `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.UrlNotificationMetadata` (message)
- `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.UrlNotificationType` (enum)

## UrlService

Allows web developers to notify Google about state changes in the URLs they own.

| GetUrlNotificationMetadata ||
|---|---|
| `` rpc GetUrlNotificationMetadata(`https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.GetUrlNotificationMetadataRequest`) returns (`https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.UrlNotificationMetadata`) `` 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. Authorization Scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/indexing` |

| PublishUrlNotification ||
|---|---|
| `` rpc PublishUrlNotification(`https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.PublishUrlNotificationRequest`) returns (`https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.PublishUrlNotificationResponse`) `` Notifies that a URL has been updated or deleted. Authorization Scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/indexing` |

## GetUrlNotificationMetadataRequest

Input for GetUrlNotificationMetadata call.

| Fields ||
|---|---|
| `url` | `string` URL that is being queried. |

## PublishUrlNotificationRequest

Input for PublishUrlNotification

| Fields ||
|---|---|
| `url_notification` | `` `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.UrlNotification` `` Description of the URL event that is being notified. |

## PublishUrlNotificationResponse

Output for PublishUrlNotification

| Fields ||
|---|---|
| `url_notification_metadata` | `` `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.UrlNotificationMetadata` `` Description of the notification events received for this URL. |

## UrlNotification

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

| 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` | `` `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.UrlNotificationType` `` The URL life cycle event that Google is being notified about. |
| `notify_time` | `` `https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` `` Creation timestamp for this notification. Users should *not* specify it, the field is ignored at the request time. |

## UrlNotificationMetadata

Summary of the most recent Indexing API notifications successfully received, for a given URL.

| Fields ||
|---|---|
| `url` | `string` URL to which this metadata refers. |
| `latest_update` | `` `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.UrlNotification` `` Latest notification received with type `URL_UPDATED`. |
| `latest_remove` | `` `https://developers.google.com/search/apis/indexing-api/v3/reference/indexing/rpc/google.indexing.v3#google.indexing.v3.UrlNotification` `` Latest notification received with type `URL_REMOVED`. |

## 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. |