Configuração do SDK Android

​

Visão geral

​

Requisitos

• Dispositivo ou emulador Android 7.0+ com “Google Play Store (Services)” instalado.
• Android Studio (as instruções de configuração usam o Android Studio Meerkat).
• Aplicativo e plataforma OneSignal configurados.

​

Configure your OneSignal app and platform

Step-by-step instructions for configuring your OneSignal app.

You can manage multiple platforms (iOS, Android, Huawei, Amazon, Web) under a single OneSignal app.

1

Create or select your app

• To add platforms to an existing app, go to Settings > Push & In-App in the OneSignal dashboard.
• To start fresh, click New App/Website and follow the prompts.

Example shows creating a new app.

2

Set up and activate a platform

• Choose a clear and recognizable name for your app and organization.
• Select the platform(s) you want to configure (iOS, Android, etc.).
• Click Next: Configure Your Platform.

Example setting up your first OneSignal app, org, and channel.

3

Configure platform credentials

Follow the prompts based on your platforms:

• Android: Set up Firebase Credentials
• iOS: p8 Token (Recommended) or p12 Certificate
• Amazon: Generate API Key
• Huawei: Authorize OneSignal

Click Save & Continue after entering your credentials.

4

Choose target SDK

Select the SDK that matches your development platform (e.g., iOS, Android, React Native, Unity), then click Save & Continue.

Select which SDK you are using to be navigated to the docs.

5

Install SDK and save your App ID

Once your platform is configured, your OneSignal App ID will be displayed. Copy and save this ID—you’ll need it when installing and initializing the SDK.If collaborating with others, use the Invite button to add developers or teammates, then click Done to complete setup.

Save your App ID and invite additional team members.

Once complete, follow the SDK installation guide for your selected platform to finish integrating OneSignal.

​

Configuração do Android

​

1. Adicionar o SDK do OneSignal

implementation("com.onesignal:OneSignal:[5.4.0, 5.4.99]")

Exemplo mostrando a adição do OneSignal ao arquivo build.gradle.kts do seu App.

​

Sincronizar o Gradle

• Clique em Sync Now no banner
• Ou vá em File > Sync Project with Gradle Files

​

2. Inicializar o SDK na classe Application

Como criar uma classe Application

Crie uma nova classe (exemplo: ApplicationClass) e adicione o seguinte código.

Kotlin

Java

Copy

Ask AI

package com.your.package.name // Replace with your package name
import android.app.Application

class ApplicationClass : Application() {
  override fun onCreate() {
    super.onCreate()
    // OneSignal initialization will go here
  }
}

Exemplo de arquivo ApplicationClass.kt.

Abra o AndroidManifest.xml do seu aplicativoNa sua tag <application>, adicione android:name=".ApplicationClass" (substitua .ApplicationClass pelo nome real da sua classe, se você a definiu como algo diferente).

xml

Copy

Ask AI

  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
      xmlns:tools="http://schemas.android.com/tools">

     <application
          android:name=".ApplicationClass"
          android:icon="@mipmap/ic_launcher"
          android:label="@string/app_name"
          ...
      </application>

  </manifest>

AndroidManifest.xml com o nome .ApplicationClass.

package com.your.package.name // Replace with your package name

import android.app.Application
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch

import com.onesignal.OneSignal
import com.onesignal.debug.LogLevel

class ApplicationClass : Application() {
   override fun onCreate() {
      super.onCreate()

      // Enable verbose logging for debugging (remove in production)
      OneSignal.Debug.logLevel = LogLevel.VERBOSE
      // Initialize with your OneSignal App ID
      OneSignal.initWithContext(this, "YOUR_APP_ID")
      // Use this method to prompt for push notifications.
      // We recommend removing this method after testing and instead use In-App Messages to prompt for notification permission.
      CoroutineScope(Dispatchers.IO).launch {
         OneSignal.Notifications.requestPermission(true)
      }
   }
}

Arquivo ApplicationClass.kt com o código do OneSignal adicionado.

​

3. Personalizar ícones padrão

​

Testando a integração do SDK do OneSignal

​

Verificar assinaturas móveis

1

Inicie seu aplicativo em um dispositivo de teste.

O prompt de permissão push nativo deve aparecer automaticamente se você adicionou o método requestPermission durante a inicialização.

Prompts de permissão push do iOS e Android

2

Verifique seu painel OneSignal

Antes de aceitar o prompt, verifique o painel OneSignal:

• Vá para Audience > Subscriptions.
• Você deve ver uma nova entrada com o status “Never Subscribed”.

