Pares chave-valor

Braze permite que você envie cargas úteis de dados extras para dispositivos de usuários via pares chave-valor. Este recurso está disponível nos canais de envio de mensagens push, in-app, e-mail e cartão de conteúdo.

Use pares de valores-chave para adicionar metadados estruturados às mensagens. Essas cargas úteis de dados extras podem enriquecer as mensagens com informações contextuais adicionais que podem influenciar a forma como uma mensagem é renderizada ou processada.

Como os pares chave-valor são metadados, esses dados não são necessariamente visíveis para o destinatário, mas podem ser usados por seus sistemas ou processos conectados para personalizar o envio de mensagens.

Cada par é composto por:

• Chave: O identificador (Exemplo: utm_source)
• Valor: Os dados associados (Exemplo: newsletter)

Casos de uso

Aqui estão alguns exemplos de casos de uso para adicionar metadados com pares de valores-chave:

1. Parâmetros de rastreamento: Anexar parâmetros UTM para fins de análise de dados
   • Chave: utm_campaign
   • Valor: spring_sale
2. Tags personalizadas: Adição de tags para roteamento interno ou categorização
   • Chave: priority
   • Valor: high
3. Disparadores de comportamento: Metadados usados para disparar ou personalizar comportamentos in-app
   • Chave: deep_link
   • Valor: app://promo-page

Notificações por push

Os pares de valores-chave podem ser adicionados a notificações por push para Android, iOS e web push. Você pode usar pares de valores-chave para atualizar métricas internas e o conteúdo do app ou personalizar as propriedades da notificação por push, como priorização de alertas, localização e sons.

No criador de mensagem, selecione a guia de Configurações, clique em Adicionar Novo Par e especifique seus pares chave-valor.

iOS

O serviço de Notificações por Push da Apple (APNs) suporta a definição de preferências de alerta e o envio de dados personalizados usando pares chave-valor. APNs faz uso da biblioteca reservada pela Apple aps, que inclui chaves e valores predeterminados que governam as propriedades de alerta.

biblioteca APS

Biblioteca de propriedades de alerta

O criador de mensagem da Braze lida automaticamente com a criação das seguintes chaves: alert e suas propriedades, content-available, sound e category.

Esses valores podem ser inseridos na guia Configurações ao criar uma messagem de push. Selecione Opções de Alerta e selecione uma chave de dicionário de alerta para que a chave seja automaticamente preenchida em uma nova entrada de chave-valor.

Quando a Braze envia uma notificação por push para a APNs, a carga útil será formatada como um JSON.

Simples carga útil

1
2
3
{
    "aps" : { "alert" : "Message received from Spencer" },
}

Carga Útil Complexa

1
2
3
4
5
6
7
8
9
10
11
12
{
    "aps" : {
        "alert" : {
            "body" : "Hi, welcome to our app!",
            "loc-key" : "France",
            "loc-args" : ["Bonjour", "bienvenue"],
            "action-loc-key" : "Button_Type_1",
            "launch-image" : "Paris"
      },
        "content-available" : 1
    },
}

Pares de chave-valor personalizados

Além dos valores de carga útil da biblioteca aps, você pode enviar pares de chave-valor personalizados para o dispositivo de um usuário. Os valores nesses pares são restritos a tipos primitivos: dicionário (objeto), vetor, string, número e Booleano.

Casos de uso para pares chave-valor personalizados incluem, mas não estão limitados a, manutenção de métricas internas e definição do contexto para a interface do usuário. Braze permite que você envie pares de chave-valor adicionais junto com uma notificação por push para serem usados como quiser em seu aplicativo dentro da chave extras. Se você preferir usar outra chave, certifique-se de que seu app possa lidar com essa chave personalizada.

A Apple aconselha os clientes a evitar incluir informações de clientes ou quaisquer dados sensíveis como dados de carga útil personalizados. Além disso, a Apple recomenda que qualquer ação associada a uma mensagem de alerta não deve excluir dados em um dispositivo.

campanhas acionadas por API

A Braze permite que você envie pares de chave-valor de string definidos pelo usuário, conhecidos como extras. Para acessar seus extras em campanhas acionadas por API e campanhas acionadas por API agendadas, no dashboard defina uma chave como “example_key” e um valor como "$json:{"foo": 1, "bar": 1}". Isso resultará em um console de desenvolvedor de saída de "extras": { "test": { "foo": 1, "bar": 1 }

Android

A Braze permite que você envie cargas de dados adicionais em notificações por push usando pares chave-valor.

Carga útil de dados

Semelhante ao push do iOS, você pode enviar pares de chave-valor personalizados para o dispositivo de um usuário.

Alguns casos de uso para pares chave-valor personalizados incluem a manutenção de métricas internas e a definição do contexto para a interface do usuário, mas podem ser usados para qualquer finalidade que você escolher.

campanhas acionadas por API

A Braze permite que você envie pares de chave-valor de string definidos pelo usuário, conhecidos como extras. Para acessar seus extras em campanhas acionadas por API e campanhas acionadas por API agendadas, no dashboard defina uma chave como “example_key” e um valor como "$json:{"foo": 1, "bar": 1}". Isso resultará em um console de desenvolvedor de saída de "extras": { "test": { "foo": 1, "bar": 1 }

Opções de envio de mensagens do FCM

As notificações por push do Android podem ser ainda mais personalizadas com as opções de mensagens do FCM. Estes incluem prioridade de notificação, som, postergação, vida útil e colapsabilidade. Esses valores podem ser inseridos na guia Configurações ao criar uma messagem de push. Consulte Configurações avançadas de notificação por push para obter mais instruções sobre como definir essas opções no criador de mensagem do Braze.

Notificações por push silenciosas

Uma notificação por push silenciosa é uma notificação por push que não contém mensagem de alerta ou som, usada para atualizar a interface ou o conteúdo do seu app em segundo plano. Essas notificações utilizam pares de chave-valor para disparar essas ações de app em segundo plano. Notificações por push silenciosas também alimentam nosso rastreamento de desinstalação.

Os profissionais de marketing devem testar esse comportamento esperado do disparo de notificações por push silenciosas antes de enviá-las aos usuários do app. Depois de compor sua iOS ou Android notificação por push silenciosa, certifique-se de direcionar apenas um usuário teste filtrando pelo ID de usuário externo ou endereço de e-mail.

Após o lançamento da campanha, você deve verificar se não recebeu nenhuma notificação por push visível no seu dispositivo de teste.

Mensagem no app

Para adicionar um par chave-valor a uma mensagem no app, selecione a guia Configurações no criador de mensagem, clique em Adicionar Novo Par e especifique seus pares chave-valor.

campanhas acionadas por API

A Braze permite que você envie pares de chave-valor de string definidos pelo usuário, conhecidos como extras. Para acessar seus extras em campanhas acionadas por API e campanhas acionadas por API agendadas, no dashboard defina uma chave como “example_key” e um valor como "$json:{"foo": 1, "bar": 1}". Isso resultará em um console de desenvolvedor de saída de "extras": { "test": { "foo": 1, "bar": 1 }

E-mails

Tanto o SparkPost quanto o SendGrid aceitas pares de chave/valor em e-mails. Se você usar o SendGrid, pares de chave/valor serão enviados como argumentos únicos. SendGrid permite que você anexe um número ilimitado de pares chave-valor até 10.000 bytes de dados. Esses pares de chave-valor podem ser vistos em postagens do Webhook de Eventos do SendGrid.

Cartões de conteúdo

Para adicionar um par chave-valor a um cartão de conteúdo, acessar a Configurações guia no criador de mensagem Braze e clicar em Adicionar Novo Par.