AndroidおよびSwift/iOS向けのTealiumリモートコマンドとKochavaの連携。
要件
- Kochava App GUID
- 以下のいずれかのモバイルライブラリ:
- Tealium for Android-Kotlin(1.0.0以降)
- Tealium for Android-Java(5.9.0以降)
- Tealium for iOS-Swift(2.1.0以降)
- 以下のいずれかのリモートコマンド連携:
- KochavaリモートコマンドJSONファイル(Android-Kotlin 1.0.0以降またはiOS-Swift 2.1.0以降が必要)
- タグ管理のKochavaリモートコマンドタグ
仕組み
Kochava連携では、次の3つの項目を使用します。
- KochavaネイティブSDK
- Kochavaのメソッドをラップするリモートコマンドモジュール
- イベントトラッキングをKochavaのネイティブ呼び出しに変換するJSON構成ファイルまたはリモートコマンドタグ
Kochavaリモートコマンドモジュールをアプリに追加すると、必要なKochavaライブラリが自動的にインストールおよびビルドされるため、ベンダー固有のコードをアプリに追加する必要はありません。依存関係マネージャーを使用してインストールする場合は、Kochava SDKを別途インストールする必要はありません。
リモートコマンドには、JSON構成ファイルを使用する方法と、タグ管理を使用してマッピングを構成する方法の2つがあります。ベンダー連携には、リモートでホストするかアプリ内にローカルに配置したJSON構成ファイルの使用を推奨します。タグ管理を使用する場合は、ベンダー連携用のリモートコマンドタグを追加します。ベンダー連携の詳細をご覧ください。
インストール
依存関係マネージャー
- Xcodeプロジェクトで、File > Add Packages… > Add Package Dependencyを選択します。
- リポジトリのURLとして
https://github.com/tealium/tealium-ios-kochava-remote-commandを入力します。 - バージョンルールを構成します。通常は
Up to next majorを推奨します。現在のTealiumKochavaバージョンがリストに表示されない場合は、Swiftパッケージのキャッシュをリセットしてください。 - インストールする
TealiumKochavaモジュールを選択し、そのモジュールをインストールするアプリターゲットを選択します。
プロジェクトに複数のアプリターゲットがあり、追加のアプリターゲットでもTealiumKochavaモジュールが必要な場合は、Frameworks, Libraries, and Embedded Contentセクションで手動で追加する必要があります。
追加のアプリターゲットにTealiumKochavaをインストールするには、次の手順を実行します。
- Project NavigatorでXcodeプロジェクトを選択します。
- XcodeプロジェクトのTARGETSセクションでアプリターゲットを選択します。
- General > Frameworks, Libraries & Embedded Contentに移動し、アプリターゲットに追加する
TealiumKochavaモジュールを選択します。
Tealium Swiftライブラリから追加のモジュールをインストールするには、Swift Package Managerの手順に従ってください。
Podfileに
tealium-swiftおよびpod "KochavaTrackeriOS"がすでに存在する場合は、それらを削除します。tealium-swiftの依存関係は、すでにTealiumKochavaフレームワークに含まれています。Podfileに次の依存関係を追加します。
pod "TealiumKochava"TealiumKochavaPodには、次のTealiumSwift依存関係が含まれています。'tealium-swift/Core' 'tealium-swift/RemoteCommands' 'tealium-swift/TagManagement'TealiumHelperファイル、およびTealiumクラスまたはKochavaリモートコマンドにアクセスするその他のファイルに、TealiumSwiftモジュールとTealiumKochavaモジュールをインポートします。
Cartfileから
tealium-swiftを削除します。tealium-swiftの依存関係は、すでにTealiumKochavaフレームワークに含まれています。Cartfileに次の依存関係を追加します。
github "tealium/tealium-ios-kochava-remote-command"
Tealium for Swift SDK(バージョン1.6.5以降)では、インストールにTealiumDelegateモジュールを含める必要があります。
まだ実行していない場合は、Tealium for Android(Kotlin)またはTealium for Android(Java)をインストールし、プロジェクトのトップレベルの
build.gradleファイルにTealium Maven URLを追加します。allprojects { repositories { mavenCentral() maven { url "https://maven.tealiumiq.com/android/releases/" } } }アプリプロジェクトの
build.gradleファイルに次の依存関係を追加して、Kochava SDKとTealium-Kochavaリモートコマンドの両方をインポートします。dependencies { implementation 'com.tealium.remotecommands:kochava:1.0.0' }
手動インストール
Kochavaリモートコマンドを手動でインストールするには、Tealium for Swiftライブラリがインストールされている必要があります。iOSプロジェクトにKochavaリモートコマンドをインストールするには、次の手順を実行します。
まだインストールしていない場合は、Kochava SDKをインストールします。
Tealium iOS Kochavaリモートコマンドリポジトリをクローンし、
Sourcesフォルダー内のファイルをプロジェクトにドラッグします。remoteAPIEnabled構成フラグをtrue.に構成します。
Kochavaリモートコマンドを手動でインストールするには、Tealium for Android(Kotlin)またはTealium for Android(Java)がインストールされている必要があります。
AndroidプロジェクトにKochavaリモートコマンドをインストールするには、次の手順を実行します。
プロジェクトルートの
build.gradleファイルにflatDirを追加します。allprojects { repositories { mavenCentral() flatDir { dirs 'libs' } } }tealium-kochava.aarを<PROJECT_ROOT>/<MODULE>/libsに追加します。build.gradleファイルにTealiumライブラリの依存関係を追加します。dependencies { implementation(name:'tealium-kochava', ext:'aar') }
初期化
すべての Tealium ライブラリで、初期化時に Kochava モバイルリモートコマンドを登録します。
JSON 構成ファイルまたは Remote Command タグを使用して、Tealium の iOS(Swift)ライブラリ向けにリモートコマンドを初期化します。
var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
profile: "PROFILE",
environment: "ENVIRONMENT",
dataSource: "DATASOURCE")
config.dispatchers = [Dispatchers.TagManagement, Dispatchers.RemoteCommands]
config.remoteAPIEnabled = true // Required to use Remote Commands
tealium = Tealium(config: config) { _ in
guard let remoteCommands = self.tealium?.remoteCommands else {
return
}
// Webview Tag
let kochava = KochavaRemoteCommand()
// Local JSON
//let kochava = KochavaRemoteCommand(type: .local(file: "kochava"))
// Remote JSON
//let kochava = KochavaRemoteCommand(type: .remote(url: "https://some.domain.com/kochava.json"))
remoteCommands.add(kochava)
}
JSON 構成ファイルまたは Remote Command タグを使用して、Tealium の Kotlin ライブラリ向けにリモートコマンドを初期化します。
val config = TealiumConfig(application,
"ACCOUNT",
"PROFILE",
Environment.DEV,
dispatchers = mutableSetOf(Dispatchers.RemoteCommands, Dispatchers.TagManagement));
val kochava = KochavaRemoteCommand(application);
var tealium = Tealium.create(TEALIUM_MAIN, config) {
// Webview Tag
remoteCommands?.add(kochava);
// Local JSON
//remoteCommands?.add(kochava, filename = "kochava.json");
// Remote JSON
//remoteCommands?.add(kochava, remoteUrl = "https://some.domain.com/kochava.json");
}
Remote Command タグを使用して、Tealium の Android(Java)ライブラリ向けにリモートコマンドを初期化します。
RemoteCommand kochava = new KochavaRemoteCommand(application);
teal.addRemoteCommand(kochava);
JSON テンプレート
JSON 構成ファイルを使用してリモートコマンドを構成する場合は、以下のテンプレートを参考にしてください。このテンプレートには、標準インストールで使用される一般的なマッピングが含まれています。必要に応じてマッピングを編集してください。
{
"config": {
"app_guid": "test app guid",
"log_level": "debug",
"app_tracking_transparency_enabled": false,
"limit_ad_tracking": true,
"identity_link_ids": {
"userID": "CUST123",
"userName": "Bob"
}
},
"mappings": {
"event_title": "custom_event_name",
"achievement_id": "custom.achievement_id",
"ad_network_name": "custom.ad_network_name",
"campaign_id": "event.ad_campaign_id",
"campaign": "event.ad_campaign_name",
"cart_add_location": "event.item_added_from",
"checkout_option": "custom.checkout_option",
"checkout_step": "custom.checkout_step",
"content": "event.content_id",
"content_type": "event.content_type",
"coupon": "custom.coupon",
"currency_code": "event.currency",
"customer_id": "event.user_id,identity_link_ids.userID",
"device_type": "event.ad_device_type",
"end_date": "event.end_date",
"flight_number": "custom.flight_number",
"game_character": "custom.character",
"group_name": "event.ad_group_name",
"guest_checkout": "event.checkout_as_guest",
"level": "event.level",
"number_nights": "custom.number_nights",
"number_pax": "custom.number_passengers",
"number_rooms": "custom.number_rooms",
"order_id": "event.order_id",
"order_shipping_amount": "custom.shipping",
"order_tax_amount": "custom.tax",
"order_total": "custom.total",
"product_brand": "custom.brand",
"product_category": "custom.category",
"product_id": "custom.product_id",
"product_name": "event.name",
"product_quantity": "event.quantity",
"product_unit_price": "event.price",
"rating": "event.rating_value",
"score": "event.score",
"search_keyword": "event.search_term",
"search_results": "event.results",
"signup_method": "event.registration_method",
"start_date": "event.start_date",
"travel_destination": "event.destination",
"travel_class": "custom.travel_class",
"travel_origin": "event.origin",
"username": "event.user_name,identity_link_ids.userName"
},
"commands": {
"launch": "initialize",
"user_login": "custom,sendidentitylink",
"user_register": "registrationcomplete",
"share": "custom",
"show_offers": "adclick,adview",
"join_group": "custom",
"travel_order": "purchase",
"unlock_achievement": "achievement",
"level_up": "levelcomplete",
"stop_tutorial": "tutorialcomplete",
"record_score": "custom",
"category": "view",
"product": "view",
"cart_add": "addtocart",
"wishlist_add": "addtowishlist",
"checkout": "checkoutstart",
"rating": "rating",
"search": "search",
"screen_veiw": "view",
"email_signup": "subscribe",
"order": "purchase",
"disable_analytics": "sleeptracker,invalidate"
}
}
プッシュメッセージトラッキング(iOS)
Tealium Swift ライブラリには、Tealium および Kochava Remote Command を介したプッシュメッセージトラッキングを処理するための TealiumRegistration プロトコルが含まれています。プッシュメッセージの認証イベント、プッシュメッセージの開封イベント、およびアンインストールトラッキングの送信に使用するラッパークラス KochavaInstance で、このプロトコルに準拠しています。プッシュメッセージトラッキング機能を利用することをお勧めします。
以下の手順で、iOS プロジェクトにプッシュメッセージトラッキングを統合します。
TealiumHelper.swiftファイルで、TealiumRegistrationプロトコルに準拠するオブジェクトの空の配列を初期化します。例:var pushMessagingHelpers = [TealiumRegistration]()KochavaRemoteCommandより前にKochavaInstanceを初期化します。- 上記の配列に
KochavaInstanceを追加します。
以下は、プッシュメッセージトラッキングを統合する例です。
var pushMessagingHelpers = [TealiumRegistration]()
//...
teal = Tealium(config: config) { responses in
guard let remoteCommands = self.tealium?.remoteCommands() else {
return
}
let kochavaInstance = KochavaInstance()
let kochavaRemoteCommand = KochavaRemoteCommand(kochavaInstance: kochavaInstance)
remoteCommands.add(kochavaRemoteCommand)
self.pushMessagingHelpers.append(kochavaInstance)
}
TealiumHelper.swift ファイル全体を確認するには、Kochava Remote Command サンプルアプリを参照してください。ユーザーが通知を登録したとき、プッシュメッセージを開いたとき、またはアプリをアンインストールしたときに Kochava へイベントを送信する方法については、AppDelegate.swift ファイルを参照してください。
Kochava のプッシュメッセージトラッキングの詳細については、Kochava iOS プッシュ通知のドキュメントを参照してください。
エンリッチメントされたディープリンク(iOS)
Tealium Swift ライブラリには、Tealium および Kochava Remote Command を介してディープリンクを処理するための TealiumDeepLinkable プロトコルが含まれています。このプロトコルは、ユーザーを目的の場所へリダイレクトする前に .deepLink イベントを送信するために使用されるラッパークラス KochavaInstance に実装されています。
iOS プロジェクトにエンリッチメントされたディープリンクを統合する手順は次のとおりです。
TealiumHelper.swiftファイルで、TealiumDeepLinkableプロトコルに準拠するオブジェクトの空の配列を初期化します。例:var deepLinkHelpers = [TealiumDeepLinkable]()KochavaRemoteCommandより前にKochavaInstanceを初期化します。- 上記の配列に
KochavaInstanceを追加します。
以下は、エンリッチメントされたディープリンク統合の完全な例です。
```swift
var deepLinkHelpers = TealiumDeepLinkable
//...
teal = Tealium(config: config) { responses in
guard let remoteCommands = self.tealium?.remoteCommands() else {
return
}
let kochavaInstance = KochavaInstance()
let kochavaRemoteCommand = KochavaRemoteCommand(kochavaInstance: kochavaInstance)
remoteCommands.add(kochavaRemoteCommand)
self.deepLinkHelpers.append(kochavaInstance)
}
```
TealiumHelper.swift ファイル全体については、Kochava Remote Command サンプルアプリを参照してください。
ユーザーが通知に登録したとき、プッシュメッセージを開いたとき、またはアプリをアンインストールしたときに Kochava へイベントを送信する方法については、AppDelegate.swift ファイルを参照してください。
Kochava のエンリッチメントされたディープリンクの詳細については、Kochava iOS のドキュメントを参照してください。
サポートされているメソッド
各 Kochava メソッドにコマンドをマッピングします。Kochava メソッドをトリガーするには、対応するコマンドを指定された形式で渡します。
iOS Remote Command
| iOS Remote Command | Kochava メソッド |
|---|---|
initialize | start() |
sleepTracker | sleepTracker (property on the KochavaTracker.shared object) |
invalidate | invalidate() |
| 以下のいずれかのイベント名 | sendEvent() |
sendIdentityLink | sendIdentityLink() |
AppDelegate の didReceiveRemoteNotification 内で手動で呼び出す | sendEvent() - event type: .pushOpened |
TealiumRegistration プロトコル(registerPushToken() メソッド)を使用して、AppDelegate の didRegisterForRemoteNotificationsWithDeviceToken 内で手動で呼び出す | addRemoteNotificationsDeviceToken() |
TealiumDeeplinkable プロトコルを使用して、AppDelegate の continue userActivity 内で手動で呼び出す | KVADeeplink.process() and/or sendEvent() - event type: .deepLink |
Android Remote Command
| Android Remote Command | Kochava メソッド |
|---|---|
configure | configure() |
setsleep | setSleep() |
| 以下のいずれかのイベント名 | sendEvent() |
標準イベント名
trackEvent メソッドでは、以下の標準イベントコマンド名がサポートされています。コマンドが送信され、そのイベントに必要なすべての変数がマッピングおよび定義されている場合、Kochava SDK でコマンドが自動的にトリガーされます。
| Remote Command | Kochava イベント名(iOS) | Kochava イベント名(Android) |
|---|---|---|
achievement | KVAEventType.achievement | Commands.ACHIEVEMENT |
addToCart | KVAEventType.addToCart | Commands.ADD_TO_CART |
addToWishlist | KVAEventType.addToWishList | Commands.Add_TO_WISH_LIST |
registrationComplete | KVAEventType.registrationComplete | Commands.REGISTRATION_COMPLETE |
tutorialComplete | KVAEventType.tutorialComplete | Commands.TUTORIAL_COMPLETE |
levelComplete | KVAEventType.levelComplete | Commands.LEVEL_COMPLETE |
checkoutStart | KVAEventType.checkoutStart | Commands.CHECKOUT_START |
purchase | KVAEventType.purchase | Commands.PURCHASE |
subscribe | KVAEventType.subscribe | Commands.SUBSCRIBE |
startTrial | KVAEventType.startTrial | Commands.START_TRIAL |
rating | KVAEventType.rating | Commands.RATING |
search | KVAEventType.search | Commands.SEARCH |
adView | KVAEventType.adView | Commands.AD_VIEW |
view | KVAEventType.view | Commands.VIEW |
pushOpened | KVAEventType.pushOpened | マッピングに customEventNameString が必要 |
pushRecieved | KVAEventType.pushReceived | マッピングに customEventNameString が必要 |
consentGranted | KochavaEventTypeEnumConsentGranted | マッピングに customEventNameString が必要 |
adClick | KVAEventType.adClick | マッピングに customEventNameString が必要 |
custom | KVAEventType.custom(マッピングに customEventNameString が必要) | マッピングに customEventNameString が必要 |
iOS では、ネイティブの KVAEvent.send() メソッドまたは TealiumDeepLinkable プロトコルのいずれかを使用し、AppDelegate で KVAEvent.deepLink イベントを送信する必要があります。
SDK のセットアップ
Kochava SDK のセットアップについて詳しくは、以下を参照してください。
初期化
Kochava SDK は、起動時に自動的に初期化されます。Kochava App GUID は、Tealium Remote Command の構成で構成されます。
| Remote Command | Kochava メソッド |
|---|---|
initialize | start() |
Kochava Remote Command タグでは、複数の構成オプションを使用できます。以下のいずれかが起動時に構成されている場合、configure() メソッドの実行時に送信されます。
構成オプション
| 名前 | TiQ 変数マッピング | 説明 | 型 |
|---|---|---|---|
| ログレベル | log_level | コンソールへの Kochava 出力に使用するログレベル:none、error、warn、info、debug、trace(ログレベルの詳細) | String |
| アトリビューションデータの取得 | retrieve_attribution_data | アトリビューションデータの準備が整ったときにそのデータを取得するデリゲート/リスナーを構成するためのブール値です。TealiumKochava では、attributionDictionary が揮発性保存に構成され、tealium_event が attribution の track 呼び出しが送信されます。デリゲート/リスナーメソッドは TealiumKochavaTracker に追加できます(アトリビューションの取得の詳細) | Bool |
| Identity Link ID | identity_link_ids | キーと値のペアの形式で異なる ID を関連付けます(ID の関連付けの詳細) | Int |
| 広告トラッキングの制限 | limit_ad_tracking | 有効にすると、アプリケーションレベルで広告トラッキングを制限します(デフォルト:false) | Bool |
| App Tracking Transparency の有効化(iOS 14 以降) | app_tracking_transparency_enabled | 有効にすると、Kochava による App Tracking Transparency(iOS 14 以降)の自動実装を有効にします。(デフォルト:false) | Bool |
トラッカーのスリープ
| Remote Command | Kochava メソッド |
|---|---|
sleeptracker(iOS) | sleepTracker(KochavaTracker.shared オブジェクトのプロパティ) |
setsleep(Android) | setSleep() |
| パラメータ | 型 |
|---|---|
sleep(必須) | Bool |
無効化(iOS)
| Remote Command | Kochava メソッド |
|---|---|
invalidate | invalidate() |
Identity Link の送信(iOS)
| Remote Command | Kochava メソッド |
|---|---|
sendidentitylink | sendIdentityLink() |
| パラメータ | 型 |
|---|---|
identityLinkIds(必須) | キーと値のペア |
カスタムイベントの送信(iOS)
| リモートコマンド | Kochavaメソッド |
|---|---|
| 標準イベント名 | send() |
| パラメータ | 型 |
|---|---|
event_parameters(任意) | キーと値のペア |
カスタムイベントの送信(iOS)
| リモートコマンド | Kochavaメソッド |
|---|---|
custom | sendCustom() |
| パラメータ | 型 |
|---|---|
custom_event_name(必須) | String |
info_dictionary(任意) | キーと値のペア |
最終更新日 :: 2026年November月18日