curl -i -X POST https://capi.profound.click/v1/events \
-H "Authorization: Bearer YOUR_CAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91",
"pixel_id": "YOUR_PIXEL_ID",
"event_name": "order_created",
"event_type": "standard",
"ts_client": '"$(( $(date +%s) * 1000 ))"',
"dedup_key": "ord_8843291001",
"anon_id": "anon_7c1e9b42",
"click_ids": { "oppref": "YOUR_OPPREF" },
"utm_pf_ad_id": "YOUR_PF_AD_ID",
"utm_pf_ad_provider": "openai",
"props": { "amount": 1999, "currency": "USD" },
"consent": { "storage": true, "send": true, "share_ads": false }
}'
{
"status": "queued",
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91"
}
Conversions API
コンバージョンイベントを送信する
Profound のブラウザーピクセルのコンバージョンイベントを記録する
POST
/
v1
/
events
curl -i -X POST https://capi.profound.click/v1/events \
-H "Authorization: Bearer YOUR_CAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91",
"pixel_id": "YOUR_PIXEL_ID",
"event_name": "order_created",
"event_type": "standard",
"ts_client": '"$(( $(date +%s) * 1000 ))"',
"dedup_key": "ord_8843291001",
"anon_id": "anon_7c1e9b42",
"click_ids": { "oppref": "YOUR_OPPREF" },
"utm_pf_ad_id": "YOUR_PF_AD_ID",
"utm_pf_ad_provider": "openai",
"props": { "amount": 1999, "currency": "USD" },
"consent": { "storage": true, "send": true, "share_ads": false }
}'
{
"status": "queued",
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91"
}
組織が所有するピクセルのコンバージョンイベントを 1 件記録します。
フィールド名とイベント名はブラウザーピクセルのイベントと同じです。API は、認識できないフィールドを含むリクエストを拒否します。
次のフィールドは Profound が自動で設定します。これらのいずれかを含むリクエストは拒否されます:
202 レスポンスは、Profound がイベントをキューに追加したことを意味します。それ以外のステータスは、Profound がイベントを記録しなかったことを意味します。
認証
string
必須
Bearer <your key> 形式の Bearer 認証ヘッダー。キーは pfck_ で始まります。キーの生成方法については、Conversions API を使い始めるを参照してください。リクエストフィールド
string
必須
お客様が生成する UUID。同じコンバージョンを再試行する際は、毎回同じ値を再利用してください。
string
必須
最大 128 文字。お客様の組織に属している必要があります。
string
必須
最大 128 文字。イベントリファレンスを参照してください。
string
必須
standard または custom。Profound は event_name からこの値を導き出します。標準イベントの名前であれば standard、それ以外は custom です。一致しない場合は拒否されます。object
必須
storage、send、share_ads (いずれもブール値)。send は必須で、true である必要があります。他の 2 つのデフォルトは false です。同意と個人データを参照してください。string
最大 256 文字。
utm_pf_ad_provider と一緒に送信してください。string
最大 128 文字。現在 Profound が使用しているプロバイダーは
openai のみです。string
最大 128 文字。ブラウザーのピクセルが保存した訪問者 ID です。
object
external_user_id と external_account_id (それぞれ最大 256 文字)。不透明な ID のみを指定してください。object
first と last: ブラウザーのピクセルが記録した獲得チャネルです。object
url、referrer、title (それぞれ最大 2,048 文字)。page を送信する場合は、3 つすべてを送信してください。string
同意状態の取得元 (例:
onetrust、tcf、explicit)。認識できない値は unknown として保存されます。integer
1 のみ受け付けられ、これがデフォルトです。ingest_id、ts_server、ip_address、origin、query_params、user_agent、channel、org_id。
イベント時刻
ts_client はコンバージョンが発生した時点であり、イベントを送信した時点ではありません。過去 7 日以内で、かつ未来の時刻であれば 5 分以内である必要があります。1 週間より古いイベントは、誤った日付で記録されるのではなく拒否されます。
レスポンス
string
queued。string
送信した
event_id。アトリビューション
アトリビューションフィールドは必須ではありませんが、これらを含まないリクエストはどの広告にも紐づけられません。ブラウザーのピクセルはアトリビューションの値をお客様のドメインのファーストパーティ Cookie に保存するため、これらの値を含むのは訪問者のブラウザーからのリクエストだけです。決済 Webhook など、ブラウザー以外からのリクエストによってコンバージョンが後から確定する場合は、それ以前のブラウザーからのリクエスト (例: チェックアウト時) で Cookie を読み取り、注文と一緒に保存しておき、イベントを送信する際にその値をコピーしてください。| 送信するフィールド | 読み取る Cookie | Cookie の内容 | 有効期間 |
|---|---|---|---|
click_ids | _pf_clk | クリック ID 名 (oppref、utm_adid、gclid) をキーとする URL エンコードされた JSON | 90 日 |
utm_pf_ad_id と utm_pf_ad_provider | _pf_id | URL エンコードされた JSON。広告 ID は ai、そのプロバイダーは ap に格納されています | 365 日 |
ヒント
- クリック ID は
click_idsで送信します。 OpenAI のopprefなど、広告プラットフォームがランディング URL にクリック ID を追加した場合は、コンバージョンをその広告に紐づけられるようclick_idsで送信してください。 - 広告のペアは一緒に送信します。 Profound は
utm_pf_ad_providerなしのutm_pf_ad_idも受け付けますが、その場合はコンバージョンを広告に紐づけることができません。両方を送信するか、どちらも送信しないでください。OpenAI の広告の場合、プロバイダーの値はopenaiです。 - どちらの Cookie にもストレージの同意が必要です。 訪問者がストレージを拒否した場合、ブラウザーのピクセルはこれらの Cookie を書き込まないため、送信する値はありません。
重複排除
- 同じコンバージョンが複数回送信された場合: Profound は、同じピクセルで同じ
event_idを持つ 2 つのイベントを 1 つとしてカウントします。リクエストを再試行する際は ID を再利用し、新しいコンバージョンの場合にのみ新しい ID を生成してください。Profound は、重複したイベントを受信後まもなく削除します。 - ブラウザーのピクセルとこの API から同じ注文が送信された場合: ブラウザーのピクセルもその注文のイベントを送信する場合は、両方のイベントで同じ
dedup_key(お客様の注文 ID) を送信してください。Profound は両方のイベントにこの値を保存し、ペアを照合できるようにします。
同意と個人データ
consent.send は true である必要があり、そうでない場合 Profound はイベントを拒否します。consent.share_ads は広告プラットフォームとの共有に関する別個の許可であり、send によって暗黙的に許可されるものではありません。コンバージョン発生時に同意管理ツールが記録した同意状態をそのまま渡してください。各許可が何を制御するかについては、同意とプライバシーを参照してください。
メールアドレス、氏名、その他の個人識別子をイベントに含めないでください。props と page については、Profound が識別子を除去したうえでイベントを保持します。それ以外の click_ids、identity、dedup_key、event_name などのフィールドでは、識別子が検出されるとリクエスト全体が拒否されます。dedup_key、identity、広告のペアについては、メールアドレス、カード番号、社会保障番号のみがチェックされるため、書式設定された数字で構成される注文 ID は問題ありません。その他のすべてのフィールドでは、電話番号のように見える値も拒否されます。
Profound は接続から何も導き出しません。IP アドレス、地域、ユーザーエージェントは取得しません。このエンドポイントを呼び出すアドレスはお客様のサーバーであり、訪問者ではありません。
curl -i -X POST https://capi.profound.click/v1/events \
-H "Authorization: Bearer YOUR_CAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91",
"pixel_id": "YOUR_PIXEL_ID",
"event_name": "order_created",
"event_type": "standard",
"ts_client": '"$(( $(date +%s) * 1000 ))"',
"dedup_key": "ord_8843291001",
"anon_id": "anon_7c1e9b42",
"click_ids": { "oppref": "YOUR_OPPREF" },
"utm_pf_ad_id": "YOUR_PF_AD_ID",
"utm_pf_ad_provider": "openai",
"props": { "amount": 1999, "currency": "USD" },
"consent": { "storage": true, "send": true, "share_ads": false }
}'
{
"status": "queued",
"event_id": "3f9c1b04-8d24-4b7a-9f10-2c5d8e7b4a91"
}
このページは役に立ちましたか？