リモートコマンド:FullStory
AndroidおよびSwift/iOSのFullStoryに対するTealiumリモートコマンドの統合。
要件
- 以下のいずれかのモバイルライブラリ:
- Tealium for Android-Kotlin (1.0.0+)
- Tealium for Android-Java (FullStory 1.0.0+の場合は5.9.0+、それ以前のバージョンの場合は5.9.0未満)
- Tealium for iOS-Swift
- 以下のいずれかのリモートコマンド統合:
- FullStoryリモートコマンドJSONファイル (Android-Kotlin 1.0.0+またはiOS-Swift 2.1.0+が必要)
- FullStoryリモートコマンドタグをTealium iQタグ管理に追加
動作方法
FullStory統合には3つのコンポーネントが使用されます:
- FullStoryネイティブSDK。
- FullStoryメソッドをラップするリモートコマンドモジュール。
- イベントトラッキングをネイティブのFullStory呼び出しに変換するJSON構成ファイルまたはリモートコマンドタグ。
FullStoryリモートコマンドモジュールをアプリに追加すると、必要なFullStoryライブラリが自動的にインストールおよびビルドされます。依存関係マネージャーのインストールを使用している場合は、FullStory SDKを別途インストールする必要はありません。
CocoaPodsまたはCarthageを依存関係マネージャーとして使用している場合は、ビルドスクリプトとして追加するためにFullStoryコマンドラインツールを手動でダウンロードする必要があります。
リモートコマンドのオプションは2つあります:
- JSON構成ファイル(推奨)を使用し、リモートまたはアプリ内でホストします。
- iQタグ管理を使用してマッピングを構成し、ベンダー統合のためにリモートコマンドタグを追加します。
詳細については、ベンダー統合を参照してください。
インストール
依存関係マネージャー
以下の依存関係マネージャーのいずれかを使用してモジュールをインストールすることをお勧めします:
- Xcodeプロジェクトで、「ファイル」>「パッケージの追加…」>「パッケージの依存関係を追加」を選択します。
- 次のリポジトリURLを入力します:
https://github.com/tealium/tealium-ios-fullstory-remote-command
。 - バージョンルールを構成します。
次のメジャーバージョンまで
の構成をお勧めします。現在のTealiumFullstory
バージョンがリストに表示されない場合は、Swiftパッケージキャッシュをリセットします。 - インストールする
TealiumFullstory
モジュールを選択し、モジュールをインストールするアプリのターゲットを選択します。
プロジェクトに複数のアプリターゲットがある場合で、TealiumFullstory
モジュールを複数のアプリターゲットに追加する必要がある場合は、フレームワーク、ライブラリ、および埋め込みコンテンツセクションに手動で追加する必要があります。
追加のアプリターゲットにTealiumFullstory
を追加するには:
- プロジェクトナビゲーターでXcodeプロジェクトを選択します。
- Xcodeプロジェクトで、TARGETSセクションのアプリターゲットを選択します。
- 一般 > フレームワーク、ライブラリ、および埋め込みコンテンツに移動し、
TealiumFullstory
モジュールをアプリターゲットに追加します。
Tealium Swiftライブラリから追加のモジュールを追加するには、Swift Package Managerの手順に従ってください。
CocoaPodsを使用してiOSのFullStoryリモートコマンドをインストールするには:
- すでにPodfileに
tealium-swift
が存在する場合は、削除します。tealium-swift
の依存関係は、TealiumFullstory
フレームワークにすでに含まれています。 - Podfileに次の依存関係を追加します:
pod "TealiumFullstory"
TealiumFullstory
ポッドには、次のTealiumSwift
の依存関係が含まれています:
'tealium-swift/Core'
'tealium-swift/TealiumRemoteCommands'
'tealium-swift/TealiumTagManagement'
TealiumSwift
およびTealiumFullstory
モジュールをTealiumHelper
ファイルおよびTealium
クラスまたはFullStoryリモートコマンドにアクセスする他のファイルにインポートします。
Carthageを使用してiOSのFullStoryリモートコマンドをインストールするには:
- Cartfileから
tealium-swift
を削除します。tealium-swift
の依存関係は、TealiumFullstory
フレームワークにすでに含まれています。 - Cartfileに次の依存関係を追加します:
github "tealium/tealium-ios-fullstory-remote-command"
Mavenを使用してAndroidのFullStoryリモートコマンドをインストールするには:
- 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
ファイルに次の依存関係を追加して、FullStory SDKとTealium-FullStoryリモートコマンドをインポートします:
dependencies {
implementation 'com.tealium.remotecommands:fullstory:1.0.0'
}
- App/Module
build.gradle
にFullStory Gradleプラグインを追加します。利用可能なプロパティで<PLUGIN PROPERTIES>
を置き換えます:
fullstory {
<PLUGIN PROPERTIES>
}
手動インストール(iOS)
FullStoryリモートコマンドの手動インストールには、Tealium for Swiftライブラリのインストールが必要です。iOSプロジェクトにFullStoryリモートコマンドをインストールするには、次の手順に従ってください:
- FullStory SDKをインストールします(まだ行っていない場合)。
- Tealium iOS FullStoryリモートコマンドリポジトリをクローンし、
Sources
フォルダ内のファイルをプロジェクトにドラッグします。 Dispatchers.RemoteCommands
をディスパッチャーとして追加します。remoteAPIEnabled
構成フラグをtrue
に構成します。
初期化
すべてのTealiumライブラリに対して、初期化時にFullStoryリモートコマンドを登録します。
Android(Kotlin)
Android(Java)ライブラリのTealiumのJSON構成ファイルまたはリモートコマンドタグを使用してリモートコマンドを初期化します。
ローカルファイルオプションを使用して、JSONリモートコマンド機能を使用する場合のコードは次のとおりです:
val config = TealiumConfig(application,
"ACCOUNT",
"PROFILE",
Environment.DEV,
dispatchers = mutableSetOf(Dispatchers.RemoteCommands));
var tealium = Tealium.create(TEALIUM_MAIN, config) {
// FullStoryリモートコマンドの初期化
val fullstoryCommand = FullStoryRemoteCommand()
// コマンドを登録
remoteCommands?.add(fullstoryCommand, filename =
"tealium-fullstory.json")
}
リモートコマンドタグ機能を使用する場合のコードは次のとおりです:
val config = TealiumConfig(application,
"ACCOUNT",
"PROFILE",
Environment.DEV,
dispatchers = mutableSetOf(Dispatchers.RemoteCommands));
var tealium = Tealium.create(TEALIUM_MAIN, config) {
// FullStoryリモートコマンドの初期化
val fullstoryCommand = FullStoryRemoteCommand()
// コマンドを登録
remoteCommands?.add(fullstoryCommand)
}
Android(Java)
AndroidのJSONリモートコマンドファイル機能は、Kotlin SDKのみで利用可能です。
リモートコマンドタグ機能を使用する場合のコードは次のとおりです:
Tealium.Config config = Tealium.Config.create(application, "ACCOUNT",
"PROFILE", "ENVIRONMENT");
Tealium teal = Tealium.createInstance(TEALIUM_MAIN, config);
FullstoryRemoteCommand fullstory = new FullstoryRemoteCommand();
// コマンドを登録
teal.addRemoteCommand(fullstory);
iOS(Swift)
iOS(Swift)ライブラリのTealiumのJSON構成ファイルまたはリモートコマンドタグを使用してリモートコマンドを初期化します。
ローカルファイルオプションを使用して、JSONリモートコマンド機能を使用する場合のコードは次のとおりです:
var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
profile: "PROFILE",
environment: "ENVIRONMENT",
dataSource: "DATASOURCE",
optionalData: nil)
config.dispatchers = [Dispatchers.TagManagement,
Dispatchers.RemoteCommands]
config.remoteAPIEnabled = true // リモートコマンドを使用するために必要
tealium = Tealium(config: config) { _ in
guard let remoteCommands = self.tealium?.remoteCommands else {
return
}
let fullstory = FullstoryRemoteCommand(type: .local(file:
"fullstory"))
remoteCommands.add(fullstory)
}
リモートコマンドタグ機能を使用する場合のコードは次のとおりです:
var tealium : Tealium?
let config = TealiumConfig(account: "ACCOUNT",
profile: "PROFILE",
environment: "ENVIRONMENT",˜˜
dataSource: "DATASOURCE",
optionalData: nil)
config.dispatchers = [Dispatchers.TagManagement,
Dispatchers.RemoteCommands]
config.remoteAPIEnabled = true // リモートコマンドを使用するために必要
tealium = Tealium(config: config) { _ in
guard let remoteCommands = self.tealium?.remoteCommands else {
return
}
let fullstory = FullstoryRemoteCommand()
remoteCommands.add(fullstory)
}
JSONテンプレート
リモートコマンドをJSON構成ファイルを使用して構成する場合は、次のテンプレートを参照して開始します。テンプレートには、標準的なeコマースインストールで使用される一般的なマッピングが含まれています。必要に応じてマッピングを編集します。
{
"config": {},
"mappings": {
"tealium_event": "event_name",
"uid": "uid_str",
"email": "user_variables.email_str",
"phone": "user_variables.phone_str",
"cart_id": "event.cart_id_str",
"product_id": "event.product_id_str",
"price": "event.price_real",
"name": "event.name_str",
"category": "event.categoryProperties"
},
"commands": {
"launch": "logevent",
"identify_user": "identify",
"tealiumSampleEvent": "logevent",
"tealiumSampleEventWithData": "logevent"
}
}
サポートされているメソッド
次のFullStoryメソッドは、FullStoryリモートコマンドタグのデータマッピングを使用してトリガーされます。以下のTealiumコマンドを使用します:
リモートコマンド | FullStoryメソッド |
---|---|
logevent |
logEvent() |
identify |
identifyUser() |
setuservariables |
setUserData() |
FullStory SDKはTealium SDKと一緒にインストールされるため、Tealium FullStoryリモートコマンドタグで提供されていない機能でも、SDKを直接呼び出すことで任意のネイティブFullStory機能をトリガーできます。
SDKのセットアップ
初期化
FullStory SDKは、起動時に自動的に初期化されます。
FullStory開発者ガイド:初期SDKセットアップ
イベントの記録
リモートコマンド | FullStoryメソッド |
---|---|
logevent |
event |
パラメーター | タイプ |
---|---|
eventName (必須) |
String |
eventData |
Map |
FullStory開発者ガイド:イベントの記録
ユーザーの識別
リモートコマンド | FullStoryメソッド |
---|---|
identify |
identifyUser |
パラメーター | タイプ |
---|---|
id (必須) |
String |
data |
Map |
FullStory開発者ガイド:識別
ユーザー変数の構成
リモートコマンド | FullStoryメソッド |
---|---|
setuservariables |
setUserData |
パラメーター | タイプ |
---|---|
data (必須) |
Map |
data
パラメーターは、キーがstrings
で値がデータ型でサフィックスが付いたオブジェクトを受け取ります(例:_str
、_int
、_bool
)。詳細については、FullStoryのカスタムAPIプロパティの構成ドキュメントを参照してください。
FullStory開発者ガイド:ユーザー変数の構成
最終更新日 :: 2024年March月29日