Configuração do SDK Android

Integrate the OneSignal Android SDK into this codebase.

Follow the instructions at:
https://raw.githubusercontent.com/OneSignal/sdk-ai-prompts/main/docs/android/ai-prompt.md

​

Passo 0. Configure o FCM no OneSignal (necessário para entregar push)

​

Contrato de configuração e requisitos

• Versão do SDK: 5.6.1+ (mais recente: verifique os releases)
• Instruções de configuração por IA: https://raw.githubusercontent.com/OneSignal/sdk-ai-prompts/main/docs/android/ai-prompt.md
• Repositório do SDK: https://github.com/OneSignal/OneSignal-Android-SDK
• Android Studio: Meerkat+ (2024.2.1+)
• API Android: 23+ mínimo (Android 6.0+), 31+ recomendado (Android 12+)
• Dispositivo/Emulador: Android 7.0+ com Google Play Services instalado
• Dependência obrigatória: com.onesignal:OneSignal:[5.6.1, 5.9.99]
• Classe Application: Necessária para inicialização correta do SDK
• Formato do App ID: UUID de 36 caracteres (exemplo: 12345678-1234-1234-1234-123456789012) — encontre em OneSignal Dashboard > Settings > Keys & IDs
• Inicialização: OneSignal.initWithContext(this, "YOUR_APP_ID")
• Otimização de bateria: Pode afetar notificações em segundo plano
• Recomendado: Atribuir External ID via OneSignal.login("user_id") para unificar usuários entre dispositivos

​

Passos de configuração do Android

• O SDK da OneSignal instalado e inicializado no seu aplicativo Android
• A solicitação de permissão de notificações push funcionando corretamente em um dispositivo real
• Um push de teste e uma mensagem in-app entregues com sucesso

​

Passo 1. Adicione o SDK da OneSignal

1. No Android Studio, abra o arquivo build.gradle.kts (Module: app) ou build.gradle (Module: app)
2. Adicione o OneSignal à seção dependencies:

implementation("com.onesignal:OneSignal:[5.6.1, 5.9.99]")

implementation 'com.onesignal:OneSignal:[5.6.1, 5.9.99]'

3. Sincronize o Gradle: Clique em Sync Now no banner que aparece ou vá em File > Sync Project with Gradle Files

​

Passo 2. Crie e configure a classe Application

1. File > New > Kotlin Class/File (ou Java Class)
2. Nome: ApplicationClass (ou o nome de sua preferência)

// FILE: ApplicationClass.kt
// PURPOSE: Initialize OneSignal when your app launches
// REQUIREMENT: Must be registered in AndroidManifest.xml

package com.your.package.name // Replace with your actual 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 to debug issues (remove in production)
        OneSignal.Debug.logLevel = LogLevel.VERBOSE

        // Replace with your 36-character App ID from Dashboard > Settings > Keys & IDs
        OneSignal.initWithContext(this, "YOUR_APP_ID")

        // Prompt user for push notification permission
        // In production, consider using an in-app message instead for better opt-in rates
        CoroutineScope(Dispatchers.IO).launch {
            OneSignal.Notifications.requestPermission(false)
        }
    }
}

// FILE: ApplicationClass.java
// PURPOSE: Initialize OneSignal when your app launches
// REQUIREMENT: Must be registered in AndroidManifest.xml

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

import android.app.Application;

import com.onesignal.Continue;
import com.onesignal.OneSignal;
import com.onesignal.debug.LogLevel;

public class ApplicationClass extends Application {
    @Override
    public void onCreate() {
        super.onCreate();

        // Enable verbose logging to debug issues (remove in production)
        OneSignal.getDebug().setLogLevel(LogLevel.VERBOSE);

        // Replace with your 36-character App ID from Dashboard > Settings > Keys & IDs
        OneSignal.initWithContext(this, "YOUR_APP_ID");

        // Prompt user for push notification permission
        // In production, consider using an in-app message instead for better opt-in rates
        OneSignal.getNotifications().requestPermission(false, Continue.none());
    }
}

1. Abra o AndroidManifest.xml do seu aplicativo
2. Na tag <application>, adicione android:name=".ApplicationClass" (substitua .ApplicationClass pelo nome real da sua classe, caso tenha definido um nome diferente).

<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>

​

Passo 3. Configure os ícones de notificação padrão (recomendado)

​

Passo 4. Teste a integração

