RemoteCommands モジュール
Tealium iQタグ管理のイベントからネイティブコードブロックをトリガーすることを可能にし、拡張機能とロードルールによって制御されます。
リモートコマンドについて詳しく学びましょう。
要件
webview
リモートコマンドを使用する場合、Tag Management Dispatcherモジュールが必要です。
インストール
Maven(推奨)または手動でRemoteCommands Dispatcherモジュールをインストールします。
Maven
Mavenを使用してモジュールをインストールするには:
-
プロジェクトのトップレベルの
build.gradle
ファイルに、次のMavenリポジトリを追加します:maven { url "https://maven.tealiumiq.com/android/releases/" }
-
プロジェクトモジュールの
build.gradle
ファイルに、RemoteCommands DispatcherのMaven依存関係を追加します。これにより、Tealium Kotlinライブラリが取り込まれます。dependencies { implementation 'com.tealium:kotlin-remotecommand-dispatcher:1.4.0' implementation 'com.tealium:remotecommands:1.0.1' }
手動
RemoteCommands Dispatcherを手動でインストールするには:
-
TealiumのCollect Dispatcherモジュールをダウンロードします。
-
ファイル
tealium-kotlin.remotecommand-1.4.0.aar
をプロジェクトの<PROJECT_ROOT>/<MODULE>/libs
ディレクトリにコピーします。 -
プロジェクトモジュールの
build.gradle
ファイルにTealiumライブラリの依存関係を追加します:dependencies { implementation(name:'tealium-kotlin.remotecommand-1.4.0', ext:'aar') }
リモートコマンドのオプション
リモートコマンドには2つの構成オプションがあります:
- JSONファイル
ベンダーの構成、データマッピング、イベントトリガーを含むJSONファイル。ローカルにロードするか、リモートでホストすることができます。 - リモートコマンドタグ
ベンダーのAPIの構成オプションを提供するiQタグ管理のタグ(Tag Managementモジュールと共に使用)。
リモートコマンドベンダー統合のリストを参照してください。
例
リモートコマンドタグは、Tealium iQタグ管理、アプリ内のJSONファイル、またはリモートサーバー上のJSONファイルを介して構成可能です。リモートコマンドが構成され、モジュールがインストールされたら、初期化に次の行を追加します:
val config = TealiumConfig(application,
"ACCOUNT",
"PROFILE",
Environment.DEV,
dispatchers = mutableSetOf(Dispatchers.RemoteCommands));
var tealium = Tealium.create(TEALIUM_MAIN, config) {
val remoteCommands = RemoteCommand(this);
// register the command
remoteCommands?.add(remoteCommands);
}
val config = TealiumConfig(application,
"ACCOUNT",
"PROFILE",
Environment.DEV,
dispatchers = mutableSetOf(Dispatchers.RemoteCommands));
var tealium = Tealium.create(TEALIUM_MAIN, config) {
val remoteCommands = RemoteCommand(this);
remoteCommands?.add(remoteCommands, filename = "FILENAME.json");
}
val config = TealiumConfig(application,
"ACCOUNT",
"PROFILE",
Environment.DEV,
dispatchers = mutableSetOf(Dispatchers.RemoteCommands));
var tealium = Tealium.create(TEALIUM_MAIN, config) {
val remoteCommands = RemoteCommand(this);
remoteCommands?.add(remoteCommands, remoteUrl = "https://tags.tiqcdn.com/dle/ACCOUNT/PROFILE/FILENAME.json");
}
JSONファイルが構成され、アプリに追加されたかサーバーにホストされた後、さまざまなJSONロードオプションについて学びましょう。
データレイヤー
このモジュールによって追加の変数は導入されません。
APIリファレンス
RemoteCommand()
新しいリモートコマンドオブジェクトを作成し、add
コマンドに渡す準備をします。
val remoteCommand = object : RemoteCommand("commandName", "description") {
override fun onInvoke(response: Response) {
Logger.dev(BuildConfig.TAG, "ResponsePayload for webView RemoteCommand ${response.requestPayload}")
}
}
パラメータ | 説明 | 例 |
---|---|---|
commandName |
必須のStringコマンド名 | "sample" |
description |
リモートコマンドのオプションのString説明 | "testing RCs" |
add()
指定したリモートコマンドをTealiumに登録し、後でトリガーできるようにします。新しいリモートコマンドを追加する前にTealiumを初期化する必要があります。
val tealium = Tealium.create(instanceName, config) {
remoteCommands?.add(remoteCommand)
}
以下は使用例です:
val remoteCommand = object : RemoteCommand("sample", "testing RCs") {
override fun onInvoke(response: Response) {
Logger.dev(BuildConfig.TAG, "ResponsePayload for webView RemoteCommand ${response.requestPayload}")
}
}
val tealium = Tealium.create(instanceName, config) {
remoteCommands?.add(remoteCommand)
}
remove()
以前に登録したリモートコマンドを削除し、再度トリガーされるのを防ぎます。
val tealium = Tealium.create(instanceName, config) {
remoteCommands?.remove("commandName")
}
removeAll
以前に登録したすべてのリモートコマンドを削除します。
val tealium = Tealium.create(instanceName, config) {
remoteCommands?.removeAll()
}
最終更新日 :: 2024年May月15日