リアルタイム通知を管理する

My Business Notifications API では、通知は Cloud Pub/Sub サービスで公開されます。Cloud Pub/Sub を設定してトピックを作成したら、通知に対して次のオペレーションを実行できます。

新規または更新されたクチコミ、質問と回答、メディアのアップロード、審査のための Google による変更、ビジネスのステータスの変更などがサポートされています。NotificationType オブジェクトは、使用可能な通知タイプのリストと説明を示します。

始める前に

My Business Notifications API を使用するには、アプリケーションを登録し、OAuth 2.0 認証情報を取得します。API の使用方法について詳しくは、基本設定をご覧ください。

Cloud Pub/Sub のセットアップ

Cloud Pub/Sub で API 通知を設定するには、次の手順を行います。

  1. Cloud Pub/Sub ガイドに沿って、アプリケーションを設定します。
  2. Cloud Pub/Sub プロジェクトでトピックを作成し、トピックの名前をメモします。
  3. pubsub.topics.publish 以上の権限を mybusiness-api-pubsub@system.gserviceaccount.com に付与します。
  4. サブスクライバーの概要ガイドに沿って、プッシュ通知または pull 通知を設定します。
  5. 通知を受け取るには、My Business Notifications API の accounts.updateNotificationSetting エンドポイントを呼び出します。この呼び出しでは、Cloud Pub/Sub で作成したトピック名を使用して、ビジネス プロフィール アカウントとトピックをリンクします。
  6. （省略可）通知を受け取るビジネス プロフィール アカウントごとに、ステップ 5 を繰り返します。

通知設定を取得する

accounts.getNotificationSetting エンドポイントは、アカウントの現在の Cloud Pub/Sub 通知設定を返します。次の表に呼び出し方法を示します。

HTTP
GET
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting

通知設定を更新する

accounts.updateNotificationSetting エンドポイントは、アカウントに関連付けられている Cloud Pub/Sub 通知設定を更新します。次の表に呼び出し方法を示します。

HTTP
PATCH
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask={commaSeparatedFieldsToUpdate}

{
  pubsubTopic: your/pubsub/topicName
}

通知設定を削除する

空の pubsubTopic を使用して accounts.updateNotificationSetting を呼び出すと、アカウントから Cloud Pub/Sub 通知設定が削除されます。次の表に呼び出し方法を示します。

HTTP
PATCH
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask=pubsubTopic