appsflyer-adobe-mobile-ios-extension

🛠 In order for us to provide optimal support, we would kindly ask you to submit any issues to [email protected]

When submitting an issue please specify your AppsFlyer sign-up (account) email , your app ID , production steps, logs, code snippets and any additional relevant information.

Table of content

• Adding the SDK to your project
• Initializing the SDK
• Manual Mode
• Guides
• API
• Data Elements
• Send consent for DMA compliance
• Swift Example

This plugin is built for

• iOS AppsFlyer SDK v6.13.1

📲 Adding the SDK to your project

Add the following to your app's Podfile:

pod 'AppsFlyerAdobeExtension', '6.13.1'

🚀 Initializing the SDK

Register the AppsFlyer extension from your Application class, alongside the Adobe SDK initialisation code:

...
#import "AppsFlyerAdobeExtension/AppsFlyerAdobeExtension.h"

@implementation AppDelegate


- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [ACPCore configureWithAppId:@"Key"];
    ...
    [AppsFlyerAdobeExtension registerExtension];
    ...
    
    [AppsFlyerAdobeExtension registerCallbacks:^(NSDictionary *dictionary) {
        NSLog(@"[AppsFlyerAdobeExtension] Received callback: %@", dictionary);
        if([[dictionary objectForKey:@"callback_type"] isEqualToString:@"onConversionDataReceived"]){
            if([[dictionary objectForKey:@"is_first_launch"] boolValue] == YES){
                NSString* af_status = [dictionary objectForKey:@"af_status"];
                if([af_status isEqualToString:@"Non-organic"]){
                    NSLog(@"this is first launch and a non organic install!");
                }
            }
        } else if([[dictionary objectForKey:@"callback_type"] isEqualToString:@"onAppOpenAttribution"]) {
            NSLog(@"onAppOpenAttribution Received");
        }
     }];

    [AppsFlyerAdobeExtension callbacksErrorHandler:^(NSError *error) {
          NSLog(@"[AppsFlyerAdobeExtension] Error receivng callback: %@" , error);
      }];
    
    return YES;
}

In Addition to adding the init code, the settings inside the launch dashboard must be set.

Setting	Description
AppsFlyer iOS App ID	Your iTunes application ID (required for iOS only)
AppsFlyer Dev Key	Your application devKey provided by AppsFlyer (required)
Bind in-app events for	Bind adobe event to appsflyer in-app events. For more info see the doc here.
Send attribution data	Send conversion data from the AppsFlyer SDK to adobe. This is required for data elements.
Debug Mode	Debug mode - set to true for testing only.
Wait for ECID	Once enabled, the SDK Initialization will be delayed until the Experience Cloud ID is set.

Note: For Send attribution data, use this feature if you are only working with ad networks that allow sharing user level data with 3rd party tools.

Manual mode

Starting version 6.13.0, we support a manual mode to separate the initialization of the AppsFlyer SDK and the start of the SDK.
In this case, the AppsFlyer SDK won't start automatically, giving the developer more freedom when to start the AppsFlyer SDK.
Please note that in manual mode, the developer is required to implement the API [[AppsFlyerLib shared] start] in order to start the SDK.
You should set this mode before starting the MobileCore SDK and after registering the extensions in AppDelegate.
If you are using CMP to collect consent data this feature is needed. See explanation here.

Example:

[ACPCore configureWithAppId:@"<ADOBE_DEV_KEY>"];
[AppsFlyerAdobeExtension registerExtension];
AppsFlyerAdobeExtension.shared.manual = true;
...
[ACPCore start:^{
    [ACPCore lifecycleStart:nil];
}];

Please look at the example below to see how to start SDK once you want.
Keep in mind you shouldn't put the start() on a lifecycle method.
To start the AppsFlyer SDK, use the start() API, like the following :

[[AppsFlyerLib shared] start];
AppsFlyerAdobeExtension.shared.manual = false;

You need to end the manual mode. This will tell the Extension to call start() from this point.

📖 Guides

• Deep Linking
• In-App Events
• Data Elements
• Attribution Data tracking with Adobe Analytics
• Deeplink Data tracking with Adobe Analytics

📑 API

See the full API available for this plugin.

📂 Data Elements

Check out the available data elements here.

Send consent for DMA compliance

For a general introduction to DMA consent data, see here. The SDK offers two alternative methods for gathering consent data:

• Through a Consent Management Platform (CMP): If the app uses a CMP that complies with the Transparency and Consent Framework (TCF) v2.2 protocol, the SDK can automatically retrieve the consent details.
  
  OR
  
  
