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
Unterstützt werden unter anderem neue oder aktualisierte Rezensionen, Fragen und Antworten, Medienuploads, Google-Updates zur Überprüfung und Änderungen des Standortstatus. Im Objekt NotificationType werden die verfügbaren Benachrichtigungstypen aufgelistet und beschrieben.
Hinweis
Wenn Sie die My Business Notifications API verwenden möchten, registrieren Sie Ihre Anwendung und rufen Sie OAuth 2.0-Anmeldedaten ab. Weitere Informationen zu den ersten Schritten mit der API finden Sie unter Grundlegende Einrichtung.
Cloud Pub/Sub einrichten
Führen Sie die folgenden Schritte aus, um API-Benachrichtigungen mit Cloud Pub/Sub einzurichten:
- 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.
- Wenn Sie Benachrichtigungen erhalten möchten, rufen Sie in der My Business Notifications API den Endpunkt
accounts.updateNotificationSetting
auf. Verwenden Sie dabei den Namen des Themas, den Sie in Cloud Pub/Sub erstellt haben, um Ihr 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 mit einem Konto verknüpften Cloud Pub/Sub-Benachrichtigungseinstellungen. 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