AutoTrackingモジュール | モジュール

AutoTrackingモジュールは、アプリ内で追加のコードを書くことなく、一般的なイベントの自動追跡をアプリに追加します。

仕組み

ビルドと初期化にAutoTrackingモジュールを含めることで、アプリに自動追跡を追加します。このモジュールには、追跡する画面とその命名方法を制御するためのいくつかのオプションがあります。

Autotrackingモジュールには2つの追跡モードがあります：

フルトラッキング
すべての画面ビューを自動的に追跡し、画面を省略したり画面名を上書きするオプションがあります。
部分的な追跡
注釈が付けられたアクティビティのみを追跡し、画面名を上書きするオプションがあります。

注釈

以下の注釈を使用して、モジュールの動作を調整します：

イベント名の上書き
この注釈を使用して、デフォルトの画面名を上書きします。

```kotlin
@Autotracked(name = "MyCustomName")
private class AnnotatedActivityWithOverride : Activity()
```

追跡に含める
部分的な追跡モードでは、この注釈を使用して特定のアクティビティを追跡します。
```
```kotlin
@Autotracked()
private class AnnotatedActivity : Activity()
```
```
追跡から省略
フルトラッキングモードでは、この注釈を使用してアクティビティを自動的に追跡しないようにします。
```
```kotlin
@Autotracked(track = false)
private class AnnotatedActivityWithoutTracking : Activity()
```
```

フルトラッキング

フルトラッキングモードは、Application.ActivityLifecycleCallbacksを使用して新しいアクティビティがフォーカスに入ったときを判断し、TealiumViewイベントをトリガーします。イベントでは、tealium_eventはクラス名に構成されますが、名前から"Activity"が削除されます。

画面名を上書きするための注釈を使用するか、アクティビティの追跡を防ぐために注釈を使用します。

Android Developers: The Activity Lifecycleから詳細を学びましょう。

部分的な追跡

部分的な追跡モードは、注釈に依存して追跡するアクティビティを決定します。注釈を使用して追跡するアクティビティを指定するか、画面名を上書きします。

ブロックリスト

ブロックリストは、文字列の単一配列を含むJSONファイルです。文字列は、自動追跡から省略するアクティビティを表します。ブロックリストにある文字列がアクティビティ名のどこかに現れると、それは追跡されません。文字列の比較は大文字と小文字を区別しません。

例えば、“Settings"や"Profile"という文字列を含むアクティビティを追跡したくない場合、ブロックリストには以下のように含めることができます：

[
  "settings", "profile"
]

ブロックリストファイルは、アプリのassetsディレクトリにローカルに保存するか、URLとしてリモートにホストすることができます。

ブロックリストを使用するためには、以下のTealiumConfigプロパティのいずれかを使用します：

インストール

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

Maven

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

プロジェクトのトップレベルのbuild.gradleファイルに、以下のMavenリポジトリを追加します：

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

プロジェクトモジュールのbuild.gradleファイルに、以下のMaven依存関係を追加します：

dependencies {
    implementation 'com.tealium:kotlin-core:1.6.0'
    implementation 'com.tealium:kotlin-autotracking:1.0.1'
}

手動

AutoTrackingモジュールを手動でインストールするには、以下の手順を実行します：

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

初期化

AutoTrackingモジュールを初期化するには、TealiumConfigのモジュールリストに追加し、追跡モードを構成します。

AutoTrackingモジュールを初期化する例：

val config = TealiumConfig(application,
              "ACCOUNT",
              "PROFILE",
              ENVIRONMENT,
              modules = mutableSetOf(Modules.AutoTracking)
              ).apply {
                autoTrackingMode = AutoTrackingMode.ANNOTATED
              }

より多くのオプションについては、TealiumConfig.autoTrackingModeを参照してください。

データレイヤー

以下の変数は、このモジュールによってトリガーされる各追跡呼び出しに含まれます：

変数名	タイプ	説明	例
`autotracked`	`String`	Autotrackingモジュールによって追跡されたすべてのイベントに構成されます。	`true`

カスタムデータ

デフォルトでは、自動的に追跡されるイベントにはコンテキスト変数は含まれません。AutoTrackingモジュールからのイベントにコンテキストデータを追加するには、TealiumConfigで構成されたグローバルデリゲートを使用して、各追跡アクティビティのカスタムデータオブジェクトのマップを返します。これはモジュールによって追跡されるすべてのイベントで実行されます。

デリゲートを構成するには：

config.autoTrackingCollectorDelegate = object: ActivityDataCollector {
    override fun onCollectActivityData(activityName: String): Map<String, Any>? {
        when (activityName) {
            "some_activity" -> return mapOf("some_key" to "some_value")
            else -> return null
        }
    }
}

または、特定のアクティビティにコンテキストデータを追加するには、Activityが同じActivityDataCollectorインターフェースを実装するようにします。

class ActivityWithDataCollector : Activity(), ActivityDataCollector {
    override fun onCollectActivityData(activityName: String): Map<String, Any>? {
        return mapOf("some_key" to "some_value")
    }
}

各追跡アクティビティで両方のデリゲートが実行されるため、グローバルレベルで共通データを追加し、onCollectActivityDataメソッドを使用して特定のデータを追加します。

APIリファレンス

TealiumConfig