Skip to content

Segmento

A Segment é uma plataforma de dados do cliente que ajuda você a coletar, limpar e ativar os dados de seus clientes.

A integração do Braze e do Segment permite rastrear seus usuários e encaminhar dados para vários provedores de análise de dados de usuários. O Segment permite que você:

Pré-requisitos

Integração

Para integrar o Braze e o Segment, você deve definir o Braze como um destino de acordo com o tipo de integração escolhido (modo de conexão). Se você for um cliente novo no Braze, poderá retransmitir dados históricos para o Braze usando replays de segmentos. Em seguida, você deve configurar mapeamentos e testar sua integração para garantir um fluxo de dados suave entre o Braze e o Segment.

Etapa 1: crie um destino da Braze

Depois de configurar suas fontes com êxito, você precisará configurar a Braze como um destino para cada fonte (iOS, Android, Web etc.). Você terá muitas opções para personalizar o fluxo de dados entre o Braze e o Segment usando as configurações de conexão.

Etapa 2: escolha a estrutura do destino e o tipo de conexão

No Segment, navegue até Destinos > Braze > Configurar o Braze > Selecione sua fonte > Configuração.

A página de configuração da fonte. Esta página inclui configurações para definir a estrutura de destino como "ações" ou "clássica" e definir o modo de conexão como "modo de nuvem" ou "modo de dispositivo".

Você pode integrar o código-fonte da Web da Segment (Analytics.js) e as bibliotecas nativas do lado do cliente com a Braze usando uma integração lado a lado (modo dispositivo) ou uma integração servidor a servidor (modo nuvem).

Sua escolha do modo de conexão será determinada pelo tipo de fonte para o qual o destino está configurado.

Integração lado a lado de SDK

Também chamada de modo dispositivo, essa integração mapeia o SDK e os métodos da Segment para o SDK da Braze, permitindo o acesso a todos os recursos do nosso SDK, como push, envio de mensagens no app e outros métodos nativos da Braze.

Ao usar uma conexão no modo dispositivo, semelhante à integração nativa do Braze SDK, o Braze SDK atribuirá um device_id e um identificador de backend, braze_id, a cada usuário. Isso permite que o Braze capture a atividade anônima do dispositivo fazendo a correspondência com esses identificadores em vez de userId.

Para configurar o Braze como um destino de modo de dispositivo para sua origem Android, escolha Actions (Ações ) como a estrutura Destination(Destino) e, em seguida, selecione Save (Salvar).

Para concluir a integração lado a lado, consulte as instruções detalhadas da Segment para adicionar a dependência de destino do Braze ao seu app para Android.

O código-fonte para a integração do modo de dispositivo Android é mantido pelo Braze e é atualizado regularmente para refletir as novas versões do Braze SDK.

Para configurar o Braze como um destino no modo dispositivo para sua origem iOS, escolha Ações como a estrutura de destino e selecione Salvar.

Para concluir a integração lado a lado, consulte as instruções detalhadas do Segment para adicionar o pod Braze Segment ao seu app para iOS.

O código-fonte da integração do modo de dispositivo iOS é mantido pela Braze e é atualizado regularmente para refletir as novas versões do Braze SDK.

A estrutura do Braze Web Mode (Actions) da Segment é recomendada para configurar o Braze como um destino de modo de dispositivo para sua fonte da Web.

Em Segment, selecione Actions (Ações ) como sua estrutura de destino e Device Mode (Modo dispositivo ) como seu modo de conexão.

O código-fonte do plug-in React Native Braze é mantido pela Segment e é atualizado regularmente para refletir as novas versões do Braze SDK.

Ao conectar uma fonte React Native Segment à Braze, configure uma origem e um destino por sistema operacional. Por exemplo, um destino para iOS e de um destino para Android.

Na base de código do seu aplicativo, inicialize condicionalmente o Segment SDK por tipo de dispositivo, usando a respectiva chave de gravação de origem associada a cada app.

Quando um token por push é registrado de um dispositivo e enviado à Braze, ele é associado ao identificador do app usado na inicialização do SDK. A inicialização condicional do tipo de dispositivo ajuda a confirmar que todos os tokens por push enviados ao Braze estão associados ao aplicativo relevante.

