Skip to main content
Activation API は JavaScript オブジェクト Kameleoon.API であり、ページのコードがこれを使用して Kameleoon のメソッドを呼び出し、ビジターのブラウザで Kameleoon のデータを読み取ります。Web Experimentation、またはハイブリッドモードの Feature Experimentation を使用するためにウェブサイトにインストールする、Kameleoon アプリケーションファイル engine.js(以前の名称は kameleoon.js)に含まれています。

Activation API の機能

Activation API は次の 4 つの機能を提供します。
  • ちらつきのないバリエーションを実行する: Core モジュールは、ちらつきのないフロントエンドの A/B テストバリエーションを実装するメソッドを提供します。
  • トラッキングデータを送信する: Goals、Data、Products の各モジュールは、コンバージョン、カスタムデータ、製品イベントを Kameleoon に送信します。これらの呼び出しは、Google Analytics などの分析ツールへのトラッキング呼び出しと同様に動作します。
  • リアルタイムのビジットデータを読み取る: Visit オブジェクトには、ビジット中に Kameleoon が収集したデータが含まれます。例えば、ビジターの過去すべてのビジットにおけるページビュー数や、最初のビジット中にウェブサイトに滞在した時間を読み取ることができます。
  • 実験の割り当てを上書きする: Kameleoon がビジターを実験に割り当てるとき、デフォルトではバリエーションをランダムに選択します。Experiments モジュールを使用すると、この割り当てを上書きして、ビジターを特定のバリエーションに登録できます。

Activation API が役立つ理由

この API は完全に JavaScript ベースで、ビジターのブラウザで実行されます。これにより、次のような利点があります。
  • 結果がすぐに返される: ほぼすべてのメソッドは同期的に実行され、すぐに結果を返します。例外は、Products モジュールの製品カタログメソッドのように、サーバー呼び出しを必要とするメソッドです。
  • 認証が不要: API には認証が不要なため、ページのコードでこれを呼び出すための認証情報は必要ありません。
  • ビジターのデータはビジターごとに非公開のまま: ブラウザの標準のセキュリティルールにより、ページがアクセスできるのは、そのビジター自身のデータ(Kameleoon が Local Storage に保存するデータ)のみです。他のビジターのデータにはアクセスできません。
ビジターのブラウザではなく、サーバーから Kameleoon のデータを読み書きする必要がある場合は、代わりに Data API を使用してください。Data API は、外部データソース、リモートサーバー、データ管理プラットフォーム(DMP)に接続します。

エンジンが読み込まれていることを確認する

Activation API の JavaScript オブジェクトを呼び出す前に、Kameleoon エンジンが読み込まれていることを確認してください。トラッキングデータの送信、実験のトリガー、ビジター属性の更新を行う際は、コマンドの遅延実行に Kameleoon の Command Queue を使用します。エンジンが読み込まれていれば、渡されたコマンドや関数は即座に実行されます。読み込まれていない場合は、後で実行するためにキューに入れられます。詳細については、Command queue のドキュメントを参照してください。

モジュール

各モジュールのページには、そのメソッドを引数および戻り値とともに掲載しています。

オブジェクト

これらのオブジェクトは、Activation API のメソッドが返すデータを説明します。各オブジェクトのページには、そのオブジェクトのプロパティが掲載されています。