コンバージョンAPI

ペイロードの仕様

リード獲得広告 - コンバージョンリードの最適化の目的を使用してCRMをMetaのコンバージョンAPIと連携すると、より質の高いリードの獲得につながる可能性があります。現在、この最適化ではFacebookまたはInstagramで生成されたネイティブリード獲得広告(インスタントフォーム)のみがサポートされます。

このガイドでは、コンバージョンリード最適化に向けてアップロードされるCRMイベントのペイロードの仕様のみを説明します。この種の最適化に関係ないイベントには、この仕様を適用しないでください。

APIなどの有用なリソースの使用に関する詳細は、コンバージョンAPIのドキュメントをご覧ください。

イベントのペイロード

パラメーター

名前説明

lead_id

整数

必須。
各リードについてFacebookで生成される各リードのID。リード獲得のWebhookにあるleadgen_idフィールドから取得される15桁または16桁の数字です。user_dataパラメーターの下に含まれます。詳しくは「リードIDを見つける」を参照してください。
マッチングでは、カスタム情報ではなくリードIDを使用する必要があります。CRMからIDの値を渡すには変数を使用してください。
注: ハッシュ化はしないでください。

event_name

文字列

必須。
CRM内で使用するステージを記録するための自由形式フィールドです。
最初のリードステージを含め、更新されるたびに確実にすべてのステージが送信されるようにします。
ステージには例えば、次のような種類があります。リードが最後の[コンバージョン]ステージに達した場合、その前のすべてのステージが事前に送信されていることになります。

  1. Facebookからの最初のリード
  2. マーケティング対象リード
  3. 販売機会
  4. コンバージョン

CRMからステージを渡すには変数を使用してください。代わりに、ステージごとに別のAPI呼び出しを作成することも可能です。

event_time

整数

必須。
CRMによってリードステージ更新イベントが更新された時刻を秒単位で示すUnixタイムスタンプ。
データベースからUnixタイムスタンプの値を渡すには変数を使用してください。
注: event_timeパラメーターの値はMetaにイベントを送信する7日前までのものにできます。このタイムスタンプはリード獲得時刻の後に発生す必要があり、そうでない場合はイベントが破棄される可能性があります。

action_source

文字列

必須。
すべてのコンバージョンリードイベントについて、このパラメーターの値はsystem_generatedに設定してください。
コンバージョンリードの連携において、この値によりコンバージョンがシステム生成された場所が特定されます。

lead_event_source

文字列

必須。
このパラメーターには、custom_dataパラメーターに含まれる、リードの発生元のツール(Hubspot、SAP、Oracle、Dynamics、In-house CRMなど)の名前を設定します。

event_source

文字列

必須。
すべてのコンバージョンリードイベントについて、このパラメーターの値はcrmに設定してください。
コンバージョンリードの連携において、この値によりcustom_dataパラメーター下でCRMとしてのイベントのソースが特定されます。

サンプル

このサンプルは、API呼び出しで送信されたイベントのペイロードの形式を表しています。

{
    "event_name": "my lead stage",
    "event_time": 1617693833,
    "user_data": {
        "lead_id": 1234567890123456
    },
    "action_source": "system_generated",
    "custom_data": {
        "lead_event_source": "Salesforce",
        "event_source": "crm"
    }
}

詳しくはこちら