Pular para o conteúdo principal
Envie dados de assinaturas e compras do RevenueCat para o OneSignal para enviar mensagens aos usuários de acordo com a etapa da assinatura em que estão. O RevenueCat atualiza as tags de cada usuário com o status de assinatura mais recente. Ele também pode enviar cada evento de compra para o OneSignal como um Custom Event. Com a integração do RevenueCat, você pode:
  • Enviar mensagens de onboarding para usuários que iniciam um teste gratuito ou assinam.
  • Reengajar usuários que cancelaram com pesquisas ou descontos.
  • Enviar mensagens transacionais sobre compras, renovações e problemas de cobrança.
  • Iniciar uma Journey no momento em que um usuário inicia um teste, cancela ou tem um problema de cobrança.

Requisitos \

Você deve estar familiarizado com tags, usuários e assinaturas.

Configuração \

Passar o OneSignal ID para o RevenueCat \

O RevenueCat usa o OneSignal ID para encontrar o usuário no OneSignal. O RevenueCat só atualiza usuários que têm um OneSignal ID salvo no RevenueCat.
Defina o External ID no OneSignal antes de enviar o OneSignal ID para o RevenueCat. Chamar login pode alterar o OneSignal ID. Se o RevenueCat tiver o ID antigo, as atualizações dele não chegam ao usuário.
1

Definir o External ID no OneSignal

Defina o External ID como o ID de usuário principal com o método login do SDK.
2

Obter o OneSignal ID

Use o observador de estado do usuário para obter o OneSignal ID sempre que ele mudar. Métodos getter também estão disponíveis.No observador, verifique se o External ID corresponde ao usuário esperado antes de passar o OneSignal ID adiante. Solicitações em cache, por exemplo de um dispositivo que estava offline, podem informar um usuário diferente.
3

Passar o OneSignal ID para o RevenueCat

Salve o OneSignal ID no RevenueCat como o atributo de assinante $onesignalUserId. Use o método auxiliar do RevenueCat setOnesignalUserID() ou defina o atributo diretamente.Se o seu aplicativo já usa o OneSignal, envie também o OneSignal ID dos usuários existentes quando eles atualizarem para a nova versão do aplicativo. Consulte os exemplos de código do RevenueCat.
No SDK do OneSignal v4 e anteriores, o RevenueCat usa o atributo $onesignalId (o Player ID) e o método auxiliar setOnesignalID().

Conectar o OneSignal ao RevenueCat \

1

Abrir a integração do OneSignal

No painel do RevenueCat, abra as configurações do projeto e escolha OneSignal no menu Integrations.
2

Adicionar seus aplicativos OneSignal

Insira o App ID e a App API key do aplicativo OneSignal para cada tipo de compra. Consulte Chaves e IDs para encontrá-los.
  • Production: as compras de produção vão para este aplicativo.
  • Sandbox: as compras sandbox vão para este aplicativo. Pode ser o mesmo aplicativo de Production ou um aplicativo separado, como o usado pelos seus builds de desenvolvimento.
Se você deixar os dois campos de uma seção vazios, o RevenueCat não envia eventos para esse tipo de compra.
3

Escolher se deseja enviar Custom Events

Ative Send as Custom Events para enviar cada evento também como um Custom Event, além de atualizar as tags. A opção vem ativada por padrão em novas integrações. Desative-a se o seu aplicativo OneSignal estiver no plano gratuito.
4

Definir os nomes das tags

Insira os nomes de tags que o RevenueCat deve usar ou mantenha os padrões. Consulte Tags que o RevenueCat envia.
O RevenueCat escolhe o aplicativo OneSignal pelo ambiente da compra, não pelo tipo de build. Compras do TestFlight, de testadores de licença do Google Play e de outras contas de teste são compras sandbox, mesmo em um build de release. Garanta que esses usuários existam no seu aplicativo Sandbox, ou a atualização falhará.
Integrações criadas antes da existência da seção Sandbox mostram o mesmo aplicativo em Production e Sandbox. Elas continuam enviando compras sandbox para o mesmo lugar de antes. Para enviar compras sandbox para outro aplicativo, altere a seção Sandbox.

Testar a integração \

1

Fazer uma compra sandbox

Instale seu aplicativo como um novo usuário e conclua uma compra sandbox. O evento vai para o aplicativo OneSignal da seção Sandbox, então configure-a primeiro.
2

Verificar o OneSignal ID no RevenueCat

No RevenueCat, abra a Customer View do usuário de teste. Confirme que $onesignalUserId aparece nos atributos do usuário.
3

Verificar se o evento foi entregue

Na Customer View, abra a compra de teste no Customer History. Confirme que o evento da integração do OneSignal existe e foi entregue.
4

Verificar o usuário no OneSignal

No aplicativo OneSignal Sandbox, acesse Audience > Users & subscriptions e pesquise o OneSignal ID. Confirme que o usuário tem as tags definidas pelo RevenueCat. Se Send as Custom Events estiver ativado, acesse Data > Events & conversions e confirme que o evento, como INITIAL_PURCHASE, chegou.
As tags no OneSignal agora são atualizadas automaticamente quando os usuários compram, renovam ou alteram a assinatura.
Teste com um novo usuário e com um usuário existente que atualize para a nova versão do seu aplicativo.

Eventos que o RevenueCat envia \

