Arquivamento de mensagens

O arquivamento de mensagens permite que você salve uma cópia das mensagens enviadas aos usuários para fins de arquivamento ou conformidade em seu bucket S3 da AWS, contêiner de Blob Storage do Azure ou bucket do Google Cloud Storage.

Este artigo aborda como configurar o arquivamento de mensagens, referências de carga útil JSON e perguntas frequentes.

O arquivamento de mensagens está disponível como um recurso complementar. Para começar com o arquivamento de mensagens, entre em contato com seu gerente de sucesso do cliente da Braze.

Como funciona

Quando esse recurso está ativado, a Braze grava um arquivo JSON compactado em gzip para cada mensagem enviada a um usuário através dos canais selecionados (e-mail, SMS/MMS ou push). A Braze grava esses arquivos no seu destino padrão de exportação de dados. Isso inclui todos os tipos de campanha para cada canal, como campanhas de e-mail de transação enviadas através da API de e-mail de transação.

Esse arquivo conterá os campos definidos em Referências de arquivo e refletirá as mensagens finais com modelo aplicado enviadas ao usuário. Todos os valores de modelo definidos em sua campanha (por exemplo, {{${first_name}}}) mostrarão o valor final que o usuário recebeu com base nas informações de perfil. Isso permite que você retenha uma cópia da mensagem enviada para atender aos requisitos de conformidade, auditoria ou suporte ao cliente.

Se você configurar credenciais para vários provedores de armazenamento em nuvem, o arquivamento de mensagens só será exportado para aquele marcado como o destino padrão de exportação de dados. Se nenhum padrão explícito for definido e um bucket S3 da AWS estiver conectado, o arquivamento de mensagens fará upload para esse bucket.

O JSON será salvo em seu bucket de armazenamento usando a seguinte estrutura de chave:

sent_messages/{channel, one of: email, push, sms}/{MD5 digest of downcased: email address, push token, or E.164 phone number}/{campaign or Canvas step API ID}/{dispatch ID}.json.gz

Um arquivo de exemplo pode ter a seguinte aparência:

sent_messages/email/819baa08d8d7e77e19d4666f5fc6050b/ee965cb2-8934-4b0a-acf1-91c899c2f915/651fd10b282850b39e1169c13975234b.json.gz

Configuração do arquivamento de mensagens

Esta seção orienta você na configuração do arquivamento de mensagens para o seu espaço de trabalho. Antes de continuar, confirme se sua empresa comprou e ativou o arquivamento de mensagens.

Etapa 1: Conecte um bucket de armazenamento em nuvem

Se ainda não tiver feito isso, conecte um bucket de armazenamento em nuvem à Braze. Para obter as etapas, consulte a documentação de nossos parceiros sobre o Amazon S3, o Azure Blob Storage ou o Google Cloud Storage.

Etapa 2: Selecione canais para o arquivamento de mensagens

A página de configurações de Arquivamento de mensagens controla quais canais salvarão uma cópia das mensagens enviadas em seu bucket de armazenamento na nuvem.

Para selecionar canais:

1. Acesse Configurações > Arquivamento de mensagens.
2. Selecione seus canais.
3. Selecione Salvar alterações.

Referências de arquivo

A seguir estão referências à carga útil JSON entregue ao seu bucket de armazenamento em nuvem cada vez que uma mensagem é enviada. Consulte nosso repositório de exemplos de código para obter arquivos de amostra de arquivamento de mensagens.

