Gerenciar notificações por e-mail do Merchant Center

Este guia explica como usar o recurso EmailPreferences para gerenciar suas notificações por e-mail do Merchant Center e ver quais tipos de e-mails a users da sua conta recebe. Para conferir a lista completa de tipos de notificação por e-mail, consulte a referência do EmailPreferences.

Só é possível usar a API Merchant para gerenciar notificações por e-mail em contas em que você foi adicionado como usuário.

Para conferir ou atualizar as 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ê pode encontrar o endereço de e-mail no campo name do recurso User.
  • O ID do comerciante da conta para começar ou parar de receber e-mails. Se a conta do comerciante for uma conta avançada e o usuário tiver acesso a ela, 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 de 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 valores a seguir para controlar as notificações por e-mail que o usuário recebe:

  • OPTED_IN: receber notificações por e-mail da conta.
  • OPTED_OUT: não receber notificações por e-mail da conta.

Confira um exemplo de solicitação para desativar as notificações por e-mail de uma conta de comerciante específica:

PATCH https://merchantapi.googleapis.com/accounts/v1beta/accounts/merchantId/users/emailAddress/emailPreferences

{
  "newsAndTips": "OPTED_OUT"
}

Conferir notificações

Para conferir as configurações de notificação por e-mail atuais de um usuário específico, chame accounts.v1beta.accounts.users.getEmailPreferences.

Confira um exemplo de solicitação, em que merchantId é o ID do comerciante da conta a que as notificações de e-mail se referem 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

Confira um exemplo de resposta de uma chamada bem-sucedida:

{
  "name": "accounts/merchantId/users/emailAddress/emailPreferences",
  "newsAndTips": "OPTED_IN"
}

Para mais informações sobre as notificações por e-mail, consulte Mudar as preferências de e-mail do Merchant Center.