Pular para o conteúdo principal

Visão Geral da Integração OneSignal + Amplitude

Integre o OneSignal com Amplitude para enviar eventos de mensagens detalhados, eventos personalizados e importar coortes de usuários comportamentais. Isso permite segmentação em tempo real baseada no comportamento do usuário para melhorar onboarding, reengajamento e conversão.

​
Principais benefícios

  • Enviar eventos de mensagens para Amplitude: Rastreie entrega, cliques, falhas e muito mais através de push, no aplicativo, email e SMS.
  • Enviar eventos personalizados para OneSignal: Envie seus eventos personalizados do Amplitude para o OneSignal.
  • Importar coortes do Amplitude: Sincronize automaticamente coortes baseadas em comportamento no OneSignal como filtros para segmentação.
Esta é uma integração no nível do aplicativo, dando controle granular sobre quais aplicativos e eventos estão vinculados.

​
Requisitos

Esta integração não cria usuários. Ela mapeia os usuários no Amplitude para aqueles no OneSignal.

​
Configuração

​
Adicionar Amplitude ao OneSignal

No OneSignal, navegue até Dados > Integrações > Amplitude e clique em Ativar.

Cartão de integração Amplitude no OneSignal

No Amplitude:
  1. Encontre sua Chave de API do projeto e copie-cole no OneSignal.
  2. Se estiver usando os servidores EU do Amplitude, marque Enviar eventos exclusivamente para o Endpoint de Residência EU do Amplitude. Você pode verificar isso pela sua URL do Amplitude. Se você ver eu.amplitude.com, então está usando os servidores EU do Amplitude.

​
Selecionar eventos de mensagens

Selecione quais eventos de mensagens do OneSignal você deseja enviar para o Amplitude. Quando terminar, clique em Ativar.

Configurações do Amplitude no OneSignal

​
Adicionar OneSignal ao Amplitude

Em seus Destinos do Amplitude, procure por OneSignal.

Adicionar Destino OneSignal no Amplitude

Opções:
  • Coortes: Sincronizar coortes do Amplitude para o OneSignal.
  • Propriedades de Usuário de Eventos: Enviar eventos personalizados do Amplitude para o OneSignal.
Depois de selecionar uma ou ambas as opções, você será solicitado a inserir as seguintes informações:
  • Nome: Como você identifica o destino no Amplitude. Defina isso como algo identificável como OneSignal - APP_NAME onde APP_NAME é o nome do aplicativo no OneSignal.
  • App ID: O ID do Aplicativo OneSignal. Disponível no OneSignal em Configurações > Chaves & IDs
  • API Key: A Chave de API do OneSignal. Disponível no OneSignal em Configurações > Chaves & IDs

​
Enviar eventos

Recurso Beta. Você deve ter o recurso Eventos Personalizados habilitado no OneSignal para enviar eventos personalizados ao OneSignal.
Habilite esta opção se desejar enviar eventos personalizados do Amplitude para o OneSignal. Selecione os Eventos do Amplitude que você gostaria de enviar para o OneSignal.

Eventos do Amplitude para enviar ao OneSignal

​
Mapeamento de USER ID

Esta etapa é essencial para que a sincronização de coortes e o rastreamento de eventos funcionem corretamente.
Para corresponder usuários em ambos os sistemas:
  • Use um identificador compartilhado: O ID Externo no OneSignal deve corresponder a uma Propriedade de ID de Usuário do Amplitude selecionada (como user_id).
  • Verifique se a propriedade de usuário selecionada existe em seus Perfis de Usuário do Amplitude e OneSignal.

​
Propriedades adicionais

Você pode enviar propriedades adicionais ao OneSignal que serão incluídas nos eventos personalizados. Isso é útil para processar eventos no OneSignal somente se eles contiverem uma propriedade específica.
Clique em Salvar quando terminar.Agora você deve conseguir exportar coortes e eventos personalizados do Amplitude para o OneSignal e coletar eventos de mensagens do OneSignal para o Amplitude.

​
Testando eventos personalizados

  1. No Destino de Eventos Amplitude > OneSignal, clique no botão Testar Conexão.

