What belongs where
Reserved versus custom
Custom attributes are for your app’s own segmentation facts. Reserved profile helpers and integration identifiers are for AppActor-owned or partner-owned fields. Do not create custom keys that imitate reserved namespaces. Across SDKs, keys with reserved prefixes such as$, appactor., or integration. are rejected or reserved for dedicated APIs.
Data flow
- Configure the SDK with the AppActor public key and the current
appUserIdwhen you have one. - Send integration identifiers to the dedicated integration-ID APIs.
- Send campaign metadata through attribution helpers or the typed attribution object.
- Enable platform helpers only on the platforms where they exist.
- Let AppActor attach the resulting context to the customer and downstream subscription events.
Clearing and merging
Attribution updates are intentionally separate from custom attribute deletes.- Use
unsetAttribute(...)only for custom attributes. - Use integration-ID unset helpers for partner identifiers.
- Use attribution helper methods or typed attribution payloads for campaign fields.
- Prefer explicit clearing semantics when the SDK exposes them instead of sending empty strings.
Campaign fields
Campaign attribution should use the attribution surface:
Use full typed attribution when you already have a full payload. Use lighter helper methods when your app learns one field at a time.
Install Referrer and Apple Ads
Apple Ads and Google Play Install Referrer are platform acquisition helpers:- Apple Ads is iOS-only and uses the native iOS attribution helper plus dashboard Apple Ads connection.
- Install Referrer is Android-only and should be enabled after Android configure.
- Both enrich attribution and analytics. Neither should grant access.
Platform pages
Integration identifiers and events
Route partner IDs and subscription events without mixing them into custom attributes.
iOS Attributes and Attribution
Send custom attributes, profile helpers, integration IDs, and campaign attribution on iOS.
Android Attributes and Attribution
Send the same attribution model from Android without mixing it with Install Referrer setup.
Apple Search Ads
Enable Apple Ads attribution and read diagnostics on iOS.
Install Referrer
Enable Google Play Install Referrer after Android configure.