In der My Business Notifications API werden Benachrichtigungen im Cloud Pub/Sub-Dienst veröffentlicht. Nachdem Sie Cloud Pub/Sub eingerichtet und ein Thema erstellt haben, können Sie die folgenden Vorgänge für Benachrichtigungen ausführen:
- Benachrichtigungseinstellungen abrufen
- Benachrichtigungseinstellungen aktualisieren
- Benachrichtigungseinstellungen löschen
Unter anderem werden neue oder aktualisierte Rezensionen, Fragen und Antworten, Medienuploads, Google-Updates zur Überprüfung und Änderungen des Standortstatus unterstützt. Das Objekt NotificationType listet die verfügbaren Benachrichtigungstypen auf und beschreibt sie.
Hinweis
Bevor Sie die My Business Notifications API verwenden können, müssen Sie Ihre Anwendung registrieren und OAuth 2.0-Anmeldedaten abrufen. Weitere Informationen zu den ersten Schritten mit der API finden Sie unter Grundlegende Einrichtung.
Cloud Pub/Sub einrichten
So richten Sie API-Benachrichtigungen mit Cloud Pub/Sub ein:
- Folgen Sie der Cloud Pub/Sub-Anleitung, um Ihre Anwendung einzurichten.
- Erstellen Sie ein Thema in Ihrem Cloud Pub/Sub-Projekt und notieren Sie sich den Namen des Themas.
- Gewähren Sie mybusiness-api-pubsub@system.gserviceaccount.com mindestens
pubsub.topics.publish
-Berechtigungen. - Folgen Sie der Anleitung unter Abonnentenübersicht, um Push- oder Pull-Benachrichtigungen einzurichten.
- Rufen Sie zum Empfangen von Benachrichtigungen den Endpunkt
accounts.updateNotificationSetting
in der My Business Notifications API auf. Verwenden Sie dabei den Namen des Themas, das Sie in Cloud Pub/Sub erstellt haben, um Ihr Google Unternehmensprofil-Konto mit dem Thema zu verknüpfen. - Optional: Wiederholen Sie Schritt 5 für jedes Google Unternehmensprofil-Konto, für das Sie Benachrichtigungen erhalten möchten.
Benachrichtigungseinstellungen abrufen
Der Endpunkt accounts.getNotificationSetting
gibt die aktuellen Cloud Pub/Sub-Benachrichtigungseinstellungen für ein Konto zurück. In der folgenden Tabelle sehen Sie, wie er aufgerufen wird:
GET https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting
Benachrichtigungseinstellungen aktualisieren
Der Endpunkt accounts.updateNotificationSetting
aktualisiert die Cloud Pub/Sub-Benachrichtigungseinstellungen, die einem Konto zugewiesen sind. In der folgenden Tabelle sehen Sie, wie er aufgerufen wird:
PATCH https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask={commaSeparatedFieldsToUpdate} { pubsubTopic: your/pubsub/topicName }
Benachrichtigungseinstellungen löschen
Wenn accounts.updateNotificationSetting
mit einem leeren pubsubTopic
aufgerufen wird, werden die Cloud Pub/Sub-Benachrichtigungseinstellungen aus einem Konto gelöscht.
In der folgenden Tabelle sehen Sie, wie er aufgerufen wird:
PATCH https://mybusinessnotifications.googleapis.com/v1/accounts/{accountId}/notificationSetting?updateMask=pubsubTopic