转化 API

有效负载规范

将您的 CRM 与 Meta 的转化 API 集成，并使用潜客广告的“高潜客户”优化目标，有助您获得更优质的结果。目前，此优化仅支持在 Facebook 或 Instagram 上生成的原生潜客广告（即时表单）。

本指南仅针对为“高潜客户”优化而上传的 CRM 事件提供了负载规范。请勿将此规范用于与此优化无关的事件。

如需更多有关此 API 入门和其他实用资源的信息，请参阅转化 API 文档。

事件负载

参数

名称描述

lead_id

整数

必要。
Facebook 为每个潜在客户生成的编号。此编号是一个 15 - 16 位数字，可通过潜客开发广告 Webhooks 中的 leadgen_id 字段获得，位于 user_data 参数下方。详情请参阅查找潜在客户编号。
进行匹配时，必须使用潜在客户编号，而不是客户信息。请使用一个变量来传送您 CRM 中的编号值。
注意：请勿进行哈希处理。

event_name

字符串

必要。
自由格式的字段，用于获取您在 CRM 中使用的各个阶段。
务必在任何阶段更新时发送所有阶段，包括原始潜在客户阶段。
例如，您的阶段可能包括以下类型。如果潜在客户到达最后的“已转化为客户的潜在客户”阶段，则所有之前的阶段都应已经提前发送。

  1. 来自 Facebook 的原始潜在客户
  2. 符合营销资格的潜在客户
  3. 具有销售机会的潜在客户
  4. 已转化为客户的潜在客户

请使用一个变量来传送您数据库中的阶段。或者，您可以为每个阶段单独创建一个 API 调用。

event_time

整数

必要。
以秒为单位的 Unix 时间戳，表示由您 CRM 更新潜在客户阶段更新事件的时间。
请使用一个变量来传送您数据库中的 Unix 时间戳值。
注意：event_time 参数值最多可比您将事件发送至 Meta 的时间早 7 天。此时间戳还必须晚于潜客开发广告的刊登时间，否则该事件可能被弃用。

action_source

字符串

必要。
针对所有“高潜客户”事件，将此参数设为值 system_generated。
对于“高潜客户”集成，此字段指定了系统在何处生成转化。

lead_event_source

字符串

必要。
将此参数设为表示潜在客户来源的工具名称（如 Hubspot、SAP、Oracle、Dynamics、In-house CRM 等），此参数位于 custom_data 参数下方。

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"
    }
}

详细了解