• email
• sms/mms
• push

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
{
  "version": 1, //numerical version of the JSON structure
  "to": ToAddress, ("[email protected]")
  "subject": SubjectLine ("20% off coupon inside!"),
  "from_name": DisplayName ("Braze"),
  "from_address": FromAddress ("[email protected]"),
  "html_body": HtmlBody,
  "plaintext_body": PlainTextBody,
  "amp_body": AMPEmailBody,
  "extras": Hash of key-value pairs from Email Extras configured in the email editor,
  "headers": HashOfHeaders,
  "sent_at": UnixTimestamp,
  "dispatch_id": DispatchIdFromBraze,
  "campaign_id": CampaignApiId, // may not be available
  "canvas_id": CanvasApiId, // may not be available
  "canvas_step_id": CanvasStepApiId, // may not be available
  "canvas_variation_id" : CanvasVariationApiId, // may not be available
  "message_variation_id": MessageVariationApiId, // may not be available,
  "attachments": Array of JSON Objects containing 'bytes' and 'file_name', // may not be available
  "user_id": String,
  "campaign_name": String, // will only be available if the message is from a campaign
  "canvas_name": String, // will only be available if the message is from Canvas
  "canvas_step_name": String, // will only be available if the message is from a Canvas
  "external_id": String
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "version": 1 //numerical version of the JSON structure
  "to": PhoneNumber, ("+15555555555"),
  "body": Body ("Hi there!"),
  "subscription_group": SubscriptionGroupExternalId,
  "provider": StringOfProviderName,
  "media_urls": ArrayOfString, // indicates a message is MMS
  "sent_at": UnixTimestamp,
  "dispatch_id": DispatchIdFromBraze,
  "campaign_id": CampaignApiId, // may not be available
  "canvas_id": CanvasApiId, // may not be available
  "canvas_step_id": CanvasStepApiId, // may not be available
  "canvas_variation_id" : CanvasVariationApiId, // may not be available
  "message_variation_id": MessagVariationApiId, // may not be available
  "user_id": String,
  "campaign_name": String, // will only be available if the message is from a campaign
  "canvas_name": String, // will only be available if the message is from Canvas
  "canvas_step_name": String, // will only be available if the message is from a Canvas
  "external_id": String
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "version": 1, //numerical version of the JSON structure
  "to": PushToken,
  "payload": JsonOfEntirePushPayload,
  "platform": one of "android_push" | "ios_push" | "kindle_push" | "web_push",
  "app_id": ApiKeyOfApp,
  "sent_at": UnixTimestamp,
  "dispatch_id": DispatchIdFromBraze,
  "campaign_id": CampaignApiId, // may not be available
  "canvas_id": CanvasApiApiId, // may not be available
  "canvas_step_id": CanvasStepApiId, // may not be available
  "canvas_variation_id" : CanvasVariationApiId, // may not be available
  "message_variation_id": MessagVariationApiId, // may not be available
  "user_id": String,
  "campaign_name": String, // will only be available if the message is from a campaign
  "canvas_name": String, // will only be available if the message is from a Canvas
  "canvas_step_name": String, // will only be available if the message is from a Canvas
  "external_id": String
}

Perguntas frequentes

Quais modelos não estão incluídos na carga útil?

As modificações feitas depois que a mensagem sai da Braze não serão refletidas no arquivo salvo em seu bucket de armazenamento em nuvem. Isso inclui modificações feitas por nossos parceiros de entrega de e-mail, como o encapsulamento de links para rastreamento de cliques e a inserção de pixels de rastreamento.

O que são mensagens sob o valor “unassociated” (não associado) no caminho da campanha?

Quando uma mensagem é enviada fora de uma campanha ou Canvas, o ID da campanha no nome do arquivo será “unassociated”. Isso acontece quando você envia mensagens de teste do dashboard, quando a Braze envia respostas automáticas de SMS/MMS, ou quando mensagens enviadas através da API não especificam um ID de campanha.

Como faço para obter mais informações sobre esse envio?

Você pode usar external_id ou dispatch_id em conjunto com user_id para cruzar a mensagem com modelo aplicado com nossos dados do Currents para encontrar mais informações, como o carimbo de data/hora em que foi entregue, se o usuário abriu ou clicou na mensagem, e mais.

Como as novas tentativas são tratadas?

Se seu bucket de armazenamento em nuvem não puder ser acessado, a Braze tentará novamente até três vezes com um jitter de backoff. As novas tentativas de limite de taxa do AWS S3 são tratadas automaticamente pela Braze.

O que acontece se minhas credenciais forem inválidas?

Se suas credenciais de armazenamento em nuvem se tornarem inválidas em algum momento, a Braze não poderá salvar nenhuma mensagem em seu bucket de armazenamento em nuvem, e essas mensagens serão perdidas. Recomendamos configurar suas preferências de notificação para Amazon Web Services, Google Cloud Services ou Azure (Microsoft Cloud Services) para que você receba alertas sobre quaisquer problemas de credenciais.

Por que o carimbo de data/hora sent_at do meu arquivo é ligeiramente diferente do carimbo de data/hora de envio no Currents?

A cópia renderizada é enviada por upload imediatamente antes de enviar a mensagem ao usuário. Devido aos tempos de upload do armazenamento em nuvem, pode haver um atraso de alguns segundos entre o carimbo de data/hora sent_at na cópia renderizada e a hora real em que o envio ocorre.

Posso criar um novo bucket especificamente para arquivamento de mensagens enquanto mantenho o bucket atual usado para dados do Currents?

Não. Se você estiver interessado em criar esses buckets específicos, envie feedback sobre o produto.

Os dados arquivados são gravados em uma pasta dedicada em um bucket existente, semelhante à forma como as exportações de dados do Currents são estruturadas?

Os dados são gravados em uma seção sent_messages do bucket. Consulte Como funciona para mais detalhes.

Posso usar o arquivamento de mensagens para agrupar arquivos em diferentes espaços de trabalho?

Não. O arquivamento de mensagens não oferece suporte ao agrupamento de arquivos com base em espaços de trabalho. Em vez disso, você pode determinar a qual espaço de trabalho o ID da API da campanha ou da etapa do Canvas pertence e, em seguida, agrupá-los com base nessa informação.