パッケージ google.indexing.v3

目次

• UrlService（インターフェース）
• GetUrlNotificationMetadataRequest（メッセージ）
• PublishUrlNotificationRequest（メッセージ）
• PublishUrlNotificationResponse（メッセージ）
• UrlNotification（メッセージ）
• UrlNotificationMetadata（メッセージ）
• UrlNotificationType（列挙型）

UrlService

ウェブ デベロッパーは、所有している URL の状態の変化について Google に通知できます。

GetUrlNotificationMetadata
rpc GetUrlNotificationMetadata(GetUrlNotificationMetadataRequest) returns (UrlNotificationMetadata) ウェブ ドキュメントに関するメタデータを取得します。このメソッドは、正常な Indexing API 通知で以前に参照した URL を照会する場合にのみ使用できます。この API を介して受信した最近の UrlNotification を含めます。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/indexing

PublishUrlNotification
rpc PublishUrlNotification(PublishUrlNotificationRequest) returns (PublishUrlNotificationResponse) URL が更新または削除されたことを通知します。 承認スコープ 次の OAuth スコープが必要です。 https://www.googleapis.com/auth/indexing

GetUrlNotificationMetadataRequest

GetUrlNotificationMetadata の呼び出しの入力。

フィールド
url	string 照会中の URL。

PublishUrlNotificationRequest

PublishUrlNotification の入力。

フィールド
url_notification	UrlNotification 通知されている URL イベントの説明。

PublishUrlNotificationResponse

PublishUrlNotification の出力。

フィールド
url_notification_metadata	UrlNotificationMetadata この URL に関して受信した通知イベントの説明。

UrlNotification

UrlNotification は Indexing API のすべての呼び出しで使用されるリソースです。ウェブ ドキュメントのライフサイクル内にイベントを 1 つ記述します。

フィールド
url	string この通知のオブジェクト。URL はこの通知の送信者が所有している必要があり、URL_UPDATED 通知の場合は、Google がクロールできる必要があります。
type	UrlNotificationType Google に通知されている URL ライフサイクル イベント。
notify_time	Timestamp この通知の作成タイムスタンプ。ユーザーが指定する必要はありません。このフィールドはリクエストの際に無視されます。

UrlNotificationMetadata

正常に受信した、特定の URL に関する最近の Indexing API 通知の概要。

フィールド
url	string このメタデータが参照する URL。
latest_update	UrlNotification 受信済みの最近の通知（タイプ: URL_UPDATED）。
latest_remove	UrlNotification 受信済みの最近の通知（タイプ: URL_REMOVED）。

UrlNotificationType

指定された URL に対して実行される可能性がある各種イベントを指定します。

列挙型
URL_NOTIFICATION_TYPE_UNSPECIFIED	（指定なし）
URL_UPDATED	指定された URL（ウェブ ドキュメント）が更新されました。
URL_DELETED	指定された URL（ウェブ ドキュメント）が削除されました。