Painel mostrando assinatura com status 'Never Subscribed'

3

Retorne ao aplicativo e toque em Allow no prompt.

4

Atualize a página de Subscriptions do painel OneSignal.

O status da assinatura agora deve mostrar Subscribed.

Painel mostrando assinatura com status 'Subscribed'

Você criou com sucesso uma assinatura móvel. As assinaturas móveis são criadas quando os usuários abrem seu aplicativo pela primeira vez em um dispositivo ou se desinstalarem e reinstalarem seu aplicativo no mesmo dispositivo.

​

Configurar assinaturas de teste

1

Adicionar às Assinaturas de Teste.

No painel, ao lado da assinatura, clique no botão Options (três pontos) e selecione Add to Test Subscriptions.

Adicionando um dispositivo às Assinaturas de Teste

2

Nomeie sua assinatura.

Nomeie a assinatura para que você possa identificar facilmente seu dispositivo mais tarde na Test Subscriptions tab.

Painel mostrando o campo 'Name your subscription'

3

Crie um segmento de usuários de teste.

Vá para Audience > Segments > New Segment.

4

Nomeie o segmento.

Nomeie o segmento Test Users (o nome é importante porque será usado posteriormente).

5

Adicione o filtro Test Users e clique em Create Segment.

Criando um segmento 'Test Users' com o filtro Test Users

Você criou com sucesso um segmento de usuários de teste. Agora podemos testar o envio de mensagens para este dispositivo individual e grupos de usuários de teste.

​

Enviar push de teste via API

1

Obtenha sua chave de API do aplicativo e ID do aplicativo.

No seu painel OneSignal, vá para Settings > Keys & IDs.

2

Atualize o código fornecido.

Substitua YOUR_APP_API_KEY e YOUR_APP_ID no código abaixo pelas suas chaves reais. Este código usa o segmento Test Users que criamos anteriormente.

Copy

Ask AI

curl -X \
POST --url 'https://api.onesignal.com/notifications' \
 --header 'content-type: application/json; charset=utf-8' \
 --header 'authorization: Key YOUR_APP_API_KEY' \
 --data \
 '{
  "app_id": "YOUR_APP_ID",
  "target_channel": "push",
  "name": "Testing basic setup",
  "headings": {
  	"en": "👋"
  },
  "contents": {
    "en": "Hello world!"
  },
  "included_segments": [
    "Test Users"
  ],
  "ios_attachments": {
    "onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
  },
  "big_picture": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'

3

Execute o código.

Execute o código no seu terminal.

4

Verifique as imagens e a entrega confirmada.

Se todas as etapas de configuração foram concluídas com sucesso, as assinaturas de teste devem receber uma notificação com uma imagem incluída:

Notificação push com imagem no iOS e Android

As imagens aparecerão pequenas na visualização de notificação recolhida. Expanda a notificação para ver a imagem completa.

5

Verifique a entrega confirmada.

No seu painel, vá para Delivery > Sent Messages e clique na mensagem para visualizar as estatísticas.Você deve ver a estatística confirmed, significando que o dispositivo recebeu o push.

Estatísticas de entrega mostrando entrega confirmada

Se você estiver em um plano Professional ou superior, role até Audience Activity para ver a confirmação no nível da assinatura:

Entrega confirmada no nível do dispositivo na Audience Activity

Você enviou com sucesso uma notificação via nossa API para um segmento.

• Sem entrega confirmada? Revise o guia de solução de problemas aqui.
• Tendo problemas? Copie e cole a solicitação de API e um log do início ao fim do lançamento do aplicativo em um arquivo .txt. Em seguida, compartilhe ambos com support@onesignal.com.

​

Enviar uma mensagem in-app

1

Feche ou coloque seu aplicativo em segundo plano no dispositivo.

Isso ocorre porque os usuários devem atender aos critérios de público in-app antes que uma nova sessão comece. No OneSignal, uma nova sessão começa quando o usuário abre seu aplicativo depois que ele ficou em segundo plano ou fechado por pelo menos 30 segundos. Para mais detalhes, consulte nosso guia sobre como as mensagens in-app são exibidas.

2

Crie uma mensagem in-app.

• No seu painel OneSignal, navegue até Messages > In-App > New In-App.
• Encontre e selecione a mensagem Welcome.
• Defina seu Audience como o segmento Test Users que usamos anteriormente.

Segmentando o segmento 'Test Users' com uma mensagem in-app

3

