VisitorService
TealiumがAndroid(Kotlin)向けに提供するVisitorServiceクラスとメソッドのリファレンスガイド。
クラス: VisitorService
以下は、Kotlin用のVisitorService
モジュールの一般的に使用されるメソッドとプロパティをまとめたものです。
メソッド/プロパティ | 説明 |
---|---|
overrideVisitorServiceUrl |
現在のVisitorProfileを取得するために使用されるURLを上書きするTealiumConfig オプション |
overrideVisitorServiceProfile |
現在のVisitorProfileを取得するために使用されるプロファイル名を上書きするTealiumConfig オプション |
requestVisitorProfile() |
現在のVisitorProfileが更新されるように要求するメソッド |
visitorServiceRefreshInterval |
SDKが自動的に最新のVisitorProfileを取得するまでの最小時間間隔を構成するTealiumConfig オプション |
overrideVisitorServiceUrl
TealiumConfig
オブジェクトの拡張プロパティ。VisitorServiceモジュールがプロジェクトに含まれている場合にのみ利用可能です。
VisitorServiceモジュールがVisitorProfileオブジェクトを取得するために使用するURLを上書きします。
デフォルトのURL: "https://visitor-service.tealiumiq.com/{ACOUNT_NAME}/{PROFILE_NAME}/{VISITOR_ID}"
val config = TealiumConfig(...)
config.overrideVisitorServiceUrl = url
overrideVisitorServiceProfile
TealiumConfig
オブジェクトの拡張プロパティ。VisitorServiceモジュールがプロジェクトに含まれている場合にのみ利用可能です。
VisitorServiceモジュールがVisitorProfileオブジェクトを取得するために使用するTealiumのプロファイル名を上書きします。デフォルトでは、VisitorServiceモジュールはTealiumConfig
で構成されたプロファイル名を使用します。
val config = TealiumConfig(...)
config.overrideVisitorServiceProfile = "main"
requestVisitorProfile
VisitorProfileが更新されるように要求するメソッド。これは、各ディスパッチ、またはディスパッチのバッチがTealium Customer Data Hubに送信された後に発生します。
このメソッドを使用して、他の任意の時点で更新を要求します。これはネットワークリクエストを行うため、コルーチンから呼び出す必要があるsuspend
関数です。メインスレッド上では呼び出されません。
runBlocking(Dispatchers.IO) {
tealium.visitorService?.requestVisitorProfile()
}
visitorServiceRefreshInterval
VisitorProfileデータの更新間隔を秒単位で構成します。requestVisitorProfile()
への呼び出しはこの構成を無視します。
デフォルト: 300 (5分)
val config = TealiumConfig(...)
config.visitorServiceRefreshInterval = TimeUnit.MINUTES.toSeconds(30) // 30分
インターフェース: VisitorUpdatedListener
VisitorUpdatedListener
はリスナークラスです。更新があるたびにVisitorProfileの最新バージョンを受け取るために登録します。実装する必要があるメソッドは1つだけです:onVisitorUpdated(visitorProfile: VisitorProfile)
。
onVisitorUpdated
既存のクラスにonVisitorUpdated
メソッドを実装するか、Tealium
インスタンスを作成した後に匿名オブジェクトを渡します。以下の例は後者を示しています。
val tealium = Tealium.create(...) {
events.subscribe(object : VisitorUpdatedListener {
override fun onVisitorUpdated(visitorProfile: VisitorProfile) {
Logger.dev("--", "VisitorProfile updated: $visitorProfile")
}
})
}
利用可能なプロパティの詳細については、VisitorProfileのドキュメンテーションを参照してください。
最終更新日 :: 2024年May月15日