使用 Conversion API 为您的网站发送转化事件。 AppLovin 建议广告主将 Conversion API 与 AppLovin Pixel 结合使用。 这有助于您获得最佳的广告活动效果。
要向 Conversion API 提交一个或多个事件,请向 https://b.applovin.com/v1/event 发送 HTTP POST 请求。
| 请求头名称 | 值 |
|---|---|
Authorization | 您的 Conversion API 密钥 |
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
pixel_id | string | 是 | 您的 pixel ID |
| 代码 | 描述 |
|---|---|
| 200 | 所有事件处理成功。 |
| 400 | 您的请求存在错误。此批次事件已被丢弃。 |
| 401 | 身份验证失败。 |
您的 HTTP 请求的 POST 负载描述了您提交的一个或多个事件:
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
events | 服务器事件[] | 是 | 要提交的事件列表。所有事件必须有效。任何无效事件都会导致整批失败。最大批次大小为 100。 |
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
data | 事件数据 | 是 | 此事件的数据。请参阅事件和对象页面,了解每个事件要发送的数据。 |
event_source_url | string | 是 | 发生事件的完整 URL(例如 https://example.com/product?product_name=widget) |
event_time | number | 是 | 当前 Unix 时间戳(毫秒) |
name | string | 是 | 此事件的名称。请参阅事件和对象参考以了解可用事件。 |
user_data | User data | 是 | 请参阅下方的 User data 表,其中包含 aleid、client_id、axwrt、alart 等数据字段。 |
measurement_partner_data | 测量数据 | 否 | 测量数据,用于告知 AppLovin 因该事件获得多少归因归功 |
dedupe_id | string | 否 | 此事件的唯一标识符。AppLovin 使用此标识符进行去重。相同的 pixel 事件和服务器到服务器(server-to-server)事件应具有相同的 dedupe_id。注意:这与下方的 aleid 不同。 |
请参阅事件和对象以了解如何为每个事件填充 data 字段。
除了此链接中记录的事件外,您还可以在下方找到其他支持的事件。
app_open 事件(仅限移动应用集成)当用户启动应用时触发此事件。 此事件无需传递数据对象。
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
alart | string | 是* | 设置为查询参数的 alart。*有关更多详细信息,请参阅下方的发送用户标识符。 |
aleid | string | 是* | 有关其他详细信息,请参阅下方的发送 aleid。 *如果 URL 中存在则为必填项(由 AppLovin 在广告点击后发送) |
axwrt | string | 是* | 在 AppLovin Pixel 中设置的 axwrt。*有关更多详细信息,请参阅下方的发送用户标识符。 |
client_id | string | 是* | 稳定的第一方用户标识符。 *有关更多详细信息,请参阅下方的发送用户标识符。 |
client_ip_address | string | 是 | 与事件对应的浏览器的 IP 地址(不含任何空格)。您可以使用 IPv4 或 IPv6 地址。推荐使用 IPv4。 |
client_user_agent | string | 是 | 设备/浏览器的 User Agent |
email | string | 是* | 用户的电子邮件地址。AppLovin 会自动使用 SHA-256 对此值进行哈希处理。如果您按照 AppLovin 的哈希指南对标识符进行预处理,也可以提供您自己的 SHA-256 哈希值。 *有关更多详细信息,请参阅下方的发送用户标识符。 |
esi | string | 是 | 事件来源指示器。移动应用事件使用 "app",网站事件使用 "web"。 |
phone | string | 是* | 用户的电话号码。AppLovin 会自动使用 SHA-256 对此值进行哈希处理。如果您按照 AppLovin 的哈希指南对标识符进行预处理,也可以提供您自己的 SHA-256 哈希值。 *有关更多详细信息,请参阅下方的发送用户标识符。 |
user_id | string | 是* | 客户的唯一标识符。 *有关更多详细信息,请参阅下方的发送用户标识符。 |
country_code | string | 否 | 用户的账单国家/地区代码。遵循 ISO 3166 标准。 |
ifa | string | 否 | 用户的广告主标识符:idfa 或 gaid |
idfv | string | 否 | 用户的应用开发商标识符 (idfv) |
os | string | 否 | 用户的操作系统:ios、android 或 desktop_os |
sid | string | 否 | 会话 ID (Session ID) |
zip | string | 否 | 用户的账单邮政编码。对于美国邮政编码,仅使用前五位数字。 |
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
accounting_mode | string | 是 | CASH 或 ACCRUAL |
attribution_lookback_window_hours | number | 是 | 触点发生并获得转化归因归功的回溯时长(以小时为单位)。留空表示无限回溯。 |
attribution_model | string | 是 | LAST_CLICK、FIRST_CLICK、LINEAR、TIME_DECAY、CUSTOM_MULTI_TOUCH、LAST_NON_DIRECT_TOUCH、CLICKS_AND_VIEWS_ENHANCED 或 ANY_CLICK 之一 |
attribution_share | number | 是 | 介于 0 和 1 之间的数字,表示基于给定的归因模型和回溯期,AppLovin 因该事件获得的归因归功比例 |
is_claimable | boolean | 是 | 用于指示 AppLovin 是否促成了该事件的标志 |
campaign_id | string | 否 | AppLovin 的广告活动 ID (campaign ID) |
creative_set_id | string | 否 | AppLovin 的素材组 ID (creative set ID),也称为 adset ID |
first_purchase_ts | number | 否 | 客户首次在广告主处进行购买的 Epoch 时间戳(毫秒) |
first_visit_ts | number | 否 | 客户首次访问广告主网站的 Epoch 时间戳(毫秒) |
is_new_customer | boolean | 否 | 客户之前是否在广告主处进行过购买 |
is_new_visitor | boolean | 否 | 客户之前是否访问过广告主网站 |
last_purchase_ts | number | 否 | 客户最近一次在广告主处进行购买的 Epoch 时间戳(毫秒) |
last_visit_ts | number | 否 | 客户最近一次访问广告主网站的 Epoch 时间戳(毫秒) |
aleid 是用户点击 AppLovin 广告后,AppLovin 添加到网站 URL 中的查询参数。
利用此参数的存在来识别哪些点击来自 AppLovin。
要发送 aleid,您可以执行以下操作之一:
aleid 查询参数时,会自动设置 Cookie _axeid。
每当您看到此类 Cookie 时,请读取其值,然后通过将其作为 aleid 查询参数的值在请求中发送。aleid URL 查询参数存在时,请获取其值。
当您的服务器看到 aleid 查询参数时,请在服务器端读取该参数。
AppLovin 建议您在网站上将其设置为名为 _axeid 的 HTTP Cookie。
将此 Cookie 的过期时间设置为一年。
与前一种方法一样,每当您看到此类 Cookie 时,请读取其值,然后通过将其作为 aleid 查询参数的值在请求中发送。AppLovin 要求您至少传递以下字段之一:client_id、axwrt、alart、user_id、email 或 phone。
client_idaxwrt_axwrt。
alartalart URL 查询参数存在时,请获取其值。
user_idemailphone[
{
"event_time": 1741784485001,
"event_source_url": "https://applovin.com",
"name": "purchase",
"user_data": {
"client_ip_address": "172.59.8.172",
"client_user_agent": "chrome/123.456 android mobile",
"aleid": "_aleid-query-param",
"axwrt": "_axwrt-cookie-value",
"email": "user@example.com",
"phone": "+11234567890",
"user_id": "customer_12345",
"client_id": "_first_party_identifier",
"sid": "sid",
"ifa": "idfa",
"idfv": "idfv",
"os": "macos",
"esi": "web",
"zip": "12345",
"country_code": "US"
},
"measurement_partner_data": {
"is_claimable": true,
"attribution_model": "LAST_CLICK",
"attribution_lookback_window_hours": 24,
"attribution_share": 0.5,
"accounting_mode": "ACCRUAL",
"campaign_id": "456",
"creative_set_id": "789",
"is_new_customer": false,
"last_purchase_ts": null,
"is_new_visitor": true,
"last_visit_ts": 1
},
"data": {
"user_id": "customer_12345",
"currency": "USD",
"value": 30,
"transaction_id": "txn_abc123_20250120",
"shipping": 5.99,
"tax": 6,
"items": [
{
"item_variant_id": "SKU-123-M",
"item_id": "PROD-456",
"item_name": "T-Shirt",
"affiliation": "affiliation",
"item_brand": "item_brand",
"item_category": "item_category",
"item_category_id": 604,
"item_category2": "item_category2",
"image_url": "image_url",
"price": 15,
"discount": 10,
"quantity": 2
}
]
}
}
]