モバイルのクイックスタートガイド
インストール
AndroidまたはiOSのTealiumのインストールを開始します。
Mavenを使用してAndroid用のTealiumライブラリをインストールするには、次の手順を実行します。
-
プロジェクトのトップレベルの
build.gradle
ファイルにTealium Maven URLを追加します。allprojects { repositories { mavenCentral() maven { url "https://maven.tealiumiq.com/android/releases/" } } }
-
プロジェクトモジュールの
build.gradle
ファイルに、次のMaven依存関係を追加します。dependencies { implementation 'com.tealium:kotlin-core:1.X.X' }
最新のリリースについては、Githubを確認し、1.X.Xを最新のリリース番号に置き換えてください。
Swift Package Managerを使用してiOS用のTealiumライブラリをインストールするには、次の手順を実行します。
- Xcodeプロジェクトで、File > Swift Packages > Add Package Dependencyを選択します。
- リポジトリのURL
https://github.com/tealium/tealium-swift
を入力します。 - バージョンルールを構成します。通常はUp to next majorが推奨されます。現在のTealium Swiftライブラリのバージョンがリストに表示されない場合は、Swiftパッケージキャッシュをリセットします。
- インストールするモジュールを選択し、Xcodeプロジェクトの各アプリターゲットにモジュールを追加します。追加する場所は、Frameworks > Libraries & Embedded Contentです。
初期化
AndroidまたはiOSのTealiumの初期化を開始します。
Tealiumを初期化するには、TealiumConfig
インスタンスを構成し、Tealium
インスタンスに渡します。Tealium Kotlinライブラリをアプリのグローバルアプリケーションクラス内のonCreate()
メソッドで初期化することを推奨します。
Tealium Kotlinライブラリの管理には、トラッキングヘルパークラスを使用します。これにより、Tealium Kotlinライブラリへの単一のエントリーポイントが提供され、将来のアップグレードが簡素化されます。
object TealiumHelper {
lateinit var tealium: Tealium
fun init(application: Application) {
val tealiumConfig = TealiumConfig(
application,
"ACCOUNT",
"PROFILE",
Environment.DEV,
dataSourceId = "DATASOURCE_ID", //optional
modules = mutableSetOf(VisitorService),
dispatchers = mutableSetOf(TagManagement, Collect)
)
tealium = Tealium.create("tealium_instance", tealiumConfig)
}
}
Tealiumを初期化するには、TealiumConfig
インスタンスをTealium()
コンストラクタに渡します。
Tealium iOSライブラリの管理には、トラッキングヘルパークラスを使用します。これにより、Tealium iOSライブラリへの単一のエントリーポイントが提供され、将来のアップグレードが簡素化されます。
class TealiumHelper {
static let shared = TealiumHelper()
let config = TealiumConfig(account: "ACCOUNT",
profile: "PROFILE",
environment: "ENVIRONMENT",
datasource: "DATASOURCE")
var tealium: Tealium?
private init() {
// 必要な構成オプションを追加
config.batchingEnabled = true
config.logLevel = .debug
// 追加するCollectors - すべてのコンパイル済みのCollectorsを含める必要はありません
config.collectors = [Collectors.Lifecycle,
Collectors.Location,
Collectors.VisitorService]
// 追加するDispatchers - コンパイル済みのDispatchersを含める必要はありません
config.dispatchers = [Dispatchers.TagManagement,
Dispatchers.RemoteCommands]
tealium = Tealium(config: config)
// オプションの初期化後処理
tealium?.dataLayer.add("mykey", "myvalue", expiry: .forever)
}
public func start() {
_ = TealiumHelper.shared
}
class func trackView(title: String, data: [String: Any]?) {
let tealView = TealiumView(title, dataLayer: data)
TealiumHelper.shared.tealium?.track(tealView)
}
class func trackEvent(title: String, data: [String: Any]?) {
let tealEvent = TealiumEvent(title, dataLayer: data)
TealiumHelper.shared.tealium?.track(tealEvent)
}
}
モバイルパブリッシュ構成はデフォルトで有効になっており、使用しない場合は無効にする必要があります。iQ Tag Managementでモバイルパブリッシュ構成を構成するか、config.shouldUseRemotePublishSettings = false
を使用して無効にします。
トラック
AndroidまたはiOSのビューとイベントのトラッキングを開始します。
ビューのトラッキング
画面ビューをトラッキングするには、TealiumView(viewName:dataLayer:)
のインスタンスをtrack()
メソッドに渡します。TealiumView
は、ビュー名(データレイヤーに表示されるtealium_event
として表示される)とオプションのデータディクショナリで構成されています。
ビューをトラッキングするには:
val tealView = TealiumView("screen_view", mutableMapOf("screen_name" to "Home"))
tealium.track(tealView);
ビューをトラッキングするには:
let tealView = TealiumView("screen_view", dataLayer: ["screen_name": "Home"])
tealium?.track(tealView)
イベントのトラッキング
ビュー以外のイベントをトラッキングするには、TealiumEvent(eventName:dataLayer:)
のインスタンスをtrack()
メソッドに渡します。TealiumEvent
は、イベント名(データレイヤーに表示されるtealium_event
として表示される)とオプションのデータディクショナリで構成されています。
イベントをトラッキングするには:
val tealEvent = TealiumEvent("user_login", mutableMapOf("customer_id" to "1234567890"))
tealium.track(tealEvent);
イベントをトラッキングするには:
let tealEvent = TealiumEvent("user_login", dataLayer: ["customer_id": "1234567890"])
tealium?.track(tealEvent)
track()
メソッドは、TealiumDispatch
のTealiumEvent
タイプを受け入れてイベントをトラッキングします。TealiumEvent
は、イベント名とオプションのデータディクショナリで構成されています。
データレイヤー
AndroidまたはiOSの共通のデータレイヤーの値と各モジュールが提供するデータの管理を開始します。
データをデータレイヤーに追加するには:
String
値を構成するには、putString()メソッドを使用します:
tealium.dataLayer.putString("my_string", "my_string_value")
同様に、異なるデータ型に対しては、put
で始まるメソッドを使用します。たとえば、整数の場合はputInt()、浮動小数点数の配列の場合はputDoubleArray()などです。さまざまなデータ型のメソッドについて詳しくは、ドキュメントを参照してください。
1日後に期限切れになるString
値を構成するには:
tealium.dataLayer.putString("my_string", "my_string_value", Expiry.afterTimeUnit(1, TimeUnit.DAYS))
データの有効期限についての詳細は、有効期限の種類を参照してください。
任意の型の値を構成するには、add()
メソッドを使用します:
tealium.dataLayer.add(key: "my_value", value: 123456)
1日後に期限切れになる任意の型の値を構成するには:
tealium?.dataLayer.add(key: "my_value", value: 123456, expiry: .afterCustom((.days, 1)))
IDの解決
Tealiumの匿名IDを使用し、独自のユーザー識別子を構成する方法を学びます。
匿名ID
Tealiumライブラリは、アプリが初めて起動されたときに一意の永続的な匿名IDを生成します。この値はvisitorId
に格納されます。この値は、各トラッキングイベントにtealium_visitor_id
として属性として含まれます。
visitor IDを取得するには:
class TealiumHelper {
lateinit var tealium: Tealium
fun getVisitorId(): String {
return tealium.visitorId
}
}
visitor IDを取得するには:
class TealiumHelper {
var tealium: Tealium?
var visitorId: String? {
tealium?.visitorId
}
}
Tealium AudienceStreamを使用している場合、visitorId
は訪問に関連付けられた匿名IDです。AudienceStreamの匿名IDについて詳しくはこちらをご覧ください。
ユーザー識別子
既知のユーザーを識別する場合は、永続的なデータストレージにユーザー識別子属性を追加します。
AudienceStreamのユーザー識別子について詳しくはこちらをご覧ください。
顧客IDなどのユーザー識別子を追加するには:
fun setKnownVisitorId(id: String) {
tealium.dataLayer.putString("customer_id", id, Expiry.FOREVER)
}
顧客IDなどのユーザー識別子を追加するには:
func setKnownVisitorId(_ id: String) {
tealium?.dataLayer.add(key: "customer_id", value: id, expiry: .forever)
}
検証
ログファイルの検査、トレースの実行、ライブイベントの表示によってデータを検証します。
ログ
AndroidまたはiOSのログについて詳しくは、以下を参照してください。
トレース
AndroidまたはiOSのトレースについて詳しくは、以下を参照してください。
トレースに参加するには、joinTrace()メソッドを呼び出します:
Tealium["INSTANCE_NAME"]?.joinTrace("TRACE_ID")
トレースから退出するには、leaveTrace()メソッドを呼び出します:
Tealium["INSTANCE_NAME"]?.leaveTrace()
トレースに参加するには、joinTrace()メソッドを呼び出します:
tealium?.joinTrace(id: "TRACE_ID")
トレースから退出するには、leaveTrace()メソッドを呼び出します:
tealium?.leaveTrace()
モバイルトレースツールは、デバイスでスキャン可能なQRコードを提供することで、TealiumモバイルSDKからのイベントを素早く表示できるようにするトレース機能をエンリッチメントします。
ライブイベント
Tealium EventStreamのライブイベント機能は、すべてのTealiumのお客様が使用できます。モバイルのインストールをトラブルシューティングするために使用します。
ライブイベントの詳細についてはこちらをご覧ください。
最終更新日 :: 2024年May月15日