Configuración Unity SDK

​

Descripción general

​

Configurar notificaciones push para tu aplicación Unity usando OneSignal

​

Requisitos

• Unity 2022.3 o más reciente
• Aplicación y plataforma de OneSignal configuradas

• macOS con Xcode 14+ (las instrucciones de configuración usan Xcode 16.2)
• Dispositivo con iOS 12+, iPadOS 12+, o simulador Xcode ejecutando iOS 16.2+

• Dispositivo o emulador Android 7.0+ con Google Play Store (Services) instalado

​

Configure su aplicación y plataforma de OneSignal

Instrucciones de configuración paso a paso

1

Cree o seleccione su aplicación

Cree una nueva aplicación haciendo clic en Nueva aplicación/sitio web, o agregue una plataforma a una aplicación existente en Configuración > Push e In-App. Seleccione la(s) plataforma(s) que desea configurar y haga clic en Siguiente: Configure su plataforma.

2

Configure las credenciales de plataforma

Ingrese las credenciales para su plataforma:

• Android: Configure las credenciales de Firebase
• iOS: Token p8 (Recomendado) o Certificado p12
• Amazon: Genere una clave API
• Huawei: Autorice OneSignal

Haga clic en Guardar y continuar después de ingresar sus credenciales.

3

Guarde su ID de aplicación e instale el SDK

Su ID de aplicación se muestra en la pantalla final. Cópielo y guárdelo — lo necesita al inicializar el SDK. Seleccione su plataforma de SDK y siga la guía de configuración.

​

Configuración

​

1. Agregar el Unity SDK de OneSignal

• Unity Asset Store
• Unity Package Manager

1. Agrega el SDK a tu cuenta vía Add to My Assets.
2. Haz clic en Open in Unity para lanzar Unity Editor y Package Manager.
3. Descarga e Import el SDK.

4. Acepta la solicitud para importar todos los archivos.
5. Ve a Window > OneSignal SDK Setup y sigue la lista de verificación, especialmente Import OneSignal packages.
6. Después de la importación, Unity actualizará el registro. Completa los pasos de configuración restantes mostrados en la ventana de configuración.

1. Navega a Edit > Project Settings > Package Manager.

2. Agrega un registro con alcance:

Name        npmjs
URL         https://registry.npmjs.org
Scope(s)    com.onesignal

3. Abre Window > Package Manager y cambia a My Registries.
4. Instala los paquetes deseados del SDK de OneSignal.
5. Abre Window > OneSignal SDK Setup y completa los pasos finales.

​

2. Configuración de plataforma

​

Configuración iOS

• Automatically Sign (Recomendado)
• Manual Provisioning

1. Ve a File > Build Settings > Player Settings.
2. Bajo Other Settings, marca Automatically Sign.

Asegúrate de que tu cuenta de Apple Developer tenga:

• Un App Group: group.{your_bundle_id}.onesignal
• Push Notifications y App Groups habilitados
• Perfiles de aprovisionamiento actualizados para tu bundle ID

​

Configuración Android

1. Ve a Edit > Project Settings > Player > Android.
2. Bajo Publishing Settings, habilita:

• Custom Main Gradle Template
• Custom Gradle Properties Template

3. Ejecuta Assets > External Dependency Manager > Android Resolver > Force Resolve.

• El nivel de API objetivo debe ser 33+ (v5.0.6+).
• Si Minify está habilitado, ejecuta Copy Android plugin to Assets desde OneSignal SDK Setup para usar OneSignalConfig.androidlib.
• Reemplaza los íconos predeterminados dentro de Assets/Plugins/Android/OneSignalConfig.androidlib/src/main/res con los tuyos propios (solo nombres de archivo en minúsculas, guiones bajos permitidos). Consulta Iconos de notificación para más.

​

Configuración Amazon

 xmlns:amazon="http://schemas.amazon.com/apk/res/android"

<uses-permission android:name="com.amazon.device.messaging.permission.RECEIVE" />
<permission android:name="COM.YOUR.PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" android:protectionLevel="signature" />
<uses-permission android:name="COM.YOUR.PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" />

<amazon:enable-feature android:name="com.amazon.device.messaging" android:required="false"/>
<service android:name="com.onesignal.notifications.services.ADMMessageHandler" android:exported="false" />
<service android:name="com.onesignal.notifications.services.ADMMessageHandlerJob"
         android:permission="android.permission.BIND_JOB_SERVICE"
         android:exported="false" />
