モバイル向けクイックスタートガイド

インストール

Android または iOS 向けの Tealium をインストールします。

Maven を使用して Android 向け Tealium ライブラリをインストールするには、次の手順を実行します。

プロジェクトの最上位の build.gradle ファイルに Tealium Maven URL を追加します。

allprojects {
      repositories {
        mavenCentral()
        maven {
          url "https://maven.tealiumiq.com/android/releases/"
        }
      }
}

プロジェクトモジュールの build.gradle ファイルに、次の Maven 依存関係を追加します。
```
dependencies {
      implementation 'com.tealium:kotlin-core:1.X.X'
}
```

GitHub で最新リリースを確認し、1.X.X を最新のリリース番号に置き換えてください。

Swift Package Manager を使用して iOS 向け Tealium ライブラリをインストールするには、次の手順を実行します。

Xcode プロジェクトで、File > Swift Packages > Add Package Dependency を選択します。
リポジトリの URL を入力します：https://github.com/tealium/tealium-swift
バージョンルールを構成します。通常は Up to next major を推奨します。現在の Tealium Swift ライブラリのバージョンが一覧に表示されない場合は、Swift パッケージのキャッシュをリセットしてください。
インストールするモジュールを選択し、Xcode プロジェクトの Frameworks > Libraries & Embedded Content で、各アプリターゲットにモジュールを追加します。

初期化

Android または iOS 向けの Tealium を初期化します。

Tealium を初期化するには、TealiumConfig インスタンスを構成し、それを Tealium インスタンスに渡します。Tealium Kotlin ライブラリは、アプリのグローバルアプリケーションクラスの onCreate() メソッド内で初期化することを推奨します。

トラッキングヘルパークラスを使用して Tealium インスタンスを管理してください。これにより、Tealium Kotlin ライブラリへの単一のエントリポイントが提供され、今後のアップグレードが容易になります。

object TealiumHelper {

  lateinit var tealium: Tealium

  fun init(application: Application) {
    val tealiumConfig = TealiumConfig(
                      application,
                      "ACCOUNT",
                      "PROFILE",
                      Environment.DEV,
                      dataSourceId = "DATASOURCE_ID",  //optional
                      modules = mutableSetOf(VisitorService),
                      dispatchers = mutableSetOf(TagManagement, Collect)
                    )
    tealium = Tealium.create("tealium_instance", tealiumConfig)
  }
}

Tealium を初期化するには、TealiumConfig インスタンスを Tealium() コンストラクターに渡します。

トラッキングヘルパークラスを使用して Tealium インスタンスを管理してください。これにより、Tealium iOS ライブラリへの単一のエントリポイントが提供され、今後のアップグレードが容易になります。

class TealiumHelper {
    static let shared = TealiumHelper()
    let config = TealiumConfig(account: "ACCOUNT",
                               profile: "PROFILE",
                               environment: "ENVIRONMENT",
                               datasource: "DATASOURCE")
    var tealium: Tealium?

    private init() {

        // add necessary config options
        config.batchingEnabled = true
        config.logLevel = .debug

        // add the Collectors you want - no need to include if want all compiled collectors
        config.collectors = [Collectors.Lifecycle,
                             Collectors.Location,
                             Collectors.VisitorService]

        // add the Dispatchers you want - no need to include if want compiled dispatchers
        config.dispatchers = [Dispatchers.TagManagement,
                              Dispatchers.RemoteCommands]

        tealium = Tealium(config: config)

        // optional post init processing
        tealium?.dataLayer.add("mykey", "myvalue", expiry: .forever)

    }

    public func start() {
        _ = TealiumHelper.shared
    }

    class func trackView(title: String, data: [String: Any]?) {    
      let tealView = TealiumView(title, dataLayer: data)
      TealiumHelper.shared.tealium?.track(tealView)
    }

    class func trackEvent(title: String, data: [String: Any]?) {
      let tealEvent = TealiumEvent(title, dataLayer: data)
      TealiumHelper.shared.tealium?.track(tealEvent)
    }
}

モバイルパブリッシュ構成はデフォルトで有効になっているため、使用しない場合は無効にする必要があります。タグ管理でモバイルパブリッシュ構成を構成するか、config.shouldUseRemotePublishSettings = false を使用して無効にしてください。

トラッキング

Android または iOS でビューとイベントのトラッキングを開始します。

ビューのトラッキング

画面ビューをトラッキングするには、TealiumView(viewName:dataLayer:) のインスタンスを track() メソッドに渡します。TealiumView は、データレイヤーに tealium_event として表示されるビュー名と、任意のデータディクショナリで構成されます。

ビューをトラッキングするには、次のようにします。

val tealView = TealiumView("screen_view", mutableMapOf("screen_name" to "Home"))
tealium.track(tealView);

ビューをトラッキングするには、次のようにします。

