REMOTE COMMANDS/INTEGRATIONS

Remote Command: AppsFlyer

Requirements

How It Works

The AppsFlyer integration uses the native AppsFlyer SDK, a remote commands module that wraps the AppsFlyer methods, and the AppsFlyer Remote Command tag that translates event tracking into native AppsFlyer calls. This solution leverages the convenience of Tealium iQ Tag Management to configure a native AppsFlyer implementation without having to add vendor-specific code to your app.

Adding the AppsFlyer remote command module to your app automatically installs and builds the required AppsFlyer libraries. If you are using a dependency manager installation, there is no need to install the AppsFlyer SDK separately.

iOS: For AppsFlyer version 4.8.11+, the SDK automatically adds the following native frameworks: AdSupport.framework and iAd.framework. Learn more in the AppsFlyer iOS SDK integration guide.

Install

Dependency Manager

We recommend using one of the following dependency managers for installation:

If you are using the Tealium iOS (Objective-C) library, use the manual installation method. The CocoaPods and Carthage options are only available if you are using the Tealium iOS (Swift) library.

    To install AppsFlyer remote commands for iOS using CocoaPods:

    1. Remove tealium-swift and pod "AppsFlyerFramework" if they exist in your Podfile. The dependency for tealium-swift is already included in the TealiumAppsFlyer framework.

    2. Add the following dependency to your Podfile:

      pod "TealiumAppsFlyer"

      The TealiumAppsFlyer pod includes the following TealiumSwift dependencies:

      'tealium-swift/Core'
'tealium-swift/TealiumDelegate'
'tealium-swift/TealiumRemoteCommands'
'tealium-swift/TealiumTagManagement'

    3. Add any other required modules manually to your Podfile, such as the following:

      'tealium-swift/TealiumLogger'
'tealium-swift/TealiumLifecycle'
'tealium-swift/TealiumAppData'

      Learn more about the recommended modules for iOS.

    4. Import the modules TealiumSwift and TealiumAppsFlyer in your TealiumHelper file, and any other files that access the Tealium class, or the AppsFlyer remote command.

    To install AppsFlyer remote commands for iOS using Carthage:

    1. Remove tealium-swift from your Cartfile. The dependency for tealium-swift is already included in the TealiumAppsFlyer framework.

    2. Remove the following line if it exists in your Cartfile:

      `binary "https://raw.githubusercontent.com/AppsFlyerSDK/AppsFlyerFramework/master/AppsFlyerLib.json"`

    3. Add the following dependency to your Cartfile:

      github "tealium/tealium-ios-appsflyer-remote-command"

    Tealium for Swift SDK (version 1.6.5+) requires the TealiumDelegate module to be included with your installation.

    To install AppsFlyer remote commands for Android using Maven:

    1. Install Tealium’s Android SDK, if you haven’t done so already.

    2. Add the Tealium Maven URL to your project’s top-level build.gradle file:

      allprojects {
repositories {
jcenter()
maven {
  url "https://maven.tealiumiq.com/android/releases/"
}
}
}

    3. Import both the AppsFlyer SDK and Tealium-AppsFlyer remote commands by adding the following dependencies in your app project’s build.gradle file:

      dependencies {
implementation 'com.tealium.remotecommands:appsflyer:1.0.0'
}

    Manual (iOS)

    The manual installation for AppsFlyer remote commands requires one of the following iOS libraries to be installed:

    To install the AppsFlyer remote commands for your iOS project:

    1. Install the AppsFlyer SDK, if you haven’t already done so.

    2. Clone the Tealium iOS AppsFlyer remote command repo and drag the files within the Sources folder into your project.

    3. When initializing the Tealium SDK, update the completion handler as follows:

      tealium = Tealium(config: config) { responses in
guard let remoteCommands = self.tealium?.remoteCommands() else {
return
}
let appsFlyerRemoteCommand = AppsFlyerRemoteCommand().remoteCommand()
remoteCommands.add(appsFlyerRemoteCommand)
}

      Add the remote command in the TealiumHelper.swift file as follows:

      let appsFlyerCommandTracker = AppsFlyerCommandTracker()
let appsFlyerCommand = AppsFlyerCommand(appsFlyerCommandTracker: appsFlyerCommandTracker)
let appsFlyerRemoteCommand = appsFlyerCommand.remoteCommand()
tealium.addRemoteCommandID("appsflyer",
                           description: nil,
                           targetQueue: DispatchQueue.main,
                           responseBlock: appsFlyerRemoteCommand)

      Import the remote command in the TealiumHelper.m file as follows:

      #import "TealiumRemoteCommandObjcApp-Swift.h"

      The Swift bridging header for your target is named ending with -Swift.h. Find this by filtering for “Module Name” in your target’s build settings.

      Learn more in the Apple Developer Documentation: Importing Swift Into Objective-C.

      Initialize the remote command as follows:

      AppsFlyerCommandTracker *appsFlyerCommandTracker = [[AppsFlyerCommandTracker alloc] init];
