Installation

This guide walks through adding the SDK dependency to your Gradle build, verifying requirements, and confirming ProGuard/R8 compatibility.

On this page

• Requirements
• Install via Gradle
• ProGuard / R8
• Transitive dependencies
• Mobile app registration

Requirements

Install via Gradle

Add the SDK dependency to your module-level build.gradle.kts:

dependencies {
    implementation("net.zetaglobal.app:core:1.0.0")
}

Or in Groovy (build.gradle):

dependencies {
    implementation 'net.zetaglobal.app:core:1.0.0'
}

The artifact is published to Maven Central. No additional repository configuration is required if your project already includes mavenCentral() in its repository block.

The SDK also requires Firebase Cloud Messaging for push notifications. Add it as a dependency in your app module:

dependencies {
    implementation("net.zetaglobal.app:core:1.0.0")
    implementation("com.google.firebase:firebase-messaging:24.1.0")
}

Note: Firebase Messaging is a compileOnly dependency of the SDK — you must declare it in your own app module for push notifications to work.

ProGuard / R8

No custom ProGuard or R8 rules are required. The SDK's AAR includes all necessary keep rules via consumer-rules.pro. Your release builds work without additional configuration.

Transitive dependencies

The SDK brings the following transitive dependencies into your project via implementation scope. If your app already uses any of these at a different version, Gradle's dependency resolution applies.

Mobile app registration

Follow the Mobile App Registration guide to register your app with ZMP. Registration produces the clientSiteId and clientSecret you pass to ZTConfig during initialization.

During registration, you will need your app's package name (Application ID), which is the applicationId value in your module-level build.gradle.kts.

Important: SDK API tokens have write-only access, restricted to updating profiles, tracking events, and logging errors. Refresh tokens are scoped to mobile-specific APIs and cannot access broader platform functionality.

For the complete ZMP portal walkthrough with screenshots, see Mobile app registration.

Next

• Getting Started — initialize the SDK with your clientSiteId and clientSecret.