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 通知設定,告知 Google 要傳送哪個主題的 Pub/Sub 通知。使用 notification_setting 中的 notification_types 欄位可操控帳戶要訂閱的事件。

每個帳戶只能有一個通知設定資源,而且只能設定一個 Pub/Sub 主題。如要刪除設定,請以空白的 notification_types 更新

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

ErrorCode

API 傳回的所有錯誤代碼。

列舉
ERROR_CODE_UNSPECIFIED 缺少錯誤代碼。
SHARES_PUBSUB_TOPIC_MESSAGE_ACROSS_VERSIONS 這個 API 的其他版本正在使用「updateNotificationSetting」 rpc 中提供的 Pub/Sub 主題名稱。請提供新的主題名稱來解決這個問題。
PUBLISH_PERMISSIONS_MISSING_FOR_PUBSUB_TOPIC 為更新通知設定提供的 Pub/Sub 主題名稱沒有使用者的發布權限。
INVALID_PUBSUB_TOPIC 為更新通知設定提供的 Pub/Sub 主題名稱無效。

GetNotificationSettingRequest

NotificationSettings.GetNotificationSettings 的要求訊息。

欄位
name

string

必要欄位。我們嘗試擷取的通知設定資源名稱。

NotificationSetting

Google Pub/Sub 主題,可在位置更新或有新評論時發布通知。每個帳戶只能有一項通知設定資源。

欄位
name

string

必要欄位。這項設定適用的資源名稱。格式為 accounts/{account_id}/notificationSetting

pubsub_topic

string

選用設定。Google Pub/Sub 主題,會在這個帳戶管理的地點更新時接收通知。如未設定,系統不會發布任何通知。

mybusiness-api-pubsub@system.gserviceaccount.com 帳戶必須至少具備 Pub/Sub 主題的「發布」權限。

notification_types[]

NotificationType

會傳送至 Pub/Sub 主題的通知類型。如要完全停止接收通知,請使用 NotificationSettings.UpdateNotificationSetting 和空白的 notification_types,或是將 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 上的商家。審核階段結束後,您對地點所做的任何修改都會反映在 Google 地圖上。呼叫 GetVoiceOfMerchantState rpc 詳情。

UpdateNotificationSettingRequest

NotificationSettings.UpdateNotificationSettings 的要求訊息。

欄位
notification_setting

NotificationSetting

必要欄位。更新後的通知設定。

update_mask

FieldMask

必要欄位。要更新的特定欄位。唯一可編輯的欄位是 notification_setting。