AppsFlyer
This guide describes how to add and configure AppsFlyer integration.
AppsFlyer is the world's leading mobile attribution & marketing analytics platform, helping app marketers around the world make better decisions.
How does Integration Work?
This integration works in two ways.
1. Receive Attribution Data from AppsFlyer
Once you successfully configured AppsFlyer integration, Apphud will receive attribution data from it. You can view this data on the user's page:
2. Send Subscription Events to AppsFlyer
Apphud can also send all subscription events to AppsFlyer. So you could view these events in the AppsFlyer dashboard and AppsFlyer could pass this data to their partners. This will help to measure the efficiency of your ad campaigns.
Collect advertising identifiers
For both iOS and Android you must manually provide advertising identifier by calling
Apphud.setAdvertisingIdentifier(idfa)
on iOS andApphud.collectDeviceIdentifiers()
on Android.
Step 1
- Integrate AppsFlyer SDK into your app.
- Pass attribution data to Apphud (required).
- Collect Device Identifiers on Android (required).
Step 2
At Apphud go to "Integrations" section and add AppsFlyer:
Step 3
Paste AppsFlyer Dev Key into "Developer key" field:
Step 4
You may have one more app created in AppsFlyer used for testing purposes not to mix test and live data. If you have a such app, paste test App Store app ID or test Package Name into "Test App ID" field.
Note
Information about how to create an app for debug purposes can be found in AppsFlyer documentation.
Step 5
You can enter your custom event names or disable some.
Note
You can use AppsFlyer built-in rich events names. View more information here.
Important Note
From AppsFlyer help: each network has its own limitations regarding the permitted characters in event names. To avoid problems, use only lower-case alpha-numeric characters (a-z and 0-9) for your in-app event names.
Pass Attribution Data to Apphud (required)
Send attribution data to Apphud (or at least Appsflyer ID). Implement delegate methods or listener.
Swift
AppsFlyerLib.shared().delegate = self
...
func onConversionDataSuccess(_ conversionInfo: [AnyHashable : Any]!) {
Apphud.addAttribution(data: conversionInfo, from: .appsFlyer, identifer: AppsFlyerLib.shared().getAppsFlyerUID()) { _ in }
}
func onConversionDataFail(_ error: Error) {
Apphud.addAttribution(data: ["error" : error.localizedDescription], from: .appsFlyer, identifer: AppsFlyerLib.shared().getAppsFlyerUID()) { _ in }
}
Objective-C
[AppsFlyerTracker sharedTracker].delegate = self;
...
- (void)onConversionDataSuccess:(NSDictionary *)conversionInfo{
[Apphud addAttributionWithData:conversionInfo from:ApphudAttributionProviderAppsFlyer identifer:AppsFlyerTracker.sharedTracker.getAppsFlyerUID callback:^(BOOL callback) {}];
}
- (void)onConversionDataFail:(NSError *)error{
[Apphud addAttributionWithData:@{@"error" : error.localizedDescription} from:ApphudAttributionProviderAppsFlyer identifer:AppsFlyerTracker.sharedTracker.getAppsFlyerUID callback:^(BOOL result){}];
}
Kotlin
val listener = object : AppsFlyerConversionListener {
override fun onConversionDataSuccess(map: MutableMap<String, Any>?) {
val uid = AppsFlyerLib.getInstance().getAppsFlyerUID(app)
Apphud.addAttribution(ApphudAttributionProvider.appsFlyer, map, uid)
}
override fun onConversionDataFail(p0: String?) {
val uid = AppsFlyerLib.getInstance().getAppsFlyerUID(app)
Apphud.addAttribution(ApphudAttributionProvider.appsFlyer, null, uid)
}
}
AppsFlyerLib.getInstance().init("APPSFLYER_DEV_KEY", listener, this)
AppsFlyerLib.getInstance().startTracking(this)
// initialize Apphud
val uid = AppsFlyerLib.getInstance().getAppsFlyerUID(this)
Apphud.addAttribution(ApphudAttributionProvider.appsFlyer, null, uid)
While configuring integration you can also choose between sending revenue as sales or proceeds (without Apple / Google 15%-30% commission).
Note
You can read more how Apple and Google calculate their commissions here and here.
Important Note
In order to receive AppsFlyer attribution data from Facebook, you should accept Facebookβs "Advanced Mobile Measurement Agreement" using this link.
Collect Device Identifiers on Android (required)
For Android SDK 1.8.0 or higher, Advertising Identifier is not collected automatically. You must manually call Apphud.collectDeviceIdentifiers()
method after SDK initialization.
When targeting Android 13 and above, you must also declare AD_ID permission in the manifest file.
Request IDFA Consent (required)
Starting iOS 14.5 access to IDFA requires user consent. You should request IDFA manually using AppTrackingTransparency framework and pass it to Apphud. Read more here.
Events Cheat Sheet
This is a list of all possible events and their parameters that are being sent to AppsFlyer.
Note
You can read more about subscription events here and parameters here.
Trial
Trial period started
Default event name: apphud_trial_started
Parameters:
af_content_id
: String
Successful conversion from trial period to regular subscription
Default event name: apphud_trial_converted
Parameters:
af_content_id
: Stringaf_revenue
: Floataf_currency
: String
Failed conversion from trial period to regular subscription
Default event name: apphud_trial_expired
Parameters:
af_content_id
: Stringreason
: String (iOS)
Cancellations
Trial Canceled
Default event name: apphud_trial_canceled
Parameters:
af_content_id
: String
Subscription Canceled
Default event name: apphud_subscription_canceled
Parameters:
af_content_id
: String
Autorenew disabled (Deprecated)
Default event name: apphud_autorenew_disabled
Parameters:
af_content_id
: String
Autorenew enabled
Default event name: apphud_autorenew_enabled
Parameters:
af_content_id
: String
Introductory Offer
Introductory offer started
Default event name: apphud_intro_started
Parameters:
af_content_id
: Stringaf_revenue
: Floataf_currency
: Stringoffer_type
: String (iOS)unit
: String (iOS)units_count
: Integer (iOS)
Introductory offer renewed
Default event name: apphud_intro_renewed
Parameters:
af_content_id
: Stringaf_revenue
: Floataf_currency
: Stringoffer_type
: String (iOS)unit
: String (iOS)units_count
: Integer (iOS)
Successful conversion from introductory offer to regular subscription
Default event name: apphud_intro_converted
Parameters:
af_content_id
: Stringaf_revenue
: Floataf_currency
: Stringoffer_type
: String (iOS)
Failed conversion from introductory offer to regular subscription or failed renewal
Default event name: apphud_intro_expired
Parameters:
af_content_id
: Stringreason
: String (iOS)offer_type
: String (iOS)
Refund during the introductory offer
Default event name: apphud_intro_refunded
Parameters:
af_content_id
: Stringaf_revenue
: Floataf_currency
: Stringreason
: String (iOS)offer_type
: String (iOS)
Regular
Subscription started
Default event name: apphud_subscription_started
Parameters:
af_content_id
: Stringaf_revenue
: Floataf_currency
: String
Subscription renewed
Default event name: apphud_subscription_renewed
Parameters:
af_content_id
: Stringaf_revenue
: Floataf_currency
: String
Subscription expired
Default event name: apphud_subscription_expired
Parameters:
af_content_id
: Stringreason
: String (iOS)
Subscription refunded
Default event name: apphud_subscription_refunded
Parameters:
af_content_id
: Stringaf_revenue
: Floataf_currency
: Stringreason
: String (iOS)
Promo Offer
Promotional offer started
Default event name: apphud_promo_started
Parameters:
af_content_id
: Stringoffer_id
: String (iOS)af_revenue
: Floataf_currency
: Stringoffer_type
: String (iOS)unit
: String (iOS)units_count
: Integer (iOS)
Promotional offer renewed
Default event name: apphud_promo_renewed
Parameters:
af_content_id
: Stringoffer_id
: String (iOS)af_revenue
: Floataf_currency
: Stringoffer_type
: String (iOS)unit
: String (iOS)units_count
: Integer (iOS)
Successful conversion from a promotional offer to a regular subscription
Default event name: apphud_promo_converted
Parameters:
af_content_id
: Stringoffer_id
: String (iOS)af_revenue
: Floataf_currency
: Stringoffer_type
: String (iOS)
Failed conversion from promotional offer to regular subscription or failed renewal
Default event name: apphud_promo_expired
Parameters:
af_content_id
: Stringoffer_id
: String (iOS)reason
: String (iOS)offer_type
: String (iOS)
Refund during the promotional offer
Default event name: apphud_promo_refunded
Parameters:
af_content_id
: Stringoffer_id
: String (iOS)af_revenue
: Floataf_currency
: Stringreason
: String (iOS)offer_type
: String (iOS)
Other Events
Non-renewing purchase
Default event name: apphud_non_renewing_purchase
Parameters:
af_content_id
: Stringaf_revenue
: Floataf_currency
: String
Non-renewing purchase refunded
Default event name: apphud_non_renewing_purchase_refunded
Parameters:
af_content_id
: Stringaf_revenue
: Floataf_currency
: Stringreason
: String (iOS)
Billing Issue
Default event name: apphud_billing_issue
Parameters:
af_content_id
: String
Billing issue Resolved
Default event name: [Apphud] billing_issue_resolved
Parameters:
af_content_id
: String
If you want sandbox purchases not to mix with your production purchases in AppsFlyer, you should create a Test App ID.
- Create a new app in AppsFlyer as described here.
- Enter the newly created Test App ID toTest App ID field in the AppsFlyer Integration page in Apphud.
- iOS: Change App ID to a Test App ID when initializing AppsFlyer SDK:
AppsFlyerLib.shared().appleAppID = "0123456789"β
- Android: Change Package Name to a Test Package Name.
Step 1
Please make sure AppsFlyer SDK is properly integrated in your app and AppsFlyer integration is configured in Apphud.
Step 2
Re-install the app and launch it again.
Step 3
Make a test purchase in your app.
Note
You can read more about testing purchases here.
Step 4
You will see attribution data on the user's page:
Step 5
Open "Events" tab in AppsFlyer and you will see Apphud events there:
Updated 6 months ago