コンバージョンAPI

コンバージョンAPIゲートウェイ: ウェブ以外のサーバーイベントAPIのサポート

v1.6.0以降、コンバージョンAPIゲートウェイは、広告主が自らのサーバーからウェブ以外のイベントをコンバージョンAPIゲートウェイに送信できる、APIエンドポイントのサポートを開始しました。これはコンバージョンAPI Directの方法と似ています。主な違いは、イベントをMetaグラフAPIに直接送信するのではなく、コンバージョンAPIゲートウェイを通して送信することです。

リクエストの送信

新しいイベントを送信するには、パスhttps://<capig.instance.url>/capi/{PIXEL_ID}/eventsからこのAPIの/eventsエッジにPOSTリクエストを送信します。

このエッジにPOSTリクエストを送信すると、Metaは新しいサーバーイベントを作成します。

curl -i -X POST \
  -d '{
  "accessKey": "<ACCESS_KEY_VIA_CAPIG_UI>",
  "data": [
    {
      "event_name": "Purchase",
      "event_time": <Unix timestamp in seconds, must be within the last seven days>,
      "user_data": {
        "em": [
          "973dfe463ec85785f5f95af5ba3906eedb2d931c24e69824a89ea65dba4e813b"
        ],
        "ph": [
          "ce3a598687c8d2e5aa6bedad20e059b4a78cca0adad7e563b07998d5cd226b8c"
        ],
        "client_ip_address": "123.123.123.123",
        "client_user_agent": "CLIENT_USER_AGENT",
        "fbc": "fb.1.1554763741205.AbCdEfGhIjKlMnOpQrStUvWxYz1234567890",
        "fbp": "fb.1.1558571054389.1098115397"
      },
      "contents": [
        {
          "id": "product123",
          "quantity": 1,
          "delivery_category": "home_delivery"
        }
      ],
      "custom_data": {
        "currency": "usd",
        "value": 123.45
      },
      "event_source_url": "http://test.com/product/123",
      "action_source": "website"
    }
  ]
}' \
https://<capig.instance.url>/capi/<PIXEL_ID>/events

アクセスキーの生成

コンバージョンAPIゲートウェイにAPIリクエストを送信するためのアクセスキーは、コンバージョンAPIゲートウェイの管理コンソールから生成することができます。

  • コンバージョンAPIゲートウェイの管理UIにログインする
  • [概要]セクションに移動する
  • アクセスキーを生成したい、[リンクされているMetaピクセル]行にある[...]をクリックする
  • [アクセスキーを生成する]をクリックする

コンバージョンAPIダイレクトのアクセストークンは、コンバージョンAPIゲートウェイのエンドポイントに対するサーバーリクエストには使用できません。

参考情報