Deep Links

A deep link is a hyperlink that launches a mobile app and, optionally, delivers specific content within the app. Deep links are often used to measure the performance of advertisement campaigns or promotional emails that link users to your app.

Supported platforms

The following platforms support deep link tracking:

• Android (Kotlin)
• iOS (Swift v2.x)

How it works

When your app is launched from a deep link, the Tealium library adds the URL to the data layer as the attribute deep_link_url.

The deep link’s query parameters are added to the data layer with attribute names in the format deep_link_param_<param name>.

For example, https://example.com/?campaign_code=SUMMER becomes:

deep_link_url = "https://example.com/?campaign_code=SUMMER"
deep_link_param_campaign_code = "SUMMER"

Deep link data layer attributes are only stored for the session.

Configuration

Android Kotlin

Deep link tracking is automatically enabled in Tealium for Android (Kotlin).

Disable automatic tracking of deep links by setting the deepLinkTrackingEnabled property to false.

Swift v2.x

Automatic deep link tracking is enabled by default in Tealium for iOS (Swift v2.x) through the method swizzling technique. Method swizzling is the dynamic swapping of one method implementation for another during a program’s runtime.

If you do not want to use method swizzling or don’t want deep links to be tracked automatically, you can disable automatic deep link tracking with the info.plist key TealiumAutotrackingDeepLinkEnabled set to false.

If you want to track deep links without method swizzling and you are using SwiftUI, after disabling the automatic tracking in the info.plist, use the TealiumAppTrackable wrapper around your application content’s View:

var body: some Scene {
    WindowGroup {
        TealiumAppTrackable {
            ContentView()
        }
    }
}

If you are using UIKit, you can instead call the handleDeeplink method on the tealium instance manually.

Swift v1.x

Tealium for iOS (Swift v1.x) requires a single line of code to be added to your app’s AppDelegate class to enable deep linking.

func application(_ app: UIApplication,
                 open url: URL,
                 options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
  tealium?.handleDeepLink(url)
  return true
}

Data Layer

The following properties are added to your data layer when your app is launched from a deep link: