Configuración del SDK de 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

​

Paso 0. Configure FCM en OneSignal (requerido para enviar push)

​

Contrato de configuración y requisitos

• Versión del SDK: 5.6.1+ (última versión: consulte los lanzamientos)
• Instrucciones de configuración con IA: https://raw.githubusercontent.com/OneSignal/sdk-ai-prompts/main/docs/android/ai-prompt.md
• Repositorio del SDK: https://github.com/OneSignal/OneSignal-Android-SDK
• Android Studio: Meerkat+ (2024.2.1+)
• API de Android: 23+ mínimo (Android 6.0+), 31+ recomendado (Android 12+)
• Dispositivo/Emulador: Android 7.0+ con Google Play Services instalado
• Dependencia requerida: com.onesignal:OneSignal:[5.6.1, 5.9.99]
• Clase Application: Requerida para la inicialización correcta del SDK
• Formato del App ID: UUID de 36 caracteres (ejemplo: 12345678-1234-1234-1234-123456789012) — se encuentra en el Panel de OneSignal > Settings > Keys & IDs
• Inicialización: OneSignal.initWithContext(this, "YOUR_APP_ID")
• Optimización de batería: Puede afectar las notificaciones en segundo plano
• Recomendado: Asigne un External ID mediante OneSignal.login("user_id") para unificar usuarios entre dispositivos

​

Pasos de configuración de Android

• Instalado e inicializado el SDK de OneSignal en su aplicación Android
• Configurado correctamente la solicitud de permisos de notificaciones push en un dispositivo real
• Entregado exitosamente una notificación push de prueba y un mensaje dentro de la aplicación

​

Paso 1. Agregue el SDK de OneSignal

1. En Android Studio, abra su archivo build.gradle.kts (Module: app) o build.gradle (Module: app)
2. Agregue OneSignal a su sección dependencies:

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

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

3. Sincronice Gradle: Haga clic en Sync Now en el banner que aparece o vaya a File > Sync Project with Gradle Files

​

Paso 2. Cree y configure la clase Application

1. File > New > Kotlin Class/File (o Java Class)
2. Nombre: ApplicationClass (o el nombre que prefiera)

// 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 el archivo AndroidManifest.xml de su aplicación
2. En su etiqueta <application> agregue android:name=".ApplicationClass" (reemplace .ApplicationClass con el nombre real de su clase si lo configuró de manera 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>

​

Paso 3. Configure los iconos de notificación predeterminados (recomendado)

​

Paso 4. Pruebe la integración

1. Inicie la aplicación en un dispositivo o emulador con Google Play Services
2. Verifique en el Panel > Audience > Subscriptions — el estado muestra “Never Subscribed”
3. Acepte el aviso de permisos cuando aparezca
4. Actualice el panel — el estado cambia a “Subscribed”

​

Cree una Suscripción de prueba y un segmento

1. Haga clic en ⋮ junto a la Suscripción > Add to Test Users > asígnele un nombre
2. Vaya a Audience > Segments > New Segment
3. Nombre: Test Users, agregue el filtro Test Users > Create Segment

​

Envíe una notificación push de prueba vía API

1. Navegue a Settings > Keys & IDs.
2. En el código proporcionado, reemplace YOUR_APP_API_KEY y YOUR_APP_ID en el código a continuación con sus claves reales. Este código utiliza el segmento Test Users que creamos 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"
  }'

​

Pruebe los mensajes dentro de la aplicación

1. Cierre la aplicación durante más de 30 segundos
2. Panel > Messages > In-App > New In-App > seleccione la plantilla Welcome
3. Audiencia: segmento Test Users
4. Disparador: On app open
5. Programación: Every time trigger conditions are satisfied
6. Haga clic en Make Message Live
7. Abra la aplicación

​

Errores comunes y soluciones

​

Gestión de usuarios

​

Asigne un 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()
}

​

Agregue Tags y 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)

​

Agregue suscripciones de correo electrónico y/o 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")

​

Privacidad y consentimiento del usuario

// 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 permisos de push

​

Escuchar eventos de push, usuario y mensajes dentro de la aplicación

​

Eventos de notificaciones 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)

​

Cambios de estado del usuario

// 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 mensajes dentro de la aplicación

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

​

Configuración avanzada y capacidades

​

Funciones específicas de Android

• Canales de notificación — Organice las notificaciones en categorías (Android 8.0+)
• Extensiones de servicio — Personalización avanzada de notificaciones
• Soporte de Huawei/HMS — Alternativa a Google Play Services

​

Funciones universales

• Deep Linking — Navegue a los usuarios a pantallas específicas desde las notificaciones
• Botones de acción — Agregue botones interactivos a las notificaciones
• Verificación de identidad — Identificación segura de usuarios
• Seguimiento de ubicación — Segmentación basada en ubicación
• Integraciones — Conecte con plataformas de análisis y datos
• Mensajería multilingüe — Notificaciones localizadas