Deep linking

The DeepLink module automatically handles incoming deep links for attribution tracking and trace management. It captures deep link URLs, extracts query parameters, manages referrer information, and integrates with the Trace module for debugging.

On iOS and Android, the module automatically listens for deep link events unless explicitly disabled. The module runs only when you add it to the modules list or provide settings for it in local or remote settings JSON.

Collected data points

When a deep link is handled, the DeepLink module collects the following data:

Data point	Key	Description
Deep link URL	`deep_link_url`	The complete URL of the deep link
Query parameters	`deep_link_param_*`	Each query parameter prefixed with `deep_link_param_`
Referrer URL	`deep_link_referrer_url`	The URL that referred to this deep link
Referrer app	`deep_link_referrer_app`	The app identifier that opened this deep link

Installation

The DeepLink module can be configured using programmatic, remote JSON, or local JSON settings.

The DeepLink module is not configurable in React Native. The native Prism SDK handles deep links automatically on both iOS and Android.

Add the DeepLink module to your Tealium configuration:

val config = TealiumConfig.Builder(
    application = application,
    accountName = "tealiummobile",
    profileName = "your-profile",
    environment = "dev",
    modules = listOf(Modules.deepLink())
).build()

To configure with enforced settings:

val config = TealiumConfig.Builder(
    application = application,
    accountName = "tealiummobile",
    profileName = "your-profile",
    environment = "dev",
    modules = listOf(Modules.deepLink {
        it.setEnabled(true)
            .setDeepLinkTraceEnabled(true)
            .setSendDeepLinkEventEnabled(false)
    })
).build()

Add the DeepLink module to your Tealium configuration:

let config = TealiumConfig(account: "tealiummobile",
                          profile: "your-profile",
                          environment: "dev",
                          modules: [
                              Modules.deepLink(),
                              // other modules...
                          ])

To configure with enforced settings:

let config = TealiumConfig(account: "tealiummobile",
                          profile: "your-profile",
                          environment: "dev",
                          modules: [
                              Modules.deepLink(forcingSettings: { builder in
                                  builder.setEnabled(true)
                                         .setDeepLinkTraceEnabled(true)
                                         .setSendDeepLinkEvent(false)
                              }),
                              // other modules...
                          ])

JSON configuration

Configure the DeepLink module in your local or remote settings JSON file:

{
    "modules": {
        "DeepLink": {
            "module_type": "DeepLink",
            "enabled": true,
            "configuration": {
                "deep_link_trace_enabled": true,
                "send_deep_link_event": false
            }
        }
    }
}

Configuration options

Setting	Key	Description	Default
Deep link trace enabled	`deep_link_trace_enabled`	Enable or disable trace from deep links. When enabled, QR codes from the QR Trace tool automatically join traces.	`true`
Send deep link event	`send_deep_link_event`	Enable or disable sending deep link events. When enabled, a deep link event is tracked automatically.	`false`

Handle deep links manually

tealium.deepLink.handle() is not available in React Native. Deep links are handled automatically by the native SDK.

tealium.deepLink.handle(url, referrer)
    .subscribe { result ->
        // Optionally handle result here
    }

tealium.deepLink.handle(link: url, referrer: .fromUrl(referrerUrl)).subscribe { result in
    // Optionally handle result here
}

Disable automatic tracking (iOS)

On iOS, deep links are tracked automatically by default. To disable automatic deep link tracking, set the TealiumAutotrackingDeepLinkEnabled key to false in your Info.plist.

API reference

For detailed class and method signatures, see the API reference documentation: