Adicione um rótulo nomeado a cada e-mail enviado e acompanhe o engajamento de aberturas e cliques dessa tag no console, sem alterar seu fluxo de envio SMTP.
Pré-requisitos
Antes de começar, verifique se você tem:
Uma tag criada no console do Direct Mail. O valor
TagNameno cabeçalho de rastreamento deve corresponder a uma tag existente.O Exemplo de chamada SMTP em Java configurado como base para seus envios.
Para obter detalhes sobre como ativar o recurso de rastreamento, consulte Como ativar o recurso de rastreamento de dados.
Adicionar dependências
Adicione as seguintes dependências ao seu projeto Maven. O código usa Gson para serializar os parâmetros de rastreamento como JSON e commons-codec para codificar o resultado em Base64.
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.6</version>
</dependency>
<dependency>
<groupId>commons-codec</groupId>
<artifactId>commons-codec</artifactId>
<version>1.2</version>
</dependency>Definir o cabeçalho de rastreamento
Crie um objeto JSON com os campos abaixo, codifique-o em Base64 e anexe-o a cada mensagem como o cabeçalho X-AliDM-Trace.
Campos do cabeçalho de rastreamento
|
Campo |
Valores aceitos |
Descrição |
|
|
|
Rastreia quantos destinatários abriram o e-mail. Usa um pixel invisível e requer que as imagens estejam ativadas no cliente de e-mail. |
|
|
|
Rastreia quantos destinatários clicaram nos links do e-mail. Substitui os links por URLs rastreadas e funciona tanto em e-mails HTML quanto em texto simples. |
|
|
Qualquer nome de tag criado no console |
Agrupa os dados de abertura e clique sob esta tag no console. Deve corresponder exatamente a uma tag existente. |
O valor TagName deve corresponder a uma tag já existente no console do Direct Mail. Se o nome não coincidir com uma tag válida, o sistema descartará silenciosamente os dados de rastreamento dessa mensagem.
Exemplo de código
// Set the tracking header to enable open and click tracking.
// For prerequisites and constraints, see "How to enable the data tracking feature".
String tagName = "Test";
HashMap<String, String> trace = new HashMap<>();
trace.put("OpenTrace", "1"); // Enable email open tracking.
trace.put("LinkTrace", "1"); // Enable URL click tracking in emails.
trace.put("TagName", tagName); // The tag name created in the console.
String jsonTrace = new GsonBuilder().setPrettyPrinting().create().toJson(trace);
String base64Trace = new String(Base64.getEncoder().encode(jsonTrace.getBytes()));
// Set the tracking header.
message.addHeader("X-AliDM-Trace", base64Trace);
// Example value in the raw EML file: X-AliDM-Trace: eyJUYWdOYW1lIjoiVGVzdCIsIk9wZW5UcmFjZSI6IjEiLCJMaW5rVHJhY2UiOiIxIn0=Após o envio do e-mail, os dados de engajamento (aberturas e cliques) aparecem em tempo real no console, agrupados pelo nome da tag especificada.