Cybexo Android SDK Setup
Last updated: November 3, 2026
| Property | Value |
|---|---|
| Dependency | com.cybexo:android-sdk:2.0.1 |
| Minimum Android version | API 24 |
| Public entry point | com.cybexo.cmp.CybexoCMP |
| App identity | A published Android CYB- App with your exact package name |
Android SDK 2.0.1 supports IAB TCF 2.4 choices and a separate Google consent dialog without a TC string.
Version 2.0.1 updates the native privacy screens, typography and navigation. Public APIs and saved-choice formats remain compatible with 2.0.0. Test your own Firebase and optional attribution integrations after updating.
Create and publish your Android App
Section titled “Create and publish your Android App”Create an Android App in the CYBEXO Dashboard. Enter the application’s actual package name, select your vendors, configure your privacy policy and publish the configuration. Use that App’s CYB- ID in Android. Version 2.0.1 accepts only CYB- App IDs. Retired App IDs are rejected; their saved choices and history are not migrated.
Under Consent, choose IAB TCF for the configured regional TCF flow or Google consent choices for a separate four-choice dialog without a TC string. This selection is independent of the Google Consent Mode delivery switch and never changes the visitor’s region. Save as Draft and then Publish. Changing the published configuration can require a fresh decision.
Add the SDK
Section titled “Add the SDK”Include google() and mavenCentral() in your dependency repositories. In the application’s Gradle configuration:
android { defaultConfig { minSdk = 24 } compileOptions { sourceCompatibility = JavaVersion.VERSION_17 targetCompatibility = JavaVersion.VERSION_17 isCoreLibraryDesugaringEnabled = true }}
dependencies { implementation("com.cybexo:android-sdk:2.0.1") coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:2.1.5")}The SDK uses Kotlin 2.2.21 metadata. Use a compatible Kotlin toolchain. Keep desugaring enabled for API 24–25. The artifact includes consumer rules for its public APIs and optional recipient integrations; validate your own optimized application build too.
Upgrade to version 2.0
Section titled “Upgrade to version 2.0”Use the documented com.cybexo.cmp APIs and recompile your application and dependent modules against version 2.0.1. Retired implementation-package imports are no longer supported; replacing the library beneath previously compiled callers is not a supported upgrade. Saved preferences and consent records are retained, but a saved grant is restored only when it passes the current ownership, configuration and freshness checks.
Your app owns its Android backup and device-transfer rules. Exclude saved consent, the default preferences containing IAB consent signals, queued consent receipts and the app-scoped visitor identifier from backup and transfer, including retained state from earlier SDK versions. Validate those rules on the Android versions and transfer mechanisms you support; the SDK does not guarantee exclusion by every device manufacturer. If app data is restored onto another device, revalidate its consent context and require a fresh choice before enabling optional collection.
Configure Firebase defaults first
Section titled “Configure Firebase defaults first”Firebase is optional and is configured by the host application. If you use it, add the normal Firebase configuration file and Google Services plugin. The review integration uses Firebase BoM 34.19.0 and com.google.firebase:firebase-analytics.
Place these defaults inside your application’s manifest <application> element, before Firebase can initialize:
<meta-data android:name="google_analytics_default_allow_analytics_storage" android:value="false" /><meta-data android:name="google_analytics_default_allow_ad_storage" android:value="false" /><meta-data android:name="google_analytics_default_allow_ad_user_data" android:value="false" /><meta-data android:name="google_analytics_default_allow_ad_personalization_signals" android:value="false" /><meta-data android:name="google_analytics_tcf_data_enabled" android:value="false" />The final setting disables Firebase’s separate automatic TCF reader: CYBEXO sends the four consent values directly. Keep Google Consent Mode enabled in the published CYBEXO App when you need this forwarding. Do not add a second mapper that overwrites the SDK’s consent updates.
Denied consent and disabled collection are different controls. Gate optional application events according to your collection policy, and verify the Firebase behavior you intend. A successful consent API call is not proof that an event reached Firebase.
Initialize and reopen choices
Section titled “Initialize and reopen choices”Initialize from a valid foreground Activity using your published Android App ID:
import com.cybexo.cmp.CybexoCMP
CybexoCMP.initialize(this, "CYB-abcdefghij") { if (CybexoCMP.initializationStatus == "READY") { // Continue the host's normal setup using the current consent state. } else { // Keep optional processing disabled and offer an appropriate retry. }}Do not treat completion as a grant. Initialization restores only an applicable, valid saved decision; otherwise the user sees privacy choices with optional choices denied. Network or configuration failure must not enable optional processing.
Provide a persistent Privacy choices entry in the app:
CybexoCMP.forceShowBanner(this)Use the SDK’s normal privacy screen for accept, reject, granular choices and withdrawal. Closing a screen without saving does not make a decision. Avoid repeated initialization per screen and do not run two CMPs against the same application’s native IAB preferences.
Understand the four Google values
Section titled “Understand the four Google values”| Signal | In the TCF flow |
|---|---|
ad_storage |
Google vendor 755 consent and purpose 1 consent |
analytics_storage |
Google vendor 755 consent and the separate Analytics choice |
ad_user_data |
Google vendor 755 consent, purpose 1 consent, and purpose 7 consent or permitted purpose 7 legitimate interest with vendor 755 legitimate interest |
ad_personalization |
Google vendor 755 consent and purposes 3 and 4 consent |
Analytics is an independent choice. In Google consent choices mode, the four options are independent and no TC string is created. Turning Google Consent Mode off disables forwarding; it does not provide evidence that a new value reached an existing recipient.
TCF mode publishes the native IABTCF_ values in Android’s default application SharedPreferences. Recipients should use this standard contract rather than an SDK-private preferences file. The SDK validates ownership, freshness, policy and published configuration before restoring a decision.
Optional attribution integrations
Section titled “Optional attribution integrations”Add and configure the services your application actually uses. CYBEXO supplies consent values automatically; the host still owns ordinary API keys, SDK initialization and session lifecycle.
Disclose every actual recipient and link its privacy information in your app’s consent information and privacy policy.
| SDK version used for integration checks | Consent route | Startup ordering |
|---|---|---|
| AppsFlyer 6.17.5 | setConsentData(AppsFlyerConsent) |
Initialize its object, apply consent, then start the session. |
| Adjust 5.8.0 | trackThirdPartySharing with google_dma options |
Apply consent before the first session; the SDK can queue it before initialization. |
| Branch 5.21.3 | Instance setDMAParamsForEEA |
Enable delayed session initialization, create the configured instance, apply consent, then start the session. |
For Branch, call Branch.expectDelayedSessionInitialization(true) before creating its instance. Consent denial does not call account logout or GDPR erasure. These DMA fields do not by themselves disable every unrelated collection feature in an attribution SDK; configure the recipient’s other collection controls as your app requires.
Use real service accounts for remote delivery tests. Local API acceptance or a queued value does not prove reception by AppsFlyer, Adjust or Branch.
Verify your integration
Section titled “Verify your integration”Check a fresh install, accept, reject, mixed choices, withdrawal, rotation and restart. Test both published framework modes if your app supports both. Confirm defaults precede collection and that UI choices, native IAB state, recipient values and consent records agree.
getConsentSnapshot() provides current consent and delivery diagnostics without creating a decision. Observe changes with a listener and remove the same listener when its owner is destroyed. A locally saved choice, an API call, HTTP acceptance and a durable server record are separate results.
Use a dedicated test Firebase project, enable DebugView for your test package, correlate a non-personal test event, and disable debug mode when finished. Test the exact release artifact in an optimized consumer application. See Google’s native app consent guidance and Firebase DebugView.
Rollback and related documentation
Section titled “Rollback and related documentation”Keep the previous app binary and configuration revision available. A rollback must retain denied startup defaults and avoid restoring an incompatible saved grant. Removing the CMP alone does not safely undo recipient state.