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()`	保留中のディスパッチを再評価するように要求します。
`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（メールアドレスやその他の内部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には従います。たとえば、接続がない場合には接続がないままキューに入れられたままです。

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

画面ビューやイベントなど、システム内でのイベントのトラッキングに使用されるメソッドです。

tealium.track(TealiumView("SCREEN_NAME", mapOf("key" to "context value")))

`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