Package google.mybusiness.notifications.v1

Индекс

Настройки уведомлений

Этот сервис позволяет пользователям управлять настройками уведомлений для своих бизнес-аккаунтов.

GetNotificationSetting

rpc GetNotificationSetting( GetNotificationSettingRequest ) returns ( NotificationSetting )

Возвращает настройки уведомлений pubsub для учетной записи.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

Обновление настроек уведомлений

rpc UpdateNotificationSetting( UpdateNotificationSettingRequest ) returns ( NotificationSetting )

Устанавливает настройку уведомления pubsub для учетной записи, сообщающую Google, по какой теме отправлять уведомления pubsub. Используйте поле Notification_types в Notification_setting, чтобы управлять событиями, на которые учетная запись хочет подписаться.

У учетной записи будет только один ресурс настройки уведомлений, и можно установить только одну тему pubsub. Чтобы удалить настройку, обновите ее, указав пустой тип Notification_types.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

Код ошибки

Все коды ошибок, возвращаемые API.

Перечисления
ERROR_CODE_UNSPECIFIED Отсутствует код ошибки.
SHARES_PUBSUB_TOPIC_MESSAGE_ACROSS_VERSIONS Имя темы публикации/подписки, указанное в rpc updateNotificationSetting, используется другими версиями этого API. Пожалуйста, укажите новое название темы, чтобы решить эту проблему.
PUBLISH_PERMISSIONS_MISSING_FOR_PUBSUB_TOPIC Название темы публикации/подписки, указанное для настройки уведомления об обновлении, не имеет разрешений на публикацию для пользователя.
INVALID_PUBSUB_TOPIC Недопустимое имя темы публикации/подписки, указанное для настройки уведомления об обновлении.

GetNotificationSettingRequest

Сообщение запроса для NotificationSettings.GetNotificationSettings.

Поля
name

string

Необходимый. Имя ресурса настройки уведомления, которую мы пытаемся получить.

Настройка уведомлений

Тема 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 пустую строку.

Тип уведомления

Тип уведомления, отправляемого в тему 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 Maps добавил к этому местоположению новый медиа-элемент. В уведомлении будет указано имя ресурса нового элемента мультимедиа.
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.

ОбновлениеNotificationSettingRequest

Сообщение запроса для NotificationSettings.UpdateNotificationSettings.

Поля
notification_setting

NotificationSetting

Необходимый. Обновлены настройки уведомлений.

update_mask

FieldMask

Необходимый. Конкретные поля, которые следует обновить. Единственное редактируемое поле — Notification_setting.