My Business Notifications API では、通知は Cloud Pub/Sub サービスで公開されます。Cloud Pub/Sub を設定してトピックを作成したら、通知に関して次の操作を行えます。
新しいクチコミまたは更新されたクチコミ、質問と回答、メディア アップロード、確認が必要な Google による変更、ビジネス情報ステータスの変更などがサポートされています。 NotificationType オブジェクトでは、使用可能な通知タイプのリストと説明が提供されます。
始める前に
My Business Notifications API を使用するには、アプリケーションを登録して、OAuth 2.0 の認証情報を取得する必要があります。Business Profile API の使用方法について詳しくは、基本セットアップをご覧ください。
Cloud Pub/Sub のセットアップ
Cloud Pub/Sub で API 通知を設定するには、次の手順を行います。
- Cloud Pub/Sub のガイドに沿って、アプリケーションを設定します。
- Cloud Pub/Sub のプロジェクトでトピックを作成し、トピックの名前を書き留めます。
pubsub.topics.publish権限以上の権限を mybusiness-api-pubsub@system.gserviceaccount.com に付与します。- サブスクライバーの概要のガイドに沿ってプッシュ通知またはプル通知を設定します。
- 通知を受け取るには、My Business Notifications API の
accounts.updateNotificationSettingエンドポイントを呼び出します。この呼び出しで、Cloud Pub/Sub で作成したトピック名を使用してビジネス プロフィール アカウントをトピックにリンクします。 - （任意）通知を受け取るビジネス プロフィール アカウントごとに、手順 5 を繰り返します。
通知設定を取得する
accounts.getNotificationSetting エンドポイントは、アカウントの現在の Cloud Pub/Sub 通知設定を返します。次の表に呼び出し方法を示します。
GET
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting
通知設定を更新する
accounts.updateNotificationSetting エンドポイントは、アカウントに関連付けられている Cloud Pub/Sub 通知設定を更新します。次の表に呼び出し方法を示します。
PATCH
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask={commaSeparatedFieldsToUpdate}
{
pubsubTopic: your/pubsub/topicName
}
通知設定を削除する
空の pubsubTopic を指定して accounts.updateNotificationSetting を呼び出すと、アカウントから Cloud Pub/Sub 通知設定が削除されます。次の表に呼び出し方法を示します。
PATCH
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask=pubsubTopic