Para configurar o Braze como um destino de modo de dispositivo para cada origem, selecione Ações como a estrutura de destino e, em seguida, selecione Salvar.

Integração de servidor para servidor

Também chamada de modo de nuvem, essa integração encaminha dados do Segment para as APIs REST do Braze. Use a estrutura do Braze Cloud Mode (Actions) do Segment para configurar um destino em modo de nuvem para qualquer uma de suas origens.

Diferentemente da integração lado a lado, a integração servidor a servidor não oferece suporte aos recursos da interface do usuário do Braze, como envio de mensagens no app, cartões de conteúdo ou registro automático de token por push. Também existem dados capturados automaticamente (como usuários anônimos e campos no nível do dispositivo) que não estão disponíveis no modo de nuvem.

Se quiser usar esses dados e recursos, considere adotar a integração lado a lado (modo de dispositivo) do SDK.

O código-fonte do destino Braze Cloud Mode (Actions) é mantido pela Segment.

Etapa 3: Configurações

Defina as configurações para seu destino. Nem todas as configurações se aplicarão a todos os tipos de destinos.

Etapa 4: métodos de mapas

O Braze oferece suporte aos métodos Page, Identify e Track Segment. Os tipos de identificadores usados nesses métodos dependerão do fato de os dados estarem sendo enviados por meio de uma integração servidor a servidor (modo nuvem) ou lado a lado (modo dispositivo). Nos destinos Braze Web Mode Actions e Cloud Mode Actions, você também pode optar por configurar um mapeamento para uma chamada de alias da Segment.

O destino Modo de nuvem (Ações) oferece uma ação Criar alias que pode ser usada para criar um usuário somente de alias ou adicionar um alias a um perfil external_id existente. A ação Identificar usuário pode ser usada juntamente com a ação Criar alias para mesclar um usuário somente de alias com um external_id depois que um estiver disponível para o usuário.

Também é possível criar uma solução alternativa e usar o braze_id para enviar dados de usuários anônimos no modo de nuvem. Para isso, é necessário incluir manualmente o endereço braze_id do usuário em todas as suas chamadas à API do Segment. Você pode saber mais sobre como configurar essa solução alternativa na documentação do Segment.

Os dados de destinos enviados à Braze podem ser agrupados em ações do modo de nuvem. Os tamanhos dos lotes são limitados a 75 eventos, e esses lotes se acumulam em um período de 30 segundos antes de serem descarregados. O agrupamento de solicitações é feito por ação. Por exemplo, as chamadas de identificação (atribuições) serão agrupadas em uma solicitação e as chamadas de rastreamento (eventos personalizados) serão agrupadas em uma segunda solicitação. A Braze recomenda ativar esse recurso, pois ele reduz o número de solicitações enviadas da Segment para a Braze. Por sua vez, isso reduzirá o risco de o destino atingir os limites de frequência do Braze e tentar novamente as solicitações.

Você pode ativar a criação de lotes para uma ação em Braze Destination > Mappings (Destino da Braze > Mapeamentos). A partir daí, clique no ícone de três pontos à direita do mapeamento e selecione Editar mapeamento. Role até a parte inferior da seção Select mappings (Selecionar mapeamentos ) e verifique se a opção Batch Data to Braze está definida como Yes (Sim).

Identificar

A chamada Identify permite vincular um usuário às suas ações e registrar atribuições sobre ele.

Certas características especiais do Segmento são mapeadas para campos de perfil de atribuição padrão no Braze:

Outros campos de perfil reservados do Braze, como email_subscribe e push_subscribe, podem ser enviados usando a convenção de nomenclatura do Braze para esses campos e passando-os como características em uma chamada de identificação.

Adição de um usuário a um grupo de inscrições

Também é possível inscrever ou cancelar a inscrição de um usuário em um determinado grupo de inscrições usando os seguintes campos no parâmetro traits.

