Package google.mybusiness.notifications.v1

Index

NotificationSettings

Ce service permet aux utilisateurs de gérer les paramètres de notification de leurs comptes professionnels.

GetNotificationSetting

rpc GetNotificationSetting(GetNotificationSettingRequest) returns (NotificationSetting)

Renvoie les paramètres de notification Pub/Sub pour le compte.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
UpdateNotificationSetting

rpc UpdateNotificationSetting(UpdateNotificationSettingRequest) returns (NotificationSetting)

Définit le paramètre de notification Pub/Sub du compte pour indiquer à Google le sujet pour lequel envoyer des notifications Pub/Sub. Utilisez le champ notification_types dans notification_setting pour gérer les événements auxquels un compte souhaite s'abonner.

Un compte n'aura qu'une seule ressource de paramètre de notification, et un seul sujet Pub/Sub peut être défini. Pour supprimer le paramètre, mettez-le à jour en spécifiant un élément notification_types vide

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

ErrorCode

Tous les codes d'erreur renvoyés par l'API.

Enums
ERROR_CODE_UNSPECIFIED Code d'erreur manquant.
SHARES_PUBSUB_TOPIC_MESSAGE_ACROSS_VERSIONS Le nom du sujet Pub/Sub indiqué dans le RPC "updateNotificationSetting" est utilisé par d'autres versions de cette API. Veuillez fournir un nouveau nom de thème pour limiter ce problème.
PUBLISH_PERMISSIONS_MISSING_FOR_PUBSUB_TOPIC Le nom du sujet Pub/Sub fourni pour le paramètre de notification de mise à jour ne dispose pas d'autorisations de publication pour l'utilisateur.
INVALID_PUBSUB_TOPIC Le nom du sujet Pub/Sub fourni pour le paramètre de notification de mise à jour n'est pas valide.

GetNotificationSettingRequest

Message de requête pour NotificationSettings.GetNotificationSettings.

Champs
name

string

Obligatoire. Nom de ressource du paramètre de notification que nous essayons de récupérer.

NotificationSetting

Sujet Google Pub/Sub permettant de publier des notifications lorsqu'un établissement est mis à jour ou reçoit un nouvel avis. Il n'existe qu'une seule ressource de paramètre de notification par compte.

Champs
name

string

Obligatoire. Nom de ressource auquel ce paramètre est destiné. au format accounts/{account_id}/notificationSetting.
pubsub_topic

string

Facultatif. Sujet Google Pub/Sub qui reçoit des notifications lorsque des établissements gérés par ce compte sont mis à jour. Si cette règle n'est pas configurée, aucune notification ne sera publiée.

Le compte mybusiness-api-pubsub@system.gserviceaccount.com doit disposer au minimum des autorisations de publication sur le sujet Pub/Sub.
notification_types[]

NotificationType

Types de notifications qui seront envoyées au sujet Pub/Sub. Pour ne plus recevoir de notifications, utilisez NotificationSettings.UpdateNotificationSetting avec un champ notification_types vide ou définissez pubsub_topic sur une chaîne vide.

NotificationType

Type de notification envoyée au sujet Pub/Sub.

Enums
NOTIFICATION_TYPE_UNSPECIFIED Aucun type de notification. Aucune notification.
GOOGLE_UPDATE L'établissement fait l'objet de mises à jour Google à examiner. Le champ "location_name" de la notification indiquera le nom de la ressource de l'établissement avec les mises à jour Google.
NEW_REVIEW Un nouvel avis a été ajouté à l'établissement. Le champ "review_name" dans la notification indiquera le nom de la ressource de l'avis qui a été ajouté, et le champ "location_name" contiendra le nom de la ressource de l'établissement.
UPDATED_REVIEW Un avis sur l'établissement a été mis à jour. Le champ "review_name" dans la notification indiquera le nom de la ressource de l'avis qui a été ajouté, et le champ "location_name" contiendra le nom de la ressource de l'établissement.
NEW_CUSTOMER_MEDIA Un nouvel élément multimédia a été ajouté à l'établissement par un utilisateur de Google Maps. La notification fournit le nom de ressource du nouvel élément multimédia.
NEW_QUESTION Une nouvelle question est ajoutée au lieu. La notification indiquera le nom de la ressource concernée.
UPDATED_QUESTION Une question du lieu est mise à jour. La notification indiquera le nom de la ressource concernée.
NEW_ANSWER Une nouvelle réponse est ajoutée au lieu. La notification fournira le nom de la ressource pour la question et la réponse.
UPDATED_ANSWER La réponse du lieu est mise à jour. La notification fournira le nom de la ressource pour la question et la réponse.
DUPLICATE_LOCATION Indique si le champ "Emplacement en double" des métadonnées d'établissement a été modifié.
LOSS_OF_VOICE_OF_MERCHANT

Obsolète: migrez les utilisations existantes de cette valeur vers la valeur "VOICE_OF_MERCHANT_UPDATED" plus développée.
VOICE_OF_MERCHANT_UPDATED Indique si l'état de la voix du marchand (VOM) est mis à jour pour l'établissement. Le VOM détermine si l'établissement est en règle et si le marchand contrôle l'établissement sur Google. Toutes les modifications apportées à l'établissement seront appliquées sur Maps une fois la phase d'examen terminée. Pour en savoir plus, appelez le RPC GetVoiceOfMerchantState.

UpdateNotificationSettingRequest

Message de requête pour NotificationSettings.UpdateNotificationSettings.

Champs
notification_setting

NotificationSetting

Obligatoire. Paramètres de notification mis à jour.
update_mask

FieldMask

Obligatoire. Champs spécifiques à mettre à jour. Le seul champ modifiable est "notification_setting".