1. Inicie o aplicativo no dispositivo ou emulador com Google Play Services
2. Verifique no Dashboard > Audience > Subscriptions — o status mostra “Never Subscribed”
3. Aceite o prompt de permissão quando ele aparecer
4. Atualize o dashboard — o status muda para “Subscribed”

​

Crie uma Subscription de teste e um segmento

1. Clique em ⋮ ao lado da Subscription > Add to Test Users > dê um nome
2. Vá para Audience > Segments > New Segment
3. Nome: Test Users, adicione o filtro Test Users > Create Segment

​

Envie um push de teste via API

1. Navegue até Settings > Keys & IDs.
2. No 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.

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

​

Teste mensagens in-app

1. Feche o aplicativo por mais de 30 segundos
2. Dashboard > Messages > In-App > New In-App > selecione o template Welcome
3. Público: segmento Test Users
4. Gatilho: On app open
5. Agendamento: Every time trigger conditions are satisfied
6. Clique em Make Message Live
7. Abra o aplicativo

​

Erros comuns e correções

​

Gerenciamento de usuários

​

Atribuir External ID (recomendado)

// Call when user logs in or is identified, safe to call multiple times
// Typically used in a login completion handler, or on app launch if already authenticated
fun onUserAuthenticated(userId: String) {
    OneSignal.login(userId)
}

// If you want to remove the External ID from the Subscription, setting it to an anonymous user
fun onUserLoggedOut() {
    OneSignal.logout()
}

​

Adicionar Tags e Custom Events

// Add a tag when the user's name is set
OneSignal.User.addTag("username", "john_doe")

// Create a custom event when user abandoned a cart
val properties = mapOf(
    "product_id" to "123456",
    "product_name" to "Product Name",
    "product_price" to 100,
    "product_quantity" to 1
)
OneSignal.User.trackEvent("abandoned_cart", properties)

​

Adicionar subscriptions de e-mail e/ou SMS

// Add email subscription
// Call when user provides their email (e.g., account creation, settings update) after calling OneSignal.login("user_id")
OneSignal.User.addEmail("user@example.com")

// Add SMS subscription
// Use E.164 format: + country code + number
// Call when user provides their phone number (e.g., account creation, settings update) after calling OneSignal.login("user_id")
OneSignal.User.addSms("+15551234567")

​

Privacidade e consentimento do usuário

// In ApplicationClass onCreate(), BEFORE OneSignal.initWithContext()
// Use this if your app requires GDPR or other privacy consent before data collection
OneSignal.consentRequired = true

// Later, after user grants consent (e.g., taps "I Agree" on your consent screen)
OneSignal.consentGiven = true

​

Solicitar permissões de push

​

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

​

Eventos de notificação push

// Add click listener to handle when users tap notifications
val clickListener = object : INotificationClickListener {
  override fun onClick(event: INotificationClickEvent) {
    Log.d("OneSignal", "Notification clicked: ${event.notification.title}")
  }
}
OneSignal.Notifications.addClickListener(clickListener)

​

Mudanças de estado do usuário

// Add subscription observer to track push subscription changes
class MyObserver : IPushSubscriptionObserver {
  init {
    OneSignal.User.pushSubscription.addObserver(this)
  }

  override fun onPushSubscriptionChange(state: PushSubscriptionChangedState) {
    if (state.current.optedIn) {
      println("User is now opted-in with push token: ${state.current.token}")
    }
  }
}

​

Eventos de mensagens in-app

// Add click listener for in-app message interactions
val clickListener = object : IInAppMessageClickListener {
  override fun onClick(event: IInAppMessageClickEvent) {
    print(event.result.actionId)
  }
}
OneSignal.InAppMessages.addClickListener(clickListener)

​

Configuração avançada e recursos

​

Recursos específicos do Android

• Canais de Notificação — Organize notificações em categorias (Android 8.0+)
• Service Extensions — Personalização avançada de notificações
• Suporte Huawei/HMS — Alternativa ao Google Play Services

​

Recursos universais

• Deep Linking — Navegue os usuários para telas específicas a partir de notificações
• Botões de Ação — Adicione botões interativos às notificações
• Verificação de Identidade — Identificação segura de usuários
• Rastreamento de Localização — Segmentação baseada em localização
• Integrações — Conecte com plataformas de análise e dados
• Mensagens Multilíngues — Notificações localizadas