Adobe Experience Platform Launch のオブジェクト参照

メモ

Adobe Experience Platform Launchは、Experience Platformのデータ収集テクノロジーのスイートとしてリブランドされています。 これらの変更は、今後数週間以内にすべての製品ドキュメントで公開される予定です。 用語の変更点の統合的な参照については、次のドキュメントを参照してください。

このドキュメントは、クライアントサイドの _satellite オブジェクト(Adobe Experience Platform Launch オブジェクトとも呼ばれます)と、それを使用して実行できる様々な関数のリファレンスになります。

track

コード

_satellite.track(identifier: string [, detail: *] )

_satellite.track('contact_submit', { name: 'John Doe' });

指定した識別子を用いて設定された Core 拡張のダイレクト型イベントタイプを使用して、すべてのルールを実行します。上記の例では、ダイレクト型イベントタイプを使用する(contact_submit 識別子が設定されている)すべてのルールをトリガーします。関連情報を含むオプションのオブジェクトも渡されます。詳細オブジェクトにアクセスするには、条件やアクションのテキストフィールド内で「%event.detail%」と入力するか、カスタムコード条件またはアクションのコードエディター内で「event.detail」と入力します。

getVar

コード

_satellite.getVar(name: string) => *

var product = _satellite.getVar('product');

名前が一致するデータ要素が存在する場合、データ要素の値が返されます。一致するデータ要素が存在しない場合は、一致する名前のカスタム変数が、以前に _satellite.setVar() を使用して設定されているかどうかを確認します。一致するカスタム変数が見つかると、その値が返されます。

Platform Launch ユーザーインターフェイスの多くのフォームフィールドでは、%% 構文を使用して変数を参照し、_satellite.getVar() の呼び出しを減らすことができます。たとえば、%product% を使用すると、製品データ要素またはカスタム変数の値にアクセスします。

setVar

コード

_satellite.setVar(name: string, value: *)

_satellite.setVar('product', 'Circuit Pro');

指定した名前と値を持つカスタム変数を設定します。変数の値は、_satellite.getVar() を使用して後でアクセスできます。

オプションとして、キーが変数名、値がそれぞれの変数値であるオブジェクトを渡すことにより、複数の変数を一度に設定できます。

_satellite.setVar({ 'product': 'Circuit Pro', 'category': 'hobby' });

getVisitorId

コード

_satellite.getVisitorId() => Object

var visitorIdInstance = _satellite.getVisitorId();

プロパティに Adobe Experience Cloud ID 拡張機能がインストールされている場合、このメソッドは訪問者 ID インスタンスを返します。詳しくは、Experience Cloud ID サービスのドキュメントを参照してください。

logger

コード

_satellite.logger.log(message: string)
_satellite.logger.info(message: string)
_satellite.logger.warn(message: string)
_satellite.logger.error(message: string)

_satellite.logger.error('No product ID found.');

ブラウザーコンソールにメッセージを記録します。メッセージは、ユーザーが Platform Launch デバッグを有効にして(_satellite.setDebug(true) を呼び出す、または適切なブラウザー拡張機能を使用して)いる場合にのみ表示されます。

ログ取得廃止の警告

_satellite.logger.deprecation(message: string)

_satellite.logger.deprecation('This method is no longer supported, plese use [new example] instead.');

ブラウザーコンソールに警告のログを記録します。ユーザーがPlatform Launchデバッグを有効にしているかどうかに関係なく、メッセージが表示されます。

コード

_satellite.cookie.set(name: string, value: string[, attributes: Object])
_satellite.cookie.get(name: string) => string
_satellite.cookie.remove(name: string)

// Writing a cookie that expires in one week.
_satellite.cookie.set('product', 'Circuit Pro', { expires: 7 });
// Reading a previously set cookie.
var product = _satellite.cookie.get('product');
// Removing a previously set cookie.
_satellite.cookie.remove('product');

cookie を読み書きするユーティリティ。これは、サードパーティのライブラリ js-cookie の公開済みコピーです。より高度な使用方法については、js-cookie の使用に関するドキュメントを参照してください。

buildInfo

コード

_satellite.buildInfo

このオブジェクトには、現在の Platform Launch ランタイムライブラリのビルドに関する情報が含まれています。オブジェクトには、次のプロパティが含まれています。

turbineVersion

現在のライブラリ内で使用されている Turbine バージョン。

turbineBuildDate

コンテナ内で使用されている Turbine のバージョンが作成された日付(ISO 8601 形式)。

buildDate

現在のライブラリが構築された日付(ISO 8601 形式)。

environment

このライブラリが構築された環境。次のいずれかの値となります。

  • 開発
  • ステージング
  • 実稼動

この例では、オブジェクトの値を示します。

{
  turbineVersion: "14.0.0",
  turbineBuildDate: "2016-07-01T18:10:34Z",
  buildDate: "2016-03-30T16:27:10Z",
  environment: "development"
}

notify

メモ

このメソッドは廃止されました。代わりに _satellite.logger.log() を使用してください。

コード

_satellite.notify(message: string[, level: number])

_satellite.notify('Hello world!');

