用于线索生成的 Conversion API

使用 Conversion API 为您的网站发送线索生成事件。AppLovin 建议广告主将 Conversion API 与 AppLovin Pixel 配合使用,以帮助实现最佳的广告活动效果。

用于线索生成的 Conversion API

请求格式

要向 AppLovin Event API 提交一个或多个事件,请向 https://b.applovin.com/v1/event 发送 HTTP POST 请求。

身份验证

请求头名称
Authorization您的 Conversion API 密钥

查询参数

名称类型是否必填描述
pixel_idstring您的 AppLovin Event Key

AppLovin dashboardKeys 区域获取您的 AppLovin Event Key 和 Conversion API 密钥。

响应代码

代码含义
200所有事件处理成功
400请求错误;整个批次均被丢弃
401身份验证失败

POST 负载

您的 HTTP 请求的 POST 负载描述了您提交的一个或多个事件:

名称类型是否必填描述
eventsServerEvent[]要提交的事件列表。所有事件必须有效。任何无效事件都将导致整批失败。最大批次大小为 100。

服务器事件

名称类型是否必填描述
dataEventData此事件的数据。请参阅下方的 EventData 以了解每个事件要发送的数据
event_source_urlstring事件发生的完整 URL(例如 https://example.com/product?product_name=widget
event_timenumber当前 Unix 时间戳(毫秒)
namestring此事件的名称。必须为 page_viewgenerate_lead 当用户导航到您网站上的新页面时触发 page_view。当潜在客户表达意向时触发 generate_lead,通常是通过提交表单(例如,当用户提交联系表单以获取有关产品的更多信息时)。
user_dataUserData请参阅下方的 User data 表,其中包含 aleidclient_idaxwrtalart 等数据字段。
dedupe_idstring此事件的唯一标识符。用于去重。相同的 pixel 事件和服务器到服务器事件应具有相同的 dedupe_id。注意,这与下方的 aleid 不同

事件数据

data每个事件的必填项

  • 对于 page_view,将 data 设置为 null

  • 对于 generate_lead,始终发送 { "currency": "«ISO-4217»", "value": «number» }

名称类型是否必填描述
currencystring货币的三位字母 ISO 4217 代码
valuenumber该操作的货币价值,反映其对您业务的质量或真实价值。对于高意向线索传递较高的值,对于重复提交或低质量线索传递 0。价值为 0 的线索可能会被折算或排除在优化之外。

可选事件

app_open 事件仅适用于移动应用集成。 当用户启动应用时触发此事件。 此事件无需传递数据对象。

用户数据

名称类型是否必填描述
alartstring*设置为查询参数的 alart
*有关更多详细信息,请参阅下方的发送用户标识符
aleidstring有关更多详细信息,请参阅下方的发送 aleid
如果 URL 中存在则为必填项(由 AppLovin 在广告点击后发送)
axwrtstring*在 AppLovin Pixel 中设置的 axwrt
*有关更多详细信息,请参阅下方的发送用户标识符
client_idstring*稳定的第一方用户标识符。
*有关更多详细信息,请参阅下方的发送用户标识符
client_ip_addressstring与事件对应的浏览器的 IP 地址(不含任何空格)。您可以使用 IPv4 或 IPv6 地址。推荐使用 IPv4。
client_user_agentstring设备/浏览器的 User Agent
emailstring*用户的电子邮件地址。AppLovin 会使用 SHA-256 自动对该值进行哈希处理。如果您根据 AppLovin 的哈希指南对标识符进行预处理,也可以提供您自己的 SHA-256 哈希值。
*有关更多详细信息,请参阅下方的发送用户标识符
esistring事件源指示器。移动应用事件使用 "app",网站事件使用 "web"
phonestring*用户的电话号码。AppLovin 会使用 SHA-256 自动对该值进行哈希处理。如果您根据 AppLovin 的哈希指南对标识符进行预处理,也可以提供您自己的 SHA-256 哈希值。
*有关更多详细信息,请参阅下方的发送用户标识符
user_idstring*客户的唯一标识符。
*有关更多详细信息,请参阅下方的发送用户标识符
country_codestring用户的账单国家/地区代码。遵循 ISO 3166 标准。
idfvstring用户的 IDFV
ifastring用户的广告主标识符。idfagaid
osstring用户的操作系统:iosandroiddesktop_os
sidstring会话 ID
zipstring用户的账单邮政编码。对于美国邮政编码,仅使用前五位数字。

发送 aleid

aleid 是用户点击 AppLovin 广告后,AppLovin 添加到网站 URL 中的查询参数。

利用该参数的存在来识别哪些点击来自 AppLovin。

要发送 aleid,您可以执行以下操作之一:

  1. 如果您的网站上安装了 AppLovin Pixel,AppLovin Pixel 在看到 aleid 查询参数时会自动设置 Cookie _axeid。 每当您看到此类 Cookie 时,读取其值,然后通过将其作为 aleid 查询参数的值在请求中发送。
  2. 当您看到 aleid URL 查询参数存在时,获取其值。 当您的服务器看到 aleid 查询参数时,在服务器端读取该参数。 AppLovin 建议您在网站上将其设置为名为 _axeidHTTP cookie。 将此 Cookie 设置为一年的过期时间。 与前一种方法一样,每当您看到此类 Cookie 时,读取其值,然后通过将其作为 aleid 查询参数的值在请求中发送。

发送用户标识符

AppLovin 要求您至少传递以下字段之一:client_idaxwrtalartuser_idemailphone

client_id
如果您的网站上没有安装 AppLovin Pixel,请传递您存储的用于识别访客的另一个稳定的第一方 Cookie。 它应该是全局唯一的,并且在用户的不同浏览会话中保持一致。
axwrt
如果您的网站上安装了 AppLovin Pixel,AppLovin Pixel 会自动设置 Cookie _axwrt
alart
对于应用用户,当您看到 alart URL 查询参数存在时,获取其值。
user_id
您系统中客户的唯一标识符。 这应该是一个稳定的标识符,在用户会话之间保持一致。
email
用户的电子邮件地址。 AppLovin 会使用 SHA-256 自动对该值进行哈希处理以保护隐私。 如果您根据 AppLovin 的指南对标识符进行预处理,也可以提供您自己的 SHA-256 哈希值。
phone
用户的电话号码。 AppLovin 会使用 SHA-256 自动对该值进行哈希处理以保护隐私。 如果您根据 AppLovin 的指南对标识符进行预处理,也可以提供您自己的 SHA-256 哈希值。

示例负载

页面浏览事件

{
  "events": [
    {
      "event_time": 1741784485001,
      "event_source_url": "https://applovin.com",
      "name": "page_view",
      "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",
        "user_id": "_user_id",
        "phone": "+1123456789",
        "email": "user@example.com",
        "client_id": "_first_party_identifier",
        "sid": "sid",
        "ifa": "idfa",
        "idfv": "idfv",
        "os": "macos",
        "esi": "web",
        "zip": "12345",
        "country_code": "US"
      },
      "data": null
    }
  ]
}

线索生成事件

{
  "events": [
    {
      "event_time": 1741784485001,
      "event_source_url": "https://applovin.com",
      "name": "generate_lead",
      "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",
        "user_id": "_user_id",
        "phone": "+1123456789",
        "email": "user@example.com",
        "client_id": "_first_party_identifier",
        "sid": "sid",
        "ifa": "idfa",
        "idfv": "idfv",
        "os": "macos",
        "esi": "web",
        "zip": "12345",
        "country_code": "US"
      },
      "data": {
        "currency": "USD",
        "value": 30
      }
    }
  ]
}

这篇文章有帮助吗?
这篇文章有帮助吗?
search