Tealium

クラス: `Tealium`

Tealium クラスは、画面表示とイベントの追跡用のメソッドを提供します。以下のドキュメントは、Kotlin用の Tealium クラスの一般的に使用されるメソッドとプロパティをまとめたものです。個々のモジュールも、有効になっている場合は Tealium クラスの独自の拡張を提供することがあります。

メソッド/プロパティ	説明
`cancelTimedEvent()`	タイムドイベントのタイマーをキャンセルします。
`consentManager`	ユーザーの同意構成を構成するための同意マネージャーにアクセスします。
`dataLayer`	デバイス上の永続的な保存にアクセスします - データレイヤー内のアイテムは各イベントに追加されます。
`endTraceVisitorSession()`	リモートで訪問セッションを終了し、セッション終了イベントをテストします。
`events`	Tealium SDK全体で多くのイベントに対するリスナークラスを提供します。
`gatherTrackData()`	データレイヤーとコレクターからすべてのトラックデータを公開します。
`joinTrace()`	現在のセッションのデータレイヤーに提供されたトレースIDを追加します。
`leaveTrace()`	トレースIDを削除してトレースを離脱します。
`linkEcidToKnownIdentifier`	現在のECIDを既知のセカンダリIDにリンクします。
`modules`	システム内のモジュールにアクセスを提供します。
`resetVisitor()`	次のトラッキングコールで新しいものを取得することにより、訪問ECIDをリセットします。
`sendQueuedDispatches()`	すべてのDispatchValidatorsが再評価されるように要求します。
`session`	現在のセッションに関連する情報を提供します。
`startTimedEvent()`	指定された名前でタイムドイベントを開始します。
`stopTimedEvent()`	タイムドイベントのタイマーを停止し、`timed_event` トラッキングコールをトリガーします。
`Tealium`	`Tealium` インスタンスを作成するコンストラクターメソッド。
`track()`	画面表示またはイベントを追跡するためのメソッド。
`visitor`	完全な `AdobeVisitor` インスタンスを返します。
`visitorId`	データレイヤーに保存されている現在の訪問ID。

`cancelTimedEvent()`

以前に開始されたタイムドイベントをキャンセルします。タイムドイベントは追跡されません。

tealium.cancelTimedEvent(name: "TIMED_EVENT_NAME")

パラメータ	タイプ	説明
`name`	`String`	タイムドイベントの名前

`consentManager`

現在の同意ステータスとカテゴリを構成し、現在のポリシーを確認することができます。詳細は同意管理ガイドを参照してください。

tealium.consentManager.userConsentStatus = ConsentStatus.CONSENTED

`dataLayer`

デバイス上でキーバリューペアの永続的な保存を提供し、有効期限を構成することもできます。各エントリは、track() メソッドを通じて送信するすべてのディスパッチにも追加されます。詳細はデータ管理ガイドを参照してください。

tealium.dataLayer.putString("key", "value", Expiry.FOREVER)

`endTraceVisitorSession()`

リモートで訪問セッションを終了します。SDKセッションを終了したり、セッションIDをリセットしたりすることはありません。

Tealium["INSTANCE_NAME"]?.endTraceVisitorSession()

`events`

SDKからの有用な情報を受け取るために、Tealium インスタンスにリスナークラスを提供します。

以下の例では、任意の同意構成変更に対するリスナーを登録します。このリスナーは、新しい同意構成と現在のポリシーを提供されます。追加のリスナーは com.tealium.core.messaging で利用可能です。

tealium.events.subscribe(object: UserConsentPreferencesUpdatedListener {
    override fun onUserConsentPreferencesUpdated(userConsentPreferences: UserConsentPreferences, policy: ConsentManagementPolicy) {
        // 同意変更に対するアクションを取る
    }
})

`gatherTrackData()`

データレイヤーとコレクターからトラックデータを取得します。

Tealium["INSTANCE_NAME"]?.gatherTrackData()

`joinTrace()`

現在のセッションのデータレイヤーに提供されたトレースIDを追加します。

Tealium["INSTANCE_NAME"]?.joinTrace(traceId)

パラメータ	タイプ	説明
`traceId`	`String`	トレースID

`leaveTrace()`

トレースIDを削除してトレースを離脱します。

Tealium["INSTANCE_NAME"]?.leaveTrace()

`linkEcidToKnownIdentifier()`

現在のECIDを既知のセカンダリ識別子、たとえばメールアドレスや他の内部IDにリンクします。

linkEcidToKnownIdentifier(
  knownId: String,
  adobeDataProviderId: String,
  authState: Int?,
  adobeResponseListener: ResponseListener<AdobeVisitor>?
  )

