AppsFlyer SDK Integration - iOS

AppsFlyer's unique device ID is created for every new install of an app. You can obtain it using the following code:

let appsflyerId = AppsFlyerTracker.shared().getAppsFlyerUID()

NSString *appsflyerId = [AppsFlyerTracker sharedTracker].getAppsFlyerUID;

Setting your own customer ID enables you to cross-reference your own unique ID with AppsFlyer’s unique ID and the other devices’ IDs. This ID is available in AppsFlyer CSV reports along with Postback APIs for cross-referencing with your internal IDs.

To set your Customer User ID:

AppsFlyerTracker.shared().customerUserID = "my user id"

[AppsFlyerTracker sharedTracker].customerUserID = @"my user id";

Getting Customer User ID:

To avoid setting the customer user ID value again beyond the first launch you can check if its value is empty or not by using: 

[AppsFlyerTracker sharedTracker].customerUserID

For more information about the Customer User ID, click here.

AppsFlyer enables you to report one or more of the user’s email addresses, if you collect them in your app. The email values can be encrypted by following encryption methods: Sha1, MD5 and plain.

Example: Collecting User Email

AppsFlyerTracker.shared().setUserEmails( ["email1@domain.com", "email2@domain.com"], with: EmailCryptTypeSHA1)

AppsFlyer automatically collects the IDFA (ID For Advertisers) and IDFV (ID For Vendors) if AdSupport.framework is included in the app.

For Uninstall Tracking, enable remote push notification on your app. See Apple's Remote Notification Programming Guide for more details.

Follow the iOS SDK integration instructions to complete the uninstall feature setup.

To enable Tracking App Launches from push notifications, add the following code to your app delegate:

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any]) {
 AppsFlyerTracker.shared().handlePushNotification(userInfo)
 }

-(void) application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
       [[AppsFlyerTracker sharedTracker] handlePushNotification:userInfo];
    }

The push message should have an af parameter with AppsFlyer tracking params.

Message Example:

{
 "aps": {
 "alert": "Push text",
 "sound": "default",
 "category": "REMINDER_CATEGORY"
 },
 "_p": 123456,
 "payloadKey": "payloadValue"
 "af": {
 "pid": "swrve_int",
 "is_retargeting": true,
 "c": "test_campaign"
 }
}

AppsFlyer allows you to track and attribute installs originating from a cross promotion of one of your apps from within the current app the user has.  Cross promoting apps can be a major growth factor in driving additional installs for your apps.

For details, see the Cross Promotion Tracking article, here.

AppsFlyer’s SDK can provide in‐app purchase server verification. To set receipt validation tracking you need to call the validateAndTrackInAppPurchase method inside the SKStoreKit’s completeTransaction: callback. This call automatically generates an af_purchase in‐app event.

- (void) validateAndTrackInAppPurchase:(NSString *) productIdentifier
price:(NSString *) price
currency:(NSString *) currency
transactionId:(NSString *) tranactionId
additionalParameters:(NSDictionary *) params
success:(void (^)(NSDictionary *response)) successBlock
failure:(void (^)(NSError *error, id reponse)) failedBlock;

This call has two callback blocks, one for ‘success’ and one for ‘failure’ (for any reason, including validation fail). On success, a dictionary is returned with the receipt validation data provided by Apple’s servers.  

#ifdef DEBUG
    [AppsFlyerTracker sharedTracker].useReceiptValidationSandbox = YES;
#endif

[[AppsFlyerTracker sharedTracker] validateAndTrackInAppPurchase:product.productIdentifier price:product.price.stringValue
currency:@"USD"
transactionId:trans.transactionIdentifier
additionalParameters:@{@"test": @"val" , @"test1" : @"val 1"}
success:^(NSDictionary *result){
  NSLog(@"Purchase succeeded And verified!!! response: %@", result[@"receipt"]);
} failure:^(NSError *error, id response) {
  NSLog(@"response = %@", response);
}];