Use o campo reservado do perfil da Braze chamado braze_subscription_groups, que pode ser associado a um vetor de objetos. Cada objeto do vetor deve ter duas chaves reservadas:

  1. subscription_group_state: Indica se o usuário está "subscribed" ou "unsubscribed" em um grupo de inscrições específico.
  2. subscription_group_id: Representa o ID exclusivo do grupo de inscrições. Você pode encontrar esse ID no dashboard do Braze, em Gerenciamento do grupo de inscrições.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
analytics.identify(
  userId: "{your-user}",
  traits: [
    "braze_subscription_groups": [
      [
        "subscription_group_id": "{your-group-id}",
        "subscription_group_state": "subscribed"
      ],
      [
        "subscription_group_id", "{your-group-id}",
        "subscription_group_state": "unsubscribed"
      ]
    ]
  ]
)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
analytics.identify(
  "{your-user}",
  buildJsonObject {
    put("braze_subscription_groups", buildJsonArray {
        add(
          buildJsonObject {
            put("subscription_group_id", "{your-group-id}")
            put("subscription_group_state", "subscribed")
          }
        )
        add(
          buildJsonObject {
            put("subscription_group_id", "{your-group-id}")
            put("subscription_group_state", "unsubscribed")
          }
        )
      }
    )
  }
)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
analytics.identify(
  "{your-user}",
  {
    braze_subscription_groups: [
      {
        subscription_group_id: "{your-group-id}",
        subscription_group_state: "subscribed"
      },
      {
        subscription_group_id: "{your-group-id}",
        subscription_group_state: "unsubscribed"
      }
    ]
  }
)
Atributos personalizados

Todas as outras características serão registradas como atributos personalizados.

Nos destinos Ações do Modo Web e Ações do Modo Nuvem, os mapeamentos acima podem ser definidos usando a Ação Atualizar Perfil de Usuário.

Rastreamento

Quando rastrear um evento, registraremos esse evento como um evento personalizado usando o nome fornecido.

Os metadados enviados dentro do objeto de propriedades da chamada de rastreamento serão registrados no Braze como as propriedades de evento personalizado para o evento associado. Todos os tipos de dados de propriedades de eventos personalizados são compatíveis.

Nos destinos Ações do modo Web e Ações do modo Nuvem, os mapeamentos acima podem ser definidos usando a Ação de rastreamento de eventos.

Pedido concluído

Quando você rastrear um evento com o nome Order Completed usando o formato descrito na API de comércio eletrônico da Segment, registraremos os produtos que você listou como compras.

Nos destinos Web Mode Actions e Cloud Mode Actions, o mapeamento padrão pode ser personalizado pela ação de rastreamento de compra.

Página

A chamada Page permite registrar sempre que um usuário vê uma página do seu site, juntamente com quaisquer propriedades opcionais sobre a página.

Esse tipo de evento pode ser usado como um disparo nos destinos Web Mode Actions e Cloud Actions para registrar um evento personalizado no Braze.

Etapa 5: Teste sua integração

Ao usar a integração lado a lado (modo de dispositivo), suas métricas de visão geral (sessões vitalícias, MAU, usuário ativo diário, aderência, sessões diárias e sessões diárias por MAU) podem ser usadas para assegurar que a Braze receba dados da Segment.

Você pode visualizar seus dados nas páginas de eventos personalizados ou de receita, ou criando um segmento. A página Eventos personalizados do dashboard permite que você visualize as contagens de eventos personalizados ao longo do tempo. Observe que você não poderá usar fórmulas que incluam estatísticas de MAU e DAU ao usar uma integração de servidor para servidor (modo de nuvem).

Se estiver enviando dados de compra para o Braze (veja o pedido concluído na guia Rastreamento da etapa 3), a página de receita permite visualizar dados sobre receita ou compras em períodos específicos ou a receita total do seu app.

A criação de um segmento permite filtrar os usuários com base nos dados de eventos e atributos personalizados.

Exclusão e supressão de usuários

Se precisar excluir ou suprimir usuários, note que o recurso de exclusão de usuários do Segment é mapeado para o endpoint /users/delete da Braze. Observe que a verificação dessas exclusões pode levar até 30 dias.

