Android SDK

image-20241107-055937.png

The full technical documentation lives here: Android SDK Overview.

This page is just a high-level overview to be used as a starting point; then follow through to the Developer Guide for integration details, APIs, and platform-specific setup.

The Zeta Android SDK connects your Android app to the Zeta Marketing Platform (ZMP). It provides a single integration for user identity, behavioral tracking, and message delivery across push, in-app messaging, and app inbox—all orchestrated from ZMP.

This documentation covers Android SDK 1.0.1. Requirements: minSdk 24 (Android 7.0), Kotlin 1.9+, Gradle 8.4+, Android Gradle Plugin 8.2+.

What the Android SDK provides

  • core — Single Maven Central module for configuration, user identity, event tracking, push notifications (FCM), in-app messages, and app inbox.

  • Identity & events — Identify users, update contacts and properties, track location, and send auto-tracked and custom events (queued locally and synced when online).

  • Messaging channels — Push via Firebase Cloud Messaging, in-app messaging, and a persistent app inbox your UI can query and display.

  • Offline-first — Events and property updates persist locally and sync in the background when connectivity returns.


Use the following articles for the canonical, up-to-date Android documentation. They are grouped in the order of a typical integration journey.

Set up and initialize

Topic

What you’ll find

Developer Guide

Overview

What the Android SDK provides, requirements, the core module, and the full integration journey.

Android SDK Overview

Installation

Add the SDK via Maven Central (Gradle), ProGuard/R8 notes, transitive dependencies, and app registration with ZMP.

Installation

Getting started

Initialize with ZTConfig in Application.onCreate(), configure region and environment, and manage opt-in / opt-out.

Getting started

Integrate core features

Topic

What you’ll find

Developer Guide

Contact management

Identify users, update email/phone contacts and custom properties, UCLID, App Set ID / GAID, location, and event tracking.

Contact management

Add messaging channels

Topic

What you’ll find

Developer Guide

Push notifications

FCM integration, notification appearance, deep links, click tracking, custom FirebaseMessagingService, and delivery events.

Push notifications

In-app messaging

Foreground SDK-rendered messages, lifecycle callbacks, campaign setup, and in-app email collection.

In-app messaging

App inbox

Fetch and query inbox messages, status updates, CTA handling, and building your own inbox UI (since 1.0.0).

App inbox

Prepare for release

Topic

What you’ll find

Developer Guide

API reference

Feature-grouped index of every public type the SDK exposes.

API reference

Changelog

API-level Added / Changed / Deprecated / Removed notes for each release.

Changelog

Data & privacy

Google Play Data Safety, GDPR/CCPA, manifest permissions, offline queueing, and secrets handling.

Data & privacy

Versioning & support

SemVer policy, supported Android/Kotlin/Gradle window, deprecation policy, and support channels.

Versioning & support

Advanced topics

Logging (ZTLogger), FCM push troubleshooting, and testing & QA checklists.

Advanced topics