Destino de Eventos Amplitude > OneSignal

  1. Certifique-se de que o "user_id" no payload está definido como um ID Externo de Usuário existente em seu Aplicativo OneSignal.
  2. Clique no botão Enviar Evento de Teste
  3. A caixa de Resposta deve permanecer vazia e você deve ver uma mensagem que diz "OneSignal has successfully received test event."

Exemplo de resposta

Se você receber um erro, certifique-se de que seu App ID do OneSignal e a chave de API REST estão adicionados ao Amplitude corretamente e o aplicativo está configurado para eventos personalizados.
  1. No OneSignal, navegue até Dados > Eventos Personalizados e você deve ver o evento de teste na lista.

Evento Personalizado no OneSignal

Se você não vir o evento, certifique-se de que o "user_id" está definido como um ID Externo de Usuário existente em seu Aplicativo OneSignal.

​
Exportar coortes do Amplitude para o OneSignal

Você pode sincronizar os usuários dentro de suas coortes do Amplitude com os usuários dentro do OneSignal, desde que tenham a propriedade User ID/External ID correspondente discutida na etapa anterior. Exportar dados de usuário do Amplitude não cria o usuário no OneSignal, o usuário já deve existir e ter o ID Externo correspondente. Para exportar usuários do Amplitude para o OneSignal:
  1. No Amplitude, crie uma coorte. Veja documentação do Amplitude sobre coortes.
  2. Clique em Sincronizar e escolha OneSignal como destino.
  3. Escolha a frequência de sincronização.

Imagem mostrando como você pode configurar uma sincronização para suas coortes com OneSignal

​
Criação de Segmento OneSignal

  • A coorte sincronizada aparece no OneSignal como um filtro de Segmento do Amplitude.
  • Um Segmento para a coorte será criado automaticamente se as seguintes condições forem atendidas:
    • Os usuários na Coorte do Amplitude também existem no OneSignal com ID Externo correspondente.
    • Você não deve exceder seu limite de Segmentos no OneSignal.
Se ambas as condições forem atendidas, o OneSignal gerará automaticamente um Segmento usando o filtro de Coorte do Amplitude e o nome da Coorte.

Como criar um Segmento a partir de uma Coorte do Amplitude

Perguntas comuns:

​
Rastrear eventos de mensagens no Amplitude

Uma vez conectado, o OneSignal enviará eventos de mensagens ao Amplitude em tempo real.

​
Eventos de mensagens

Estes são os tipos de eventos de mensagens que o OneSignal envia ao Amplitude. Você pode selecionar quais desses eventos deseja enviar para seu projeto Amplitude nas Configurações de Integrações do OneSignal.
Tipo de Evento de Mensagem (OneSignal)Nome do Evento de Mensagem (Amplitude)Descrição do Evento
Push Sent[OneSignal] Push SentNotificação push enviada com sucesso.
Push Received[OneSignal] Push Confirmed deliveryNotificação push recebida com sucesso
Push Clicked[OneSignal] Push ClickedNotificação push tocada no dispositivo
Push Failed[OneSignal] Push FailedFalha ao enviar push. Verifique o relatório de mensagens com falha no OneSignal.
Push Unsubscribed[OneSignal] Push UnsubscribedA Assinatura cancelou a inscrição de push.
In-App Impression[OneSignal] IAM DisplayedMensagem no aplicativo exibida com sucesso no dispositivo
In-App Clicked[OneSignal] IAM ClickedMensagem no aplicativo clicada no dispositivo
In-App Page Displayed[OneSignal] IAM Page DisplayedPágina da mensagem no aplicativo é exibida
Email Sent[OneSignal] Email SentEmail enviado com sucesso
Email Received[OneSignal] Email Confirmed deliveryEmail recebido pelo destinatário
Email Opened[OneSignal] Email OpenedEmail aberto pelo destinatário
Email Link Clicked[OneSignal] Email ClickedLink do email clicado
Email Unsubscribed[OneSignal] Email UnsubscribedEmail com cancelamento de inscrição pelo destinatário
Email Reported As Spam[OneSignal] Email Reported As SPAMEmail reportado como spam pelo destinatário
Email Bounced[OneSignal] Email Hard BouncedEmail retornado ao remetente devido a erro permanente
Email Failed[OneSignal] Email Failed deliveryNão foi possível entregar o email na caixa de entrada do destinatário
Email Suppressed[OneSignal] Email Not delivering to suppressed email addressEmail não entregue pois o destinatário suprimiu o endereço de email para o qual foi enviado
SMS Sent[OneSignal] SMS SentSMS enviado ao destinatário
SMS Failed[OneSignal] SMS Failed deliveryFalha ao enviar SMS
SMS Delivered[OneSignal] SMS Confirmed deliveerySMS entregue com sucesso
SMS Undelivered[OneSignal] SMS UndeliveredO SMS não pôde ser enviado.

