Central de Preferências de e-mail via API

Configurar uma Central de Preferências oferece um local centralizado para que seus usuários editem e gerenciem suas preferências de notificação para o envio de mensagens por e-mail. Este artigo inclui etapas para criar uma Central de Preferências gerada por API, mas você também pode criar uma Central de Preferências usando o editor de arrastar e soltar.

No dashboard da Braze, acesse Audience > Email Preference Centers.

Aqui é onde você pode gerenciar e visualizar cada grupo de inscrições. Cada grupo de inscrições que você criar será adicionado a esta lista da Central de Preferências. Você pode criar múltiplas centrais de preferências.

Importante

A Central de Preferências foi projetada para ser usada dentro do canal de e-mail da Braze. Os links da Central de Preferências são dinâmicos com base em cada usuário e não podem ser hospedados externamente.

Criar uma Central de Preferências com API

Usando os endpoints da Braze para Central de Preferências, você pode criar uma Central de Preferências, um site hospedado pela Braze, que pode exibir o estado de inscrição e os status dos grupos de inscrições dos seus usuários. Usando HTML e CSS, sua equipe de desenvolvimento pode construir a Central de Preferências para que o estilo da página corresponda às diretrizes da sua marca.

O uso de Liquid permite recuperar os nomes dos seus grupos de inscrições e o status de cada usuário. Dessa forma, a Braze armazena e recupera esses dados quando a página é carregada.

Pré-requisitos

Etapa 1: Use o endpoint Criar Central de Preferências

Vamos começar a construir uma Central de Preferências usando o endpoint Criar Central de Preferências. Para personalizar sua Central de Preferências, você pode incluir HTML alinhado com sua marca no campo preference_center_page_html e no campo confirmation_page_html.

O endpoint Gerar URL da Central de Preferências permite que você obtenha a URL da Central de Preferências para um usuário específico fora de um e-mail enviado pela Braze.

Nota

A Braze renderiza confirmation_page_html em um iframe que usa uma URL data:. Os navegadores tratam URLs data: como origens opacas. Como resultado, scripts nesse iframe não podem carregar recursos externos adicionais, e a navegação na janela pai ou a comunicação entre frames a partir dessa página falha.

Em vez disso, você pode vincular a conteúdo externo, como uma URL de pesquisa hospedada, em vez de incorporar scripts. Se você precisar incorporar uma ferramenta de terceiros e o fornecedor permitir, use um <iframe title="Descrição do conteúdo incorporado" src="https://example.com/..."> apontando para a URL HTTPS hospedada da ferramenta.

Etapa 2: Inclua na sua campanha de e-mail

Importante

Existem certos navegadores, como os apps Naver para Android e iOS, que não oferecem suporte à Central de Preferências da Braze. Caso preveja que alguns dos seus usuários usem esses navegadores, considere fornecer métodos alternativos para que eles gerenciem suas preferências de e-mail.

Para inserir um link para a Central de Preferências nos seus e-mails, use a seguinte Liquid tag no local desejado do seu e-mail, de forma semelhante a como você inseriria URLs de cancelamento de inscrição.

1
{{preference_center.${kitchenerie_preference_center_example}}}

Você também pode usar uma combinação de HTML que inclua Liquid. Por exemplo, você pode colar o seguinte como URL no editor de HTML ou no editor de arrastar e soltar. Isso mostra o layout básico da Central de Preferências que lista todos os grupos de inscrições de e-mail automaticamente. Se você usar alias de link, adicione um ponto de interrogação (?) após a Liquid tag para que a Braze possa anexar parâmetros de rastreamento.

1
<a href="{{preference_center.${kitchenerie_preference_center_example}}}?">Edit your preferences</a>

A Central de Preferências tem uma caixa de seleção que permite que seus usuários cancelem a inscrição de todos os e-mails.

Testando Centrais de Preferências

Os links da Central de Preferências são gerados para cada usuário no momento do envio e estão vinculados a um envio ativo de Campaign ou Canvas. Envios de teste e prévias do editor não suportam salvar alterações de inscrição. Esse é o comportamento esperado.

O que você verá

• Envios de teste: As Liquid tags da Central de Preferências podem não resolver para um link válido. Se a página carregar, o botão Save Preferences estará desativado e as alterações de inscrição não serão salvas.
• Guia de prévia do editor de arrastar e soltar: Você pode visualizar o layout e o estilo, mas não pode testar o salvamento de preferências a partir do editor.

Como testar de ponta a ponta

Para verificar se os links e botões da Central de Preferências funcionam antes de um lançamento completo:

1. Crie uma Campaign de e-mail ou uma etapa de e-mail no Canvas que inclua sua Liquid tag da Central de Preferências.
2. Direcione apenas seus usuários teste ou um pequeno Segment interno.
3. Lance a mensagem e abra o e-mail a partir de uma caixa de entrada real (não use Send Test).
4. Selecione o link da Central de Preferências, atualize os grupos de inscrições e selecione Save Preferences.
5. Confirme as alterações no perfil do usuário no dashboard da Braze.

Como alternativa para Centrais de Preferências criadas via API, use o endpoint Gerar URL da Central de Preferências para obter uma URL funcional para um usuário específico fora de um envio de teste.

Para outras limitações de envio de teste, consulte Enviar mensagens de teste.

Prévia, envio de teste e envio ativo

Editar uma Central de Preferências

Você pode editar e atualizar sua Central de Preferências usando o endpoint Atualizar Central de Preferências.

Identificar centrais de preferências e detalhes

Para identificar suas centrais de preferências, use o endpoint Ver detalhes da Central de Preferências para retornar informações relacionadas, como o timestamp da última atualização, o ID da Central de Preferências e mais.

