Package google.mybusiness.notifications.v1

Índice

NotificationSettings

Este servicio permite que los usuarios administren la configuración de notificaciones de sus cuentas comerciales.

GetNotificationSetting

rpc GetNotificationSetting(GetNotificationSettingRequest) returns (NotificationSetting)

Muestra la configuración de notificaciones de Pub/Sub para la cuenta.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.
UpdateNotificationSetting

rpc UpdateNotificationSetting(UpdateNotificationSettingRequest) returns (NotificationSetting)

Establece la configuración de notificaciones de Pub/Sub para la cuenta que le informa a Google sobre qué tema enviar notificaciones de Pub/Sub. Utiliza el campo notification_types dentro de notification_setting para manipular los eventos a los que una cuenta desea suscribirse.

Una cuenta solo tendrá un recurso de configuración de notificaciones y solo se puede establecer un tema de Pub/Sub. Para borrar el parámetro de configuración, actualiza con un notification_types vacío.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

ErrorCode

Todos los códigos de error que muestra la API.

Enumeradores
ERROR_CODE_UNSPECIFIED Falta el código de error.
SHARES_PUBSUB_TOPIC_MESSAGE_ACROSS_VERSIONS Otras versiones de esta API están usando el nombre del tema de Pub/Sub proporcionado en la rpc "updateNotificationSetting". Proporciona un nombre de tema nuevo para mitigar este problema.
PUBLISH_PERMISSIONS_MISSING_FOR_PUBSUB_TOPIC El nombre del tema de Pub/Sub proporcionado para el parámetro de configuración de notificaciones de actualización no tiene permisos de publicación para el usuario.
INVALID_PUBSUB_TOPIC El nombre del tema de Pub/Sub proporcionado para la configuración de notificaciones de actualización no es válido.

GetNotificationSettingRequest

Mensaje de solicitud para NotificationSettings.GetNotificationSettings.

Campos
name

string

Obligatorio. El nombre del recurso de la configuración de notificaciones que intentamos recuperar.

NotificationSetting

Un tema de Google Pub/Sub en el que se pueden publicar notificaciones cuando una ubicación se actualiza o tiene una nueva opinión. Solo habrá un recurso de configuración de notificaciones por cuenta.

Campos
name

string

Obligatorio. El nombre del recurso para el que se usa esta configuración. Esta tiene el formato accounts/{account_id}/notificationSetting.
pubsub_topic

string

Opcional. El tema de Google Pub/Sub que recibirá notificaciones cuando se actualicen las ubicaciones administradas por esta cuenta. Si no la estableces, no se publicarán notificaciones.

La cuenta mybusiness-api-pubsub@system.gserviceaccount.com debe tener, como mínimo, permisos de publicación en el tema de Pub/Sub.
notification_types[]

NotificationType

Los tipos de notificaciones que se enviarán al tema de Pub/Sub. Para dejar de recibir notificaciones por completo, usa NotificationSettings.UpdateNotificationSetting con un notification_types vacío o configura pubsub_topic en una string vacía.

NotificationType

Tipo de notificación enviada al tema de Pub/Sub.

Enumeradores
NOTIFICATION_TYPE_UNSPECIFIED Sin tipo de notificación. No coincidirá con ninguna notificación.
GOOGLE_UPDATE La ubicación tiene actualizaciones de Google para revisar. El campo location_name de la notificación proporcionará el nombre del recurso de la ubicación con las actualizaciones de Google.
NEW_REVIEW Se agregó una opinión nueva a la ubicación. El campo review_name de la notificación proporcionará el nombre del recurso de la opinión que se agregó, y location_name tendrá el nombre del recurso de la ubicación.
UPDATED_REVIEW Se actualizó una opinión sobre la ubicación. El campo review_name de la notificación proporcionará el nombre del recurso de la opinión que se agregó, y location_name tendrá el nombre del recurso de la ubicación.
NEW_CUSTOMER_MEDIA Un usuario de Google Maps agregó un nuevo elemento multimedia a la ubicación. La notificación proporcionará el nombre del recurso del nuevo elemento multimedia.
NEW_QUESTION Se agrega una pregunta nueva a la ubicación. La notificación proporcionará el nombre del recurso en cuestión.
UPDATED_QUESTION Se actualiza una pregunta sobre la ubicación. La notificación proporcionará el nombre del recurso en cuestión.
NEW_ANSWER Se agregará una respuesta nueva a la ubicación. La notificación proporcionará el nombre del recurso de la pregunta y la respuesta.
UPDATED_ANSWER Se actualiza la respuesta de la ubicación. La notificación proporcionará el nombre del recurso de la pregunta y la respuesta.
DUPLICATE_LOCATION Indica si hay un cambio en el campo de ubicación duplicada de los metadatos de ubicación.
LOSS_OF_VOICE_OF_MERCHANT

Obsoleto: migra los usos existentes de este valor a "VOICE_OF_MERCHANT_UPDATED" más expandida.
VOICE_OF_MERCHANT_UPDATED Indica si la ubicación tiene una actualización en el estado de Voice of Merchant (VOM). El VOM determina si la ubicación está en regla y el comercio tiene el control de la empresa en Google. Las modificaciones que se realicen en la ubicación se propagarán en Maps una vez que se apruebe la fase de revisión. Llama a GetVoiceOfMerchantState rpc para obtener más detalles.

UpdateNotificationSettingRequest

Mensaje de solicitud para NotificationSettings.UpdateNotificationSettings.

Campos
notification_setting

NotificationSetting

Obligatorio. La configuración de notificaciones actualizada.
update_mask

FieldMask

Obligatorio. Los campos específicos que deben actualizarse. El único campo que se puede editar es notification_setting.