Kameleoon の Data API は、外部ユーザーに固有のデータの保存と取得、オフラインゴールコンバージョンの管理など、複数の機能を提供する REST API です。Data API を使用して、Kameleoon が自動的に送信した訪問イベント、または Activation API や SDK メソッドを通じて送信した訪問イベントを受信したかどうかを判別できます。この記事では、Data API の GET visit/visitor エンドポイント を使用して、特定のイベントタイプが Kameleoon によって取り込まれたかどうかを確認する方法を説明します。この検証は、トラッキングコードをテストする際に特に役立ちます。以下のセクションでは、これらのイベントをプログラム的に確認する方法を説明します。
イベントパラメーター
前述のとおり、すべてのリクエストは Data API の GET visit/visitor エンドポイント に対して行う必要があります。
実験の露出、カスタムデータ、コンバージョン イベントリクエストの標準パラメーターには次のものが含まれます。
いずれか:
- visitorCode (string): 訪問者に対する Kameleoon の一意の ID。
mappingValue が指定されていない場合は必須です。
または
-
mappingValue (string): 該当する場合、マッピング識別子(訪問者のクロスデバイス ID として機能)として設定されたカスタムデータの値。
visitorCode が指定されていない場合は必須です。
-
siteCode (string): Kameleoon プロジェクトを識別する英数字の一意の文字列。このリンクからこのコードを取得します。
-
currentVisit (string | optional): 現在の訪問に関連するデータを受信するには
true に設定します。Feature Experimentation を利用しているユーザーのみがアクティブな訪問のデータをリクエストできます。
-
リクエストされる特定のイベントに応じて、各リクエストには
true に設定された 1 つの追加のブール値パラメーター(experiment、customdata、または conversion のいずれか)を含める必要があります。以下の例で示しています。
イベントリクエスト
以下は、各イベントに固有のリクエストとレスポンスの形式の例です。
よりユーザーフレンドリーな出力を得るには、リクエストヘッダーに prettyPrint=true パラメーターを含めます。
実験の露出
リクエスト
curl -X GET 'https://eu-data.kameleoon.io/visit/visitor?siteCode=f17c21u1ag&visitorCode=245fc¤tVisit=true&maxNumberPreviousVisits=20&experiment=true'
レスポンス
{
"previousVisits": [
{
"siteCode": "f17c21u1ag",
"visitorCode": "245fc",
"timeStarted": 1748912914969,
"timeLastEvent": 1748912914969,
"experimentEvents": [
{
"itp": false,
"tabId": -218793282,
"time": 1748977476606,
"data": {
"id": 250830,
"variationId": 978588
}
}
]
}
]
}
レスポンス例で、id は実験の ID、variationId は訪問者が露出された実験の特定のバリエーションを表します。
カスタムデータ
リクエスト
curl -X GET 'https://eu-data.kameleoon.io/visit/visitor?siteCode=f17c21u1ag&visitorCode=245fc¤tVisit=true&maxNumberPreviousVisits=20&customdata=true'
レスポンス
{
"previousVisits": [
{
"siteCode": "f17c21u1ag",
"visitorCode": "245fc",
"timeStarted": 1748912914969,
"timeLastEvent": 1748912914969,
"customDataEvents": [
"itp": false,
"tabId": 51426880,
"time": 1748978024982,
"data": {
"index": 1,
"valuesCountMap": {
"true":1
},
"overwrite": true,
"mappingIdentifier": false
},
"itp": false,
"tabId": 51426880,
"time": 1748978024982,
"data": {
"index": 3,
"valuesCountMap": {
"1": 1},
},
"overwrite": false,
"mappingIdentifier": false
]
}
]
}
レスポンス例で、index はカスタムデータの一意の ID です。
コンバージョン
リクエスト
curl -X GET 'https://eu-data.kameleoon.io/visit/visitor?siteCode=f17c21u1ag&visitorCode=245fc¤tVisit=true&maxNumberPreviousVisits=20&conversion=true'
レスポンス
{
"previousVisits": [
{
"siteCode": "f17c21u1ag",
"visitorCode": "245fc",
"timeStarted": 1748912914969,
"timeLastEvent": 1748912914969,
"conversionEvents": [
{
"itp": false,
"time": 1748912914969,
"data": {
"goalId": 361517,
"revenue": 23.5,
"negative": false,
"metadata": {}
}
}
]
}
]
}