Personalizar uma Central de Preferências

A Braze gerencia as atualizações do estado de inscrição a partir da Central de Preferências, o que mantém a Central de Preferências sincronizada. No entanto, você também pode criar e hospedar sua própria Central de Preferências usando as APIs de grupos de inscrições com as seguintes opções.

Opção 1: Link com parâmetros de query string

Use pares de campo-valor de query string no corpo da URL para passar o ID do usuário e a categoria de e-mail para a página, de modo que os usuários só precisem confirmar sua escolha de cancelar a inscrição. Essa opção é boa para quem armazena um identificador de usuário em formato hash e ainda não possui uma central de inscrições.

Para essa opção, cada categoria de e-mail requer seu próprio link específico de cancelamento de inscrição:
http://mycompany.com/query-string-form-fill?field_id=Alex&field_category=offers

Dica

Também é possível aplicar hash ao ID externo do usuário no momento do envio usando um filtro Liquid. Isso converterá o user_id em um valor hash MD5, por exemplo:

1
2
{% assign my_string = ${user_id} | md5 %}
My encoded string is: {{my_string}}

Opção 2: Autenticar com JSON web token

Use um JSON web token para autenticar usuários em uma parte do seu servidor web (por exemplo, preferências da conta) que normalmente está protegida por uma camada de autenticação, como login com nome de usuário e senha.

Essa abordagem não requer pares de campo-valor de query string incorporados na URL, pois eles podem ser passados na carga útil do JSON web token, por exemplo:

1
2
3
4
5
{
    "user_id": "1234567890",
    "name": "Alex Smith",
    "category": "offers"
}

Perguntas frequentes

Por que minha Central de Preferências não funciona em um envio de teste?

Os links da Central de Preferências exigem um contexto de envio real. Envios de teste não geram URLs válidas da Central de Preferências, e o botão Save Preferences fica desativado se a página for carregada. Esse é o comportamento esperado. Para testar de ponta a ponta, lance uma Campaign ou etapa do Canvas para um usuário teste ou um Segment interno pequeno, ou use o endpoint Gerar URL da Central de Preferências. Para mais detalhes, consulte Testando centrais de preferências.

Eu não criei uma Central de Preferências. Por que estou vendo “PreferenceCenterBrazeDefault” no meu dashboard?

Isso é usado para renderizar a Central de Preferências quando o Liquid legado ${preference_center_url} é utilizado, o que significa que etapas do Canvas ou modelos que referenciam ${preference_center_url} ou preference_center.${PreferenceCenterBrazeDefault} não funcionarão. Isso também se aplica a mensagens enviadas anteriormente que incluíam o Liquid legado ou “PreferenceCenterBrazeDefault” como parte da mensagem.

Se você referenciar ${preference_center_url} em uma nova mensagem novamente, uma Central de Preferências chamada “PreferenceCenterBrazeDefault” será criada novamente.

As centrais de preferências suportam múltiplos idiomas?

Não. No entanto, você pode usar Liquid ao escrever o HTML para páginas personalizadas de aceitação e cancelamento de inscrição. Se você estiver usando links dinâmicos para gerenciar cancelamentos de inscrição, trata-se de um link único.

Por exemplo, se você estiver rastreando a taxa de cancelamento de inscrição para usuários que falam espanhol, precisaria usar Campaigns separadas ou aproveitar a análise de dados do Currents (como verificar quando um usuário cancela a inscrição e conferir o idioma preferido desse usuário).

Como outro exemplo, para rastrear taxas de cancelamento de inscrição para usuários que falam espanhol, você poderia adicionar um parâmetro de query string como ?Spanish=true à URL de cancelamento de inscrição se o idioma do usuário for espanhol e usar um link de cancelamento de inscrição regular caso contrário:

1
2
3
4
{% if ${language} == 'spanish' %} "${unsubscribe_url}?spanish=true"
{% else %}
${unsubscribe_url}
{% endif %}

Então, por meio do Currents, você poderia identificar quais usuários falam espanhol e quantos eventos de clique houve para esse link de cancelamento de inscrição.

Ambos os links de cancelamento de inscrição e as centrais de preferências de e-mail são obrigatórios para o envio?

Não. Se você vir a mensagem “Your Email Body does not include an unsubscribe link” ao compor uma campanha de e-mail, esse aviso é esperado se o seu link de cancelamento de inscrição estiver em um bloco de conteúdo.

Como atualizo o ícone padrão do navegador?

Por padrão, o ícone ao lado do nome da aba do navegador (favicon) usa o logotipo da Braze. Para adicionar um favicon personalizado, você o define por meio do atributo links-tags na sua chamada de API para Criar ou Atualizar a Central de Preferências. A Braze então injeta a tag <link rel="icon" ...> na página hospedada para você.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "name": "MyPreferenceCenter",
  "preference_center_title": "Email Preferences",
  "preference_center_page_html": "<!doctype html> ...",
  "confirmation_page_html": "<!doctype html> ...",
  "state": "active",
  "options": {
    "links-tags": [
      {
        "rel": "icon",
        "type": "image/png",
        "sizes": "32x32",
        "href": "https://yourcdn.com/path/to/favicon-32x32.png"
      },
      {
        "rel": "shortcut icon",
        "type": "image/x-icon",
        "href": "https://yourcdn.com/path/to/favicon.ico"
      },
      {
        "rel": "apple-touch-icon",
        "sizes": "180x180",
        "href": "https://yourcdn.com/path/to/apple-touch-icon.png"
      }
    ]
  }
}