Shopping Tracker API reference
イベント作成
イベントのリストを受け取り、トラッキングデータとして保存します。
エンドポイント: POST https://cubki.jp/trackers/events/shopping/assistants/ASSISTANT_ID.json
パスパラメータ
Assistant ID
利用する#CBK assistantの識別子。
- プレースホルダー:
ASSISTANT_ID
- 型: 数値 (必須)
- 例:
16
詳細はこちら: Assistant ID
Content Type
application/json
ペイロード
トラッキングID
ユーザーをグローバルに識別するためにに割り当てられる識別子。
識別子の衝突を避けるため、会社名のアルファベット表記等をプレフィックスとして利用することを推奨しています。
トラッキングIDなしにイベントデータを送信することは可能ですが、この値はユーザーの行動を追跡するために利用されるため、トラッキングIDを常に利用することを強く推奨しています。トラッキングIDを持たないイベントデータは分析時に利用されない場合があります。
- フィールド:
trackingId
- 型: 文字列
- 例:
mycompany/47b44a60-d8b8-4374-bd33-8777de8961e3
ネームスペース
イベントデータを分離するための名前。
- フィールド:
namespace
- 型: 文字列 (必須)
- 制約
- 最大64文字
- 例:
website1-tracking
詳細はこちら: ネームスペース
イベントリスト
トラッキング対象のイベントのリスト。
- フィールド:
events
- 型: Eventオブジェクトの配列 (必須)
- 例:
[{ "type": "impression", "productId": "ABC-1" }]
詳細はこちら: イベントオブジェクトの作成
Curlを使ったリクエスト例
リクエストに使用する変数とペイロードを準備します。
$ ASSISTANT_ID=<Your #CBK assistant ID>
$ cat <<PAYLOAD > events.json
{
"events": [
{
"productId": "product-1",
"type": "impression"
},
{
"productId": "product-2",
"type": "impression"
}
],
"namespace": "website1-tracking",
"trackingId": "mycompany/ef5553d9-f5a2-42cb-99dd-26d769f00657"
}
PAYLOAD
作成したペイロードを送信します。
$ curl -X POST -H "Content-Type: application/json" https://cubki.jp/trackers/events/shopping/assistants/${ASSISTANT_ID}.json --data @events.json
{}
レスポンス
- 正常ケース
- Status:
202
- Body: 空JSONオブジェクト (
{}
)
- Status:
- クライアントエラーのケース
- Status:
4xx
(400
-499
) - Body: エラー詳細を含むオブジェクト
- Status: