> For the complete documentation index, see [llms.txt](https://user.netmera.com/netmera-developer-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://user.netmera.com/netmera-developer-guide/platforms/android/sdk-integration.md). # SDK Integration ## Onboarding Checklist: Android Please find the Onboarding Checklist for iOS and Android below. Follow the titles in the checklist to ensure you have completed each essential step in your onboarding process with Netmera. {% file src="/files/p2Ag81QcahQy6LCBbnsl" %} ## Step 1: Select a Platform 1. Navigate to **Developers** > **Netmera Onboarding**. 2. Select **Android** and click **Start** to proceed.
## Step 2: Create a Firebase Configuration Netmera uses Firebase Cloud Messaging (FCM) for delivering push notifications. 1. Go to the [Firebase Developers Console](https://console.firebase.google.com/) and create a new project. 2. Generate a new **Private Key** (JSON file) for your project. {% @arcade/embed url="" flowId="wWs2Yesf5jfbmH6BBLOc" %} 3. Upload the JSON file you downloaded from Firebase Cloud Messaging to the `Project > app-level root` `directory`.
4. Choose one of the four options: ***Node.js, Java, Python, and Go***. The choice of option does not require any action. Simply click the 'Generate New Private Key' button to download the file. No further selections are needed.
5. Upload this file in **Netmera Panel > Developers > Netmera Onboarding > Android > Step 2: Create A Firebase Configuration > FCM Service Account Key.**
## Step 3: Select a Target SDK Select the SDK for your application development framework as **Native Android**.
## Step 4: Integrate Netmera SDK
{% hint style="warning" %} **Important Notes on SDK API Key:** * **Do not** use the API key from a **test** **panel** in production. * **Each panel has a unique API key**, and using the wrong one can result in data misdirection or errors. **To obtain your SDK API Key:** 1. Go to the Netmera Panel. 2. Navigate to Developer > API > SDK API Key. 3. Copy your SDK API Key from this section. {% endhint %} ### Standard Gradle If your project is using Standard Gradle: * Add the following snippets to integrate the Netmera SDK into your project. {% tabs %} {% tab title="Project" %} In this step, only copy the url specified below and add it to maven. ```groovy buildscript { repositories { google() maven {url 'https://developer.huawei.com/repo/'} // only include for HMS copy the url and add it to maven } dependencies { classpath 'com.android.tools.build:gradle:{your_project_android_tools_version}' classpath 'com.google.gms:google-services:{your_google_services_version}' classpath 'com.huawei.agconnect:agcp:{your_agcp_version}' // only include for HMS } } allprojects { repositories { google() maven {url 'https://developer.huawei.com/repo/'} // only include for HMS copy the url and add it to maven maven { url "https://release.netmera.com/release/android" } } } ``` {% endtab %} {% tab title="App" %} You should add Netmera dependency to your dependencies section in your: `build.gradle(:app)` {% hint style="danger" %} Check [Changelog](/netmera-developer-guide/platforms/android/changelog.md) to find the SDK versions listed as '4.x.x' below. {% endhint %} ```groovy dependencies { implementation 'com.netmera:nmcore:4.x.x' implementation 'com.netmera:nmfcm:4.x.x' implementation 'com.netmera:nmhms:4.x.x' // If you only need to support Google services, use the following versions: // implementation 'com.netmera:nmcore:4.x.x' // implementation 'com.netmera:nmfcm:4.x.x' // For applications that only want to support Huawei devices, use these dependencies: // implementation 'com.netmera:nmcore:4.x.x' // implementation 'com.netmera:nmhms:4.x.x' } // Must be added at the bottom of the app's build.gradle apply plugin: 'com.google.gms.google-services' apply plugin: 'com.huawei.agconnect' // only include for HMS ``` **Netmera BOM (Bill of Materials) Support** {% hint style="warning" %} BOM support is available starting from version 4.5.0. {% endhint %} Using the BOM allows you to manage Netmera SDK versions more easily and ensures compatibility between `nmcore`, `nmfcm`, and `nmhms` modules. ```groovy dependencies { implementation platform('com.netmera:netmera-bom:4.x.x') implementation 'com.netmera:nmcore' implementation 'com.netmera:nmfcm' implementation 'com.netmera:nmhms' // If you only need to support Google services, use the following versions: // implementation platform('com.netmera:netmera-bom:4.x.x') // implementation 'com.netmera:nmcore' // implementation 'com.netmera:nmfcm' // For applications that only want to support Huawei devices, use these dependencies: // implementation platform('com.netmera:netmera-bom:4.x.x') // implementation 'com.netmera:nmcore' // implementation 'com.netmera:nmhms' } // Must be added at the bottom of the app's build.gradle apply plugin: 'com.google.gms.google-services' apply plugin: 'com.huawei.agconnect' // only include for HMS ``` {% endtab %} {% endtabs %} ### Gradle Version Catalogs If your project is using [Gradle Version Catalogs](https://docs.gradle.org/current/userguide/version_catalogs.html): * Add the following snippets to integrate the Netmera SDK into your project. #### Kotlin {% tabs %} {% tab title="Project" %} 
plugins {
    alias(libs.plugins.androidApplication) apply false
    alias(libs.plugins.jetbrainsKotlinAndroid) apply false
    alias(libs.plugins.google.services) apply false
    alias(libs.plugins.androidLibrary) apply false
}
If you want to integrate Huawei Mobile Services (HMS), add the following configuration to your `build.gradle` file before `plugins`. **Following part is only for Huawei integration.** 
// This part is only for Huawei integration
buildscript {
    val agpVersion = "project_agp_version"
    val agcpVersion = "agcp_version"
    repositories {
        maven {
            url = uri("https://developer.huawei.com/repo/")
        }
    }
    dependencies {
        classpath("com.android.tools.build:gradle:$agpVersion")
        classpath("com.huawei.agconnect:agcp:$agcpVersion")on")
    }
}

plugins {
    ...
}
**For more information, visit the following link:** [Huawei AppGallery Connect Guide](https://developer.huawei.com/consumer/en/doc/AppGallery-connect-Guides/agc-get-started-android-0000001058210705#EN-US_TOPIC_0000001058750970__p12140631115817). **Note: Check your `libs.versions.toml` file:** * This file is usually located within the `gradle` folder in the root directory of your project. * Review how the relevant plugin is defined. {% endtab %} {% tab title="App" %} 
plugins {
    alias(libs.plugins.androidApplication)
    alias(libs.plugins.jetbrainsKotlinAndroid)
    alias(libs.plugins.google.services)
    id("com.huawei.agconnect") // only include for HMS
}
dependencies {
    implementation(libs.netmera.core)
    implementation(libs.netmera.fcm)
    implementation(libs.netmera.hms) // only include for HMS
}
**Netmera BOM (Bill of Materials) Support** {% hint style="warning" %} BOM support is available starting from version 4.5.0. {% endhint %} Using the BOM allows you to manage Netmera SDK versions more easily and ensures compatibility between `nmcore`, `nmfcm`, and `nmhms` modules. ```groovy dependencies { implementation(platform(libs.netmera.bom)) implementation(libs.netmera.core) implementation(libs.netmera.fcm) implementation(libs.netmera.hms) // only include for HMS } ``` {% endtab %} {% tab title="settings.gradle" %} ```kotlin dependencyResolutionManagement { repositories { google() maven { url = uri("https://release.netmera.com/release/android") } maven { url = uri("https://developer.huawei.com/repo/") // only include for HMS } } } ``` In this step, only copy the url "" and add it to maven. {% endtab %} {% tab title="libs.version.toml" %} {% hint style="warning" %} Check [Changelog](/netmera-developer-guide/platforms/android/changelog.md) to find the SDK versions listed as '4.x.x' below. {% endhint %} ```kotlin [versions] netmeraCore = "4.x.x" netmeraFcm = "4.x.x" netmeraHms = "4.x.x" googleServices = "your_google_services_version" [libraries] netmera-core = { group = "com.netmera", name = "nmcore", version.ref = "netmeraCore" } netmera-fcm = { group = "com.netmera", name = "nmfcm", version.ref = "netmeraFcm" } netmera-hms = { group = "com.netmera", name = "nmhms", version.ref = "netmeraHms" } // only include for HMS [plugins] google-services = { id = "com.google.gms.google-services", version.ref = "googleServices" } ``` **Netmera BOM (Bill of Materials) Support** {% hint style="warning" %} BOM support is available starting from version 4.5.0. {% endhint %} Using the BOM allows you to manage Netmera SDK versions more easily and ensures compatibility between `nmcore`, `nmfcm`, and `nmhms` modules. ```groovy [versions] netmeraBom = "4.x.x" [libraries] netmera-bom = { group = "com.netmera", name = "netmera-bom", version.ref = "netmeraBom" } netmera-core = { group = "com.netmera", name = "nmcore" } netmera-fcm = { group = "com.netmera", name = "nmfcm" } netmera-hms = { group = "com.netmera", name = "nmhms" } ``` {% endtab %} {% endtabs %} #### Groovy {% tabs %} {% tab title="Project" %} ```groovy plugins { alias(libs.plugins.androidApplication) apply false alias(libs.plugins.jetbrainsKotlinAndroid) apply false alias(libs.plugins.google.services) apply false alias(libs.plugins.androidLibrary) apply false } ``` If you want to integrate Huawei Mobile Services (HMS), add the following configuration to your `build.gradle` file before `plugins`. **Following part is only for Huawei integration.** 
// This part is only for Huawei integration
buildscript {
    val agpVersion = "YOUR_PROJECT_AGP_VERSION" //
    repositories {
        maven { url 'https://developer.huawei.com/repo/' }
    }
    dependencies {
        classpath "com.huawei.agconnect:agcp:your_agcp_version"
    }
}

plugins {
    ...
}
**For more information, visit the following link:** [Huawei AppGallery Connect Guide](https://developer.huawei.com/consumer/en/doc/AppGallery-connect-Guides/agc-get-started-android-0000001058210705#EN-US_TOPIC_0000001058750970__p12140631115817). **Note: Check your `libs.versions.toml` file:** * This file is usually located within the `gradle` folder in the root directory of your project. * Review how the relevant plugin is defined. {% endtab %} {% tab title="App" %} ```groovy plugins { alias(libs.plugins.androidApplication) alias(libs.plugins.jetbrainsKotlinAndroid) alias(libs.plugins.google.services) id("com.huawei.agconnect") // only include for HMS } dependencies { implementation libs.netmera.core implementation libs.netmera.fcm implementation libs.netmera.hms // only include for HMS } ``` **Netmera BOM (Bill of Materials) Support** {% hint style="warning" %} BOM support is available starting from version 4.5.0. {% endhint %} Using the BOM allows you to manage Netmera SDK versions more easily and ensures compatibility between `nmcore`, `nmfcm`, and `nmhms` modules. ```groovy dependencies { implementation platform(libs.netmera.bom) implementation libs.netmera.core implementation libs.netmera.fcm implementation libs.netmera.hms // only include for HMS } ``` {% endtab %} {% tab title="settings.gradle" %} ```groovy dependencyResolutionManagement { repositories { google() maven { url "https://release.netmera.com/release/android" } maven { url "https://developer.huawei.com/repo/" } } } ``` In this step, only copy the url "" and add it to maven. {% endtab %} {% tab title="libs.version.toml" %} {% hint style="warning" %} Check [Changelog](/netmera-developer-guide/platforms/android/changelog.md) to find the SDK versions listed as '4.x.x' below. {% endhint %} ```groovy [versions] netmeraCore = "4.x.x" netmeraFcm = "4.x.x" netmeraHms = "4.x.x" // only include for HMS googleServices = “your_google_services_version” [libraries] netmera-core = { group = "com.netmera", name = "nmcore", version.ref = "netmeraCore" } netmera-fcm = { group = "com.netmera", name = "nmfcm", version.ref = "netmeraFcm" } netmera-hms = { group = "com.netmera", name = "nmhms", version.ref = "netmeraHms" } // only include for HMS [plugins] google-services = { id = "com.google.gms.google-services", version.ref = "googleServices" } ``` **Netmera BOM (Bill of Materials) Support** {% hint style="warning" %} BOM support is available starting from version 4.5.0. {% endhint %} Using the BOM allows you to manage Netmera SDK versions more easily and ensures compatibility between `nmcore`, `nmfcm`, and `nmhms` modules. ```groovy [versions] netmeraBom = "4.x.x" [libraries] netmera-bom = { group = "com.netmera", name = "netmera-bom", version.ref = "netmeraBom" } netmera-core = { group = "com.netmera", name = "nmcore" } netmera-fcm = { group = "com.netmera", name = "nmfcm" } netmera-hms = { group = "com.netmera", name = "nmhms" } ``` {% endtab %} {% endtabs %} ## Step 5: Initialize Netmera SDK ### Initialize Netmera SDK 1. Add the following initialization code inside the `onCreate()` method of your `Application` class. {% hint style="info" %} **If Application Class is Not Already Present:** 1. Create an Application Class\ If your project doesn't yet have an `Application` class, create one and include the initialization code as shown below. 2. Update AndroidManifest.xml\ In the `AndroidManifest.xml`, add your `Application` class by specifying `android:name` in the `` tag. 3. To exclude Netmera Android SDK files from auto-backup if your app supports backup, please see the relevant title [Android Integration FAQs](/netmera-developer-guide/platforms/android/sdk-integration/android-integration-faqs.md#q10-excluding-netmera-android-sdk-files-from-auto-backup-if-your-app-supports-backup). {% endhint %} {% tabs %} {% tab title="Kotlin" %} {% hint style="danger" %} **`registerActivityLifecycleCallbacks`** method must be called in the Main Thread. {% endhint %} ```kotlin override fun onCreate() { super.onCreate() // Must be called on the Main Thread registerActivityLifecycleCallbacks(NMActivityLifecycleCallbacks(this)) val configBuilder = NetmeraConfiguration.Builder() .apiKey(apiKey) .firebaseSenderId(PropertiesUtil.gcmSenderId) .huaweiSenderId(PropertiesUtil.hmsSenderId) // only include for HMS .logging(true) // enables logging in logcat .addProvider(NMFCMProvider()) .addProvider(NMHMSProvider()) // only include for HMS Netmera.init(configBuilder.build(this)) } ``` {% endtab %} {% tab title="Java" %} {% hint style="danger" %} **`registerActivityLifecycleCallbacks`** method must be called in the Main Thread. {% endhint %} ```java @Override public void onCreate() { super.onCreate(); // Must be called on the Main Thread registerActivityLifecycleCallbacks(new NMActivityLifecycleCallbacks(this)); NetmeraConfiguration.Builder configBuilder = new NetmeraConfiguration.Builder(); configBuilder.apiKey(apiKey) .firebaseSenderId(PropertiesUtil.gcmSenderId) .huaweiSenderId(PropertiesUtil.hmsSenderId) // only include for HMS .logging(true); // enable logging in logcat .addProvider(new NMFCMProvider()) .addProvider(new NMHMSProvider()); // only include for HMS Netmera.init(configBuilder.build(this)); } ``` {% endtab %} {% endtabs %} {% hint style="info" %} **Configuring baseUrl for On-Premise Applications** * **For On-Premise Applications:**\ Include the following code to configure the base URL and API key: ```java configBuilder.baseUrl(baseUrl).apiKey(apiKey); ``` * **For Non-On-Premise Applications:**\ Only the API key needs to be configured: ```java configBuilder.apiKey(apiKey); ``` {% endhint %} ### Optional: Initialization Callback To implement the initialization callback: 1. Add the following code to handle success and failure: {% tabs %} {% tab title="Kotlin" %} ```kotlin Netmera.setInitSessionCallback(object : NMInitSessionResultListener { override fun onSuccess(result: NetmeraInitSessionResult) { val segmentInfo = if (result.segments.isEmpty()) { "no segments found!" } else { result.segments.joinToString { "${it.name}(${it.id})" } } Log.i(LOG_TAG, "Init session success — segments: $segmentInfo") } override fun onFailure(error: String?) { Log.e(LOG_TAG, "Init session failure — $error") } }) ``` {% endtab %} {% tab title="Java" %} ```java Netmera.init( configBuilder.build(this), new NMInitSessionListener() { @Override public void onSuccess() { Log.i("NetmeraApp", "Session init completed"); } @Override public void onFailure(String error) { Log.e( "NetmeraApp", "Error occurred when trying to init session with Netmera. Error::" + error ); } } ); ``` {% endtab %} {% endtabs %} ### Optional: Enable Logging Use logging only for debugging. Set `.logging(true)` during development and `.logging(false)` before release. {% tabs %} {% tab title="Kotlin" %} ```kotlin .logging(true) // development .logging(false) // production ``` {% endtab %} {% tab title="Java" %} ```java Netmera.logging(true); // development Netmera.logging(false); // production ``` {% endtab %} {% endtabs %} {% hint style="info" %} If your app uses a custom `FirebaseMessagingService` or `HmsMessageService`, review [Custom FCM Implementation](/netmera-developer-guide/platforms/android/sdk-integration/custom-fcm-implementation.md) and [Custom HMS Implementation](/netmera-developer-guide/platforms/android/sdk-integration/custom-hms-implementation.md) before completing the integration. {% endhint %} {% hint style="info" %} **Important Note for Obfuscation:** No special obfuscation rules are needed for Netmera. Its functionality remains unaffected, even with code obfuscation enabled. {% endhint %} ## Android SDK Integration Complete The Android SDK integration has been successfully completed, and your devices are now set to receive the following types of push notifications via the Netmera Dashboard: * **Standard Push Notifications** * **Interactive Push Notifications** * **Widgets** * **Push Notifications with Deeplinks** {% hint style="warning" %} #### **Warning During App Store Submission:** When submitting your application to the App Store, you might encounter the `com.google.android.gms.permission.AD_ID` alert. Here’s how to handle it: 1. Choose **'Yes'** when prompted. 2. On the subsequent page, make sure the **'analytics'** option is selected. 3. After this, no further additions to the manifest are required; simply merging the manifest will suffice. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://user.netmera.com/netmera-developer-guide/platforms/android/sdk-integration.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.