Personalize o conteúdo da mensagem, se desejar.

Exemplo de personalização da mensagem de boas-vindas in-app

4

Defina o Trigger como 'On app open'.

5

Agende a frequência.

Em Schedule > How often do you want to show this message? selecione Every time trigger conditions are satisfied.

Opções de agendamento de mensagens in-app

6

Torne a mensagem ativa.

Clique em Make Message Live para que ela fique disponível para seus Test Users cada vez que eles abrirem o aplicativo.

7

Abra o aplicativo e veja a mensagem.

Depois que a mensagem in-app estiver ativa, abra seu aplicativo. Você deve vê-la exibida:

Mensagem in-app de boas-vindas exibida nos dispositivos

Não está vendo a mensagem?

• Inicie uma nova sessão
  • Você deve fechar ou colocar o aplicativo em segundo plano por pelo menos 30 segundos antes de reabrir. Isso garante que uma nova sessão seja iniciada.
  • Para mais informações, consulte como as mensagens in-app são exibidas.
• Ainda no segmento Test Users?
  • Se você reinstalou ou trocou de dispositivo, adicione novamente o dispositivo às Assinaturas de Teste e confirme se ele faz parte do segmento Test Users.
• Tendo problemas?
  • Siga Getting a Debug Log enquanto reproduz as etapas acima. Isso gerará logs adicionais que você pode compartilhar com support@onesignal.com e nós ajudaremos a investigar o que está acontecendo.

​

Identificação de usuário

​

Atribuir ID externo

​

Adicionar tags de dados

Um perfil de usuário no OneSignal com uma tag chamada "current_level" definida como "6"

Editor de segmento mostrando um segmento direcionado a usuários com valor de current_level maior que 4 e menor que 10

Captura de tela mostrando uma notificação push direcionada ao segmento Level 5-10 com uma mensagem personalizada

A notificação push é recebida em um dispositivo iOS e Android com o conteúdo personalizado

​

Adicionar assinaturas de email e/ou SMS

• Use o método addEmail para criar assinaturas de email.
• Use o método addSms para criar assinaturas de SMS.

Um perfil de usuário com assinaturas push, email e SMS unificadas por ID externo

​

Privacidade e consentimento do usuário

• setConsentRequired(true): Impede a coleta de dados até que o consentimento seja dado.
• setConsentGiven(true): Habilita a coleta de dados uma vez que o consentimento é concedido.

• Dados coletados pelo SDK
• Manipulação de dados pessoais

​

Solicitar permissões push

​

Ouvir eventos push, de usuário e in-app

​

Eventos de notificação push

• addClickListener(): Detecta quando uma notificação é tocada. Útil para Deep Linking.
• addForegroundLifecycleListener(): Controla como as notificações se comportam em primeiro plano.

​

Mudanças de estado do usuário

• addObserver() para estado do usuário: Detecta quando o ID externo é definido.
• addPermissionObserver(): Rastreia a interação específica do usuário com o prompt de permissão push nativo.
• addObserver() para assinatura push: Rastreia quando o status da assinatura push muda.

​

Eventos de mensagem in-app

• addClickListener(): Lida com ações de clique in-app. Ideal para deep linking ou rastreamento de eventos.
• addLifecycleListener(): Rastreia o ciclo de vida completo das mensagens in-app (exibido, clicado, dispensado, etc.).

​

Configuração avançada e recursos

• 🔁 Migração para o OneSignal de outro serviço
• 🌍 Rastreamento de localização
• 🔗 Deep Linking
• 🔌 Integrações
• 🧩 Extensões de serviço móvel
• 🛎️ Botões de ação
• 🌐 Mensagens em vários idiomas
• 🛡️ Verificação de identidade
• 📊 Resultados personalizados
• 📲 Live Activities

​

Configuração e referência do SDK móvel

​

Layout de notificação personalizado

• Siga o guia de notificação personalizada do Android
• Aplique as alterações via a Extensão de serviço de notificação

​

Desabilitar comportamento de abertura padrão

  <application ...>
     <meta-data android:name="com.onesignal.NotificationOpened.DEFAULT" android:value="DISABLE" />
  </application>

​

Dados de fundo e substituições de push

• Use a Extensão de serviço de notificação para lidar com dados de fundo ou substituir visuais de notificação
• Use os Manipuladores de evento de notificação do SDK para ler dados adicionais de uma notificação

​

Suporte a idiomas da direita para a esquerda (RTL)

  <application
    android:supportsRtl="true"
    ...
  </application>