Na API My Business Notifications, as notificações são publicadas no serviço Cloud Pub/Sub. Depois de configurar o Cloud Pub/Sub e criar um tópico, é possível executar as seguintes operações nas notificações:
- Recuperar as configurações de notificação.
- Atualizar as configurações de notificação.
- Excluir as configurações de notificação.
Avaliações novas ou atualizadas, perguntas e respostas, uploads de mídia, atualizações do Google para revisão, mudanças de estado do local e muito mais são compatíveis. O objeto NotificationType lista e descreve os tipos de notificação disponíveis.
Antes de começar
Para usar a API My Business Notifications, registre seu aplicativo e receba as credenciais do OAuth 2.0. Para saber como começar a usar a API, consulte Configuração básica.
Configuração do Cloud Pub/Sub
Para configurar notificações de API com o Cloud Pub/Sub, siga estas etapas:
- Siga o guia do Cloud Pub/Sub para configurar o aplicativo.
- Crie um tópico no seu projeto do Cloud Pub/Sub e anote o nome do tópico criado.
- Conceda pelo menos as permissões
pubsub.topics.publish
a mybusiness-api-pubsub@system.gserviceaccount.com. - Siga o guia Visão geral do assinante para configurar notificações push ou pull.
- Para receber notificações, chame o endpoint
accounts.updateNotificationSetting
na API My Business Notifications. Na chamada, use o nome do tópico que você criou no Cloud Pub/Sub para vincular sua conta do Perfil da Empresa ao tópico. - (Opcional) Repita a etapa 5 para cada conta do Perfil da Empresa em que você quer receber notificações.
Recuperar as configurações de notificação
O endpoint accounts.getNotificationSetting
retorna as configurações de notificação atuais do Cloud Pub/Sub para uma conta. A tabela a seguir mostra como chamá-lo:
GET https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting
Atualizar as configurações de notificação
O endpoint accounts.updateNotificationSetting
atualiza as configurações de notificação do Cloud Pub/Sub associadas a uma conta. A tabela a seguir mostra como chamá-lo:
PATCH https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask={commaSeparatedFieldsToUpdate} { pubsubTopic: your/pubsub/topicName }
Excluir configurações de notificação
Chamar accounts.updateNotificationSetting
com um pubsubTopic
vazio exclui as configurações de notificação do Cloud Pub/Sub de uma conta.
A tabela a seguir mostra como chamá-lo:
PATCH https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask=pubsubTopic