Package google.mybusiness.notifications.v1

Index

NotificationSettings

Mit diesem Dienst können Nutzer die Benachrichtigungseinstellungen für ihre Geschäftskonten verwalten.

GetNotificationSetting

rpc GetNotificationSetting(GetNotificationSettingRequest) returns (NotificationSetting)

Gibt die Pub/Sub-Benachrichtigungseinstellungen für das Konto zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.
UpdateNotificationSetting

rpc UpdateNotificationSetting(UpdateNotificationSettingRequest) returns (NotificationSetting)

Legt die Pub/Sub-Benachrichtigungseinstellung für das Konto fest, mit der Google darüber informiert wird, für welches Thema Pub/Sub-Benachrichtigungen gesendet werden sollen. Mit dem Feld „benachrichtigung_types“ in „benachrichtigungseinstellung“ können Sie die Ereignisse bearbeiten, die für ein Konto abonniert werden sollen.

Ein Konto hat nur eine Ressource für Benachrichtigungseinstellungen und es kann nur ein Pub/Sub-Thema festgelegt werden. Wenn du die Einstellung löschen möchtest, gib ein leeres „nachricht_types“ an

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

  • https://www.googleapis.com/auth/business.manage

Weitere Informationen finden Sie in der Übersicht über OAuth 2.0.

ErrorCode

Alle Fehlercodes, die von der API zurückgegeben werden.

Enums
ERROR_CODE_UNSPECIFIED Fehlercode fehlt.
SHARES_PUBSUB_TOPIC_MESSAGE_ACROSS_VERSIONS Der im RPC „updateNotificationSetting“ angegebene Pub/Sub-Themenname wird von anderen Versionen dieser API verwendet. Geben Sie einen neuen Themennamen an, um dieses Problem zu beheben.
PUBLISH_PERMISSIONS_MISSING_FOR_PUBSUB_TOPIC Der Name des Pub/Sub-Themas, der für die Einstellung für die Updatebenachrichtigung angegeben wurde, hat keine Veröffentlichungsberechtigungen für den Nutzer.
INVALID_PUBSUB_TOPIC Der in der Einstellung für die Updatebenachrichtigung angegebene Name des Pub/Sub-Themas ist ungültig.

GetNotificationSettingRequest

Anfragenachricht für NotificationSettings.GetNotificationSettings.

Felder
name

string

Erforderlich. Der Ressourcenname der Benachrichtigungseinstellung, die abgerufen werden soll.

NotificationSetting

Ein Google Pub/Sub-Thema, in dem Benachrichtigungen veröffentlicht werden können, wenn ein Standort aktualisiert wird oder eine neue Rezension vorliegt. Pro Konto gibt es nur eine Ressource für die Benachrichtigungseinstellung.

Felder
name

string

Erforderlich. Der Ressourcenname, für den diese Einstellung gilt. Sie hat das Format accounts/{account_id}/notificationSetting.
pubsub_topic

string

Optional. Das Google Pub/Sub-Thema, das Benachrichtigungen erhält, wenn von diesem Konto verwaltete Standorte aktualisiert werden. Wenn die Richtlinie nicht konfiguriert ist, werden keine Benachrichtigungen gepostet.

Das Konto mybusiness-api-pubsub@system.gserviceaccount.com muss mindestens Veröffentlichungsberechtigungen für das Pub/Sub-Thema haben.
notification_types[]

NotificationType

Die Benachrichtigungstypen, die an das Pub/Sub-Thema gesendet werden. Um den Empfang von Benachrichtigungen vollständig zu beenden, verwenden Sie NotificationSettings.UpdateNotificationSetting mit einem leeren notification_types oder legen Sie für pubsub_topic einen leeren String fest.

NotificationType

Art der an das Pub/Sub-Thema gesendeten Benachrichtigung.

Enums
NOTIFICATION_TYPE_UNSPECIFIED Kein Benachrichtigungstyp. Es werden keine Benachrichtigungen gefunden.
GOOGLE_UPDATE Für den Standort liegen Google-Aktualisierungen zur Überprüfung vor. Das Feld „location_name“ in der Benachrichtigung enthält den Ressourcennamen des Standorts mit Aktualisierungen durch Google.
NEW_REVIEW Dem Standort wurde eine neue Rezension hinzugefügt. Das Feld "review_name" in der Benachrichtigung enthält den Ressourcennamen der hinzugefügten Rezension. "location_name" enthält den Ressourcennamen des Standorts.
UPDATED_REVIEW Eine Rezension für den Standort wurde aktualisiert. Das Feld "review_name" in der Benachrichtigung enthält den Ressourcennamen der hinzugefügten Rezension. "location_name" enthält den Ressourcennamen des Standorts.
NEW_CUSTOMER_MEDIA Ein Google Maps-Nutzer hat dem Ort ein neues Medienelement hinzugefügt. Die Benachrichtigung enthält den Ressourcennamen des neuen Medienelements.
NEW_QUESTION Dem Ort wird eine neue Frage hinzugefügt. In der Benachrichtigung wird der Name der betreffenden Ressource angegeben.
UPDATED_QUESTION Eine Frage zum Standort wird aktualisiert. In der Benachrichtigung wird der Name der betreffenden Ressource angegeben.
NEW_ANSWER Dem Ort wird eine neue Antwort hinzugefügt. Die Benachrichtigung enthält den Ressourcennamen der Frage und Antwort.
UPDATED_ANSWER Eine Antwort zum Standort wird aktualisiert. Die Benachrichtigung enthält den Ressourcennamen der Frage und Antwort.
DUPLICATE_LOCATION Gibt an, ob sich das Feld für den doppelten Standort der Standortmetadaten geändert hat.
LOSS_OF_VOICE_OF_MERCHANT

Eingestellt: Migrieren Sie die vorhandenen Nutzungen dieses Werts zum erweiterten „VOICE_OF_MERCHANT_UPDATED“.
VOICE_OF_MERCHANT_UPDATED Gibt an, ob der Status des Voice of Merchant (VOM) für den Standort aktualisiert wurde. Die VOM gibt vor, ob der Standort einen einwandfreien Status hat und der Händler die Kontrolle über das Unternehmen auf Google hat. Nach Abschluss der Überprüfungsphase werden alle am Standort vorgenommenen Änderungen in Google Maps übernommen. Rufen Sie für weitere Informationen den RPC-Dienst GetVoiceOfMerchantState auf.

UpdateNotificationSettingRequest

Anfragenachricht für NotificationSettings.UpdateNotificationSettings.

Felder
notification_setting

NotificationSetting

Erforderlich. Die Benachrichtigungseinstellungen wurden aktualisiert.
update_mask

FieldMask

Erforderlich. Die Felder, die aktualisiert werden sollen. Das einzige bearbeitbare Feld ist „benachrichtigungseinstellung“.