Attention : Nous allons bientôt modifier l'API en profondeur, ce qui va nécessiter un travail de migration. Veuillez vous informer régulièrement via notre page sur les prochaines versions et le planning d'abandon. Vous pouvez également vous inscrire à notre liste de diffusion.

Gérer les notifications en temps réel

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 :

Cette fonctionnalité peut être utilisée pour les avis (nouveaux ou mis à jour), les questions et les réponses, 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 :

  1. Configurez votre application en suivant les instructions du guide Cloud Pub/Sub.
  2. Créez un sujet dans votre projet Cloud Pub/Sub et notez son nom.
  3. Accordez au minimum des autorisations pubsub.topics.publish à mybusiness-api-pubsub@system.gserviceaccount.com.
  4. Pour configurer des notifications push ou pull, suivez le guide Présentation des abonnements.
  5. Pour recevoir des notifications, appelez le point de terminaison accounts.updateNotificationSetting dans l'API Google My Business. Pour associer votre compte GMB au sujet que vous avez créé dans Cloud Pub/Sub, utilisez le nom du sujet dans l'appel.
  6. (Facultatif) Répétez l'étape 5 pour chaque compte Google My Business 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 :

HTTP
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 :

HTTP
PATCH
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting

{
  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 :

HTTP
PATCH
https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting