リモートコマンド：SKAdNetwork

SKAdNetworkは、広告主が広告キャンペーンの成功を測定するために使用するAppleのSDKであり、ユーザーのプライバシーを保護します。

必要条件

動作方法

SKAdNetwork統合には2つのアイテムが使用されます。

SKAdNetwork変換値を送信するリモートコマンドモジュール
イベントトラッキングを変換値に変換するためのJSON構成ファイルまたはリモートコマンドタグ

JSON構成ファイルは、この統合の推奨オプションであり、アプリ内またはリモートでホストされます。Tag Managementを使用している場合は、ベンダー統合のためにリモートコマンドタグを追加します。ベンダー統合について詳しくは、こちらをご覧ください。

インストール

依存関係マネージャー

Xcodeプロジェクトで、「ファイル > パッケージの追加… > パッケージの依存関係を追加」を選択します。
リポジトリのURL https://github.com/tealium/tealium-ios-skadnetwork-remote-command を入力します。
バージョンルールを構成します。通常は「次のメジャーバージョンまで」が推奨されます。現在のTealiumSKAdNetworkバージョンがリストに表示されない場合は、Swiftパッケージキャッシュをリセットします。
インストールするTealiumSKAdNetworkモジュールを選択し、モジュールをインストールするアプリのターゲットを選択します。
プロジェクトに複数のアプリターゲットがある場合で、TealiumSKAdNetworkモジュールを他のアプリターゲットに追加する必要がある場合は、フレームワーク、ライブラリ、および埋め込みコンテンツセクションに手動で追加する必要があります。

追加のアプリターゲットにTealiumSKAdNetworkをインストールするには:

プロジェクトナビゲーターでXcodeプロジェクトを選択します。
Xcodeプロジェクトで、TARGETSセクションのアプリターゲットを選択します。
一般 > フレームワーク、ライブラリ、および埋め込みコンテンツに移動し、TealiumSKAdNetworkモジュールをアプリターゲットに追加します。

Podfileにpod "tealium-swift"とpod "SKAdNetwork"が存在する場合は、削除します。tealium-swiftの依存関係は、すでにTealiumSKAdNetworkフレームワークに含まれています。
Podfileに次の依存関係を追加します:
```
pod "TealiumSKAdNetwork"
```
TealiumSKAdNetworkポッドには、次のTealiumSwiftの依存関係が含まれています:
```
"tealium-swift/Core"
"tealium-swift/RemoteCommands"
```
インストール時にディスパッチャーポッドを含める必要があります。tealium-swift/Collectまたはtealium-swift/TagManagementのいずれかを選択し、他の個別のサブモジュールもPodfileに含めます。例:
```
pod "TealiumSKAdNetwork"
pod "tealium-swift/Collect"
pod "tealium-swift/Lifecycle"
pod "tealium-swift/Attribution"
```
TealiumSwiftモジュールとTealiumSKAdNetworkモジュールをTealiumHelperファイルと、Tealiumクラスにアクセスする他のファイルにインポートします。

Cartfileからtealium-swiftを削除します。tealium-swiftの依存関係は、すでにTealiumSKAdNetworkフレームワークに含まれています。
Cartfileに次の行が存在する場合は、削除します:
```
github "skadnetwork/ios_sdk"
```

Cartfileに次の依存関係を追加します:

github "tealium/tealium-ios-skadnetwork-remote-command"

手動インストール

SKAdNetworkリモートコマンドの手動インストールには、Tealium for Swiftライブラリのインストールが必要です。iOSプロジェクトにSKAdNetworkリモートコマンドをインストールするには、次の手順を実行します。

SKAdNetwork SDKをインストールします（まだインストールしていない場合）。
Tealium iOS SKAdNetworkリモートコマンドリポジトリをクローンし、Sourcesフォルダ内のファイルをプロジェクトにドラッグします。
remoteAPIEnabled構成フラグをtrueに構成します。

初期化

JSON構成ファイルまたはTealiumのiOS（Swift）ライブラリのリモートコマンドタグを使用して、リモートコマンドを初期化します。

以下のコードは、ローカルファイルオプションを使用したJSONリモートコマンド機能に対応するように設計されています:

var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
                           profile: "PROFILE",
                           environment: "ENVIRONMENT",
                           dataSource: "DATASOURCE",
                           optionalData: nil)

config.remoteAPIEnabled = true // リモートコマンドを使用するために必要
config.dispatchers = [Dispatchers.RemoteCommands, Dispatchers.Collect]

