服务器事件参数

参数描述
event_name
字符串

必要。
标准事件自定义事件的名称。此字段用于删除由网站(通过 Meta Pixel 像素代码)或应用(通过 SDK 或应用事件 API)以及转化 API 发送的重复事件。event_id 参数也用于删除重复事件。


对于相同的客户操作,浏览器事件或应用事件的 event 应与服务器事件的 event_name 相符。如果我们在 48 小时内发送的事件之间找到匹配项,则只考虑第一个事件。如果几乎同一时间收到服务器和浏览器/应用事件(即彼此相差 5 分钟以内),则将优先考虑浏览器/应用事件。详细了解删除重复的 Pixel 像素代码事件和服务器事件

event_time
整数

必要。
Unix 时间戳(以秒为单位),表示事件的实际发生时间。指定时间可能早于您将事件发送至 Facebook 的时间。其目的在于实现批处理和服务器性能优化。您必须以格林威治标准时间 (GMT) 时区格式发送该日期。


event_time 最长可比您将事件发送至 Facebook 的时间早 7 天。如果 data 中的任何 event_time 早于 7 天前,我们会为整个请求返回错误,而且不会处理任何事件。

user_data
对象

必要。
包含客户信息数据的映射。请参阅客户信息参数,了解有关选项。请参阅高级匹配,了解通过 Meta Pixel 像素代码发送的数据的可用比较选项。

custom_data
对象

可选。
包含事件其他企业数据的映射。详情请参阅自定义数据参数

event_source_url
字符串

可选。
事件发生的浏览器网址。此网址必须以 http://https:// 开头,并且应与已认证的网域相匹配。


注意:event_source_url 是使用转化 API 分享网站事件的必要项。

opt_out
布尔值

可选。
表示不应将此事件用于广告投放优化的标记。设置为 true 时,该事件仅可用作归因条件。

event_id
字符串

可选。
此编号可以是广告主选定的任何唯一字符串。参数 event_nameevent_id 用于删除由网站(通过 Meta Pixel 像素代码)或应用(通过 SDK 或应用事件 API)以及转化 API 发送的重复事件。请注意,虽然我们将 event_id 标记为可选项,但是建议您在删除重复事件时采用此参数。


删除重复事件时,浏览器事件或应用事件的 eventID 必须与对应服务器事件的 event_id 相匹配。详细了解处理重复的 Pixel 像素代码事件和转化 API 事件


订单号或交易编号是 event_id 可用的两个标识符。例如,如果顾客在您的网站购物两次,订单号分别为 123 和 456,则每次转化 API 调用都需要在 event_id 中添加相应的订单号。这样,我们就可以将这两次购物事件正确区分为不同订单。两次相应的浏览器 Pixel 像素代码购物事件也需要在 eventID 参数中发送相同的订单号,以便我们了解实际上只发生了两次事件,而不是四次独立购物。


如果事件不具备固有编号数字,可以使用随机数字(前提是在浏览器和服务器事件之间也发送此随机数字)。

action_source
字符串

必要。
您可通过此字段指定转化发生的位置。了解事件发生的位置有助于确保将广告投放至正确的受众。使用转化 API,即表示您同意:就您所知 action_source 参数准确无误。


您可在 action_source 字段中发送的值如下:


  • email — 转化通过邮件发生。
  • website — 转化在网站上完成。
  • app — 转化在移动应用上完成。
  • phone_call — 转化通过电话完成。
  • chat — 转化通过消息应用、短信或在线消息功能完成。
  • physical_store — 转化在实体店面对面完成。
  • system_generated — 转化自动发生,例如将订阅续费设置为每月自动支付。
  • business_messaging — 转化是通过 Messenger、Instagram 或 WhatsApp 的直达广告产生的。
  • other — 转化通过本文未列出的其他方式完成。
注意:所有操作来源值都支持广告成效衡量和自定义受众创建功能。所有操作来源(除 physical_store 外)都支持广告优化功能。
data_processing_options
数组

可选。
您希望为特定事件启用的处理选项。对于受限数据使用,当前可接受值为 LDU。您可以发送一个空数组来明确指定,不得使用“受限数据使用”限制来处理此事件。详细了解数据处理选项。请参阅转化 API 实现示例

data_processing_options_country
整数

如果您在 data_processing_options 下发送 LDU,则为必要项
您希望与此数据处理选项相关联的国家/地区。当前可接受值为 1(代表美国),或者 0(请求我们为此事件进行地理定位)。详细了解数据处理选项。请参阅转化 API 实现示例

data_processing_options_state
整数

在某些情况下为必要项。(查看下方备注以了解详情。)
您希望与此数据处理选项相关联的州/省。当前可接受值为 1000(代表加利福尼亚州),或者 0(请求我们为此事件进行地理定位)。


注意:

  • 如果您设置国家/地区,则必须同时设置州/省。否则,我们会将我们的地理位置逻辑应用于整个事件。
  • 如果您在 data_processing_options 下发送 LDU 而不提供 IP 地址,则此字段为必要项。

详细了解数据处理选项。请参阅转化 API 实现示例

app_data

对象

对应用事件为必要参数

这些参数用于将应用数据和设备信息分享给转化 API。

extinfoapp_data 的子参数。

extinfo

对象

对应用事件为必要参数

扩展设备信息,例如屏幕的宽度和高度。此参数是一个数组,各个值之间使用逗号分隔。使用 extinfo 时,所有值均为必要项,并且必须按照以下索引顺序排列。如果缺少某个值,则需使用空字符串作为占位符填充。


注意:


  • 对于 Android,version 必须为 a2

  • 对于 iOS,version 必须为 i2

0

字符串

必要

extinfo 的 version


示例:i2

1

字符串

应用项目包名称


示例:com.facebook.sdk.samples.hellofacebook

2

字符串

段版本(整数或字符串)


示例:1.0

3

字符串

长版本


示例:1.0 long

4

字符串

必要

操作系统版本


示例:13.4.1

5

字符串

设备型号名称


示例:iPhone5,1

6

字符串

区域设置


示例:En_US

7

字符串

时区缩写


示例:PDT

8

字符串

运营商


示例:AT&T

9

int64

屏幕宽度


示例:320

10

int64

屏幕高度


示例:568

11

字符串

屏幕密度


示例:2

12

int64

CPU 核心数


示例:2

13

int64

外部存储空间大小 (GB)


示例:13

14

int64

剩余的外部存储空间 (GB)


示例:8

15

字符串

设备时区


示例:USA/New York

referrer_url
字符串

可选。
在访问 Meta Pixel 像素代码触发所在的广告主页面之前,访问的最近集客网站。这是 JavaScript 角度的 HTTP 来源网址。referral_url 是用户在访问当前页面之前所访问的页面,或者 iFrame。