É necessário selecionar um identificador de usuário comum entre a Braze e a Segment (como em external_id). Depois de iniciar uma solicitação de exclusão com o Segment, você pode visualizar o status na guia solicitações de exclusão no dashboard do Segment.

Repetições de segmentos

A Segment presta um serviço aos clientes para “reproduzir” todos os dados históricos em um novo parceiro de tecnologia. Os novos clientes da Braze que desejarem importar todos os dados históricos relevantes poderão fazê-lo por meio da Segment. Fale com seu representante da Segment se isso for algo de seu interesse.

O Segment se conectará ao nosso endpoint/users/track para importar dados de usuários para o Braze em seu nome.

Melhores práticas

Review use cases to avoid data overages.

O Segment não limita o número de elementos de dados que os clientes enviam para ele. O segmento permite que você envie todos ou decida quais eventos serão enviados ao Braze. Em vez de enviar todos os seus eventos usando o Segment, sugerimos que você analise os casos de uso com suas equipes de marketing e editorial para determinar quais eventos serão enviados ao Braze para evitar excedentes de dados.

Understand the difference between the custom API endpoint and the custom REST API endpoint in the Mobile Device Mode destination settings.

Seu endpoint da Braze API (chamado de “Custom API Endpoint” na Segment) é o endpoint de SDK que a Braze configura para seu SDK (por exemplo, sdk.iad-03.braze.com). Seu endpoint da API REST da Braze (chamado de “Custom REST API Endpoint” na Segment) é o endpoint da REST API (por exemplo, https://rest.iad-03.braze.com)

Ensure your custom API endpoint is correctly input into the mobile device mode destination settings.

É necessário seguir o formato adequado para não correr o risco de informar o endpoint do Braze SDK incorretamente. Seu endpoint do Braze SDK não deve incluir https:// (por exemplo, sdk.iad-03.braze.com), senão a integração da Braze será interrompida. Isso é necessário porque o Segment prefixa automaticamente seu endpoint com https://, o que resulta em uma tentativa de inicialização da Braze com o endereço inválido https://https://sdk.iad-03.braze.com.

Data mapping nuances.

Cenários em que os dados não serão transmitidos conforme o esperado:

  1. Atributos personalizados aninhados
    • Embora os atributos personalizados aninhados possam tecnicamente ser enviados ao Braze por meio do Segment, toda a carga útil será enviada a cada vez. Isso incorrerá em pontos de dados por chave passada no objeto aninhado toda vez que a carga útil for enviada.

      Para gastar apenas um subconjunto de pontos de dados quando a carga útil é enviada, você pode usar o recurso de funções de destino personalizadas pertencente ao Segment. Esse recurso da plataforma Segment permite que você personalize a forma como os dados são enviados para destinos downstream.

2. Passagem de dados anônimos de servidor para servidor.

  • Os clientes podem usar as bibliotecas de servidor para servidor da Segment para canalizar dados anônimos para outros sistemas. Consulte a seção de métodos de mapa para saber mais sobre como enviar usuários sem um external_id para o Braze por meio de uma integração de servidor para servidor (modo de nuvem).
Customization of Braze initialization.

Há várias maneiras diferentes de personalizar o Braze: push, mensagens no app, cartões de conteúdo e inicialização. Com uma integração lado a lado, você ainda pode personalizar o push, as mensagens no app e os cartões de conteúdo, como faria com uma integração direta do Braze.

No entanto, personalizar quando o Braze SDK é integrado ou especificar as configurações de inicialização é uma tarefa complicada que nem sempre é possível. Isso ocorre porque a Segment inicializa o Braze SDK para você quando a inicialização do Segment ocorre.

Sending deltas to Braze.

Ao passar os dados de usuários, verifique se só passa valores para atributos que foram alterados desde a última atualização. Isso evitará o registro de pontos de dados desnecessários. Para fontes do lado do cliente, use a ferramenta middleware de código aberto da Segment para otimizar sua integração e limitar o uso de pontos de dados, eliminando chamadas identify() da Segment.

New Stuff!