Pular para o conteúdo principal

Visão geral da integração OneSignal Segment

Visão geral

A integração OneSignal + Segment permite que você:
  • Envie características e eventos de usuários do Segment para o OneSignal para enriquecer perfis de usuários, potencializar segmentação e acionar mensagens.
  • Envie eventos de entrega e engajamento de mensagens do OneSignal para o Segment para análises centralizadas e data warehousing.
Esta configuração bidirecional suporta todos os principais canais do OneSignal: Push, In-App, Email e SMS.

Requisitos

  • Uma Conta OneSignal Growth, Professional ou Enterprise.
  • Permissões de Administrador do Segment
  • O SDK Móvel e/ou SDK Web do OneSignal do qual você deseja enviar dados. Integrações apenas de Email ou SMS não requerem o SDK.
  • A Propriedade do OneSignal: ID Externo que mapeia para o userId do Segment.com.

Configuração

1. Configure o OneSignal

Use um aplicativo existente ou crie um novo no dashboard do OneSignal. Em seguida, configure seus canais preferidos:

2. Conecte o Segment ao OneSignal

No Dashboard do OneSignal, navegue até Dados > Integrações e clique em Ativo no cartão Segment.com. Em seguida, continue com as opções de configuração.

Entrada de dados

“Entrada de Dados” para o OneSignal permite que você envie segmentos do OneSignal, tags e eventos personalizados da sua conta Segment.com para o OneSignal. Clique em Autenticar na seção Entrada de Dados da página de configurações do Segment.com no Dashboard do OneSignal.
Os eventos personalizados estão atualmente em beta. Para solicitar acesso, entre em contato com support@onesignal.com com:
  • Nome da sua empresa
  • Seu ID de Organização do OneSignal
  • O(s) ID(s) de Aplicativo que você deseja habilitar
Uma vez habilitado para rastrear eventos personalizados, a integração Segment.com enviará tanto Data Tags quanto Eventos, então você não precisará atualizar nenhum template existente que referencie data tags.

Configurações de autenticação de Entrada de Dados

Assim que você clicar em Autenticar, uma página web do Segment.com será aberta e você será solicitado a fazer login na sua conta Segment.com. Em seguida, você será solicitado a configurar um novo destino de dados da sua conta Segment.com.

Tela de configuração do Segment

Saída de dados

Habilitar “Saída de Dados” para o Segment.com sincroniza eventos de mensagens gerados de volta para sua conta Segment.com. Esses eventos de mensagens são gerados ao enviar mensagens para seus usuários na plataforma OneSignal. Mais detalhes sobre que tipo de eventos podem ser gerados e as propriedades com as quais são enviados podem ser encontrados abaixo. Primeiro, você precisa adicionar o OneSignal como uma fonte da sua conta Segment.com. Você pode fazer isso navegando até a listagem de Fonte OneSignal no Catálogo de Conexões do Segment. A partir daí, você pode adicionar seu token de API do Segment.com no Dashboard do OneSignal. Por favor, navegue até Dados > Integrações > Segment no Dashboard do OneSignal para adicionar a chave de API do Segment.

Configuração de chave de API de Saída de Dados

Após configurar a chave de API, certifique-se de verificar suas configurações de Política de Dados no Segment.com para determinar se você precisa enviar eventos para o Endpoint de Residência da UE do Segment. Depois que todas essas configurações estiverem concluídas, você pode selecionar quais eventos deseja sincronizar com sua Conta Segment dependendo de quais canais você utiliza com o OneSignal.

3. Adicione o destino OneSignal no Segment

Em Segment.com Dashboard > Destinos você deve ver OneSignal. Caso contrário, adicione o OneSignal como um novo destino. Habilite o Destino OneSignal, você também deve ver sua Chave de API e ID de Aplicativo do OneSignal já configurados.

Configuração de destino OneSignal no Segment

Se a chave de API e o ID do Aplicativo não estiverem definidos, navegue até o dashboard do OneSignal, selecione o Aplicativo e vá para Configurações > Chaves e IDs. Copie e cole o “ID do Aplicativo” e a “chave de API” no Segment.com.

Múltiplas Fontes do Segment.com

Se você tiver múltiplas fontes, pode utilizar o recurso Personas > Spaces do Segment para vincular múltiplas fontes a um destino.

4. Envie dados do Segment para o OneSignal

O OneSignal armazena registros no nível do canal: Push/IAM, Email e SMS. Esses registros já devem estar criados no OneSignal e você também deve definir o alias de ID Externo no OneSignal para corresponder ao campo userID enviado pelo Segment.com.
Registros que não tenham um mapeamento ID de Usuário do Segment <—> ID Externo do OneSignal serão descartados.

Características ou propriedades do usuário

Você pode agregar dados em todos os pontos de contato com o cliente no Segment e, em seguida, enviar essas propriedades do usuário em tempo real para o OneSignal como Data Tags. Nota: O OneSignal não pode aceitar objetos aninhados ou arrays como propriedades de usuário. Identify - Características ou propriedades de usuário enviadas usando a chamada Identify do Segment são armazenadas como data tags no OneSignal. Por exemplo:

