Firebaseディスパッチャー

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

要件

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

モジュールの追加

1. Tealiumモバイルプロファイルで、モジュールに移動し、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 モジュールを追加する場合は、インストールと初期化の手順を省略してください。詳しくは、モジュールの追加を参照してください。

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 を初期化します。デバイスがオフラインの場合、Firebase SDK はイベントをキューに追加し、接続が復旧した時点で送信します。

アプリがコード内でモジュールを構成する場合は、TealiumConfig の modules リストにモジュールを追加します。

import com.tealium.prism.core.api.Tealium
import com.tealium.prism.core.api.TealiumConfig
import com.tealium.prism.core.api.misc.Environment
import com.tealium.prism.core.api.Modules
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)
}

イベント

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 リファレンス