ビジターサービスモジュール | モジュール | Tealium開発者ドキュメントプレビュー

使用法

ビジターサービスモジュールは、ネイティブモバイルアプリにデータレイヤーのエンリッチメント機能を提供します。

このモジュールの使用には、Tealium AudienceStreamのライセンスが必要です。取得したビジタープロファイルを使用して、アプリケーション全体の顧客体験やデータレイヤーをエンリッチメントします。

インストール

ビジターサービスモジュールは、Maven（推奨）または手動でインストールします。

Maven

Mavenを使用してモジュールをインストールするには：

プロジェクトのトップレベルの build.gradle ファイルに、次のMavenリポジトリを追加します：
```
maven {
      url "https://maven.tealiumiq.com/android/releases/"
}
```
プロジェクトモジュールの build.gradle ファイルに、TealiumライブラリとビジターサービスモジュールのMaven依存関係を追加します
```
dependencies {
      implementation 'com.tealium:kotlin-core:1.5.5'
      implementation 'com.tealium:kotlin-visitor-service:1.2.0'
}
```

手動

ビジターサービスモジュールを手動でインストールするには：

Tealiumのビジターサービスモジュールをダウンロードします。
ファイル tealium-kotlin.visitorservice-1.2.0.aar をプロジェクトの <PROJECT_ROOT>/<MODULE>/libs ディレクトリにコピーします。
プロジェクトモジュールの build.gradle ファイルにTealiumライブラリの依存関係を追加します：
```
dependencies {
      implementation(name:'tealium-kotlin.visitorservice-1.2.0', ext:'aar')
}
```

Collect DispatcherはメインのTealium Kotlin SDKに依存しているので、インストール手順に従ってこれも利用可能にすることを確認してください。

ビジタープロファイルデータ

現在のビジターデータを利用するには、最新のビジタープロファイルが更新されるたびに受け取るためのデリゲートオブジェクトを登録する必要があります：

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

VisitorProfileオブジェクトは、ビジターに関連する多くのフィールドにアクセスできます - 以下に利用可能なプロパティを概説します：

パラメータ	プロパティ	値
`arraysOfBooleans`	key: String, value: List<Boolean>	`key: "5129", value: listOf(true,false,true,true)`
`arraysOfNumbers`	key: String, value: List<Double>	`key: "57", value: listOf(4.82125, 16.8, 0.5714285714285714)`
`arraysOfStrings`	key: String, value: List<String>	`key: "5213", value: listOf("green shirts", "green shirts", "blue shirts")`
`audiences`	key: String, name: String	`key: "tealiummobile_demo_103", name: "Kotlin Users"`
`badges`	key: String, value: Boolean	`key: "2815", value: true`
`booleans`	key: String, value: Boolean	`key: "4868", value: true`
`currentVisit`	現在の訪問プロファイルのすべての属性。現在の訪問プロファイルにはAudiencesやBadgesは含まれていません。	`CurrentVisit`
`dates`	key: String, value: Long	`key: "22", value: 1567120112000`
`numbers`	key: String, value: Double	`key: "5728", value: 4.82125`
`setsOfStrings`	key: String, value: Set<String>	`key: "5211", value: setOf("green shirts", "red shirts", "blue shirts")`
`strings`	key: String, value: String	`key: "5380", value: "green shirts"`
`tallies`	key: String, value: Map<String, Double>	`key: "57", mapOf("category 1" to 2.0, "category 2" to 1.0)`

以下は、ビジタープロファイルが取得された後にそれをどのように操作するかの基本的な例です。キー名はアカウント/プロファイルごとに異なります。

val returningVisitor = visitorProfile.badges?.get("returning_visitor")
returningVisitor?.let {
    if (returningVisitor == true) {
        val ltv = visitorProfile.numbers?.get("lifetime_value")
        // take action
    }
}

構成オプション

TealiumConfigオブジェクトを作成する際に、以下の構成を使用してビジタープロファイルを取得するためのURLを構成します：

ビジターサービスURLの上書き

ビジタープロファイルの更新を取得する際に使用するURLを構成します。

参照：TealiumConfig.overrideVisitorServiceUrl.

val config = TealiumConfig(...)
config.overrideVisitorServiceUrl = "https://your.preferred.visitor-service.com"

デフォルト：https://visitor-service.tealiumiq.com/{ACCOUNT_NAME}/{PROFILE_NAME}/{VISITOR_ID}

ビジターサービスプロファイルの上書き

ビジタープロファイルの更新を取得する際に使用するTealiumプロファイルを構成します。参照：TealiumConfig.overrideVisitorServiceProfile.

val config = TealiumConfig(...)
config.overrideVisitorServiceProfile = "someOtherTealiumProfile"

ビジタープロファイルの更新間隔

最新のVisitorProfileデータを取得するための呼び出し間隔（秒）を構成します。参照：TealiumConfig.visitorServiceRefreshInterval.

デフォルト：300（5分）

val config = TealiumConfig(...)
config.visitorServiceRefreshInterval = TimeUnit.MINUTES.toSeconds(30) // 30 minutes

APIリファレンス

ビジターサービスモジュールで使用されるメソッドのリファレンスについては、Tealium SDK for Android APIのVisitorServiceクラスを参照してください。