let tealView = TealiumView("screen_view", dataLayer: ["screen_name": "Home"])
tealium?.track(tealView)

イベントのトラッキング

ビュー以外のイベントをトラッキングするには、TealiumEvent(eventName:dataLayer:) のインスタンスを track() メソッドに渡します。TealiumEvent は、データレイヤーに tealium_event として表示されるイベント名と、任意のデータディクショナリで構成されます。

イベントをトラッキングするには、次のようにします。

val tealEvent = TealiumEvent("user_login", mutableMapOf("customer_id" to "1234567890"))
tealium.track(tealEvent);

イベントをトラッキングするには、次のようにします。

let tealEvent = TealiumEvent("user_login", dataLayer: ["customer_id": "1234567890"])
tealium?.track(tealEvent)

track() メソッドは、イベント名と任意のデータディクショナリで構成される TealiumEvent 型の TealiumDispatch を受け取り、イベントをトラッキングします。

データレイヤー

一般的なデータレイヤー値と各モジュールによって提供されるデータの管理を、Android または iOS 向けに開始します。

データレイヤーにデータを追加するには、次のようにします。

String 値を構成するには、putString() メソッドを使用します。

tealium.dataLayer.putString("my_string", "my_string_value")

他のデータ型についても同様に、メソッド名は put で始まります。たとえば、整数には putInt()、浮動小数点数の配列には putDoubleArray() を使用します。さまざまなデータ型のメソッドについて詳しく説明します。

String 値を1日後に期限切れになるよう構成するには、次のようにします。

tealium.dataLayer.putString("my_string", "my_string_value", Expiry.afterTimeUnit(1, TimeUnit.DAYS))

有効期限の種類について詳しく説明します。

任意の型の値を構成するには、add() メソッドを使用します。

tealium.dataLayer.add(key: "my_value", value: 123456)

任意の型の値を1日後に期限切れになるよう構成するには、次のようにします。

tealium?.dataLayer.add(key: "my_value", value: 123456, expiry: .afterCustom((.days, 1)))

IDの解決

Tealiumの匿名IDを使用し、独自のユーザー識別子を構成する方法について説明します。

匿名ID

Tealiumライブラリは、アプリの初回起動時に一意で永続的な匿名IDを生成します。この値は visitorId に保存されます。また、この値は属性 tealium_visitor_id として、追跡される各イベントに含まれます。

訪問IDを取得するには、次のようにします。

class TealiumHelper {
	lateinit var tealium: Tealium

    fun getVisitorId(): String {
        return tealium.visitorId
    }
}

訪問IDを取得するには、次のようにします。

class TealiumHelper {
	var tealium: Tealium?

    var visitorId: String? {
		tealium?.visitorId
	}
}

Customer Data Platform（CDP）を使用している場合、visitorId は訪問に関連付けられた匿名IDです。Customer Data Platform（CDP）の匿名IDについて詳しく説明します。

ユーザー識別子

既知のユーザーを識別する場合は、永続データ保存にユーザー識別子属性を追加します。

CDPのユーザー識別子について詳しく説明します。

顧客IDなどのユーザー識別子を追加するには、次のようにします。

fun setKnownVisitorId(id: String) {
    tealium.dataLayer.putString("customer_id", id, Expiry.FOREVER)
}

顧客IDなどのユーザー識別子を追加するには、次のようにします。

func setKnownVisitorId(_ id: String) {
	tealium?.dataLayer.add(key: "customer_id", value: id, expiry: .forever)
}

検証

ログファイルの確認、トレースの実行、ライブイベントの表示によってデータを検証します。

ログ

Android または iOS のロギングを開始します。

ログレベルを構成するには、logLevel プロパティを構成します。

Logger.logLevel = LogLevel.DEV // or LogLevel.QA, LogLevel.PROD

ログレベルを構成するには、logLevel プロパティを構成します。

config.logLevel = .debug // or .info, .error, .fault, .silent

トレース

Android または iOS でトレースを開始します。

トレースに参加するには、joinTrace() メソッドを呼び出します。

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

トレースから離脱するには、leaveTrace() メソッドを呼び出します。

Tealium["INSTANCE_NAME"]?.leaveTrace()

トレースに参加するには、joinTrace() メソッドを呼び出します。

tealium?.joinTrace(id: "TRACE_ID")

トレースから離脱するには、leaveTrace() メソッドを呼び出します。

tealium?.leaveTrace()

モバイルトレースツールは、デバイスでスキャン可能なQRコードを提供することでトレース機能をエンリッチメントし、Tealium Mobile SDKから送信されるイベントをすばやく確認できるようにします。

ライブイベント

Event Streamingのライブイベント機能は、モバイルインストールのトラブルシューティングを目的として、すべてのTealiumのお客様が利用できます。

ライブイベントの使用方法について詳しく説明します。