turbine 自由変数

メモ

Adobe Experience Platform Launch は、Adobe Experience Platform のデータ収集テクノロジースイートとしてリブランドされています。 その結果、製品ドキュメント全体でいくつかの用語の変更がロールアウトされました。 用語の変更点の一覧については、次のドキュメントを参照してください。

turbine オブジェクトは、拡張機能のライブラリモジュールの範囲内の「自由変数」です。Adobe Experience Platform タグのランタイムに固有の情報とユーティリティを提供し、require() を使用しなくてもライブラリモジュールでいつでも利用できます。

buildInfo

console.log(turbine.buildInfo.turbineBuildDate);

turbine.buildInfo は、現在のタグのランタイムライブラリに関するビルド情報を含むオブジェクトです。

{
    turbineVersion: "14.0.0",
    turbineBuildDate: "2016-07-01T18:10:34Z",
    buildDate: "2016-03-30T16:27:10Z"
}
プロパティ 説明
turbineVersion 現在のライブラリ内で使用されている Turbine バージョン。
turbineBuildDate コンテナ内で使用されている Turbine のバージョンが作成された日付(ISO 8601 形式)。
buildDate 現在のライブラリが構築された日付(ISO 8601 形式)。

environment

console.log(turbine.environment.stage);

turbine.environment は、ライブラリがデプロイされている環境に関する情報を含むオブジェクトです。

{
    id: "ENbe322acb4fc64dfdb603254ffe98b5d3",
    stage: "development"
}
プロパティ 説明
id 環境のID。
stage このライブラリが構築された環境。指定できる値はdevelopmentstagingproductionです。

debugEnabled

タグデバッグが現在有効になっているかどうかを示すboolean値。

メッセージをログに記録するだけの場合、これを使用する必要はありません。代わりに、常に turbine.logger を使用してメッセージをログに記録し、タグのデバッグが有効になっている場合にのみメッセージがコンソールに出力されるようにします。

getDataElementValue

console.log(turbine.getDataElementValue(dataElementName));

データ要素の値が返されます。

getExtensionSettings

var extensionSettings = turbine.getExtensionSettings();

拡張機能の設定ビューから最後に保存された設定オブジェクトが返されます。

返される設定オブジェクト内の値は、データ要素から取得した値である可能性があることに注意してください。このため、データ要素の値が変更されている場合、異なる時間に getExtensionSettings() を呼び出すと、違う結果が返されることがあります。最新の値を取得するには、できるだけ長い間待ってから、getExtensionSettings() を呼び出してください。

getHostedLibFileUrl

var loadScript = require('@adobe/reactor-load-script');
loadScript(turbine.getHostedLibFileUrl('AppMeasurement.js')).then(function() {
  // Do something ...
})

hostedLibFiles プロパティは、タグのランタイムライブラリとともに様々なファイルをホストするために、拡張機能マニフェスト内で定義できます。このモジュールによって、指定されたライブラリファイルがホストされている URL が返されます。

getSharedModule

var mcidInstance = turbine.getSharedModule('adobe-mcid', 'mcid-instance');

別の拡張機能から共有されているモジュールを取得します。一致するモジュールが見つからない場合は、undefined が返されます。共有モジュールの詳細については、共有モジュールの実装に関するページを参照してください。

logger

turbine.logger.error('Error!');

ログユーティリティは、コンソールにメッセージを記録するために使用します。ユーザーがデバッグを有効にしている場合、メッセージはコンソールのみに表示されます。デバッグを有効にするには、 Adobe Experience Cloud Debugger を使用することをお勧めします。別の方法として、ユーザーはブラウザー開発者コンソール内で次のコマンド _satellite.setDebug(true) を実行できます。ロガーには次のメソッドがあります。

  • logger.log(message: string):コンソールにメッセージを記録します。
  • logger.info(message: string):コンソールに情報メッセージを記録します。
  • logger.warn(message: string):コンソールに警告メッセージを記録します。
  • logger.error(message: string):コンソールにエラーメッセージを記録します。
  • logger.debug(message: string):デバッグメッセージをコンソールに記録します。(ブラウザーコンソール内でverbose ログが有効になっている場合にのみ表示されます)
  • logger.deprecation(message: string):ユーザーがタグデバッグを有効にしているかどうかに関する警告メッセージをコンソールに記録します。

onDebugChanged

コールバック関数を turbine.onDebugChanged に渡すと、タグは、デバッグが切り替えられるたびにコールバックを呼び出します。タグ は、デバッグが有効な場合は true、デバッグが無効な場合は false のブール値をコールバック関数に渡します。

メッセージをログに記録するだけの場合、これを使用する必要はありません。代わりに、常に turbine.logger を使ってメッセージをログに記録すると、タグデバッグが有効な場合にメッセージがコンソールにのみ出力されます。

propertySettings

console.log(turbine.propertySettings.domains);

現在のタグのランタイムライブラリのプロパティに対してユーザーが定義する、次の設定を含むオブジェクト:

  • propertySettings.domains: Array<String>

    プロパティの対象となるドメインの配列です。

  • propertySettings.undefinedVarsReturnEmpty: boolean

    拡張機能の開発者は、この設定を気に掛ける必要はありません。

このページ