O RevenueCat envia os eventos a seguir. O nome do evento é o valor da tag last_event_type e o nome do Custom Event. Nem toda loja informa todos os eventos. Consulte a tabela de Events do RevenueCat para ver o suporte por loja.
Não remova o acesso em SUBSCRIPTION_PAUSED. Remova o acesso somente em EXPIRATION.

Tags que o RevenueCat envia \

Para cada evento, o RevenueCat adiciona ou atualiza estas tags no usuário. Ao criar a integração, um nome de tag vazio usa o nome padrão. Para parar de enviar uma tag, limpe o nome dela no painel do RevenueCat depois de criar a integração. Se todos os nomes de tags estiverem vazios, o RevenueCat não envia nada para o OneSignal.
active_subscription não tem nome padrão. O RevenueCat só a envia depois que você insere um nome de tag para ela no painel do RevenueCat.

Tag subscription_status \

Quando um evento altera o status de assinatura do usuário, o RevenueCat atualiza subscription_status para um destes valores. Por exemplo, o exemplo de NON_RENEWING_PURCHASE abaixo não a inclui. Para clientes com mais de uma assinatura ativa, subscription_status reflete apenas a assinatura com o evento mais recente.

Exemplos de tags \

Estes exemplos mostram a atualização de tags que o RevenueCat envia ao OneSignal para cada evento.

Custom Events que o RevenueCat envia \

Com Send as Custom Events ativado, o RevenueCat envia cada evento de Eventos que o RevenueCat envia para o OneSignal como um Custom Event, além de atualizar as tags. A opção vem ativada por padrão em novas integrações. Integrações configuradas antes da existência da opção ficam com ela desativada até que você a ative. Cada Custom Event:
  • Recebe o nome do evento, como TRIAL_STARTED ou RENEWAL.
  • Vai para o mesmo usuário e aplicativo do OneSignal que a atualização de tags.
  • Usa o horário do evento como carimbo de data/hora, como o horário da compra ou da expiração.
  • Inclui os dados da assinatura como propriedades do evento, com os nomes de tags que você configurou.
As propriedades do evento omitem app_user_id, last_event_type, last_event_at e qualquer tag com nome vazio. Se todos os nomes de tags estiverem vazios, o RevenueCat não envia nem a atualização de tags nem o Custom Event.
Use os Custom Events do RevenueCat para:
  • Iniciar uma Journey quando um usuário aciona TRIAL_STARTED ou BILLING_ISSUE.
  • Aguardar em uma Journey até que um usuário acione TRIAL_CONVERTED e enviar uma mensagem alternativa se isso não acontecer.
  • Personalizar mensagens da Journey com propriedades do evento, como {{ journey.first_event.properties.product_id }} quando o evento colocou o usuário na Journey. Os nomes das propriedades correspondem aos nomes de tags configurados no RevenueCat.
  • Segmentar usuários pelos eventos de compra que acionaram.
Os Custom Events exigem:
  • Acesso a Event Streams para eventos de mensagem de saída (Limitações de plano e excedentes se aplicam)
  • Acesso a Custom Events para sincronização de eventos de entrada (Limitações de plano e excedentes se aplicam)
  • Plano de Conta Atualizado (não disponível em apps gratuitos)

Custom Events

Acione Journeys, personalize mensagens e segmente usuários com Custom Events.

Perguntas frequentes \

Como sei se a integração está funcionando? \

Pesquise o OneSignal ID do usuário em Audience > Users & subscriptions e verifique as tags definidas pelo RevenueCat. No RevenueCat, o Customer History mostra se cada evento da integração do OneSignal foi entregue. Para verificar os Custom Events, acesse Data > Events & conversions.

Por que os eventos do RevenueCat não chegam ao OneSignal? \

A causa mais comum é um OneSignal ID ausente ou desatualizado no RevenueCat. Confirme que $onesignalUserId está definido no usuário no RevenueCat e que você chama login antes de enviá-lo. Verifique também se a compra foi para o aplicativo correto: compras sandbox, incluindo as do TestFlight e de testadores de licença do Google Play, vão para o aplicativo da seção Sandbox.

Por que minhas compras sandbox atualizam o aplicativo errado? \

O RevenueCat envia compras sandbox para o aplicativo da seção Sandbox e compras de produção para o aplicativo da seção Production. Atualize a seção Sandbox no painel do RevenueCat para alterar o destino das compras sandbox.

Posso usar os Custom Events do RevenueCat no plano gratuito? \

Não. Os Custom Events exigem um plano pago do OneSignal. No plano gratuito, desative Send as Custom Events no RevenueCat. As atualizações de tags continuam funcionando.

O RevenueCat envia valores de receita para o OneSignal? \

Não. O RevenueCat não envia preços nem receita para o OneSignal. Ele envia dados de assinatura, como produto, loja, status e datas.

Quantas tags posso definir? \

O OneSignal limita quantas tags cada usuário pode ter ao mesmo tempo. O limite depende do seu plano. Consulte Preços. Para enviar menos tags, limpe no painel do RevenueCat os nomes das tags de que você não precisa.

Custom Events

Acione Journeys, personalize mensagens e segmente usuários com eventos.

Tags

Armazene propriedades de usuário e use-as para segmentação e personalização.

Configurações da Journey

Coloque usuários em Journeys quando acionarem um Custom Event.

Chaves e IDs

Encontre o App ID e a App API key do OneSignal.