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`

// 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()`

TealiumViewまたはTealiumEventタイプを使用して、オプショナルな関連データとともに画面ビューまたはイベントをトラックします。

val tealiumView = TealiumView("VIEW_NAME", mapOf("key" to "context value"))
tealium.track(tealiumlView)

パラメーター	タイプ	説明	例
`viewName`	`String`	トラックされる画面の名前	`"Buy Now View"`
`dataLayer`	`Map`	(オプショナル) データレイヤーで追跡されるキーと値のペアのオブジェクト	`mapOf("product_id" to "widget123")`

viewNameに渡された値はデータレイヤーの変数tealium_eventとして表示されます。

val tealiumEvent = TealiumEvent("EVENT_NAME", mapOf("key" to "context value"))
tealium.track(tealiumEvent)

パラメーター	タイプ	説明	例
`eventName`	`String`	トラックされるイベントの名前	`"Buy Now Event"`
`dataLayer`	`Map`	(オプショナル) データレイヤーで追跡されるキーと値のペアのオブジェクト	`mapOf("product_id" to "widget123")`

eventNameに渡された値はデータレイヤーの変数tealium_eventとして表示されます。

`visitor`

完全なAdobeVisitorインスタンスを返します。

var tealium: Tealium?
//...
val visitor = tealium.adobeVisitorApi?.visitor?.let { visitor ->
    val ecid = visitor.experienceCloudId
    val nextRefresh = visitor.nextRefresh
    val blob = visitor.blob
    val region = visitor.region
    val idSyncTTL = visitor.idSyncTTL
}

`visitorId`

訪問IDの現在の文字列です。データレイヤー内に保存され、必要に応じて上書きされることがあります。

val visitorId = tealium.visitorId

クラス: Tealium

cancelTimedEvent()

consentManager

dataLayer

endTraceVisitorSession()

events

gatherTrackData()

joinTrace()

leaveTrace()

linkEcidToKnownIdentifier()

modules

resetVisitor()

sendQueuedDispatches()

session

startTimedEvent()

stopTimedEvent()

track()

visitor

visitorId