概要

Kameleoon プラットフォームでは、お客様がさまざまな用途で使用できる複数の API を提供しています。これらの API を使用することで、フロントエンドの A/B 実験の実施、データの取得と送信による Kameleoon の自社デジタルエコシステムへの統合、実験のプログラム的な作成や更新などの特定のタスクの自動化、Product Recommendation および Search Personalization アドオンを利用している場合は商品カタログのインポートまたは更新が可能になります。 Kameleoon には主に 4 つの API グループがあります。

• Activation API(JavaScript API)
• Automation API(REST API)
• Data API(REST API)
• Product Recommendation API(REST API)

この記事では、これらの API の概要を高レベルで提供し、開発者が必要な API を素早く特定して関連ドキュメントへ移動できるようサポートします。

​

Activation API​

Activation API は、Kameleoon Web Experimentation を使用している場合や Feature Experimentation を Hybrid モード で使用している場合に Web サイトにインストールされる Kameleoon アプリケーションファイル engine.js(旧名称 kameleoon.js)に付属する JavaScript API です。この API を使用すると、JavaScript を通じて直接メソッドを呼び出し、さまざまなデータ構造にアクセスできます。さらに、AI Predictive Targeting アドオンで利用可能な、リアルタイムで顧客中心の傾向スコアである Kameleoon Conversion Score (KCS) も提供します。 この API には次のような用途があります。

• ちらつきのないフロントエンドの A/B テストバリエーションを実装するためのメソッドを提供します。これらのメソッドは、Kameleoon プラットフォームの適切な機能とアンチフリッカリング技術の活用に欠かせません。Kameleoon を扱うフロントエンド開発者は、これらに精通しておくべきです。
• コンバージョンデータや訪問者/顧客の特性など、Kameleoon にデータを送信するためのトラッキングメソッドを提供します。これらのメソッドは、Google Analytics などの分析ソリューションが提供するものと同様に機能します。HTML ページに埋め込まれた JavaScript から直接、または Google Tag Manager (GTM) などのタグマネージャーを通じて呼び出すことができます。Kameleoon CommandQueue に関するドキュメントの参照もおすすめします。
• 商品ビュー、購入、カートへの商品追加、自動商品レコメンデーションの取得、ソーシャルプルーフや緊急性のユースケースに使う商品固有の統計情報の取得など、商品関連イベントを追跡するメソッドを提供します。
• Kameleoon によって収集された有用なリアルタイム情報を提供します。たとえば、訪問者のページビューを追跡でき、データはすべての過去の訪問にわたって保存・アクセスできます。現在 5 回目の訪問中であっても、訪問者が最初の訪問でサイトに滞在した時間を判別できます。
• Kameleoon のデフォルトの割り当てバケッティングロジックを上書きするエントリーポイントを提供します。たとえば、訪問者が初めて A/B 実験に割り当てられたとき、そのバリエーションはランダムに決定されます。API を使用すると、この割り当てを上書きして、訪問者を特定のバリエーションに登録できます。

Activation API の完全なドキュメントはこちらです。カスタム JavaScript Kameleoon イベントに関する別途のガイドもあります。

​

Automation API​

Automation API は、Kameleoon App を通じて利用可能なほぼすべての操作をプログラム的にトリガーして実行できる REST API です。これにより、独自のソフトウェアを開発してプラットフォームと連携し、すべての機能や能力を活用できます。 たとえば、当社のクライアントの一部は、この API を使用して Kameleoon を Git リポジトリと統合し、バージョン管理システム内で直接 Kameleoon バリエーションコードを管理しています。カスタムダッシュボードを設計し、Kameleoon から直接実験結果を取得することもできます。この API は使いやすく、Kameleoon と連携・操作するカスタムシステムを簡単に構築できます。 Automation API の完全なドキュメントはこちらです。

​

Data API​

Data API は、訪問者のブラウザにローカルに保存されているのではなく、リモートサーバーに保存されているデータの取得と書き込みを可能にする REST API です。データがブラウザ側で即時利用可能な Activation API とは異なり、この API は外部データソース、リモートサーバー、または DMP との通信向けに設計されています。一方、Automation API とは異なり、1 分間に何百万回もの呼び出しを処理できるため、訪問者単位のリクエストに適しています。 たとえば、Data API は クロスデバイス履歴調整 に使用されます。これは、ユニーク訪問者のあらゆるデバイスにわたる完全なアクション履歴を自動的に同期する強力な Kameleoon の機能です。訪問者がスマートフォンで Web サイトを 2 回閲覧し、その後デスクトップコンピューターで再訪問した場合、Activation API データレイヤーでは正しくその訪問者の 3 回目の訪問として報告されます。その背後では、データ同期を確保するために、当社のサーバーが Data API へ呼び出しを行っています。 もう 1 つの一般的なユースケースは、Activation API を介して直接送信できない「遅延トランザクション」の登録です。たとえば、旅行パッケージを販売しており、最終的なトランザクションまたは確認がオンラインではなく実店舗で対面で発生する場合、この API を使用してそれらのトランザクションを記録できます。これは、Web/JavaScript ベースの API では不可能です。 Data API は REST 準拠の API であるため、Java、C#、NodeJS、Python などの任意の言語の REST 対応フレームワークを使用して呼び出すことができます。REST 規約に従っているため、それに慣れている開発者は簡単に使用できます。 Data API の完全なドキュメントはこちらです。

​

Product Recommendation API​

Product Recommendation API は、商品カタログの効率的な管理と、パーソナライズされた商品および検索レコメンデーションの取得を可能にする RESTful API です。この API は、独自のバックエンドシステムやモバイルアプリケーション内でレコメンデーションロジックを処理したいクライアントに特に有用です。 この API には次のような用途があります。

​

商品カタログ管理​

商品カタログのインポートおよび更新には、次のエンドポイントを使用する必要があります。

• Import Categories – 商品カテゴリを Kameleoon にアップロードします。
• Import Products – カタログに商品を追加または更新します。
• Update Available Products – 商品の在庫状況をリアルタイムで同期します。
• Remove Products – Kameleoon から商品を削除します。

​

商品および検索レコメンデーション​

• Get Product Recommendations – 訪問者の行動に基づいて、パーソナライズされた商品提案を取得します。
• Get Search Recommendations – ユーザークエリに合わせた検索レコメンデーションを取得します。