ライフサイクルモジュール

使用法

ライフサイクルモジュールは、アプリのライフサイクルイベントと関連データを自動的に追跡します。ライブラリが初めてロードされたときに起動イベントがトリガーされ、UIApplicationWillResignActive通知でスリープイベントが、UIApplicationDidBecomeActiveでウェイクイベントがトリガーされます。

このモジュールの使用は、Adobe Analyticsを使用している場合に推奨されます。それ以外の場合でも、オプションですが、追加でキャプチャされるイベント（起動/ウェイク/スリープ）が他のベンダーの実装に役立つかもしれません。

以下のプラットフォームがサポートされています：

• iOS
• tvOS
• watchOS
• macOS

要件

UIKitの依存関係がターゲットアプリに追加されている場合、それ以上の構成や実装は必要ありません。その他のプラットフォームビルド（watchOS、macOS）では、ライフサイクルモジュールの機能を手動でトリガーすることができます（API Referenceを参照）。

インストール

Swift Package Manager、CocoaPods、またはCarthageを使用してライフサイクルモジュールをインストールします。

Swift Package Manager（推奨）

バージョン1.9.0+でサポートされているSwift Package Managerは、Tealium Swiftライブラリをインストールする最も簡単で推奨される方法です：

1. Xcodeプロジェクトで、File > Add Package Dependenciesを選択します。
2. リポジトリURLを入力します：https://github.com/tealium/tealium-swift
3. バージョンルールを構成します。通常、"Up to next major"が推奨されます。現在のTealium Swiftライブラリのバージョンがリストに表示されない場合は、Swiftパッケージキャッシュをリセットします。
4. インストールするモジュールのリストからLifecycleモジュールを選択し、Xcodeプロジェクトの各アプリターゲットに追加します。Frameworks and Librariesの下にあります。

iOS用のSwift Package Managerのインストールについて詳しくはこちらをご覧ください。

CocoaPods

CocoaPodsでライフサイクルモジュールをインストールするには、以下のpodをPodfileに追加します：

pod 'tealium-swift/Lifecycle'

iOS用のCocoaPodsのインストールについて詳しくはこちらをご覧ください。

Carthage

Carthageでライフサイクルモジュールをインストールするには、以下の手順を実行します：

1. Xcodeでアプリターゲットの一般構成ページに移動します。

2. 次のフレームワークをEmbedded Binariesセクションに追加します：

   TealiumLifecycle.framework
   

3. ライフサイクルライブラリをインポートするには、プロジェクトに次のインポート文を追加します：

   import TealiumLifecycle
   

iOS用のCarthageのインストールについて詳しくはこちらをご覧ください。

構成

ライフサイクルモジュールをインスタンス化するには、SDKを初期化するときにTealiumConfigオブジェクトで指定する必要があります：

import TealiumCore
import TealiumInAppPurchase

let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",
                           datasource: "DATASOURCE")

config.collectors = [Collectors.Lifecycle]
tealium = Tealium(config: config) { _ in }

必要なコレクターを正しく指定する方法については、Collectorsのドキュメンテーションを参照してください。

データレイヤー

モジュールが有効な間、次の変数が各トラッキング呼び出しで送信されます：

クラッシュ検出

ライフサイクルモジュールは基本的なクラッシュ検出を行いますが、クラッシュの原因についての詳細は収集しません。スリープイベントが先行せずにライフサイクル起動イベントが見られるたびにクラッシュを記録します。 通常、アプリがユーザーによって閉じられると、OSからの通知がライフサイクルのスリープイベントをトリガーしますが、アプリがクラッシュすると、これが発生する時間がなく、したがって、スリープイベントは発生しません。クラッシュ後の次回の起動時に、lifecycle_diddetectcrash変数がtrueに構成され、lifecycle_totalcrashcount変数が1増加します。

より高度なクラッシュ検出が必要な場合、クラッシュレポーターモジュールは各クラッシュの詳細とクラッシュの理由を提供します。これは現在、iOSのみでサポートされています。

API リファレンス

以下のAPIメソッドは、UIKitをサポートしていないプラットフォームを対象としている場合にのみ使用する必要があります。

launchDetected()

ライフサイクルのレコードを起動イベントで更新し、ライフサイクルイベントのディスパッチをトリガーします。

func someMethodCalledAtLaunchTime {
    tealium?.lifecycle?.launchDetected()

}

wakeDetected()

ライフサイクルのレコードをウェイクイベントで更新し、ライフサイクルイベントのディスパッチをトリガーします。

func someMethodCalledWhenAppStarts {
    tealium?.lifecycle?.wakeDetected()

}

wakeDetected()の呼び出しは、同じ関数内のlaunchDetected()の後に安全に追加されます。モジュールは、インスタンス化されたインスタンスごとに単一の起動イベントのみを受け入れます。

sleepDetected()

ライフサイクルのレコードをスリープイベントで更新し、ライフサイクルイベントのディスパッチをトリガーします。

func someMethodCalledBeforeAppTerminated {
    tealium?.lifecycle?.sleepDetected()
}

dictionary

ライフサイクルデータを[String: Any]の辞書として読み取り専用でアクセスできるプロパティ。

// ライフサイクルデータ辞書から合計ウェイクカウントを取得
let wakeCount = tealium?.lifecycle?.dictionary?["lifecycle_totalwakecount"]