tealium = Tealium(config: config) { _ in
    guard let remoteCommands = self.tealium?.remoteCommands else {
        return
    }

    // Webviewタグ
    let skadnetwork = SKAdNetworkRemoteCommand(delegate: self)

    // ローカルJSON
    //let skadnetwork = SKAdNetworkRemoteCommand(type: .local(file: "skadnetwork"), delegate: self)

    // リモートJSON
    //let skadnetwork = SKAdNetworkRemoteCommand(type: .remote(url: "https://some.domain.com/skadnetwork.json"), delegate: self)

	remoteCommands.add(skadnetwork)
}

デリゲート

デリゲートはオプションのパラメータであり、変換の更新と完了時の呼び出しを受け取るために使用され、エラーのデバッグと処理、およびトラッキングも行うことができます。

    /// 新しい変換値を送信する必要があると検出した場合
    func onConversionUpdate(conversionData: ConversionData, lockWindow: Bool)
    /// 新しい変換値が送信され、完了した場合、オプションでエラーも含まれます
    func onConversionUpdateCompleted(error: Error?)
}

JSONテンプレート

リモートコマンドを構成する場合は、JSON構成ファイルを使用する場合、次のテンプレートを参照して開始します。必要に応じてマッピングを編集します。

テンプレートには、シンプルな値の帰属戦略の共通マッピングが含まれています。いくつかのイベントで送信する細かい値と粗い値をマッピングしています。

