API Reference | Audiencelab

All methods are accessed through AudienceLabSDK.

Initialization

Method	Description
`initialize(context, apiKey, options)`	Initialize the SDK with a `Context`. Preferred form for persisted state and lifecycle hooks.
`initialize(apiKey, options)`	Initialize without explicit `Context`. Uses in-memory state only.
`init(...)`	Alias for `initialize(...)`.
`isInitialized()`	Returns `Boolean` — whether the SDK has been initialized.

Event Methods

Method	Description
`sendPurchaseEvent(...)`	Track a purchase. Sends `type: "purchase"` with `total_purchase_value`.
`sendAdEvent(...)`	Track an ad event. Sends `type: "ad"` with `total_ad_value`.
`sendCustomEvent(name, params?, dedupeKey?)`	Track a custom event. Sends `type: "custom"` with `en` and `pr`.
`sendUserMetrics()`	Send daily retention metrics when eligible.

User Properties

Method	Description
`setUserProperty(key, value, scope)`	Set a `wp` or `bp` property using `UserPropertyScope`.
`setUserProperty(key, value, isWhitelisted)`	Boolean overload for setting `wp` or `bp`.
`unsetUserProperty(key, scope)`	Remove a property.
`unsetUserProperty(key, isWhitelisted)`	Boolean overload for removing a property.
`clearUserProperties(scope)`	Clear one property set.
`clearUserProperties(isWhitelisted)`	Boolean overload for clearing one property set.
`getWhitelistedUserProperties()`	Returns whitelisted property map.
`getBlacklistedUserProperties()`	Returns blacklisted property map.

For blacklisted email and phone keys, the Android SDK automatically normalizes and SHA-256 hashes the stored value.

Identity and Diagnostics

Method	Description
`setAdvertisingIdProvider(provider)`	Set a GAID provider.
`setAppSetIdProvider(provider)`	Set an App Set ID provider.
`setAdvertisingId(gaid)`	Manually set GAID. Sent as `ga`.
`clearAdvertisingId()`	Clear manual GAID.
`setAppSetId(appSetId)`	Manually set App Set ID. Sent as `asid`.
`clearAppSetId()`	Clear manual App Set ID.
`setLimitAdTracking(lat)`	Set Limit Ad Tracking preference. Sent as `lat`.
`isIdentitySettled()`	Returns whether identity resolution has settled.
`getIdentityDebugSnapshot()`	Returns masked identity diagnostics.
`getDeviceDebugSnapshot()`	Returns device debug diagnostics.
`getTokenDebugSnapshot()`	Returns token/retry debug diagnostics.
`getQueueDebugSnapshot()`	Returns queued event diagnostics.
`setRequestResultCallback(callback)`	Register request outcome callback.
`clearRequestResultCallback()`	Clear request outcome callback.
`setRequestDebugListener(listener)`	Register detailed request debug listener.
`clearRequestDebugListener()`	Clear request debug listener.

Token and Attribution

Method	Returns	Description
`getCreativeToken()`	`String?`	Stored creative token from `/fetch-token`.

Configuration

Method	Returns	Description
`setSdkEnabled(Boolean)`	—	Master SDK toggle.
`setSDKEnabled(Boolean)`	—	Alias for `setSdkEnabled(Boolean)`.
`isSdkEnabled()`	`Boolean`	Whether SDK is enabled.
`getIsSDKEnabled()`	`Boolean`	Alias getter for SDK enabled state.
`toggleMetricsCollection(Boolean)`	—	Enable/disable data collection.
`isMetricsCollectionEnabled()`	`Boolean`	Whether collection is enabled.
`getIsMetricsCollection()`	`Boolean`	Alias getter for metrics collection state.
`setDebugEnabled(Boolean)`	—	Enable/disable debug mode.
`isDebugEnabled()`	`Boolean`	Whether debug mode is on.
`getIsDebugEnabled()`	`Boolean`	Alias getter for debug state.
`isDevelopmentMode()`	`Boolean`	Current backend `dev` mode.

Cumulative Values

Method	Returns	Description
`getTotalPurchaseValue()`	`Double`	Lifetime cumulative purchase value.
`getTotalAdValue()`	`Double`	Lifetime cumulative ad revenue.

Queue

Method	Returns	Description
`getQueueSize()`	`Int`	Number of queued webhook events.

Version Info

Method	Returns	Description
`getSdkVersion()`	`String`	SDK version. Sent as `sdk_version`.
`getAppVersion()`	`String`	App version. Sent as `app_version`.
`getRuntimeVersion()`	`String`	Android runtime version.

Webhook Envelope Fields

All events include these common fields automatically:

Field	Source	Description
`creativeToken`	Stored from `/fetch-token`	Attribution token
`sdk_type`	`"native_android"`	Platform identifier
`sdk_version`	Auto-detected	SDK version
`app_version`	Config or auto-detected	Host app version
`os_system`	Auto-detected	e.g. `"Android 14"`
`device_name`	Auto-detected	Human-readable device name
`device_model`	Auto-detected	e.g. `"SM-S911B"`
`utc_offset`	Auto-detected	UTC offset in hours
`ga`	GAID provider or manual	Google Advertising ID
`asid`	App Set ID provider or manual	Android App Set ID
`aid`	Auto-collected	Android ID (hex)
`lat`	Auto-detected or manual	Limit Ad Tracking preference
`eid`	Auto-generated	Event identifier
`dk`	Event API input	Optional deduplication key
`created_at`	Auto-generated	Event creation timestamp
`wp`	User properties	Whitelisted properties
`bp`	User properties	Blacklisted properties
`dev`	SDK config	Development mode flag

User Properties

Set and manage user properties with the Android SDK

Debug and Diagnostics

Inspect request, token, identity, device, and queue state for the Android SDK

On this page

Initialization Event Methods User Properties Identity and Diagnostics Token and Attribution Configuration Cumulative Values Queue Version Info Webhook Envelope Fields