Dans l'API My Business Notifications, les notifications sont publiées dans le service Cloud Pub/Sub. Après avoir configuré Cloud Pub/Sub et créé un sujet, vous pouvez effectuer les tâches suivantes concernant les notifications :
- Récupérer les paramètres de notification
- Mettre à jour les paramètres de notification
- Supprimer les paramètres de notification
Cette fonctionnalité peut être utilisée pour les avis, les questions et les réponses (nouveaux ou mis à jour), les importations de supports, les mises à jour Google pour examen, les changements apportés à l'état des établissements, etc. L'objet NotificationType répertorie et décrit les différents types de notification disponibles.
Avant de commencer
Pour utiliser l'API My Business Notifications, enregistrez votre application et obtenez des identifiants OAuth 2.0. Pour découvrir comment vous lancer avec l'API, consultez Configuration de base.
Configurer Cloud Pub/Sub
Pour configurer les notifications envoyées par l'API avec Cloud Pub/Sub :
- Configurez votre application en suivant les instructions du guide Cloud Pub/Sub.
- Créez un sujet dans votre projet Cloud Pub/Sub et notez son nom.
- Accordez au minimum des autorisations
pubsub.topics.publish
à mybusiness-api-pubsub@system.gserviceaccount.com. - Pour configurer des notifications push ou pull, suivez le guide Présentation des abonnements.
- Pour recevoir des notifications, appelez le point de terminaison
accounts.updateNotificationSetting
dans l'API My Business Notifications. Pour associer votre compte de fiches d'établissement au sujet que vous avez créé dans Cloud Pub/Sub, utilisez le nom du sujet dans l'appel. - (Facultatif) Répétez l'étape 5 pour chaque compte de fiches d'établissement pour lequel vous souhaitez recevoir des notifications.
Récupérer les paramètres de notification
Le point de terminaison accounts.getNotificationSetting
renvoie les paramètres de notification Cloud Pub/Sub actuels pour un compte donné. Le tableau suivant montre comment l'appeler :
GET https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting
Mettre à jour les paramètres de notification
Le point de terminaison accounts.updateNotificationSetting
met à jour les paramètres de notification Cloud Pub/Sub associés à un compte. Le tableau suivant montre comment l'appeler :
PATCH https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask={commaSeparatedFieldsToUpdate} { pubsubTopic: your/pubsub/topicName }
Supprimer les paramètres de notification
L'appel de accounts.updateNotificationSetting
avec un pubsubTopic
vide permet de supprimer les paramètres de notification Cloud Pub/Sub d'un compte.
Le tableau suivant montre comment l'appeler :
PATCH https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask=pubsubTopic