AppsFlyerCommand *appsFlyerCommand = [[AppsFlyerCommand alloc] initWithAppsFlyerCommandTracker: appsFlyerCommandTracker];
TEALRemoteCommandResponseBlock appsFlyerRemoteCommand = [appsFlyerCommand remoteCommand];
[[Tealium instanceForKey:@"MY_INSTANCE"] addRemoteCommandID:@"appsflyer"
                                    description:@"AppsFlyer Remote Command"
                                    targetQueue:dispatch_get_main_queue()
                                    responseBlock: appsFlyerRemoteCommand];

      Manual (Android)

      The manual installation for AppsFlyer remote commands requires the following Android library to be installed:

      To install the AppsFlyer remote commands for your Android project:

      1. Add flatDir to your project root build.gradle file:

        allprojects {
  repositories {
     jcenter()
     flatDir {
         dirs 'libs'
     }
  }
}

      2. Add tealium-appsflyer.aar to <PROJECT_ROOT>/<MODULE>/libs.

      3. Add the Tealium library dependency to your build.gradle file:

        dependencies {
  implementation(name:'tealium-appsflyer', ext:'aar')
}

      Initialize

      For all Tealium libraries, register the AppsFlyer Remote Command when you initialize.

        The following code is designed for use with Tealium’s Android library:

        private val devKey = "<your_appsflyer_dev_key>"

// Sets up a config object and creates a Tealium instance
val config: Tealium.Config = Tealium.Config.create(application, "your_account", "your_profile", "dev");
var tealium: Tealium = Tealium.createInstance(TEALIUM_MAIN, config)

// New code to add the AppsFlyer Remote Command
val appsFlyerRemoteCommand = AppsFlyerRemoteCommand(instanceName, application, appsFlyerDevKey = devKey)
tealium.addRemoteCommand(appappsFlyerRemoteCommandsflyer);

        The following code is designed for use with Tealium’s Swift library for iOS:

        var teal : Tealium?
let config = TealiumConfig(account: "your_account",
                           profile: "your_profile",
                           environment: "dev",
                           datasource: "abc123",
                           optionalData: nil)

teal = Tealium(config: config) { responses in
  guard let remoteCommands = self.tealium?.remoteCommands() else {
        return
  }
  let appsFlyerRemoteCommand = AppsFlyerRemoteCommand().remoteCommand()
  remoteCommands.add(appsFlyerRemoteCommand)
}

        The following code is designed for use with Tealium’s Objective-C library for iOS, although it is written in Swift. A Bridging Header is required in your Xcode project for this code to work correctly.

        // Sets up a config object and creates a Tealium instance.
let config = TEALConfiguration(account: "your_account",
                               profile: "your_profile",
                               environment: "dev",
                               datasource: "abc123")
let teal = Tealium.newInstance(forKey: "teal", configuration: config)

let appsFlyerCommand = AppsFlyerRemoteCommand(appsFlyerCommandTracker: AppsFlyerCommandTracker())
let appsFlyerRemoteCommand = appsFlyerCommand.remoteCommand()
teal.addRemoteCommandID("appsflyer", description: nil, targetQueue: DispatchQueue.main, responseBlock: appsFlyerRemoteCommand)

        Push Message Tracking

        The Tealium Swift library includes a TealiumRegistration protocol for handling push message tracking via Tealium and the AppsFlyer Remote Command. We conform to this protocol in AppsFlyerCommandTracker and is used to send push message authorization events, push message open events, and to uninstall tracking. We recommend taking advantage of the push message tracking capability.

        The following steps integrate push message tracking for your iOS project:

        1. In the TealiumHelper.swift file, initialize an empty array of objects that conform to the TealiumRegistration protocol. For example:

          var pushMessagingTrackers = [TealiumRegistration]()

        2. Initialize the AppsFlyerCommandTracker before the AppsFlyerRemoteCommand

        3. Append the AppsFlyerCommandTracker to the array described above

        The following is full example of the push message tracking integration:

        var pushMessagingTrackers = [TealiumRegistration]()

//...