{
    "config": {
      "send_higher_value": true
    },
    "mappings": {
        "fine_value":"fine_value",
        "coarse_value":"coarse_value"
    },
    "commands": {
        "launch": "initialize,registerappforattribution,setconversionvalue",
        "register": "setconversionvalue",
        "login": "setconversionvalue",
        "tutorial": "setconversionvalue",
        "addtocart": "setconversionvalue",
        "purchase": "setconversionvalue",
        "user_type:premium,subscribe": "setconversionvalue"
    },
    "statics": {
        "launch": {
            "fine_value": 0,
            "coarse_value": "low"
        }
}

テンプレートには、標準のイベントベースの帰属戦略の共通マッピングが含まれています。各イベントは、変換値の6ビットのうちの1つにマップされます。

{
    "config": {
      "send_higher_value": true
    },
    "mappings": {
        "bit_number":"bit_number",
        "fine_value":"fine_value",
        "coarse_value":"coarse_value"
    },
    "commands": {
        "launch": "initialize,registerappforattribution,setconversionvalue",
        "register": "setconversionbit",
        "login": "setconversionbit",
        "tutorial": "setconversionbit",
        "addtocart": "setconversionbit",
        "purchase": "setconversionbit",
        "user_type:premium,subscribe": "setconversionbit"
    },
    "statics": {
        "launch": {
            "fine_value": 0,
            "coarse_value": "low"
        },
        "register": {
            "bit_number": 0,
            "coarse_value": "low"
        },
        "login": {
            "bit_number": 1,
            "coarse_value": "low"
        },
        "tutorial": {
            "bit_number": 2,
            "coarse_value": "low"
        },
        "addtocart": {
            "bit_number": 3,
            "coarse_value": "medium"
        },
        "purchase": {
            "bit_number": 4,
            "coarse_value": "high"
        },
        "user_type:premium,subscribe": {
            "bit_number": 5,
            "coarse_value": "high"
        },
    }
}

テンプレートには、混合帰属戦略の共通マッピングが含まれています。6つのビットのうち2つを値の格納に使用し、4つのビットをイベントのエンコードに使用します。

{
    "config": {
      "send_higher_value": true
    },
    "mappings": {
        "bit_number":"bit_number",
        "fine_value":"fine_value",
        "coarse_value":"coarse_value",
        "limit_to_highest_n_bits": "limit_to_highest_n_bits",
        "limit_to_lowest_n_bits": "limit_to_lowest_n_bits"
    },
    "commands": {
        "launch": "initialize,registerappforattribution,setconversionvalue",
        "register": "setconversionbit",
        "login": "setconversionbit",
        "tutorial": "setconversionbit",
        "addtocart": "setconversionbit",
        "purchase": "setconversionbit",
        "subscribe": "setconversionvalue"
    },
    "statics": {
        "launch": {
            "fine_value": 0,
            "coarse_value": "low"
        },
        "register": {
            "bit_number": 0,
            "coarse_value": "low"
        },
        "login": {
            "bit_number": 1,
            "coarse_value": "low"
        },
        "tutorial": {
            "bit_number": 2,
            "coarse_value": "low"
        },
        "addtocart": {
            "bit_number": 3,
            "coarse_value": "medium"
        },
        "purchase": {
            "bit_number": 4,
            "coarse_value": "high"
        },
        "user_type:common,subscribe": {
            "limit_to_highest_n_bits": 2,
            "fine_value": 1,
            "coarse_value": "low"
        },
        "user_type:premium,subscribe": {
            "limit_to_highest_n_bits": 2,
            "fine_value": 2,
            "coarse_value": "medium"
        },
        "user_type:premium_plus,subscribe": {
            "limit_to_highest_n_bits": 2,
            "fine_value": 3,
            "coarse_value": "high"
        }
    }
}

サポートされているメソッド

以下のメソッドは、変換値を変更するために使用され、これらのコマンドからのデータマッピングをトリガーとします。

リモートコマンド	SKAdNetworkメソッド
`initialize`	`configure()`
`registerappforattribution`	`registerAppForAdNetworkAttribution()`
`setconversionbit`	`setConversionBit()`
`resetconversionbit`	`resetConversionBit()`
`setconversionvalue`	`setConversionValue()`
`resetconversionvalue`	`resetConversionValue()`

これらのメソッドはすべて変換値に影響を与え、SKAdNetwork APIの変換値の更新を引き起こします。

Initialize

send_higher_valueフラグをtrueに構成して、低い値をフィルタリングし、高い値のみを送信することができます。

リモートコマンド	SKAdNetworkメソッド
`initialize`	`configure()`

パラメーター	型
`send_higher_value`	`Bool`

Register App For Attribution

これは、iOS < 14向けの古いメソッドです。iOSバージョン14より古いバージョンをサポートしている場合、変換値を報告することはできませんが、このメソッドを使用してインストールが行われたことを報告することはできます。このメソッドは、おそらく古いOSバージョンをサポートしている場合に、起動時に送信する必要があります。

リモートコマンド	SKAdNetworkメソッド
`registerappforattribution`	`registerAppForAdNetworkAttribution()`

Set Conversion Bit

変換値で上げるビットを指定することができます。ただし、ビットがすでに上げられている場合、細かい値は変更されません。

リモートコマンド	SKAdNetworkメソッド
`setconversionbit`	`setConversionBit()`

パラメーター	型	説明
`bit_number`	`Int`	0から5までの数値
`coarse_value`	`String`	このインストールの粗い値（low-medium-high）
`lock_window`	`Bool`	現在のウィンドウで変換値を再度更新したくない場合はtrue

Reset Conversion Bit

変換値でリセットするビットを指定することができます。ただし、これはsend_higher_valueがfalseに構成されている場合にのみ発生します。ビットをリセットすると、変換値が自動的に低下するためです。

リモートコマンド	SKAdNetworkメソッド
`resetconversionbit`	`resetConversionBit()`

パラメーター	型	説明
`bit_number`	`Int`	0から5までの数値
`coarse_value`	`String`	このインストールの粗い値（low-medium-high）
`lock_window`	`Bool`	現在のウィンドウで変換値を再度更新したくない場合はtrue

Set Conversion Value

変換値を指定することができます。send_higher_valueがtrueの場合、高い値のみが取得されます。

リモートコマンド	SKAdNetworkメソッド
`setconversionvalue`	`setConversionValue()`

パラメーター	型	説明
`fine_value`	`Int`	0から63までの数値
`coarse_value`	`String`	このインストールの粗い値（low-medium-high）
`lock_window`	`Bool`	現在のウィンドウで変換値を再度更新したくない場合はtrue
`limit_to_highest_n_bits`	`Int`	1から5までの数値で、この値を表すために使用するビット数を指定します。デフォルトは6です。
`limit_to_lowest_n_bits`	`Int`	1から5までの数値で、この値を表すために使用するビット数を指定します。デフォルトは6です。

最上位ビットまたは最下位ビットのどちらかから制限を指定できますが、両方を指定することはできません。

Reset Conversion Value

構成のsend_higher_valueフラグを無視し、変換値を開始状態（fine value = 0、coarse value = nil）にリセットします。

リモートコマンド	SKAdNetworkメソッド
`resetconversionvalue`	`resetConversionValue()`