​
Propriedades do evento

Estas são as propriedades presentes em qualquer evento enviado do OneSignal para o Amplitude
NOME DA PROPRIEDADEDESCRIÇÃO
Distinct IDO external_id associado com a mensagem
Message IDO identificador da mensagem discreta
Message NameO nome da mensagem
Message TitleO título da mensagem
Message ContentsO conteúdo da mensagem
message_typeO tipo de mensagem enviada: push, no aplicativo, email, SMS
template_idO template de mensagem usado (Mensagens de API e Jornada)
subscription_idO identificador OneSignal de dispositivo/email/sms
device_typeO tipo de dispositivo que recebeu a mensagem
languageO código de idioma de dois caracteres do dispositivo
sourceonesignal (é indicado como a fonte para todos os eventos)
Veja Por que meus dados de entrega não correspondem entre Amplitude e OneSignal?

​
Perguntas Frequentes

​
Por que as contagens de minha coorte e segmento não correspondem?

  1. IDs Externos ausentes ou incompatíveis Apenas usuários com um ID Externo OneSignal e ID de Usuário Amplitude correspondentes são incluídos. Esta integração não cria usuários ou assinaturas.
  2. Usuários não inscritos Segmentos OneSignal exibem apenas a contagem de Assinaturas inscritas. Assinaturas não inscritas estão disponíveis para Jornadas ou Mensagens no Aplicativo.
Por exemplo, se uma coorte do Amplitude tem 10 usuários mas o segmento OneSignal mostra 8 Assinaturas, os 2 usuários faltantes podem:
  • Não existir no OneSignal ou ter um ID Externo incorreto.
  • Ter assinaturas não inscritas.
Para verificar, confira a aba Público > Usuários no OneSignal para ver se os usuários existem e têm assinaturas ativas.

​
Usuários não inscritos sincronizam do Amplitude?

Sim, mas eles são excluídos das contagens de segmento OneSignal no momento. Você ainda pode enviar mensagens para eles via Jornadas ou mensagens no aplicativo se eles tiverem outras Assinaturas ou seu tipo de Assinatura suportar isso.

​
Por que os dados de entrega não correspondem?

Um único usuário pode ter múltiplas Assinaturas (dispositivos push, endereços de email, números de telefone). Cada Assinatura gera seu próprio evento de entrega. Por exemplo:
  • 1 usuário = 2 Android + 1 iOS + 2 Web = 5 Assinaturas push
  • 1 mensagem push = até 5 eventos enviados/recebidos/clicados
Use o subscription_id nas propriedades do evento para rastrear a fonte exata. Para solucionar eventos ausentes:
  • Certifique-se de que OneSignal.login seja chamado sempre que um usuário for identificado para definir o ID Externo.
  • Verifique se OneSignal.logout não está removendo o ID Externo.
  • Verifique solicitações de API ou uploads CSV que possam alterar o ID Externo.

​
Como podemos enviar eventos de usuário/assinatura?

Eventos de nível de usuário e assinatura (por exemplo, permissão concedida, login/logout do usuário) não são enviados automaticamente. O SDK OneSignal tem ouvintes de eventos que podem ser usados para rastrear esses eventos para você enviar ao Amplitude:

​
Por que o ID de Assinatura OneSignal é adicionado ao Amplitude como device_id?

O Amplitude espera um device_id para desduplicação. O OneSignal usa subscription_id para isso, que é mapeado automaticamente para device_id. Veja a documentação do Amplitude para mais informações.