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.

44KB

Netmera Mobile Technical Onboarding Checklist.xlsx

Open

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 and create a new project.

2. Generate a new Private Key (JSON file) for your project.

1. Upload the JSON file you downloaded from Firebase Cloud Messaging to the Project > app-level root directory.

1. 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.

1. 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

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.

Standard Gradle

If your project is using Standard Gradle:

• Add the following snippets to integrate the Netmera SDK into your project.

Project

In this step, only copy the url specified below and add it to maven.

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" } 
    }
}

App

Gradle Version Catalogs

If your project is using Gradle Version Catalogs:

• Add the following snippets to integrate the Netmera SDK into your project.

Kotlin

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.

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.

App

settings.gradle

libs.version.toml

Groovy

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 = "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.

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.

App

settings.gradle

libs.version.toml

Step 5: Initialize Netmera SDK

Initialize Netmera SDK

1. Add the following initialization code inside the onCreate() method of your Application class.

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 <application> tag.

3. To exclude Netmera Android SDK files from auto-backup if your app supports backup, please see the relevant title Q10: Excluding Netmera Android SDK files from auto-backup if your app supports backup.

Kotlin

registerActivityLifecycleCallbacks method must be called in the Main Thread.

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

Java

Configuring baseUrl for On-Premise Applications

• For On-Premise Applications: Include the following code to configure the base URL and API key:

  configBuilder.baseUrl(baseUrl).apiKey(apiKey);

• For Non-On-Premise Applications: Only the API key needs to be configured:

  configBuilder.apiKey(apiKey);

Optional: Initialization Callback

To implement the initialization callback:

1. Add the following code to handle success and failure:

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")
    }
})
 

Java

Optional: Enable Logging

Use logging only for debugging. Set .logging(true) during development and .logging(false) before release.

Kotlin

.logging(true)   // development
.logging(false)  // production

Java

If your app uses a custom FirebaseMessagingService or HmsMessageService, review Custom FCM Implementation and Custom HMS Implementation before completing the integration.

Important Note for Obfuscation:

No special obfuscation rules are needed for Netmera. Its functionality remains unaffected, even with code obfuscation enabled.

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

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.