インストール

必要条件

Apache Cordova (7.0.0+)
CocoaPods

ライブラリ

このプラグインには以下のTealiumライブラリが含まれています：

バージョン1.1.1+から、フレームワークファイルはプラグインに含まれなくなりました。代わりに、iOSとAndroidのそれぞれの依存関係マネージャーが使用されます。

サンプルアプリ

私たちのライブラリ、トラッキング方法、およびベストプラクティスの実装に慣れるために、Tealium for Cordovaのsample appを探索してください。

Tealium for CordovaはNPMまたは手動でインストールします。

NPM

Node package manager (NPM)は推奨されるインストールタイプです。パッケージ名はtealium-cordova-pluginです。

NPMを介してプラグインをインストールするには、プロジェクトディレクトリ内で次のコマンドを実行します：

cordova plugin add tealium-cordova-plugin

手動

NPMを使用できない場合は、プラグインを手動でインストールできます。

Command-Line Interface (CLI)で次のコマンドを実行します：

cd <YOUR_PROJECT_FOLDER>/
cordova platform add <PLATFORM>
cordova plugin add </LOCAL_PATH_TO_TEALIUM_PLUGIN/>
cordova build <PLATFORM>

初期化

init()メソッドは、次の例に示すようにTealium Cordovaプラグインを初期化します：

tealium.init({
    account                : "ACCOUNT",
    profile                : "PROFILE",
    environment            : "ENVIRONMENT",
    datasource             : "DATASOURCE",
    instance               : "INSTANCE",
    isLifecycleEnabled     : "TRUE_OR_FALSE",
    isCrashReporterEnabled : "TRUE_OR_FALSE",
    logLevel               : tealium.logLevels.DEV,
    collectDispatchProfile : "DISPATCH_PROFILE",
    collectDispatchURL     : "DISPATCH_URL"});

デフォルトでは、コアのiOSとAndroidライブラリはTealium Collectデータをアカウントの"main"プロファイルに送信します。Tealium Collectを別のエンドポイントに向けるには、プロファイルまたはエンドポイントURLを上書きします。

プロファイルの上書き例：

tealium.init({
    account                : "ACCOUNT",
    profile                : "PROFILE",
    environment            : "ENVIRONMENT",
    instance               : window.tealium_instance,
    collectDispatchProfile : "PROFILE"});

エンドポイントURLの上書き例：

tealium.init({
    account            : "ACCOUNT",
    profile            : "PROFILE",
    environment        : "ENVIRONMENT",
    instance           : window.tealium_instance,
    collectDispatchURL : "https://collect.tealiumiq.com/vdata/i.gif?tealium_account=ACCOUNT&tealium_profile=PROFILE"});

ビルドのヒント

アプリのビルドに問題がある場合や、プラットフォームを削除して再追加する必要がある場合は、次のコマンドを実行します。ここで、PLATFORMは"android"または"ios"のいずれかです：

cordova platform rm PLATFORM
cordova platform add PLATFORM

これは通常、物理デバイスのビルド時にXCodeの署名エラーを解決します。

ビルドを実行中にCocoaPodsで問題が発生し、ローカルのCocoaPodsキャッシュをクリアしたい場合は、次のコマンドを実行します：

pod cache clean --all && pod repo update

アンインストール

Tealiumプラグインを削除するには、次のコマンドを実行します：

cordova plugin rm tealium-cordova-plugin

インストールされている場合は、補足的なTealiumモジュールを削除します：

tealium-cordova-crashreporter
tealium-cordova-adidentifier
tealium-cordova-installreferrer

Ionic Framework

TealiumのCordovaプラグインはIonic Frameworkのサポートを提供します。インストールするには次のコマンドを実行します：

ionic cordova plugin add tealium-cordova-plugin
npm install @ionic-native/tealium

次の例はIonic Frameworkの使用方法を示しています：

import { Tealium, TealConfig } from '@ionic-native/tealium/ngx';

constructor(private tealium: Tealium) { }

//...

let tealConfig: TealConfig = {
   account: "ACCOUNT",
   profile: "PROFILE",
   environment: "ENVIRONMENT",      // one of "dev", "qa" or "prod"
   isLifecycleEnabled: "true",      // enable lifecycle tracking
   isCrashReporterEnabled: "false", // disable crash reporter (Android only)
   instance: "INSTANCE"             // use the same instance name for all subsequent API calls
}

this.tealium.init(tealConfig).then(()=>{
   this.tealium.trackView({"screen_name": "homescreen"});
});