<receiver android:name="com.onesignal.notifications.receivers.ADMMessageReceiver"
          android:permission="com.amazon.device.messaging.permission.SEND" >
  <intent-filter>
    <action android:name="com.amazon.device.messaging.intent.REGISTRATION" />
    <action android:name="com.amazon.device.messaging.intent.RECEIVE" />
    <category android:name="COM.YOUR.PACKAGE_NAME" />
  </intent-filter>
</receiver>

​

Configuración Huawei

​

Opcional: Deshabilitar el módulo de ubicación

• Alternancia del Editor (interactiva): En el Unity Editor, ve a Project Settings > OneSignal y habilita Disable Location Module. La configuración se guarda en ProjectSettings/OneSignalSettings.json.
• Variable de entorno (CLI/CI): Exporta ONESIGNAL_DISABLE_LOCATION=true (o 1) en la shell antes de iniciar Unity. La variable de entorno tiene prioridad sobre la alternancia del Editor.

{
    "disableLocation": true
}

ONESIGNAL_DISABLE_LOCATION=true /path/to/Unity \
  -batchmode -quit -projectPath . -buildTarget Android

env:
  ONESIGNAL_DISABLE_LOCATION: true

​

Aplicar el cambio después de que las dependencias nativas estén en caché

• Elimina Assets/OneSignal/Editor/OneSignalAndroidDependencies.xml y Assets/OneSignal/Editor/OneSignaliOSDependencies.xml, luego vuelve a abrir el proyecto para que Unity los regenere desde ProjectSettings/OneSignalSettings.json.
• Ejecuta Assets > External Dependency Manager > Android Resolver > Force Resolve para que Assets/Plugins/Android/mainTemplate.gradle use los paquetes sin ubicación.
• Vuelve a exportar el proyecto Xcode de iOS y ejecuta pod install si es necesario.
• Elimina Build/ y otras salidas generadas antes de volver a compilar.

​

3. Inicializar el SDK

using OneSignalSDK;