パラメータ	タイプ	説明
`knownId`	`String`	既知の識別子。
`adobeDataProviderId`	`String`	Adobeデータプロバイダー識別子。
`authState`	`Int`	認証状態。
`adobeResponseListener`	`ResponseListener<AdobeVisitor>`	Adobeレスポンスリスナー。

例:

var tealium: Tealium?
...

tealium.adobeVisitorApi?.linkEcidToKnownIdentifier(
  "myidentifier",
  "123456",
  AdobeAuthState.AUTH_STATE_AUTHENTICATED,
  null
  )

`modules`

SDKのモジュールマネージャーにアクセスを提供し、特定のモジュールへのアクセスを提供するために使用されます。

tealium.modules.getModule(VisitorService::class.java)?.delegate = myDelegate

`resetVisitor()`

次のトラッキングコールで新しいものを取得することにより、訪問ECIDをリセットします。

resetVisitor()

例:

var tealium: Tealium?
//...
tealium?.adobeVisitorApi?.resetVisitor()

`sendQueuedDispatches()`

ディスパッチがDispatchValidatorによって様々な理由でキューに入れられます。このメソッドを使用して再評価を要求することができますが、イベントバッチングの制限は無視され、他のDispatchValidatorsは遵守されます。例えば、接続がなく、依然として接続がない場合、キューに入れられたディスパッチはキューに残ります。

tealium.sendQueuedDispatches()

`session`

現在のセッションに関連するすべてのデータを含みます。

val sessionId = tealium.session.id

`startTimedEvent()`

指定された名前でタイムドイベントを開始します。同じイベント名でこのメソッドが再び呼び出された場合、イベントが終了またはキャンセルされていない限り無視されます。イベント開始時間は保存されません。

イベント名とともにオプショナルデータが渡された場合、タイマーがstopTimedEvent()呼び出しで停止されたときにトラックコールに追加されます。

tealium.startTimedEvent(name: "TIMED_EVENT_NAME", mapOf("custom_value" to "custom_key"))

パラメータ	タイプ	説明
`name`	`String`	タイムドイベントの名前
`mapOf("custom_key" to "custom_value")`	`Map`	(オプショナル) データレイヤーで追跡されるキー値ペアデータのオブジェクト

`stopTimedEvent()`

タイムドイベントのタイマーを停止し、timed_eventトラッキングコールをトリガーします。

tealium.stopTimedEvent(name: "TIMED_EVENT_NAME")

パラメータ	タイプ	説明
`name`	`String`	タイムドイベントの名前

`Tealium`

Tealiumインスタンスを作成するコンストラクターメソッド。

val config = TealiumConfig(key, config);

パラメータ	タイプ	説明	例
`key`	`String`	新しいTealiumインスタンスの名前	`"abc123"`
`config`	`Tealium.Config`	新しいインスタンスの構成	`tealConfigObj`

// Assuming execution is within Application.onCreate()
val config = TealiumConfig(this, "ACCOUNT_NAME", "PROFILE_NAME", Environment.PROD)
val tealium = Tealium.create("main", config)

モジュールはバックグラウンドスレッドで初期化されるため、Tealiumオブジェクトの作成直後には準備が整っていない場合があります。インスタンスが準備でき次第、必要な構成を追加するために完了ブロックを追加します：

val tealium = Tealium.create("main", config) {
    events.subscribe(object : VisitorUpdatedListener {
        override fun onVisitorUpdated(visitorProfile: VisitorProfile) {
            Logger.dev("--", "VisitorProfile updated: $visitorProfile")
        }
    })
}

`track()`

オプショナルイベントデータを含むスクリーンビューまたはイベントをトラックします。

tealium.track(tealiumlEvent)

パラメータ	タイプ	説明
`tealiumlEvent`	`TealiumView` or `TealiumEvent`	イベント名とオプショナルイベントデータを含むディスパッチオブジェクト。

イベントをトラックするには、TealiumViewまたはTealiumEventオブジェクトをtrack()メソッドに渡します：

val tealiumlEvent = TealiumView(
  "purchase", 
  mutableMapOf(
    "customer_id" to "abc123", 
    "order_total" to 10.00, 
    "product_id" to listOf("PROD123", "PROD456"),
    "order_id" to "0123456789"
  )
)
tealium.track(tealiumlEvent);

クラス: Tealium

cancelTimedEvent()

consentManager

dataLayer

endTraceVisitorSession()

events

gatherTrackData()

joinTrace()

leaveTrace()

linkEcidToKnownIdentifier()

modules

resetVisitor()

sendQueuedDispatches()

session

startTimedEvent()

stopTimedEvent()

track()