Pular para o conteúdo principal
Esta página faz parte de Aplicativo de exemplo: uma integração completa do OneSignal, que acompanha um aplicativo real do início ao fim. O aplicativo é o Clean Beans, uma escala de limpeza para casas compartilhadas, construído com Expo (React Native) e um backend Supabase. As mensagens in-app aparecem enquanto alguém usa o aplicativo. O conteúdo, o público e o agendamento delas ficam no painel do OneSignal, então podem mudar sem uma nova versão. O Clean Beans as usa para cinco tarefas.

Gatilhos: deixe o aplicativo decidir o momento \

Um gatilho é uma chave e um valor que o aplicativo define. Qualquer mensagem in-app configurada para corresponder a ele é exibida. Toda tela do Clean Beans tem um botão de ajuda no cabeçalho que define um gatilho, com o nome da tela como valor.
src/components/HelpButton.tsx
app/(tabs)/_layout.tsx
Uma única chave de gatilho atende treze telas. Adicionar ajuda para uma nova tela significa adicionar um botão com um novo valor e criar uma mensagem no painel.
Uma mensagem in-app de sobreposição de ajuda exibida sobre o painel

Tocar no botão de ajuda no painel mostra uma sobreposição de ajuda.

Configuração do painel. Em Messages > In-App, crie uma mensagem cujo gatilho seja help_topic is dashboard e repita para cada tela. Tutoriais guiados com várias etapas usam o mesmo gatilho com um layout de carrossel.
Uma mensagem in-app de tutorial guiado formada por cards deslizáveis

Um tutorial guiado com várias etapas criado como um carrossel de cards.

Mensagens com HTML personalizado \

As sobreposições de ajuda são escritas em HTML, então combinam exatamente com o design do aplicativo. Uma mensagem in-app em HTML se comunica com o SDK por meio do objeto OneSignalIamApi. Duas regras se aplicam a todo elemento clicável:
  • Dê a ele um data-onesignal-unique-label exclusivo, para que os cliques sejam rastreados corretamente.
  • Associe um listener que chame um método de OneSignalIamApi. Links simples não são rastreados.
docs/iam-html/help-dashboard.html

Pré-solicitação de permissão de push \

O diálogo de permissão do sistema só pode ser exibido uma vez. Uma mensagem in-app exibida antes pode explicar o que o usuário vai receber, e apenas quem toca em Enable notifications vê o diálogo do sistema.
Uma mensagem in-app explicando os benefícios de ativar as notificações

Uma pré-solicitação explica o benefício antes de o diálogo do sistema aparecer.

docs/iam-html/push-permission-prompt.html
Se você usar uma pré-solicitação, remova a chamada requestPermission() da inicialização do aplicativo. Caso contrário, o diálogo do sistema aparece primeiro e a pré-solicitação não tem mais nada a pedir.

Aviso de atualização do aplicativo \

Quando uma nova versão é lançada, quem está na versão antiga vê um aviso para atualizar. Essa mensagem não precisa de nenhum código no aplicativo. O público dela é um segmento de usuários em uma versão mais antiga do aplicativo.
Uma mensagem in-app pedindo ao usuário que atualize o aplicativo

O aviso de atualização, exibido apenas para quem está em uma versão mais antiga.

Uma única mensagem atende as duas plataformas. O script escolhe a loja de acordo com o dispositivo, e openUrl rastreia o clique, abre a loja e fecha a mensagem.
docs/iam-html/app-update-prompt.html
A saudação usa uma tag, com um valor alternativo para usuários que não a têm.
docs/iam-html/app-update-prompt.html
Configuração do painel. Crie um segmento com o filtro App version menor que a sua versão atual e use-o como público da mensagem. Atualize o filtro a cada lançamento.
A substituição de tags funciona no texto e nos atributos de uma mensagem in-app em HTML, mas não dentro das tags script.

Pedido de avaliação: devolver um clique ao aplicativo \

Um bom momento para pedir uma avaliação na loja de aplicativos é logo depois de algo dar certo. O Clean Beans pede quando uma sessão de limpeza leva uma sequência a um múltiplo de sete dias. Esta é a única mensagem in-app em que um toque precisa executar código no aplicativo, porque a tela de avaliação nativa só pode ser aberta pelo próprio aplicativo.
1

O aplicativo define um gatilho em um marco de sequência

Ele espera até a tela da sessão fechar, para que o aviso nunca interrompa a limpeza, e lembra o último marco em que pediu.
src/lib/reviewPrompt.ts
2

A mensagem envia um nome de clique de volta ao aplicativo

addClickName passa um nome para o listener de clique do aplicativo. Ele não fecha a mensagem, então o script a fecha logo em seguida.
docs/iam-html/review-prompt.html
3

O aplicativo abre a tela de avaliação nativa

O listener de clique verifica o nome e pede ao sistema que mostre a tela.
src/lib/reviewPrompt.ts
app/_layout.tsx
Uma mensagem in-app de pedido de avaliação

A mensagem in-app de pedido de avaliação.

Configuração do painel. Crie uma mensagem in-app em HTML com o gatilho ask_for_review is show. Agende-a para ser exibida no máximo uma vez a cada 17 semanas.
A Apple mostra a tela de avaliação no máximo três vezes por usuário em um ano, e o Google tem seu próprio limite, então tocar no botão não garante que algo seja exibido. A tela nunca aparece em compilações do TestFlight. Teste esse fluxo com uma compilação da App Store.

Gatilhos in-app

Tipos de gatilhos e como se combinam.

Mensagens in-app em HTML

Crie mensagens com seu próprio HTML.

API JavaScript in-app

Todos os métodos de OneSignalIamApi.