DispatchQueueモジュール
使用方法
DispatchQueueモジュールは、ConnectivityモジュールおよびConsentManagerモジュールと連動して動作して、デバイスのオフライン時やユーザーがまだトラッキングに同意していない場合に保留中のディスパッチをディスクに格納します。接続が復旧した場合やユーザーがトラッキングに同意した場合は、ディスパッチのキューが送信されます。デフォルトでは、キュー内のディスパッチ数の上限は20です。この上限を超えると、最新のディスパッチを格納するためにディスパッチが古い方から消去されます。データはUserDefaultsに格納されます。
このモジュールの使用は、ConsentManagerモジュールまたはConnectivityモジュールを使用している場合は必須です。それ以外の場合も、初期化前のTealiumCoreモジュールによるキューへのイベント追加を支援することを強く推奨します。
以下のプラットフォームがサポートされています。
- iOS
- tvOS
- watchOS
- macOS
インストール
DispatchQueueモジュールをCocoaPodsまたはCarthageによってインストールします。
CocoaPods
DispatchQueueモジュールをCocoaPodsによってインストールするには、Podfileに以下のポッドを追加します。
pod 'tealium-swift/TealiumDispatchQueue'
フレームワークは自動でインスタンス化され、TealiumCore
ポッドに依存しています。iOS向けCocoaPodsのインストールの詳細については、こちらを参照してください。
Carthage
DispatchQueueモジュールをCarthageによってインストールするには、以下の手順に従います。
Xcodeで対象アプリの[General]構成ページに移動します。
以下のフレームワークを[Embedded Binaries]セクションに追加します。
TealiumDispatchQueue.framework
フレームワークは自動でインスタンス化され、TealiumCore
に依存しています。追加のインポートステートメントは必要ありません。iOS向けCarthageのインストールの詳細については、こちらを参照してください。
データレイヤー
モジュールが有効な場合に、トラッキングコールのたびに以下の変数が送信されます。
変数 | 説明 | 値の例 |
---|---|---|
was_queued |
ディスパッチがキューに追加されたことを示します。 | ["true" , "false" ] |
APIリファレンス
このモジュール用のパブリックAPIメソッドはありません。成功と失敗は、Delegateモジュールを通じて監視できます。
以下の追加のメソッドがTealiumConfig
クラスによって提供されます。
setMaxQueueSize()
ディスパッチの保管のために永続的なキューの最大サイズを設定します。デフォルトは20イベントです。
tealConfig.setMaxQueueSize(size)
パラメータ | 型 | 説明 | 例 |
---|---|---|---|
size |
Int |
ディスパッチの保管のために永続的なキューの最大サイズ(デフォルト:20 ) |
50 |
getMaxQueueSize()
キューの最大サイズを取得します。
tealConfig.getMaxQueueSize();
戻り値 | 戻り値の型 |
---|---|
Maximum persistent queue size for dispatch storage | Int |