Exemplo de chamada identify do usuário

Track - Para eventos e propriedades associadas enviadas usando a chamada Track do Segment, o OneSignal armazenará todas as propriedades do evento como data tags, mas descartará o nome do evento ao armazenar as tags. Se você quiser manter os nomes dos eventos nas data tags, pode anexar o nome do evento às propriedades antes de enviá-las ao OneSignal. Por exemplo:
let timestampInSeconds = Int(NSDate().timeIntervalSince1970).toString()//convert to string since Segment adds decimals to end
//name will be dropped and only properties will be sent to OneSignal as tag "last opened: timestampInSeconds"
analytics.track(
  name: "iOS App Last Opened",
  properties: ["last opened": timestampInSeconds]
)

Exemplo de propriedades de chamada track

Interface de características e propriedades do usuário

Audiência Personas e Características Computadas

Audiências Persona aparecem automaticamente como um segmento no OneSignal. Características computadas são atualizadas como Data Tags nos registros de usuário do OneSignal. Audiência

Interface de audiência persona e características computadas

Audiências enviadas usando a chamada Track do Segment criarão um segmento do OneSignal com o Nome da Audiência. Audiências enviadas usando a chamada Identify do Segment irão
  • criar um segmento do OneSignal com o Nome da Audiência
  • adicionar data tags (se houver propriedades adicionais na chamada Identify) em todos os registros de usuário correspondentes.

Segmentos criados no OneSignal a partir do Segment

As chamadas Identify e Track são enviadas automaticamente para o OneSignal sempre que um usuário entra ou sai da Audiência. Características Computadas As Características Computadas de Personas são armazenadas como Data Tags nos registros de usuário do OneSignal, seja passadas ao OneSignal como uma chamada Identify ou uma chamada Track. Você pode então usar essas data tags para criar manualmente segmentos do OneSignal e automatizar seus fluxos de trabalho de mensagens.

Eventos de Mensagem

Tipos de Eventos

Estes são os tipos de eventos de mensagem que o OneSignal envia para o Segment
Tipo de MessageEventDescrição do Evento
Push SentNotificação push enviada com sucesso
Push ReceivedNotificação push recebida com sucesso
Push ClickedNotificação push tocada no dispositivo
In-App Message DisplayedMensagem In-App exibida com sucesso no dispositivo
In-App Message ClickedMensagem In-App clicada no dispositivo
In-App Message Page DisplayedPágina de Mensagem In-App é exibida
Email SentEmail enviado com sucesso
Email OpenedEmail aberto pelo destinatário
Email UnsubscribedDestinatário cancelou inscrição do email
Email ReceivedEmail recebido pelo destinatário
Email Reported As SpamEmail relatado como spam pelo destinatário
Email HardbouncedEmail retornado ao remetente devido a erro permanente
Email FailedNão foi possível entregar o email na caixa de entrada
SMS SentSMS enviado ao destinatário
SMS DeliveredSMS entregue com sucesso
SMS FailedFalha ao enviar SMS

Propriedades de Eventos

Estas são as propriedades presentes nos eventos enviados do OneSignal para o Segment.com
NOME DA PROPRIEDADEDESCRIÇÃO
userIdO external_id associado à mensagem
anonymousIdO subscription_id
messageIdO identificador da mensagem discreta
campaign_idO mesmo valor que messageId
message_nameO nome da mensagem
message_titleO título da mensagem
message_contentsO conteúdo da mensagem
subscription_typeO canal através do qual a mensagem foi enviada
template_idO template de mensagem usado
subscription_id.O identificador de dispositivo/email/sms do OneSignal
device_typeO tipo de dispositivo que recebeu a mensagem
languageO código de idioma de dois caracteres do dispositivo
message_typeO tipo de mensagem enviada: push, in-app, email, SMS

Perguntas frequentes

Como podemos passar eventos de Assinatura?

Os eventos de assinatura não estão sendo enviados automaticamente no momento. Isso pode ser feito com os Métodos do Observador de Assinatura do SDK do OneSignal. Consulte Rastreamento de Assinatura para mais detalhes.

Gerenciando Propriedades de Usuário Reservadas e Personalizadas do Segment no OneSignal

  • Todas as características de usuário do Segment são enviadas ao OneSignal como data tags. O número de data tags permitidas no OneSignal depende do seu plano de preços do OneSignal. Tags acima do número permitido serão descartadas.
  • O OneSignal sempre atualiza as propriedades firstName e lastName para usuários correspondentes. Todas as outras características são adicionadas/atualizadas por ordem de chegada. As tags firstName e lastName são armazenadas como “first_name” e “last_name”.
  • Propriedades de usuário enviadas ao OneSignal com valores em branco/nulos são removidas do registro de usuário do OneSignal. Isso é feito para garantir que você esteja dentro dos seus limites de data tag.