DeepLinkHandler モジュール

DeepLinkHandler モジュールは、受信したディープリンクをアトリビューションとトレース管理のために追跡します。アプリがディープリンクから起動されると、モジュールは URL を取得し、そのクエリパラメータをデータレイヤーに抽出します。デフォルトでは、ディープリンク処理は自動的に実行されます。

仕組み

ディープリンクによってアプリが開かれると、モジュールは完全な URL を deep_link_url としてデータレイヤーに追加します。各クエリパラメータは抽出され、プレフィックス deep_link_param_ を使用して個別に追加されます。たとえば、https://example.com/?campaign_code=SUMMER の場合、次のデータが生成されます。

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

ディープリンクのデータレイヤー属性は、セッション中のみ保存されます。

データレイヤー

ディープリンクが処理されると、次の属性がデータレイヤーに追加されます。

属性	型	説明
`deep_link_url`	`String`	クエリパラメータを含む、ディープリンクの完全な URL。
`deep_link_param_X`	`String`	ディープリンク URL の各クエリパラメータ。`X` はパラメータ名です。
`deep_link_referrer_url`	`String`	このディープリンクへの参照元となったページまたはリソースの URL。
`deep_link_referrer_app`（iOS のみ）	`String`	カスタム URL スキームを使用してこのディープリンクを開いたアプリのバンドル識別子。

インストール

DeepLinkHandler モジュールは prism-core に含まれています。prism-core は、他のすべての Prism モジュールの推移的依存関係です。

DeepLinkHandler モジュールは TealiumPrismCore に含まれています。リポジトリ URL https://github.com/Tealium/tealium-prism-swift を使用して Swift Package Manager の依存関係として追加するか、CocoaPods を使用する場合は Podfile に追加します。

pod 'tealium-prism/Core'

代わりに Prism ライブラリ全体をインストールするには、次のようにします。

pod 'tealium-prism'

初期化

TealiumConfig の modules リストにモジュールを追加します。

val config = TealiumConfig.Builder(
    application = application,
    accountName = "ACCOUNT",
    profileName = "PROFILE",
    environment = Environment.PROD,
    modules = listOf(
        Modules.deepLink(),
        // other modules...
    )
).build()

let config = TealiumConfig(
    account: "ACCOUNT",
    profile: "PROFILE",
    environment: "prod",
    modules: [
        Modules.deepLink(),
        // other modules...
    ]
)

ディープリンクを手動で処理する

ディープリンクを手動で処理するには、Tealium インスタンスのディープリンクプロパティで handle を呼び出します。

tealium.deepLink.handle(uri).subscribe { result ->
    // Optionally handle result here
}

// With a referrer URL:
tealium.deepLink.handle(uri, referrerUri).subscribe { result ->
    // Optionally handle result here
}

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

構成

ディープリンクの自動追跡を無効にする

デフォルトでは、アプリがディープリンクから起動されると、モジュールがディープリンクを自動的に処理します。

ディープリンクの自動追跡を無効にするには、次のようにします。

Modules.deepLink { settings ->
    settings.setAutomaticDeepLinkTrackingEnabled(false)
}

アプリの Info.plist ファイルに、値を false に構成したキー TealiumAutotrackingDeepLinkEnabled を追加します。

ディープリンクイベントを有効にする

デフォルトでは、ディープリンクが処理されたときに、モジュールは個別の追跡イベントを送信しません。ディープリンクイベントを有効にすると、ディープリンクが開かれるたびに、モジュールは deep_link イベントも追跡します。

Modules.deepLink { settings ->
    settings.setSendDeepLinkEventEnabled(true)
}

Modules.deepLink(forcingSettings: { builder in
    builder.setSendDeepLinkEvent(true)
})

ディープリンク経由のトレースを有効にする

デフォルトでは、Tealium QR Trace ツールの QR コードをスキャンすると、自動的にトレースセッションに参加します。

ディープリンクを使用してトレースに参加する機能を無効にするには、次のようにします。

Modules.deepLink { settings ->
    settings.setDeepLinkTraceEnabled(false)
}

Modules.deepLink(forcingSettings: { builder in
    builder.setDeepLinkTraceEnabled(false)
})

JSON 構成

ローカルまたはリモートの構成 JSON ファイルでモジュールを構成します。

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

Settings Builder リファレンス

詳細については、DeepLinkSettingsBuilder を参照してください。

メソッド	説明
`setAutomaticDeepLinkTrackingEnabled(enabled: Boolean)`	ディープリンクの自動処理を有効または無効にします。
`setDeepLinkTraceEnabled(enabled: Boolean)`	ディープリンクからのトレース機能を有効または無効にします。デフォルト：`true`。
`setSendDeepLinkEventEnabled(enabled: Boolean)`	ディープリンクが開かれたときの `deep_link` イベント送信を有効または無効にします。デフォルト：`false`。
`setEnabled(enabled: Boolean)`	モジュールを永続的に有効または無効にします。
`setOrder(order: Int)`	モジュールが初期化される順序を構成します。

詳細については、DeepLinkSettingsBuilder を参照してください。

メソッド	説明
`setDeepLinkTraceEnabled(_:)`	ディープリンクからのトレース機能を有効または無効にします。デフォルト：`true`。
`setSendDeepLinkEvent(_:)`	ディープリンクが開かれたときの `deep_link` イベント送信を有効または無効にします。デフォルト：`false`。
`setEnabled(_:)`	モジュールを永続的に有効または無効にします。
`setOrder(_:)`	モジュールが初期化される順序を構成します。
`setRules(_:)`	モジュールを実行するタイミングを決定するルールを構成します。