teal = Tealium(config: config) { responses in
  guard let remoteCommands = self.tealium?.remoteCommands() else {
        return
  }
  let appsFlyerCommandTracker = AppsFlyerCommandTracker()
  let appsFlyerCommand = AppsFlyerCommand(appsFlyerCommandTracker: appsFlyerCommandTracker)
  let appsFlyerRemoteCommand = appsFlyerCommand.remoteCommand()
  remoteCommands.add(appsFlyerRemoteCommand)
  self.pushMessagingTrackers.append(appsFlyerCommandTracker)
}

        To see the entire TealiumHelper.swift file, explore the AppsFlyer Remote Command sample app. To send an event to AppsFlyer once a user has registered for notifications, opened a push message, or uninstalled the app, see the file AppDelegate.swift.

        Learn more about AppsFlyer’s push message and uninstall tracking functionality in the iOS SDK integration for developers guide.

        Supported Methods

        The following AppsFlyer methods are triggered using a data mapping in the AppsFlyer Remote Command tag using these Tealium commands:

        Remote Command AppsFlyer Method
        initialize initialize()
        trackLaunch trackLaunch()
        Any of the below event names trackEvent()
        setHost setHost()
        setUserEmails setUserEmails()
        setCurrencyCode currencyCode (property on the AppsFlyerTracker.shared object)
        setCustomerId customerUserID (property on the AppsFlyerTracker.shared object)
        disableDeviceTracking setDeviceTrackingDisabled
        disableTracking isStopTracking (property on the AppsFlyerTracker.shared object)
        resolveDeeplinkUrls resolveDeepLinkURLs (property on the AppsFlyerTracker.shared object)
        Manually called in AppDelegate within didReceiveRemoteNotification handlePushNotification()
        Manually called in AppDelegate within didReceiveRemoteNotification trackEvent() - event name: af_opened_from_push_notification
        Manually called in AppDelegate within didRegisterForRemoteNotificationsWithDeviceToken registerPushToken()

        Standard Event Names

        The following is a list of standard event names supported with the trackEvent method. If any of the below command names are sent, they are automatically triggered in the AppsFlyer SDK. This is assuming all the required variables are also mapped and defined for that particular event. Learn more about recording in-app events and the see the full list of recommended in-app events per vertical.

        Remote Command AppsFlyer Event Name
        achievedLevel "af_level_achieved"
        addPaymentInfo "af_add_payment_info"
        addToCart "af_add_to_cart"
        addToWishlist "af_add_to_wishlist"
        completeRegistration "af_complete_registration"
        completeTutorial "af_tutorial_completion"
        initiateCheckout "af_initiated_checkout"
        purchase "af_purchase"
        subscribe "af_subscribe"
        startTrial "af_start_trial"
        rate "af_rate"
        search "af_search"
        spentCredits "af_spent_credits"
        unlockAchievement "af_achievement_unlocked"
        contentView "af_content_view"
        listView "af_list_view"
        adClick "af_ad_click"
        adView "af_ad_view"
        travelBooking "af_travel_booking"
        share "af_share“
        invite "af_invite"
        reEngage "af_re_engage"
        update "af_update"
        login "af_login"
        customerSegment "af_customer_segment"
        pushNotificationOpened "af_opened_from_push_notification"

        Since the AppsFlyer SDK is installed alongside the Tealium SDK, you are able to trigger any native AppsFlyer functionality given the corresponding tag configuration.

        SDK Setup

        Initialize

        The AppsFlyer SDK is initialized automatically upon launch. The AppsFlyer API key is set in the tag configuration.

        Remote Command AppsFlyer Method
        initialize initialize()

        AppsFlyer Developer Guide: Initial SDK Setup

        There are several configuration options available that can be configured in the AppsFlyer Remote Command Tag. If any of the below are set on launch, they are sent during the initialize method.

        Configuration Options
        Name TiQ variable mapping Type
        debug debug Bool
        disableIAdTracking disable_apple_ad_tracking Bool
        minTimeBetweenSessions time_between_sessions Int
        anonymizeUser anonymize_user Bool
        shouldCollectDeviceName collect_device_name Bool
        customData custom_data Dictionary or Map

        AppsFlyer Developer Guide: Additional APIs

        Track Launch

        Remote Command AppsFlyer Method
        initialize or launch trackLaunch()

        If you have the lifecycle module installed, this event automatically sends every app launch.

        AppsFlyer Developer Guide: Initializing the SDK

        Location

        Track Location

        Remote Command AppsFlyer Method
        tracklocation trackEvent() - event name af_location_coordinates
        Parameter Type
        latitude (required) Bool
        longitude (required) Bool

        If you have the location module installed, the latitude and longitude are sent with every event.

        AppsFlyer API Reference: Location Tracking

        Other Options

        Set Host

        Remote Command AppsFlyer Method
        sethost setHost
        Parameter Type
        host (required) String
        hostPrefix (required) String

        AppsFlyer API Reference: Set Host

        Set User Emails

        Remote Command AppsFlyer Method
        setsermails setUserEmails
        Parameter Type
        emails (required) [String]
        cryptType (required) Int
        Crypt Type Reference
        Value Type
        0 None
        1 SHA1
        2 MD5
        3 SHA256

        AppsFlyer API Reference: Set User Email

        Set Currency Code

        Remote Command AppsFlyer Property
        setcurrencycode currencyCode
        Parameter Type
        currency (required) String

        AppsFlyer API Reference: Set Currency Code

        Set Customer ID

        Remote Command AppsFlyer Property
        setcustomerid customerUserID
        Parameter Type
        customerId (required) String
        • AppsFlyer Additional APIs: Set Customer ID
        • iOS
        • Android
        Remote Command AppsFlyer Property
        resolvedeeplinkurls resolveDeepLinkURLs
        Parameter Type
        deepLinkUrls (required) [String]

        AppsFlyer API Reference: Resolve Deep Link URLs

        Disable Tracking

        Remote Command AppsFlyer Property
        disabletracking isStopTracking
        Parameter Type
        stopTracking (required) Bool

        AppsFlyer Additional APIs: Stop Tracking (Opt-out)

        Remote Command: Braze