Package google.mybusiness.notifications.v1

索引

NotificationSettings

此服务允许用户管理其商家帐号的通知设置。

GetNotificationSetting

rpc GetNotificationSetting(GetNotificationSettingRequest) returns (NotificationSetting)

返回帐号的 PubSub 通知设置。

授权范围

需要以下 OAuth 作用域：

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

有关详情，请参阅 OAuth 2.0 概览。
UpdateNotificationSetting

rpc UpdateNotificationSetting(UpdateNotificationSettingRequest) returns (NotificationSetting)

设置帐号的 PubSub 通知设置，以告知 Google 应针对哪个主题发送 PubSub 通知。使用 notification_setting 中的 notification_types 字段来操纵帐号想要订阅的事件。

一个账号只能有一个通知设置资源，并且只能设置一个 PubSub 主题。如需删除此设置，请使用空 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 指明营业地点的商户语音 (VOM) 状态是否有更新。VOM 用于指明营业地点是否信誉良好，以及商家能否在 Google 上控制商家。通过审核阶段后，对营业地点所做的任何修改都将传播到 Google 地图。如需了解详情，请调用 GetVoiceOfMerchantState rpc。

UpdateNotificationSettingRequest

NotificationSettings.UpdateNotificationSettings 的请求消息。

字段
notification_setting

NotificationSetting

必需。已更新的通知设置。
update_mask

FieldMask

必需。应更新的特定字段。唯一可修改的字段是 notification_setting。