ブラウザーコンソールにメッセージを記録します。メッセージは、ユーザーが Platform Launch デバッグを有効にして(_satellite.setDebug(true) を呼び出す、または適切なブラウザー拡張機能を使用して)いる場合にのみ表示されます。

オプションのログレベルを渡すことができます。ログレベルは、記録されるメッセージのスタイル設定とフィルタリングに影響します。サポートされているレベルは次のとおりです。

3 - 情報メッセージ。

4 - 警告メッセージ。

5 - エラーメッセージ。

ログレベルを指定しない場合や、その他のレベルの値を渡す場合、メッセージは通常のメッセージとして記録されます。

setCookie

メモ

このメソッドは廃止されました。代わりに _satellite.cookie.set() を使用してください。

コード

_satellite.setCookie(name: string, value: string, days: number)

_satellite.setCookie('product', 'Circuit Pro', 3);

ユーザーのブラウザーで cookie を設定します。cookie は指定した日数の間持続します。

readCookie

メモ

このメソッドは廃止されました。代わりに _satellite.cookie.get() を使用してください。

コード

_satellite.readCookie(name: string) => string

var product = _satellite.readCookie('product');

ユーザーのブラウザーから cookie を読み取ります。

removeCookie

メモ

このメソッドは廃止されました。代わりに _satellite.cookie.remove() を使用してください。

コード

_satellite.removeCookie(name: string)

_satellite.removeCookie('product');

ユーザーのブラウザーから cookie を削除します。

デバッグ関数

次の関数は、実稼動コードからはアクセスできません。これらはデバッグ目的のみを目的としており、必要に応じて時間の経過と共に変化します。

container

コード

_satellite._container

重要

この関数は、実稼動コードからはアクセスできません。デバッグ目的のみを目的としており、必要に応じて時間の経過と共に変化します。

monitor

コード

_satellite._monitors

重要

この関数は、実稼動コードからはアクセスできません。デバッグ目的のみを目的としており、必要に応じて時間の経過と共に変化します。

サンプル

Platform Launch ライブラリを実行する Web ページで、コードのスニペットを HTML に追加します。通常、コードは、Platform Launch ライブラリを読み込む <script> タグの前の <head> タグに配置されます。これにより、Platform Launch ライブラリで発生する最も古いシステムイベントを監視できます。次に例を示します。

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Title</title>
  <script>
    window._satellite = window._satellite || {};
    window._satellite._monitors = window._satellite._monitors || [];
    window._satellite._monitors.push({
      ruleTriggered: function (event) {
        console.log(
          'rule triggered',
          event.rule
        );
      },
      ruleCompleted: function (event) {
        console.log(
          'rule completed',
          event.rule
        );
      },
      ruleConditionFailed: function (event) {
        console.log(
          'rule condition failed',
          event.rule,
          event.condition
        );
      }
    });
  </script>
  <script src="//assets.adobedtm.com/launch-EN5bfa516febde4b22b3e7c6f96f6b439f.min.js"
          async></script>
</head>
<body>
  <h1>Click me!</h1>
</body>
</html>

最初のスクリプトタグでは、Platform Launch ライブラリがまだ読み込まれていないので、最初の _satellite のオブジェクトが作成され、_satellite._monitors の配列が初期化されます。次に、スクリプトがそ配列にモニターオブジェクトを追加します。モニターオブジェクトは、次のメソッドを指定できます。これらのメソッドは、後で Platform Launch ライブラリによって呼び出されます。

ruleTriggered

イベントがトリガーされた後、ルールの条件とアクションが処理される前に呼び出されます。ruleTriggered に渡されたイベントオブジェクトには、トリガーされたルールに関する情報が含まれます。

ruleCompleted

ルールが完全に処理された後に呼び出されます。つまり、イベントが発生した場合、すべての条件を満たし、すべてのアクションが実行されました。ruleCompleted に渡されたイベントオブジェクトには、完了したルールに関する情報が含まれます。

ruleConditionFailed

ルールがトリガーされ、その条件の 1 つが失敗した後に呼び出されます。ruleConditionFailed に渡されたイベントオブジェクトには、トリガーされたルールと、失敗した条件に関する情報が含まれます。

ruleTriggered が呼び出されると、その直後に ruleCompleted または ruleConditionFailed が呼び出されます。

メモ

1 つのモニターで、3 つのメソッドすべて(ruleTriggeredruleCompleted、および ruleConditionFailed)を指定する必要はありません。Platform Launch は、モニターで提供されている、あらゆるサポートメソッドで動作します。

モニターのテスト

上記の例では、モニターで 3 つのメソッドをすべて指定しています。呼び出されると、モニターは関連情報を記録します。これをテストするには、Platform Launch ライブラリで 2 つのルールを設定します。

  1. クリックイベントと、ブラウザー情報(ブラウザーが Chrome の場合にのみ渡されます)を含むルール。
  2. クリックイベントと、ブラウザー情報(ブラウザーが Firefox の場合にのみ渡されます)を含むルール。

Chrome でページを開く場合は、ブラウザーコンソールを開いて、ページを選択すると、コンソールに以下が表示されます。

必要に応じて、追加のフックまたは追加の情報をこれらのハンドラーに追加できます。

このページ