AndroidおよびSwift/iOS向けのTealiumリモートコマンドによるUsabilla連携。
要件
- UsabillaアプリIDとフォームID
- 次のいずれかのモバイルライブラリ:
- Tealium for Android-Kotlin(1.0.0以降)
- Tealium for Android-Java(Usabilla 1.0.0以降の場合は5.9.0以降、以前のバージョンの場合は5.9.0未満)
- Tealium for iOS-Swift
- 次のいずれかのリモートコマンド連携:
- UsabillaリモートコマンドJSONファイル(Android-Kotlin 1.0.0以降またはiOS-Swift 2.1.0以降が必要)
- タグ管理のUsabillaリモートコマンドタグ
仕組み
Usabilla連携では、次の3つの要素を使用します。
- UsabillaネイティブSDK
- Usabillaのメソッドをラップするリモートコマンドモジュール
- イベントトラッキングをUsabillaのネイティブ呼び出しに変換するJSON構成ファイルまたはリモートコマンドタグ
Usabillaリモートコマンドモジュールをアプリに追加すると、必要なUsabillaライブラリが自動的にインストールおよびビルドされます。依存関係マネージャーを使用してインストールする場合、Usabilla SDKを別途インストールする必要はありません。
リモートコマンドには、JSON構成ファイルを使用する方法と、タグ管理を使用してマッピングを構成する方法の2つがあります。ベンダー連携には、リモートでホストするかアプリ内にローカルで配置したJSON構成ファイルを使用することをお勧めします。タグ管理を使用する場合は、ベンダー連携用のリモートコマンドタグを追加します。ベンダー連携の詳細をご覧ください。
インストール
依存関係マネージャー
- Xcodeプロジェクトで、File > Add Packages… > Add Package Dependencyを選択します。
- リポジトリURLとして
https://github.com/tealium/tealium-ios-usabilla-remote-commandを入力します。 - バージョンルールを構成します。通常は
Up to next majorをお勧めします。現在のTealiumUsabillaバージョンがリストに表示されない場合は、Swiftパッケージのキャッシュをリセットしてください。 - インストールする
TealiumUsabillaモジュールを選択し、そのモジュールをインストールするアプリターゲットを選択します。
プロジェクトに複数のアプリターゲットがあり、複数のターゲットでTealiumUsabillaモジュールが必要な場合は、Frameworks, Libraries, and Embedded Contentセクションで手動で追加する必要があります。
追加のアプリターゲットにTealiumUsabillaをインストールするには、次の手順を実行します。
- Project NavigatorでXcodeプロジェクトを選択します。
- XcodeプロジェクトのTARGETSセクションでアプリターゲットを選択します。
- General > Frameworks, Libraries & Embedded Contentに移動し、
TealiumUsabillaモジュールを選択してアプリターゲットに追加します。
Tealium Swiftライブラリから追加のモジュールを追加するには、Swift Package Managerの手順に従ってください。
Podfileに
tealium-swiftおよびpod "Usabilla"がすでに存在する場合は、それらを削除します。tealium-swiftの依存関係は、すでにTealiumUsabillaフレームワークに含まれています。次の依存関係をPodfileに追加します。
pod "TealiumUsabilla"TealiumUsabillaPodには、次のTealiumSwift依存関係が含まれています。'tealium-swift/Core' 'tealium-swift/TealiumDelegate' 'tealium-swift/RemoteCommands' 'tealium-swift/TagManagement'TealiumHelperファイル、およびTealiumクラスまたはUsabillaリモートコマンドにアクセスするその他のファイルに、TealiumSwiftモジュールとTealiumUsabillaモジュールをインポートします。
Cartfileから
tealium-swiftを削除します。tealium-swiftの依存関係は、すでにTealiumUsabillaフレームワークに含まれています。Cartfileに次の行が存在する場合は削除します。
github "usabilla/usabilla-u4a-ios-swift-sdk"次の依存関係をCartfileに追加します。
github "tealium/tealium-ios-usabilla-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ファイルに次の依存関係を追加して、Tealium-Usabillaリモートコマンドをインポートします。dependencies { implementation 'com.tealium.remotecommands:usabilla:1.0.0' }
手動インストール
Usabillaリモートコマンドを手動でインストールするには、Tealium for Swiftライブラリがインストールされている必要があります。iOSプロジェクトにUsabillaリモートコマンドをインストールするには、次の手順を実行します。
まだインストールしていない場合は、Usabilla SDKをインストールします。
Tealium iOS Usabillaリモートコマンドリポジトリをクローンし、
Sourcesフォルダー内のファイルをプロジェクトにドラッグします。remoteAPIEnabled構成フラグをtrue.に構成します。
Usabillaリモートコマンドを手動でインストールするには、Tealium for Android(Kotlin)またはTealium for Android(Java)がインストールされている必要があります。
AndroidプロジェクトにBranchリモートコマンドをインストールするには、次の手順を実行します。
プロジェクトルートの
build.gradleファイルにflatDirを追加します。allprojects { repositories { mavenCentral() flatDir { dirs 'libs' } } }tealium-usabilla.aarを<PROJECT_ROOT>/<MODULE>/libsに追加します。Tealiumライブラリの依存関係を
build.gradleファイルに追加します。dependencies { implementation(name:'tealium-usabilla', ext:'aar') }
初期化
すべての Tealium ライブラリで、初期化時に Usabilla リモートコマンドを登録する必要があります。
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 usabilla = UsabillaRemoteCommand()
// Local JSON
//let usabilla = UsabillaRemoteCommand(type: .local(file: "usabilla"))
// Remote JSON
//let usabilla = UsabillaRemoteCommand(type: .remote(url: "https://some.domain.com/usabilla.json"))
remoteCommands.add(usabilla)
}
JSON 構成ファイルまたは Remote Command タグを使用して、Tealium の Android(Kotlin)ライブラリ用リモートコマンドを初期化します。
val config = TealiumConfig(application,
"ACCOUNT",
"PROFILE",
Environment.DEV,
dispatchers = mutableSetOf(Dispatchers.RemoteCommands, Dispatchers.TagManagement));
val usabilla = UsabillaRemoteCommand(TEALIUM_MAIN, config);
var tealium = Tealium.create(TEALIUM_MAIN, config) {
// Webview Tag
remoteCommands?.add(usabilla);
// Local JSON
//remoteCommands?.add(usabilla, filename = "usabilla.json");
// Remote JSON
//remoteCommands?.add(usabilla, remoteUrl = "https://some.domain.com/usabilla.json");
}
Usabilla SDK では、追加の(オプションの)初期化パラメータを使用できます。
usabillaHttpClient = nullHttpClientオブジェクトをオーバーライドし、SDK が行うすべての接続を処理するカスタムクライアントを挿入できるようにします。詳しくは、カスタム HTTP クライアントを参照してください。usabillaReadyCallback = null
初期化プロセスの終了を通知するために使用されるコールバックであるUsabillaReadyCallbackオブジェクトをオーバーライドします。autoFragmentManager = false
デフォルトで有効になっているパッシブフィードバックを無効にします。パッシブフィードバックでは、Android のFragmentManagerを最新の状態に維持し、android.app.Application.ActivityLifecycleCallbacksを使用して監視する必要があります。autoFeedbackHandler = false
パッシブおよびキャンペーンのフィードバックフォームに関するイベントトラッキングの処理と、送信または閉じられたフォームの自動削除を無効にします(デフォルトでは有効)。パッシブとキャンペーンの両方のフィードバックフォームの終了を処理する Usabilla イベントをリッスンするために、2 つのandroid.content.BroadcastReceiverが登録されます。
次の例は、オプションパラメータの使用方法を示しています。
val usabilla = UsabillaRemoteCommand(TEALIUM_MAIN, config,
usabillaHttpClient = null,
usabillaReadyCallback = null,
autoFragmentManager = false,
autoFeedbackHandler = false);
Android の JSON Remote Command ファイル機能は、Kotlin SDK でのみ使用できます。Tealium の Android(Java)ライブラリ用 Remote Command タグを初期化します。
Tealium.Config config = Tealium.Config.create(application, "ACCOUNT", "PROFILE", "ENVIRONMENT");
Tealium teal = Tealium.createInstance(TEALIUM_MAIN, config);
RemoteCommand usabilla = new UsabillaRemoteCommand(TEALIUM_MAIN, config);
teal.addRemoteCommand(usabilla);
Usabilla SDK では、追加の(オプションの)初期化パラメータを使用できます。
usabillaHttpClient = nullHttpClientオブジェクトをオーバーライドし、SDK が行うすべての接続を処理するカスタムクライアントを挿入できるようにします。詳しくは、カスタム HTTP クライアントを参照してください。usabillaReadyCallback = null
初期化プロセスの終了を通知するために使用されるコールバックであるUsabillaReadyCallbackオブジェクトをオーバーライドします。autoFragmentManager = false
デフォルトで有効になっているパッシブフィードバックを無効にします。パッシブフィードバックでは、Android のFragmentManagerを最新の状態に維持し、android.app.Application.ActivityLifecycleCallbacksを使用して監視する必要があります。autoFeedbackHandler = false
パッシブおよびキャンペーンのフィードバックフォームに関するイベントトラッキングの処理と、送信または閉じられたフォームの自動削除を無効にします(デフォルトでは有効)。パッシブとキャンペーンの両方のフィードバックフォームの終了を処理する Usabilla イベントをリッスンするために、2 つのandroid.content.BroadcastReceiverが登録されます。
次の例は、オプションパラメータの使用方法を示しています。
RemoteCommand usabilla = new UsabillaRemoteCommand(TEALIUM_MAIN, config,
usabillaHttpClient = null,
usabillaReadyCallback = null,
autoFragmentManager = false,
autoFeedbackHandler = false);
JSON テンプレート
JSON 構成ファイルを使用してリモートコマンドを構成する場合は、次のテンプレートを参照して作業を開始してください。このテンプレートには、標準的な e コマース実装で使用される一般的なマッピングが含まれています。必要に応じてマッピングを編集してください。
{
"config": {
"appId": "YOUR_APP_ID",
"debugEnabled": true
},
"mappings": {
"event_name": "event",
"display_campaigns": "canDisplayCampaigns",
"dismiss_automatically": "dismissAutomatically",
"form_id": "formId",
"form_ids": "formIds",
"customer_first_name": "custom.customer_first_name"
},
"commands": {
"launch": "initialize",
"display_campaigns": "candisplaycampaigns",
"dismiss": "dismissautomatically",
"button_click": "sendevent",
"load_form": "loadfeedbackform",
"set_variables": "setcustomvariable",
"reset": "resetcampaigndata"
}
}
トラッキング
フォームの読み込みが成功した場合と失敗した場合、およびパッシブフィードバックフォームとキャンペーンフィードバックフォームの両方について、イベントが自動的にトラッキングされます。
サポートされているメソッド
各 Usabilla メソッドまたはプロパティにコマンドをマッピングします。Usabilla のメソッドまたはプロパティをトリガーするには、対応するコマンドを指定された形式で渡します。
| リモートコマンド | Usabilla のメソッド/プロパティ |
|---|---|
initialize | initialize() |
sendevent | sendEvent() |
debugenabled | debugEnabled |
displaycampaigns | canDisplayCampaigns |
loadfeedbackform | loadFeedbackForm() |
preloadfeedbackforms | preloadFeedbackForms() |
removecachedforms | removeCachedForms() |
dismissautomatically | dismissAutomatically |
setcustomvariable | customVariables |
resetcampaigndata | resetCampaignData() |
Since the Usabilla SDK is integrated with the Tealium SDK, you may trigger any native Usabilla functionality given the corresponding tag configuration.
SDK のセットアップ
初期化
Usabilla SDK は起動時に自動的に初期化されます。Usabilla API キーはタグ構成で指定します。
| リモートコマンド | Usabilla メソッド |
|---|---|
initialize | initialize() |
Usabilla 開発者ガイド:SDK の初期セットアップ
デバッグ
| リモートコマンド | Usabilla プロパティ |
|---|---|
debugenabled | debugEnabled |
| パラメーター | 型 |
|---|---|
debugEnabled(必須) | Bool |
Usabilla 開発者ガイド:SDK の初期セットアップ
キャンペーンの切り替え
| リモートコマンド | Usabilla プロパティ |
|---|---|
displaycampaigns | canDisplayCampaigns |
| パラメーター | 型 |
|---|---|
canDisplayCampaigns(必須) | Bool |
Usabilla 開発者ガイド:キャンペーンの切り替え
Campaign toggling is not available for Android
ターゲティングオプション
イベントの送信
| リモートコマンド | Usabilla メソッド |
|---|---|
sendevent | sendEvent() |
| パラメーター | 型 |
|---|---|
event(必須) | String |
Usabilla 開発者ガイド:ターゲティングオプション
カスタム変数の構成
| リモートコマンド | Usabilla プロパティ |
|---|---|
setcustomvariable | customVariables |
| パラメーター | 型 |
|---|---|
custom.###(必須) | String |
Usabilla 開発者ガイド:カスタム変数の構成
フォーム
フィードバックフォームの読み込み
| リモートコマンド | Usabilla メソッド |
|---|---|
loadfeedbackform | loadFeedbackForm |
| パラメーター | 型 | 例 |
|---|---|---|
formId(必須) | String | |
fragmentId(Android のみ) | Integer | R.id.activity_main |
Usabilla 開発者ガイド:フィードバックフォームの読み込み
フィードバックフォームの事前読み込み
| リモートコマンド | Usabilla メソッド |
|---|---|
preloadfeedbackforms | preloadFeedbackForms |
| パラメーター | 型 |
|---|---|
formIds(必須) | [String] |
Usabilla 開発者ガイド:フィードバックフォームの事前読み込み
キャッシュされたフォームの削除
| リモートコマンド | Usabilla メソッド |
|---|---|
removecachedforms | removeCachedForms |
Usabilla 開発者ガイド:キャッシュされたフォームの削除
自動的に閉じる
| リモートコマンド | Usabilla プロパティ |
|---|---|
dismissautomatically | dismissAutomatically |
| パラメーター | 型 |
|---|---|
dismissAutomatically(必須) | Bool |
Usabilla 開発者ガイド:手動で閉じる
リセット
| リモートコマンド | Usabilla プロパティ |
|---|---|
resetcampaigndata | resetCampaignData |
Usabilla 開発者ガイド:すべてのキャンペーンのリセット
最終更新日 :: 2026年November月18日