• Through a dedicated SDK API: Developers can pass Google's required consent data directly to the SDK using a specific API designed for this purpose.

Use CMP to collect consent data

A CMP compatible with TCF v2.2 collects DMA consent data and stores it in NSUserDefaults. To enable the SDK to access this data and include it with every event, follow these steps:

1. Call [[AppsFlyerLib shared] enableTCFDataCollection:true] to instruct the SDK to collect the TCF data from the device.
2. Add the extension to MobileCore extensions : [AppsFlyerAdobeExtension registerExtension].
3. Set the extension to be on manual mode to true- meaning the developer will have the responsability to start the SDK.
   This will allow us to delay the Conversion call in order to provide the SDK with the user consent. AppsFlyerAdobeExtension.shared.manual = true
4. Initialize MobileCore.
5. In the applicationDidBecomeActive lifecycle method, use the CMP to decide if you need the consent dialog in the current session to acquire the consent data. If you need the consent dialog move to step 4; otherwise move to step 5.
6. Get confirmation from the CMP that the user has made their consent decision and the data is available in NSUserDefaults.
7. Call start() to the SDK.
8. Set manual mode to false.

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [[AppsFlyerLib shared] enableTCFDataCollection:true];

    // Override point for customization after application launch.
    [ACPCore setLogLevel:ACPMobileLogLevelVerbose];
    [ACPCore configureWithAppId:@"DEV_KEY"];

    
    [AppsFlyerAdobeExtension registerExtension];
    [ACPAnalytics registerExtension];
    [ACPIdentity registerExtension];
    [ACPLifecycle registerExtension];
    [ACPSignal registerExtension];
    AppsFlyerAdobeExtension.shared.manual = true;
    
    [ACPCore start:^{
        [ACPCore lifecycleStart:nil];
    }];

    [AppsFlyerAdobeExtension registerCallbacks:^(NSDictionary *dictionary) {
        NSLog(@"[AppsFlyerAdobeExtension] Received callback: %@", dictionary);
    }];
    
    [AppsFlyerAdobeExtension callbacksErrorHandler:^(NSError *error) {
        NSLog(@"[AppsFlyerAdobeExtension] Error receivng callback: %@" , error);
    }];

    return YES;
}

// Deep Link reporting using Univeral Links.
 - (BOOL) application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> *restorableObjects))restorationHandler {
     [AppsFlyerAdobeExtension continueUserActivity:userActivity restorationHandler:restorationHandler];
    return YES;
}

// Deep Link reporting for URL Schemes.
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url options:(NSDictionary *) options {
    [AppsFlyerAdobeExtension openURL:url options:options];
    return YES;
}

Manually collect consent data

If your app does not use a CMP compatible with TCF v2.2, use the SDK API detailed below to provide the consent data directly to the SDK.

1. Add the extension to MobileCore extensions : [AppsFlyerAdobeExtension registerExtension].
2. Set the extension to be on manual mode to true- meaning the developer will have the responsability to start the SDK.
   This will allow us to delay the Conversion call in order to provide the SDK with the user consent. AppsFlyerAdobeExtension.shared.manual = true
3. Initialize MobileCore.
4. In the applicationDidBecomeActive lifecycle method determine whether the GDPR applies or not to the user.
   - If GDPR applies to the user, perform the following:
   1. Given that GDPR is applicable to the user, determine whether the consent data is already stored for this session.
      1. If there is no consent data stored, show the consent dialog to capture the user consent decision.
      2. If there is consent data stored continue to the next step.
   2. To transfer the consent data to the SDK create an AppsFlyerConsent object with the following parameters:
      - forGDPRUserWithHasConsentForDataUsage- Indicates whether the user has consented to use their data for advertising purposes. - hasConsentForAdsPersonalization- Indicates whether the user has consented to use their data for personalized advertising.
   3. Call [[AppsFlyerLib shared] setConsentData:[[AppsFlyerConsent alloc] initForGDPRUserWithHasConsentForDataUsage:BOOL hasConsentForAdsPersonalization:BOOL]].
   4. Call start() to the SDK.
   5. Set manual mode to false.
   
   - If GDPR doesn’t apply to the user perform the following:
   1. Call [[AppsFlyerLib shared] setConsentData:[[AppsFlyerConsent alloc] initNonGDPRUser]].
   2. Call start() to the SDK.
   3. Set manual mode to false.

Swift Example

See the Swift Example here.