ライフサイクルトラッキングモジュール

インストール

ライフサイクルトラッキングモジュールは、Maven または手動でインストールできます。

Maven

Maven を使用してライフサイクルトラッキングモジュールをインストールするには、次の手順を実行します。

1. プロジェクトの最上位の build.gradle ファイルに、次の Maven リポジトリを追加します。

   // Top-level build file where you add configuration options common to all sub-projects/modules.
   allprojects {
   repositories {
         mavenCentral()
         // Tealium Maven repo directive
         maven {
         url "https://maven.tealiumiq.com/android/releases/"
         }
   }
   }
   

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

   dependencies {
   // only add if not already present
   implementation 'com.tealium:library:5.8.0'
   // add lifecycle to list of dependencies
   implementation 'com.tealium:lifecycle:1.1.4'
   }
   

手動

ライフサイクルトラッキングモジュールを手動でインストールするには、次の手順を実行します。

1. Tealium のライフサイクルトラッキングモジュールをダウンロードします。

2. tealium.lifecycle-1.1.4.aar ファイルを、プロジェクトの <PROJECT_ROOT>/<MODULE>/libs ディレクトリにコピーします。

3. プロジェクトモジュールの build.gradle ファイルに、Tealium ライブラリの依存関係を追加します。

   dependencies {
         implementation(name:'tealium.lifecycle-1.1.4', ext:'aar')
   }
   

自動追跡イベント

このモジュールは、lifecycle_type 変数によって構成される次のライフサイクルイベントを追跡します。

Tealium のライフサイクルトラッキングは、利用状況をアクティビティのライフサイクルにのみ関連付けます。

このライブラリは Application.ActivityLifecycleCallbacks API を利用し、onActivityResumed および onActivityPaused で条件を評価します。

次のコードで有効にします。

Tealium.Config config = Tealium.Config.create(application, "ACCOUNT", "PROFILE", "ENVIRONMENT");
boolean isAutoTracking = true;

// Additional instance for Lifecycle Tracking
LifeCycle.setupInstance("INSTANCE_NAME", config, isAutoTracking);
// Standard Tealium instance
Tealium.createInstance("INSTANCE_NAME", config);

手動追跡イベント

特定のライフサイクルパラダイムや、一般的ではないライフサイクルトラッキングで使用できます。この方法は、ほとんどの実装では推奨されません。ライフサイクルを手動で追跡できるようにするには、ライフサイクルの初期化コードを更新して、isAutoTracking を false に構成します。

launch イベントを手動で追跡するには、trackLaunchEvent() メソッドを呼び出します。

LifeCycle lifeCycle = LifeCycle.getInstance(TEALIUM_INSTANCE_ID);

if(lifeCycle != null) {

    // OPTIONAL
    Map<String, String> data = new HashMap<>();
    data.put("boot_time", "5ms");

    lifeCycle.trackLaunchEvent(data);
}

sleep イベントを手動で追跡するには、trackSleepEvent() メソッドを呼び出します。

LifeCycle lifeCycle = LifeCycle.getInstance(TEALIUM_INSTANCE_ID);

if(lifeCycle != null) {

    // OPTIONAL
    Map<String, String> data = new HashMap<>();
    data.put("foreground_time", "4000ms");

    lifeCycle.trackSleepEvent(data);
}

wake イベントを手動で追跡するには、trackWakeEvent() メソッドを呼び出します。

LifeCycle lifeCycle = LifeCycle.getInstance(TEALIUM_INSTANCE_ID);

if(lifeCycle != null) {

    // OPTIONAL
    Map<String, String> data = new HashMap<>();
    data.put("background_time", "600000ms");

    lifeCycle.trackWakeEvent(data);
}

Tealium および関連付けられた LifeCycle マルチトンは、タグ管理のパブリッシュ構成によってリモートから無効化できます。インスタンスを取得してそのメソッドを呼び出す際は、Null チェックを実行してください。

クラッシュ検出

launch イベントの後に wake イベントが続いた場合、またはその逆の場合は、アプリが正常に sleep しなかったため、クラッシュが発生したことを示します。前述のシーケンスが Tealium ライブラリのシャットダウンによって発生した場合、クラッシュイベントとは見なされません。

クラッシュイベントが検出されると、launch または wake イベントのデータに lifecycle_diddetectcrash 変数が追加されます。

{
    "lifecycle_type" : "launch",
    "lifecycle_diddetectcrash" : "true",
    //...
}

データレイヤー

Lifecycle Trackingモジュールは、指定されたライフサイクルイベントタイプ（launch、wake、sleep）に対して、以下の変数を追加します。

APIリファレンス

Lifecycle Trackingモジュールのメソッドに関する完全なリファレンスについては、Tealium SDK for Android APIのLifeCycleクラスを参照してください。