void Start () {
  // Enable verbose logging for debugging (remove in production)
  OneSignal.Debug.LogLevel = LogLevel.Verbose;
  // Initialize with your OneSignal App ID
  OneSignal.Initialize("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.
  await OneSignal.Notifications.RequestPermissionAsync(true);
}

​

Probar la integración del SDK de OneSignal

​

Verificar suscripciones móviles

1

Inicie su aplicación en un dispositivo de prueba.

El mensaje de permiso push nativo debe aparecer automáticamente si agregó el método requestPermission durante la inicialización.

2

Verifique su panel de OneSignal

Antes de aceptar el mensaje, verifique el panel de OneSignal:

• Vaya a Audiencia > Suscripciones.
• Debería ver una nueva entrada con el estado “Nunca suscrito”.

3

Regrese a la aplicación y toque Permitir en el mensaje.

4

Actualice la página de suscripciones del panel de OneSignal.

El estado de la suscripción ahora debería mostrar Suscrito.

Ha creado exitosamente una suscripción móvil. Las suscripciones móviles se crean cuando los usuarios abren su aplicación por primera vez en un dispositivo o si desinstalan y reinstalan su aplicación en el mismo dispositivo.

​

Configurar suscripciones de prueba

1

Agregar a suscripciones de prueba.

En el panel, junto a la suscripción, haga clic en el botón Opciones (tres puntos) y seleccione Agregar a suscripciones de prueba.

2

Nombre su suscripción.

Nombre la suscripción para que pueda identificar fácilmente su dispositivo más tarde en la pestaña de suscripciones de prueba.

3

Cree un segmento de usuarios de prueba.

Vaya a Audiencia > Segmentos > Nuevo segmento.

4

Nombre el segmento.

Nombre el segmento Test Users (el nombre es importante porque se usará más adelante).

5

Agregue el filtro de usuarios de prueba y haga clic en Crear segmento.

Ha creado exitosamente un segmento de usuarios de prueba. Ahora podemos probar el envío de mensajes a este dispositivo individual y grupos de usuarios de prueba.

​

Enviar push de prueba mediante API

1

Obtenga su clave API de aplicación e ID de aplicación.

En su panel de OneSignal, vaya a Configuración > Claves e IDs.

2

Actualice 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 usa el segmento Test Users que creamos anteriormente.

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

Ejecute el código.

Ejecute el código en su terminal.

4

Verifique imágenes y entrega confirmada.

Si todos los pasos de configuración se completaron exitosamente, las suscripciones de prueba deberían recibir una notificación con una imagen incluida:

Las imágenes aparecerán pequeñas en la vista de notificación colapsada. Expanda la notificación para ver la imagen completa.

5

Verifique la entrega confirmada.

En su panel, vaya a Entrega > Mensajes enviados, luego haga clic en el mensaje para ver las estadísticas.Debería ver la estadística confirmado, lo que significa que el dispositivo recibió el push.

Ha enviado exitosamente una notificación mediante nuestra API a un segmento.

• ¿No recibió la imagen? Es posible que falte su extensión de servicio de notificaciones.
• ¿No hay entrega confirmada? Revise la guía de solución de problemas aquí.
• ¿Tiene problemas? Copie y pegue la solicitud de API y un registro desde el inicio hasta el final del lanzamiento de la aplicación en un archivo .txt. Luego comparta ambos con support@onesignal.com.

​

Enviar un mensaje in-app

1

Cierre o ponga en segundo plano su aplicación en el dispositivo.

Esto se debe a que los usuarios deben cumplir con los criterios de audiencia in-app antes de que comience una nueva sesión. En OneSignal, una nueva sesión comienza cuando el usuario abre su aplicación después de que ha estado en segundo plano o cerrada durante al menos 30 segundos. Para obtener más detalles, consulte nuestra guía sobre cómo se muestran los mensajes in-app.

2

Cree un mensaje in-app.

• En su panel de OneSignal, navegue a Mensajes > In-App > Nuevo In-App.
• Busque y seleccione el mensaje de Bienvenida.
• Establezca su audiencia como el segmento de usuarios de prueba que usamos anteriormente.

3

Personalice el contenido del mensaje si lo desea.

4

Establezca el activador en 'Al abrir la aplicación'.

5

Programe la frecuencia.

En Programar > ¿Con qué frecuencia desea mostrar este mensaje? seleccione Cada vez que se cumplan las condiciones de activación.

6

Active el mensaje.

Haga clic en Activar mensaje para que esté disponible para sus usuarios de prueba cada vez que abran la aplicación.

7

Abra la aplicación y vea el mensaje.

Después de que el mensaje in-app esté activo, abra su aplicación. Debería verlo mostrarse:

¿No ve el mensaje?

• Inicie una nueva sesión
  • Debe cerrar o poner en segundo plano la aplicación durante al menos 30 segundos antes de volver a abrirla. Esto asegura que se inicie una nueva sesión.
  • Para obtener más información, consulte cómo se muestran los mensajes in-app.
• ¿Sigue en el segmento de usuarios de prueba?
  • Si reinstaló o cambió de dispositivo, vuelva a agregar el dispositivo a suscripciones de prueba y confirme que forma parte del segmento de usuarios de prueba.
• ¿Tiene problemas?
  • Siga Obtener un registro de depuración mientras reproduce los pasos anteriores. Esto generará un registro adicional que puede compartir con support@onesignal.com y le ayudaremos a investigar qué está sucediendo.

​

Identificación de usuarios

​

Asignar ID externo

​

Agregar etiquetas de datos

​

Agregar suscripciones de email y/o SMS

• Use el método addEmail para crear suscripciones de email.
• Use el método addSms para crear suscripciones de SMS.

​

Privacidad y consentimiento del usuario

• setConsentRequired(true): Previene la recopilación de datos hasta que se otorgue el consentimiento.
• setConsentGiven(true): Habilita la recopilación de datos una vez que se otorga el consentimiento.

• Datos recopilados por el SDK
• Manejo de datos personales

​

Solicitar permisos push

​

Escuchar eventos push, de usuario e in-app

​

Eventos de notificación push

• addClickListener(): Detecte cuándo se toca una notificación. Útil para enlaces profundos.
• addForegroundLifecycleListener(): Controle cómo se comportan las notificaciones en primer plano.

​

Cambios de estado del usuario

• addObserver() para estado del usuario: Detecte cuándo se establece el ID externo.
• addPermissionObserver(): Rastree la interacción específica del usuario con el mensaje de permiso push nativo.
• addObserver() para suscripción push: Rastree cuándo cambia el estado de la suscripción push.

​

Eventos de mensajes in-app

• addClickListener(): Maneje acciones de clic in-app. Ideal para enlaces profundos o seguimiento de eventos.
• addLifecycleListener(): Rastree el ciclo de vida completo de los mensajes in-app (mostrados, clicados, descartados, etc.).

​

Configuración y capacidades avanzadas

• 🔁 Migración a OneSignal desde otro servicio
• 🌍 Seguimiento de ubicación
• 🔗 Enlaces profundos
• 🔌 Integraciones
• 🧩 Extensiones de servicio móvil
• 🛎️ Botones de acción
• 🌐 Mensajería multiidioma
• 🛡️ Verificación de identidad
• 📊 Resultados personalizados
• 📲 Actividades en vivo

​

Configuración y referencia del SDK móvil