Ce guide explique comment utiliser la ressource EmailPreferences
pour gérer vos notifications par e-mail Merchant Center et voir les types d'e-mails que reçoivent les users
de votre compte.
Pour obtenir la liste complète des types de notifications par e-mail, consultez la documentation de référence sur EmailPreferences
.
Vous ne pouvez utiliser l'API Merchant que pour gérer les notifications par e-mail pour les comptes auxquels vous êtes ajouté en tant qu'utilisateur.
Pour afficher ou mettre à jour les notifications par e-mail, vous avez besoin des valeurs suivantes:
- Adresse e-mail de l'utilisateur qui reçoit les e-mails. Vous trouverez son adresse e-mail dans le champ
name
de la ressourceUser
. - Référence marchand du compte pour lequel vous souhaitez commencer ou arrêter de recevoir des e-mails. Si le compte marchand est un compte avancé et que l'utilisateur a accès à ce compte, utilisez l'ID du marchand du compte avancé.
Activer ou désactiver les notifications
Pour mettre à jour les paramètres de notification par e-mail d'un compte marchand spécifique, appelez accounts.v1beta.accounts.users.updateEmailPreference
avec l'merchantId
du compte et l'adresse e-mail de l'utilisateur.
Utilisez les valeurs suivantes pour contrôler les notifications par e-mail que l'utilisateur reçoit:
OPTED_IN
: recevoir des notifications par e-mail pour le compte.OPTED_OUT
: vous ne recevez pas de notifications par e-mail pour le compte.
Voici un exemple de requête permettant de désactiver les notifications par e-mail pour un compte marchand spécifique:
PATCH https://merchantapi.googleapis.com/accounts/v1beta/accounts/merchantId/users/emailAddress/emailPreferences
{
"newsAndTips": "OPTED_OUT"
}
Afficher les notifications existantes
Pour afficher les paramètres de notification par e-mail actuels d'un utilisateur spécifique, appelez accounts.v1beta.accounts.users.getEmailPreferences
.
Voici un exemple de requête, dans laquelle merchantId
est l'ID du marchand du compte concerné par les notifications par e-mail, et emailAddress
est l'adresse e-mail de l'utilisateur qui reçoit les e-mails.
GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/merchantId/users/emailAddress/emailPreferences
Voici un exemple de réponse à un appel réussi:
{
"name": "accounts/merchantId/users/emailAddress/emailPreferences",
"newsAndTips": "OPTED_IN"
}
Pour en savoir plus sur les notifications par e-mail, consultez Modifier vos préférences relatives aux e-mails Merchant Center.