Firebase ディスパッチャー

Firebase ディスパッチャーは、デバイス上の Firebase Analytics SDK にイベントを転送する Tealium Prism モジュールです。Prism でイベントを一度追跡すると、ディスパッチャーはネイティブの Firebase API を呼び出します。Tealium モバイルプロファイルで、データレイヤーから Firebase イベント、パラメータ、ユーザープロパティ、および同意構成へのマッピングを構成します。

要件

Firebase ディスパッチャーには以下が必要です：

インストール

pluginManagement {
    repositories {
        google()
        gradlePluginPortal()
        mavenCentral()
    }
}

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven { url = uri("https://maven.tealiumiq.com/android/releases/") }
    }
}

plugins {
    id("com.google.gms.google-services") version "4.4.2"
}

dependencies {
    implementation("com.tealium.prism:firebase:0.2.0")
    implementation(platform("com.google.firebase:firebase-bom:34.6.0"))
    implementation("com.google.firebase:firebase-analytics")
}

.package(url: "https://github.com/Tealium/tealium-prism-ios-firebase-dispatcher.git", from: "0.2.0")

pod 'TealiumPrismFirebase'

初期化

Firebase モジュールを含むリモートまたはローカル構成がある場合、コードは必要ありません。ディスパッチャーはアプリの起動時に自動的に登録され、構成が存在するまで非アクティブのままです。詳細については、リモートおよびローカル構成を参照してください。

ディスパッチャーは Firebase を自動的に初期化します。iOS では、ディスパッチャーは最初の使用時に FirebaseApp.configure() を呼び出し、アプリが既に行っている場合はスキップします。Android では、firebase-analytics コンテンツプロバイダーが起動時に Firebase を初期化します。

デバイスがオフラインの場合、Firebase SDK はイベントをキューに入れ、接続が復旧したときに配信します。

コードでモジュールを構成する場合、TealiumConfig の modules リストにモジュールを追加します：

import com.tealium.prism.core.api.Tealium
import com.tealium.prism.core.api.TealiumConfig
import com.tealium.prism.core.api.Modules
import com.tealium.prism.core.api.misc.Environment
import com.tealium.prism.firebase.firebase

val config = TealiumConfig.Builder(
    application = this,
    accountName = "my_account",
    profileName = "my_profile",
    environment = Environment.PROD,
    modules = listOf(
        Modules.collect(),
        Modules.firebase()
    )
)
    .setSettingsUrl("https://tags.tiqcdn.com/dle/my_account/my_profile/mobile_settings_prod.json")
    .build()
val tealium = Tealium.create(config)

import TealiumPrismCore
import TealiumPrismFirebase

let config = TealiumConfig(account: "my_account",
                           profile: "my_profile",
                           environment: "prod",
                           modules: [
                            Modules.collect(),
                            Modules.firebaseDispatcher()
                           ],
                           settingsUrl: "https://tags.tiqcdn.com/dle/my_account/my_profile/mobile_settings_prod.json")
let tealium = Tealium.create(config: config)

リモート変更がそれを上書きできないように構成をロックするには、ビルダークロージャを渡します。詳細については、高度な構成を参照してください。

Modules.firebase { builder ->
    builder.setAnalyticsEnabled(true)
}

Modules.firebaseDispatcher { builder in
    builder.setAnalyticsEnabled(true)
}

モジュールの構成

1. Tealium モバイルプロファイルで Modules に移動し、Firebase モジュールを追加します。
2. モジュール構成を構成します。各構成はオプションです。省略された場合、Firebase は独自のデフォルトを適用します。
3. データレイヤー変数から Firebase の宛先へのマッピングを追加します。データマッピングを参照してください。
4. 必要に応じて、ロードルールでモジュールを制限します。詳細については、ルールを参照してください。
5. モバイル構成を保存して公開します。SDK は起動時および各リモート構成の更新時に公開されたファイルを取得します。モバイル構成の公開を参照してください。

session_timeout_seconds と analytics_collection_enabled はコマンドとしても利用可能です。モジュール構成はモジュールの開始時および SDK が更新された構成を取得するたびに適用されます。対応するコマンドはイベント時に適用されます。

データマッピング

マッピングはデータレイヤー変数を Firebase コマンドペイロードの宛先にコピーします。次のマッピングは、tealium_event が purchase の場合に logevent を実行し、イベント名を Firebase イベント名として使用し、order_total を Firebase の value パラメータとして送信します：

利用可能なマッピングは以下の通りです：

Firebase 構成

標準

E-コマース

同意構成

イベント

Firebaseイベントをトリガーするには、モバイルプロファイルのFirebaseモジュールでtealium_eventの値を対応するFirebaseイベント名にマッピングします。たとえば、このマッピングではtealium_event="purchase"がpurchaseおよびlogEventのFirebaseイベントをトリガーします。

initiateconversionmeasurement

logevent

resetdata

setanalyticscollectionenabled

setconsent

setdefaultparameters

setsessiontimeout

setuserid

setuserproperty

検証

テストデバイスでFirebaseデバッグモードを有効にし、logeventにマッピングされるイベントを追跡します。イベントは数秒以内にDebugViewにマッピングされたパラメータと共に表示されます。

• Xcodeデバッグコンソールでイベントを表示する（iOS）
• デバッグログでイベントを表示する（Android）

イベントが表示されない場合は、Traceを使用して、期待されるデータレイヤー値でPrismにイベントが到達したことを確認してください。

トラブルシューティング

コマンドエラー

コマンドが失敗すると、ディスパッチャーは警告をログに記録し、そのコマンドをスキップして続行します。同じイベントにマップされた他のコマンドは実行され、イベントは他のディスパッチャーにも到達します。デバイスログでCommand '<name>' failed:を検索してください。メッセージの言い回しはiOSとAndroidでわずかに異なりますが、エラータイプは両方で同じです。

より一般的でないエラーemptyParameter, emptyArray, noValidParametersは、マッピングされた値が空である場合や、コマンドに対してサポートされている宛先がマッピングされていない場合に発生します。

制限事項

• initiateconversionmeasurementとlog_levelはiOS専用です。
• アプリ内でアクティブにできるFirebaseディスパッチャーは1つだけです。

参考文献

• Prism iOS Firebase API参照
• Prism Android Firebase API参照