AppsFlyerTracker.shared().validateAndTrack(inAppPurchase:  product.productIdentifier, price: "\(product.price)", currency:  product.priceLocale.currencyCode, transactionId:  trans.transactionIdentifier, additionalParameters: nil,success:{(result) in
   print("Purchase succeeded And verified!!! response \(result)")
   },failure:{(error,message) in
   print("response = \(message)")
   })

For a list of possible return values for validating receipts, please refer to Apple's documentation here.

AppsFlyer provides you with a method to annonymize specific user identifiers in AppsFlyer analytics. This method complies with the latest privacy requirements and complies with Facebook data and privacy policies. Default is NO, meaning no anonymization is performed by default.

Use this API during the SDK Initialization to explicitly anonymize a user's installs, events and sessions:

AppsFlyerTracker.shared().deviceTrackingDisabled = true

[AppsFlyerTracker sharedTracker].deviceTrackingDisabled = YES;

Tracking can be restarted by calling deviceTrackingDisabled again set to false.

For AppsFlyer to count two separate sessions, the default time between each session must be at least 5 seconds.  A session commences when the user opens the app.  If you want to configure a different time between sessions, use the following API:

AppsFlyerTracker.shared().minTimeBetweenSessions = <your_custom_time_in_seconds>

[AppsFlyerTracker sharedTracker].minTimeBetweenSessions = <your_custom_time_in_seconds>;

The app extension requires permissions to use the Internet:

1. Go to your app extension's info.plist file
2. In the NSExtension / NSExtensionAttributes set the RequestsOpenAccess flag to YES.

Add the following code to the app extension's UIViewController viewDidLoad:

override func viewDidLoad() {    
        super.viewDidLoad()
        AppsFlyerTracker.shared().appsFlyerDevKey = "MY_APPSFLYER_KEY"

        // MY_APP_ID below stands for you app ID on iTunes Connect. Should be 9 or 10 digits.
        AppsFlyerTracker.shared().appleAppID = "MY_APP_ID"
                
        AppsFlyerTracker.sharedTracker().trackAppLaunch()
    }

- (void)viewDidLoad {
        [super viewDidLoad];
        // Replace MY_APPSFLYER_KEY below by your AppsFlyer dev key
        [AppsFlyerTracker sharedTracker].appsFlyerDevKey = @"MY_APPSFLYER_KEY";

        // MY_APP_ID below stands for you app ID on iTunes Connect. Should be 9 or 10 digits.
        [AppsFlyerTracker sharedTracker].appleAppID = @"MY_APP_ID";
                
        [[AppsFlyerTracker sharedTracker] trackAppLaunch];
    }

In some extreme cases you might want to shut down all SDK tracking due to legal and privacy compliance. This can be achieved with the isStopTracking API. Once this API is invoked, our SDK will no longer communicate with our servers and stop functioning.

AppsFlyerTracker.shared().isStopTracking = true

[AppsFlyerTracker sharedTracker].isStopTracking = true;

AppsFlyer SDK allows you to collect Device Name for your internal analysis. By default, this capability is turned off. To turn it on use the following API:

AppsFlyerTracker.shared().shouldCollectDeviceName = false`

[AppsFlyerTracker sharedTracker].shouldCollectDeviceName = NO;

The setAdditionalData API is required to integrate on the SDK level with several external partner platforms, including Segment, Adobe and Urban Airship. Use this API only if the integration article of the platform specifically states setAdditionalData API is needed.
The following is a code example for implementing setAdditionalData on iOS for Objective-C or Swift

NSDictionary* CustomDataMap = [[NSDictionary alloc] initWithObjectsAndKeys:@"value_of_param_1", @"custom_param_1", nil];
    
[[AppsFlyerTracker sharedTracker] setAdditionalData:CustomDataMap];

let CustomDataMap: [AnyHashable: Any] = [
   "custom_param_1" : "value_of_param_1"
]
        
AppsFlyerTracker.shared().customData = CustomDataMap