Neste guia, explicamos como usar o
recurso EmailPreferences
para gerenciar as notificações por e-mail
do Merchant Center e quais
tipos de e-mails que o
users
recebe. Para ver a lista completa de tipos de notificação por e-mail, consulte a
referência
EmailPreferences
.
Só é possível usar a API do Merchant Center para gerenciar notificações por e-mail das contas em que você foi adicionado como usuário.
Para acessar ou atualizar notificações por e-mail, você precisa dos seguintes valores:
- O endereço de e-mail do usuário que recebe os e-mails. Você encontra o endereço de e-mail deles no campo
name
do recursoUser
. - O ID do comerciante da conta sobre a qual começar ou parar de receber e-mails. Se a conta do comerciante for avançada e o usuário tiver acesso à conta avançada, use o ID do comerciante da conta avançada.
Ativar ou desativar as notificações
Para atualizar as configurações de notificação por e-mail de uma conta do comerciante específica, chame accounts.v1beta.accounts.users.updateEmailPreference
com o merchantId
da conta e o endereço de e-mail do usuário.
Use os seguintes valores para controlar as notificações por e-mail que o usuário recebe:
OPTED_IN
: receber notificações por e-mail sobre a conta.OPTED_OUT
: não receber notificações por e-mail sobre a conta.
Veja a seguir um exemplo de solicitação para desativar as notificações por e-mail de um usuário de uma conta de comerciante específica:
PATCH https://merchantapi.googleapis.com/accounts/v1beta/accounts/merchantId/users/emailAddress/emailPreferences
{
"newsAndTips": "OPTED_OUT"
}
Ver notificações existentes
Para conferir as configurações atuais de notificação por e-mail de um usuário específico, chame
accounts.v1beta.accounts.users.getEmailPreferences
.
Veja um exemplo de solicitação, em que merchantId
é o ID do comerciante da conta que contém as notificações por e-mail, e emailAddress
é o endereço de e-mail do usuário que recebe os e-mails.
GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/merchantId/users/emailAddress/emailPreferences
Veja um exemplo de resposta de uma chamada bem-sucedida:
{
"name": "accounts/merchantId/users/emailAddress/emailPreferences",
"newsAndTips": "OPTED_IN"
}
Para mais informações sobre notificações por e-mail, consulte Mudar suas preferências de e-mail do Merchant Center.