> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Configuración del SDK de Huawei Unity
> Guía del SDK para configurar Unity con dispositivos Huawei
## Descripción general
Esta guía explica cómo integrar notificaciones push de OneSignal en una aplicación Unity distribuida en Huawei AppGallery.
Solo sigue estas instrucciones si tu aplicación está distribuida en Huawei AppGallery.
***
## Requisitos
* [Android Studio](https://developer.android.com/studio)
* Un dispositivo Huawei con "Huawei App Gallery" instalada
* Aplicación y Plataforma de OneSignal configuradas
***
### Configure your OneSignal app and platform
Configure your OneSignal app with the platforms you support — Apple (APNs), Google (FCM), Huawei (HMS), and/or Amazon (ADM).
If your organization already has a OneSignal account, [ask to be invited](/docs/en/manage-team-members) to the Organization. Otherwise, [sign up for a free account](https://onesignal.com) to get started.
Create a new app by clicking **New App/Website**, or add a platform to an existing app in **Settings > Push & In-App**. Select the platform(s) you want to configure and click **Next: Configure Your Platform**.
Enter the credentials for your platform:
* **Android**: [Set up Firebase credentials](/docs/en/android-firebase-credentials)
* **iOS**: [p8 token (recommended)](/docs/en/ios-p8-token-based-connection-to-apns) or [p12 certificate](/docs/en/ios-p12-generate-certificates)
* **Amazon**: [Generate API key](/docs/en/generate-an-amazon-api-key)
* **Huawei**: [Authorize OneSignal](/docs/en/authorize-onesignal-to-send-huawei-push)
Click **Save & Continue** after entering your credentials.
Your **App ID** is displayed on the final screen. Copy and save it — you need it when initializing the SDK. Select your SDK platform, then follow the setup guide.
***
## Configuración
### 1. Configurar el SDK de OneSignal
Sigue la guía de configuración del SDK de OneSignal Unity para implementar nuestro SDK en tu aplicación.
Ten en cuenta que la configuración de Firebase/Google no es requerida para compilaciones de aplicaciones lanzadas en Huawei AppGallery.
### 2. Configuración de Huawei
[Configuración de Plataforma Huawei en OneSignal](https://developer.huawei.com/consumer/en/doc/HMS-Plugin-Guides-V1/preparedevenv-0000001050155838-V1)
Archivo de Configuración de Huawei (agconnect-services.json) *Desde la [Lista de Proyectos de AppGallery Connect](https://developer.huawei.com/consumer/en/service/josp/agc/index.html#/myProject) selecciona tu aplicación. Haz clic en el botón "agconnect-services.json" para descargar este archivo.*
Coloca esto dentro de Assets/Plugins/Android/OneSignalConfig
### 3. Generar una huella digital de certificado de firma
Puedes omitir este paso si ya has agregado tu huella digital de certificado SHA-256 al dashboard de Huawei para un servicio diferente de Huawei.
Sigue [Generar una Huella Digital de Certificado de Firma](https://developer.huawei.com/consumer/en/doc/development/HMS-Guides/Preparations#h2-1575707383351)
### 4. Agregar plugin gradle de Huawei y dependencias
**4a.1** Ve a File -> Build Settings -> Player Settings -> Android -> Publishing Settings y haz clic bajo Custom Main Gradle Template. Esto creará un mainTemplate.gradle.
**4a.2** En mainTemplate.gradle elimina el comentario `// GENERATED BY UNITY. REMOVE THIS COMMENT TO PREVENT OVERWRITING WHEN EXPORTING AGAIN`
* Bajo `dependencies` agrega `implementation 'com.huawei.hms:push:6.3.0.304'`
**4a.3** Crea un nuevo archivo llamado Assets/Plugins/Android/settingsTemplate.gradle con el siguiente contenido.
```groovy Unity 2019.3+ theme={null}
import java.nio.file.Files
// This file contents should be placed at Assets/Plugins/Android/settingsTemplate.gradle
// This works around Unity's 2019.3 bug where their root build.gradle is placing buildscript under allprojects
// On it's own it doesn't create issues however doing so means including a buildscript block in any sub projects
// such as "unityLibrary" which is generated from the template Assets/Plugins/Android/mainTemplate.gradle does not work.
// It results in a build error of "Configuration with name 'compileClasspath' not found." on a lint task.
// Normally adding "lintOptions { abortOnError false }" bypasses any lint task errors however
// either due to a bug with the Android Gradle plugin or an order of operations this does seem to be applying in this case.
// Until Unity fixes their root build.gradle we will need to keep using this file to enable any additional Gradle plugins.
static void enableJetifier(Project project) {
project.ext['android.useAndroidX'] = true
project.ext['android.enableJetifier'] = true
}
static void addBuildscript(Project project) {
project.buildscript {
repositories {
maven { url 'https://plugins.gradle.org/m2/' } // Gradle Plugin Portal
maven { url 'http://developer.huawei.com/repo/' }
}
dependencies {
classpath 'com.huawei.agconnect:agcp:1.6.5.300'
}
}
}
static void applyPlugins(Project project) {
// Only apply to the :app project. (Unity calls this :launcher)
if (project.name != 'launcher')
return
project.afterEvaluate {
it.apply plugin: 'com.huawei.agconnect'
}
}
static void copyHMSFile(Project project) {
// Only apply to the :app project. (Unity calls this :launcher)
if (project.name != 'launcher')
return
def newFile = new File("${project.rootDir}/launcher/agconnect-services.json")
if (newFile.exists())
return
def file = new File("${project.rootDir}/unityLibrary/OneSignalConfig/agconnect-services.json")
Files.copy(file.toPath(), newFile.toPath())
}
gradle.rootProject {
it.afterEvaluate {
it.allprojects {
// Since Unity 2019.3 enabling Jetifier via mainTemplate.gradle is no longer working
// Enabling it for all gradle projects here.
enableJetifier(it)
addBuildscript(it)
applyPlugins(it)
copyHMSFile(it)
}
}
}
// Per Unity's docs /*/*INCLUDES/*/* should be at the bottom.
// https://docs.unity3d.com/Manual/android-gradle-overview.html
// However it seem to have left out this include line
include ':launcher', ':unityLibrary'
**INCLUDES**
```
**4b.1** Ve a File -> Build Settings -> Player Settings -> Android -> Publishing Settings y haz clic bajo Custom Gradle Template. Esto creará un mainTemplate.gradle.
**4b.2** En mainTemplate.gradle elimina el comentario `// GENERATED BY UNITY. REMOVE THIS COMMENT TO PREVENT OVERWRITING WHEN EXPORTING AGAIN`
* Bajo `buildscript { repositories }` agrega `maven { url 'http://developer.huawei.com/repo/' }`
* Bajo `buildscript { dependencies }` agrega `classpath 'com.huawei.agconnect:agcp:1.6.5.300'`
* Bajo `allprojects { repositories }` agrega `maven { url 'http://developer.huawei.com/repo/' }`
Después de agregar estas dependencias, agrega debajo de `allprojects {}` lo siguiente
```groovy Unity 2019.2 theme={null}
allprojects {
...
}
task copyReport(type: Copy) {
from file("$projectDir/OneSignalConfig/agconnect-services.json")
into file("$projectDir")
}
allprojects {
afterEvaluate {
for (def task in it.tasks)
if (task != rootProject.tasks.copyReport)
task.dependsOn rootProject.tasks.copyReport
}
}
```
Bajo `dependencies` agrega `implementation 'com.huawei.hms:push:6.3.0.304'`
Al final del archivo agrega `apply plugin: 'com.huawei.agconnect'`
***
## Pasos de configuración adicionales
### Configurar servicio de ubicación de Huawei (opcional)
En mainTemplate.gradle bajo `dependencies` agrega `implementation 'com.huawei.hms:location:`
Asegúrate también de agregar el permiso de ubicación a tu AndroidManifest.xml si aún no lo tienes
```xml AndroidManifest.xml theme={null}
```
***
## Solución de problemas de Huawei
Durante las pruebas, asegúrate de mantener el [método setLogLevel de OneSignal](./mobile-sdk-reference#setloglevel) establecido en VERBOSE.
Revisa los logs para ver cualquier error que se genere y los [Códigos de Error Comunes de Huawei](https://developer.huawei.com/consumer/en/doc/development/HMS-2-References/hmssdk_huaweipush_api_reference_errorcode).
Es posible que necesites crear una firma de keystore de debug o release (elige la ruta de compilación de aplicación correcta, `debug` o `release`) para evitar un error `6003` al registrarse para el `pushToken` de Huawei con el SDK de OneSignal. Ve la [sección "Configure a Signature"](https://developer.huawei.com/consumer/en/doc/HMS-Guides/Preparations#h2-1584707362385)
Esto significa que hay una clase que HMS necesita y que falta en la aplicación para push. Solo tener `com.huawei.hms:push` en el `build.gradle` hará que este error específico ya no ocurra. Sin embargo, si tienes configuraciones agresivas de Proguard o R8, esto podría causar problemas. Recomendamos desactivar `minifyEnabled` temporalmente si lo tienes para ver si esa es la raíz del problema.
Además, no debes mezclar versiones principales de otras bibliotecas HMS. Comienza con 4 o 5. Asegúrate de no tener una mezcla de 3 a 5 que creará otros errores
```
E/OneSignal: HMS ApiException getting Huawei push token!
com.huawei.hms.common.ApiException: -5: Core error
```
Revisa tus reglas de Proguard o R8 para asegurarte de que estén configuradas correctamente. Posiblemente deshabilítalo temporalmente para ver si está relacionado. Si corrige el problema después de deshabilitar Proguard o R8, entonces puedes seguir esta guía y volver a activarlo. Ve la [sección "Configure a Signature"](https://developer.huawei.com/consumer/en/doc/HMS-Guides/Preparations#h2-1584707362385)
## Testing the OneSignal SDK integration
This guide helps you verify that your OneSignal SDK integration is working correctly by testing push notifications, subscription registration, and in-app messaging.
If you are testing with an Android emulator, it should start with a cold boot.
1. Go to **Device Manager** in Android Studio.
2. Select your emulator device and click **Edit**.
3. Go to **Additional Settings** or **More**.
4. Set the **Boot option** to **Cold Boot**.
5. Save changes and restart the emulator.
### Check mobile subscriptions
The native push permission prompt should appear automatically if you added the `requestPermission` method during initialization.
Before accepting the prompt, check the OneSignal dashboard:
* Go to **Audience > Subscriptions**.
* You should see a new entry with the status "Never Subscribed".
The subscription's status should now show **Subscribed**.
You have successfully created a [mobile subscription](/docs/en/subscriptions).
Mobile subscriptions are created when users first open your app on a device or if they uninstall and reinstall your app on the same device.
### Set up test users
test users are helpful for testing a push notification before sending a message.
In the dashboard, next to the subscription, click the **Options (three dots)** button and select **Add to Test Users**.
Name the subscription so you can easily identify your device later in the **test users tab**.
Go to **Audience > Segments > New Segment**.
Name the segment `Test Users` (the name is important because it will be used later).
You have successfully created a segment of test users.
We can now test sending messages to this individual device and groups of test users.
### Send test push via API
In your OneSignal dashboard, go to **Settings > [Keys & IDs](/docs/en/keys-and-ids)**.
Replace `YOUR_APP_API_KEY` and `YOUR_APP_ID` in the code below with your actual keys. This code uses the `Test Users` segment we created earlier.
```curl theme={null}
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"
}'
```
Run the code in your terminal.
If all setup steps were completed successfully, the test users should receive a notification with an image included:
Images will appear small in the collapsed notification view. Expand the notification to see the full image.
In your dashboard, go to **Delivery > Sent Messages**, then click the message to view stats.
You should see the **confirmed** stat, meaning the device received the push.
You have successfully sent a notification via our API to a segment.
* No image received? Your [Notification Service Extension](#ios-setup) might be missing.
* No confirmed receipt? Review the troubleshooting guide [here](/docs/en/confirmed-delivery#troubleshooting-confirmed-delivery).
* Having issues? Copy-paste the api request and a log from start to finish of app launch into a `.txt` file. Then share both with `support@onesignal.com`.
### Send an in-app message
[In-app messages](/docs/en/in-app-messages-setup) let you communicate with users while they are using your app.
This is because users must meet the in-app audience criteria *before* a new session starts. In OneSignal, a new session starts when the user opens your app after it has been in the background or closed for at least 30 seconds. For more details, see our guide on [how in-app messages are displayed](/docs/en/in-app-messages-setup#how-are-iams-displayed%3F).
* In your OneSignal dashboard, navigate to **Messages > In-App > New In-App**.
* Find and select the **Welcome** message.
* Set your Audience as the **Test Users** segment we used previously.
Under **Schedule > How often do you want to show this message?** select **Every time trigger conditions are satisfied**.
Click **Make Message Live** so it is available to your Test Users each time they open the app.
After the in-app message is live, open your app. You should see it display:
Not seeing the message?
* Start a new session
* You must close or background the app for at least 30 seconds before reopening. This ensures a new session is started.
* For more, see [how in-app messages are displayed](/docs/en/in-app-messages-setup#how-are-iams-displayed%3F).
* Still in the `Test Users` segment?
* If you reinstalled or switched devices, re-add the device to [Test Users](#set-up-test-users) and confirm it's part of the Test Users segment.
* Having issues?
* Follow [Getting a Debug Log](/docs/en/capturing-a-debug-log) while reproducing the steps above. This will generate additional logging that you can share with `support@onesignal.com` and we will help investigate what's going on.
You have successfully setup the OneSignal SDK and learned important concepts like:
* Gathering [Subscriptions](/docs/en/subscriptions), setting [Test Users](/docs/en/find-set-test-subscriptions), and creating [Segments](/docs/en/segmentation).
* Sending [Push](/docs/en/push) with images and [Confirmed receipt](/docs/en/confirmed-delivery) using Segments and our [Create message](/reference/create-message) API.
* Sending [In-app messages](/docs/en/in-app-messages-setup).
Continue with this guide to identify users in your app and setup additional features.
***
## User identification
Previously, we demonstrated how to create mobile [Subscriptions](/docs/en/subscriptions). Now we'll expand to identifying [Users](/docs/en/users) across all their subscriptions (including push, email, and SMS) using the OneSignal SDK. We'll cover External IDs, tags, multi-channel subscriptions, privacy, and event tracking to help you unify and engage users across platforms.
### Assign External ID
Use an External ID to identify users consistently across devices, email addresses, and phone numbers using your backend's user identifier. This ensures your messaging stays unified across channels and 3rd party systems (especially important for [Integrations](/docs/en/integrations)).
Set the External ID with our SDK's [`login` method](/docs/en/mobile-sdk-reference#login-external-id) each time they are identified by your app.
OneSignal generates unique read-only IDs for subscriptions (Subscription ID) and users (OneSignal ID).
As users download your app on different devices, subscribe to your website, and/or provide you email addresses and phone numbers outside of your app, new subscriptions will be created.
Setting the External ID via our SDK is highly recommended to identify users across all their subscriptions, regardless of how they are created.
### Add Tags
[Tags](/docs/en/add-user-data-tags) are key-value pairs of string data you can use to store user properties (like `username`, `role`, or preferences) and events (like `purchase_date`, `game_level`, or user interactions). Tags power advanced [Message Personalization](/docs/en/message-personalization) and [Segmentation](/docs/en/segmentation) allowing for more advanced use cases.
Set tags with our SDK [`addTag` and `addTags` methods](/docs/en/mobile-sdk-reference#data-tags) as events occur in your app.
In this example, the user reached level 6 identifiable by the tag called `current_level` set to a value of `6`.
We can create a segment of users that have a level of between 5 and 10, and use that to send targeted and personalized messages:
### Add email and/or SMS subscriptions
Earlier we saw how our SDK creates mobile subscriptions to send push and in-app messages. You can also reach users through emails and SMS channels by creating the corresponding subscriptions.
* Use the [`addEmail` method](/docs/en/mobile-sdk-reference#addemail-%2C-removeemail) to create email subscriptions.
* Use the [`addSms` method](/docs/en/mobile-sdk-reference#addsms-%2C-removesms) to create SMS subscriptions.
If the email address and/or phone number already exist in the OneSignal app, the SDK will add it to the existing user, it will not create duplicates.
You can view unified users via **Audience > Users** in the dashboard or with the [View user API](/reference/view-user).
Best practices for multi-channel communication
* Obtain explicit consent before adding email or SMS subscriptions.
* Explain the benefits of each communication channel to users.
* Provide channel preferences so users can select which channels they prefer.
***
### Privacy & user consent
To control when OneSignal collects user data, use the SDK's consent gating methods:
* [`setConsentRequired(true)`](/docs/en/mobile-sdk-reference#setconsentrequired): Prevents data collection until consent is given.
* [`setConsentGiven(true)`](/docs/en/mobile-sdk-reference#setconsentgiven): Enables data collection once consent is granted.
See our Privacy & security docs for more on:
* [Data collected by the SDK](/docs/en/data-collected-by-the-onesignal-sdk)
* [Handling personal data](/docs/en/handling-personal-data)
***
## Prompt for push permissions
Instead of calling `requestPermission()` immediately on app open, take a more strategic approach. Use an in-app message to explain the value of push notifications before requesting permission.
For best practices and implementation details, see our [Prompt for push permissions](/docs/en/prompt-for-push-permissions) guide.
***
## Listen to push, user, and in-app events
Use SDK listeners to react to user actions and state changes.
The SDK provides several event listeners for you to hook into. See our [SDK reference guide](/docs/en/mobile-sdk-reference) for more details.
### Push notification events
* [`addClickListener()`](/docs/en/mobile-sdk-reference#addclicklistener-push): Detect when a notification is tapped. Helpful for [Deep Linking](/docs/en/deep-linking).
* [`addForegroundLifecycleListener()`](/docs/en/mobile-sdk-reference#addforegroundlifecyclelistener-push): Control how notifications behave in foreground.
For full customization, see [Mobile Service Extensions](/docs/en/service-extensions).
### User state changes
* [`addObserver()` for user state](/docs/en/mobile-sdk-reference#addobserver-user-state): Detect when the External ID is set.
* [`addPermissionObserver()`](/docs/en/mobile-sdk-reference#addpermissionobserver-push): Track the user's specific interaction with the native push permission prompt.
* [`addObserver()` for push subscription](/docs/en/mobile-sdk-reference#addobserver-push-subscription-changes): Track when the push subscription status changes.
### In-app message events
* [`addClickListener()`](/docs/en/mobile-sdk-reference#addclicklistener-in-app): Handle in-app click actions. Ideal for deep linking or tracking events.
* [`addLifecycleListener()`](/docs/en/mobile-sdk-reference#addclicklistener-in-app): Track full lifecycle of in-app messages (shown, clicked, dismissed, etc.).
***
## Advanced setup & capabilities
Explore more capabilities to enhance your integration:
* [🔁 Migrating to OneSignal from another service](/docs/en/migrating-to-onesignal)
* [🌍 Location tracking](/docs/en/mobile-sdk-reference#location)
* [🔗 Deep Linking](/docs/en/deep-linking)
* [🔌 Integrations](/docs/en/integrations)
* [🧩 Mobile Service Extensions](/docs/en/service-extensions)
* [🛎️ Action buttons](/docs/en/action-buttons)
* [🌐 Multi-language messaging](/docs/en/multi-language-messaging)
* [🛡️ Identity Verification](/docs/en/identity-verification)
* [📊 Custom Outcomes](/docs/en/custom-outcomes)
* [📲 Live Activities](/docs/en/live-activities)
### Mobile SDK setup & reference
Make sure you've enabled all key features by reviewing the [Mobile push setup](/docs/en/mobile-push-setup) guide.
For full details on available methods and configuration options, visit the [Mobile SDK reference](/docs/en/mobile-sdk-reference).
Congratulations! You've successfully completed the Mobile SDK setup guide.
***
Need help?
Chat with our Support team or email `support@onesignal.com`
Please include:
* Details of the issue you're experiencing and steps to reproduce if available
* Your OneSignal App ID
* The External ID or Subscription ID if applicable
* The URL to the message you tested in the OneSignal Dashboard if applicable
* Any relevant [logs or error messages](/docs/en/capturing-a-debug-log)
We're happy to help!
***