Package google.mybusiness.notifications.v1

索引

NotificationSettings

このサービスを使って、ユーザーはビジネス アカウントの通知設定を管理できます。

GetNotificationSetting

rpc GetNotificationSetting(GetNotificationSettingRequest) returns (NotificationSetting)

アカウントの Pub/Sub 通知設定を返します。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/business.manage

詳細については、OAuth 2.0 の概要をご覧ください。
UpdateNotificationSetting

rpc UpdateNotificationSetting(UpdateNotificationSettingRequest) returns (NotificationSetting)

アカウントの Pub/Sub 通知設定を設定して、Pub/Sub 通知を送信するトピックを Google に通知します。notification_setting 内の notification_types フィールドを使用して、アカウントが登録するイベントを操作する

各アカウントで使用できる通知設定リソースは 1 つだけです。また、設定できる Pub/Sub トピックは 1 つのみです。設定を削除するには、空の notification_types を使用して更新してください

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/business.manage

詳細については、OAuth 2.0 の概要をご覧ください。

ErrorCode

API から返されるすべてのエラーコード。

列挙型
ERROR_CODE_UNSPECIFIED エラーコードがありません。
SHARES_PUBSUB_TOPIC_MESSAGE_ACROSS_VERSIONS 「updateNotificationSetting」RPC で指定された Pub/Sub トピック名は、この API の他のバージョンで使用されています。この問題を軽減するために、新しいトピック名を指定してください。
PUBLISH_PERMISSIONS_MISSING_FOR_PUBSUB_TOPIC 更新通知設定に指定された Pub/Sub トピック名には、ユーザーの公開権限がありません。
INVALID_PUBSUB_TOPIC 更新通知設定に指定された Pub/Sub トピック名が無効です。

GetNotificationSettingRequest

NotificationSettings.GetNotificationSettings に対するリクエスト メッセージです。

フィールド
name

string

必須。取得しようとしている通知設定のリソース名。

NotificationSetting

ビジネスが更新された時点、または新たなクチコミがあったときに通知を公開できる Google Pub/Sub トピック。通知設定リソースは、アカウントごとに 1 つだけ存在します。

フィールド
name

string

必須。この設定の対象となるリソース名。形式は accounts/{account_id}/notificationSetting です。
pubsub_topic

string

（省略可）このアカウントで管理しているビジネスが更新されたときに通知を受け取る Google Pub/Sub トピック。未設定のままにした場合、通知は投稿されません。

アカウント mybusiness-api-pubsub@system.gserviceaccount.com には、Pub/Sub トピックに対する少なくとも Publish 権限が必要です。
notification_types[]

NotificationType

Pub/Sub トピックに送信される通知のタイプ。通知の受信を完全に停止するには、空の notification_types を指定して NotificationSettings.UpdateNotificationSetting を使用するか、pubsub_topic を空の文字列に設定します。

NotificationType

Pub/Sub トピックに送信される通知のタイプ。

列挙型
NOTIFICATION_TYPE_UNSPECIFIED 通知タイプがありません。どの通知とも一致しません。
GOOGLE_UPDATE ビジネス情報に Google による変更があります。通知の location_name フィールドには、Google による変更が行われたビジネスのリソース名が表示されます。
NEW_REVIEW 新しいクチコミがビジネスに追加されました。通知の review_name フィールドには、追加されたクチコミのリソース名が表示され、location_name には、ビジネスのリソース名が含まれます。
UPDATED_REVIEW ビジネスのクチコミが更新されました。通知の review_name フィールドには、追加されたクチコミのリソース名が表示され、location_name には、ビジネスのリソース名が含まれます。
NEW_CUSTOMER_MEDIA Google マップのユーザーによって、新しいメディア アイテムがビジネスに追加されました。通知には、新しいメディア アイテムのリソース名が表示されます。
NEW_QUESTION 新しい質問がビジネスに追加されます。通知には、質問のリソース名が記載されています。
UPDATED_QUESTION ビジネスに関する質問が更新されました。通知には、質問のリソース名が記載されています。
NEW_ANSWER 新しい回答がビジネスに追加されます。通知には、質問と回答のリソース名が記載されています。
UPDATED_ANSWER ビジネスの回答が更新される。通知には、質問と回答のリソース名が記載されています。
DUPLICATE_LOCATION 位置情報メタデータの重複するビジネス情報フィールドに変更があったかどうかを示します。
LOSS_OF_VOICE_OF_MERCHANT

非推奨: この値の既存の用途を、より拡張された「VOICE_OF_MERCHANT_UPDATED」に移行しました。
VOICE_OF_MERCHANT_UPDATED ビジネスの Voice of Merchant（VOM）ステータスの更新があるかどうかを示します。VOM は、ビジネスが良好な状態かどうか、販売者が Google 上のビジネスを管理できるかどうかを決定します。ビジネスに加えた変更は、審査の段階に合格した後でマップに反映されます。詳しくは、GetVoiceOfMerchantState rpc を呼び出してください。

UpdateNotificationSettingRequest

NotificationSettings.UpdateNotificationSettings に対するリクエスト メッセージです。

フィールド
notification_setting

NotificationSetting

必須。更新された通知設定。
update_mask

FieldMask

必須。更新するフィールドです。編集可能なフィールドは notification_setting のみです。