Huawei Unity SDK Setup

Follow these instructions if your app is distributed on the Huawei AppGallery.


  • Android Studio
  • A Huawei device with "Huawei App Gallery" installed
  • Configured OneSignal App and Platform

Configure your OneSignal App and Platform

Details on configuring your OneSignal App and Platform (click to expand)

If you haven't already, sign up for a free account on

You can setup multiple platforms (iOS, Android, Web, Email, SMS) within the same OneSignal App under Settings > Platforms. If you want to create a new app select New App/Website. If this is your first OneSignal app, you will see the next page.

Name your app and organization something recognizable, then select the platform to setup. You can always set up more platforms in this OneSignal App later within Settings > Platforms.

Click Next: Configure Your Platform.

To configure your app, follow the prompts based on the platforms you support.

After you setup your credentials, click Save & Continue.

Choose your Apps Target SDK, the click Save & Continue.

Finally, you will be directed to install the SDK and provided your OneSignal App ID. Make sure to save your App ID as you will need it later.

If you need a teammate or your developer to assist, you can click Invite them to the app and select Done when finished.

Continue through the documentation to finish adding OneSignal to your app.


1. Setup the OneSignal Unity SDK

Follow the OneSignal Unity SDK setup guide. Firebase / Google setup not required for app builds released to the Huawei AppGallery.

2. Huawei Setup

Huawei Platform Setup on OneSignal

Huawei Configuration File (agconnect-services.json)
From the AppGallery Connect Project List select your app.
Click on the "agconnect-services.json" button to download this file.

  • Place this inside Assets/Plugins/Android/OneSignalConfig

3. Generating a Signing Certificate Fingerprint

You can skip this step if you already have added your SHA-256 certificate fingerprint to Huawei's dashboard for a different Huawei service.

Follow Generating a Signing Certificate Fingerprint

4. Add Huawei Gradle Plugin and Dependencies

Unity 2019.3 Or Newer

4a.1 Go to File -> Build Settings -> Player Settings -> Android -> Publishing Settings and click under
Custom Main Gradle Template. This will create a mainTemplate.gradle.

4a.2 On mainTemplate.gradle remove the comment

  • Under dependencies add implementation 'com.huawei.hms:push:'

4a.3 Create a new file named Assets/Plugins/Android/settingsTemplate.gradle with the following contents.

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 '' } // Gradle Plugin Portal
            maven { url '' }
        dependencies {
            classpath 'com.huawei.agconnect:agcp:'

static void applyPlugins(Project project) {
    // Only apply to the :app project. (Unity calls this :launcher)
    if ( != 'launcher')

    project.afterEvaluate {
        it.apply plugin: 'com.huawei.agconnect'

static void copyHMSFile(Project project) {
    // Only apply to the :app project. (Unity calls this :launcher)
    if ( != 'launcher')

    def newFile = new File("${project.rootDir}/launcher/agconnect-services.json")

    if (newFile.exists())

    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.


// Per Unity's docs /*/*INCLUDES/*/* should be at the bottom.

// However it seem to have left out this include line
include ':launcher', ':unityLibrary'

Unity 2019.2 Or Older

4b.1 Go to File -> Build Settings -> Player Settings -> Android -> Publishing Settings and click under
Custom Gradle Template. This will create a mainTemplate.gradle.

4b.2 On mainTemplate.gradle remove the comment

  • Under buildscript { repositories } add maven { url '' }
  • Under buildscript { dependencies } add classpath 'com.huawei.agconnect:agcp:'
  • Under allprojects { repositories } add maven { url '' }

  • After adding these dependencies, add below allprojects {} the following
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
  • Under dependencies add implementation 'com.huawei.hms:push:'

  • At the bottom of the file add apply plugin: 'com.huawei.agconnect'

5. Run and test your app

Run your app on a real Huawei device to make sure your device is subscribed to notifications as a Huawei device and can receive notifications sent from the OneSignal dashboard.

6. Configure Huawei Location Service (Optional)

On mainTemplate.gradle under dependencies add implementation 'com.huawei.hms:location:<HUAWEI HMS VERSION #>

Make sure to also add the location permission to your AndroidManifest.xml if you don't have this already

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>

  • HMS error code reference to help debug logs and successfully integrate HMS Core SDK with the OneSignal SDK.