转化跟踪对接指南

Advertiser Integration Guide

转化跟踪对接指南

通过简单的 API 对接,让元气智广与您的广告系统实现转化数据互通。本指南将带您完成从配置到回传的完整流程。

适用对象 · 投放自有 APP 的广告主 对接方式 · API 回调域名 · chelaile.tracking.biddingads.com
📋
您将了解

完成本指南后,您将能够配置点击监测链接、接收用户设备信息、完成转化归因,并通过回调 API 回传转化事件。整个对接流程通常可在 1-2 小时内完成。

工作原理

转化跟踪的核心思路很简单:元气智广在用户点击广告时,将设备信息传递给广告主;广告主在用户完成转化后,将转化事件回传给元气智广。这样双方就能准确匹配点击与转化,实现精准归因。

🔄
数据流转过程
  1. 用户点击广告 用户在元气智广媒体内点击您的广告。
  2. 元气智广上报点击 我们调用您配置的点击监测链接,并替换宏参数,将用户设备信息(IDFA、OAID 等)和回调链接发送给您。
  3. 广告主归因匹配 您将收到的设备信息与自己 APP 监测到的转化设备进行匹配,确认转化来源。
  4. 回传转化事件 匹配成功后,您通过回调链接将转化事件(激活、注册、付费等)回传给元气智广。

准备工作

在开始对接前,请确保您已具备以下条件:

  • 点击监测服务:您自有或第三方的点击监测服务地址,用于接收元气智广的点击上报
  • HTTPS 支持:您的监测服务需支持 HTTPS(推荐)或 HTTP
  • 设备 ID 采集:您的 APP 能采集用户设备 ID(IDFA、OAID、AndroidID 等)
  • 转化事件定义:明确您需要回传的转化事件类型(激活、注册、付费等)
提示

如果您使用第三方归因平台(如 AppsFlyer、Adjust 等),请确保该平台支持自定义点击监测链接和回调配置。

步骤 1:配置点击监测链接

点击监测链接是元气智广向您上报点击事件的入口。您需要在创建广告计划时填写此链接,我们将在此链接后拼接宏参数并调用。

链接格式

点击监测链接由以下部分组成:

https://您的监测地址?+ 宏参数 + 回调链接参数 + 自定义参数(可选)

必须包含的参数

  • 回调链接:用于接收您的转化回传。格式为 callback_url=_CALLBACK_URL_
    这是必须添加的参数,否则无法完成转化回传

推荐包含的宏参数

为了完成归因,建议在链接中包含以下设备信息参数:

参数说明示例
_IDFA_iOS 设备 ID63557E56-67E6-4359-9F28-998736FA28B7
_OAID_Android 设备 IDa557ce7503c8396ebe77367b54dc7651
_ANDROIDID_Android ID9774d56d682e549c
_IP_用户 IP 地址116.236.101.90
_OS_操作系统ios 或 android
注意

宏参数必须全部大写,且两侧为单下划线(如 _IDFA_)。拼写错误将导致参数无法被识别和替换。

完整示例

click_track_url 示例
https://track.yourdomain.com/click?callback_url=_CALLBACK_URL_
  &idfa=_IDFA_&oaid=_OAID_&androidid=_ANDROIDID_
  &ip=_IP_&os=_OS_&source=qiyuanzhiguang

步骤 2:接收点击事件

当用户点击广告后,元气智广会立即调用您配置的点击监测链接。您需要:

  1. 解析 URL 参数 从请求 URL 中提取宏参数替换后的值,包括设备 ID、IP、回调链接等
  2. 存储回调链接 将 callback_url 参数值与用户设备信息关联存储,用于后续转化回传
  3. 返回成功响应 返回 HTTP 200 状态码,表示已成功接收点击事件
最佳实践

建议将回调链接原样存储,不要修改或重新编码。回传时直接使用存储的链接,仅替换 type 参数值。

步骤 3:完成转化归因

归因由您或您对接的第三方归因平台完成。当用户在您的 APP 内完成转化行为(如激活、注册、付费)时:

  1. 采集转化设备 ID 从转化用户设备采集 IDFA、OAID 等设备标识
  2. 匹配点击记录 将转化设备 ID 与之前存储的点击记录进行匹配
  3. 确认转化来源 匹配成功后,确认该转化来自元气智广的广告投放

步骤 4:回传转化事件

归因完成后,您需要通过回调链接将转化事件回传给元气智广。这是计算转化的关键步骤。

回传前准备

  • 解码回调链接:对存储的 callback_url 进行 UTF-8 URL 解码
    Java 示例:java.net.URLDecoder.decode(callbackUrl, "UTF-8")
  • 设置事件类型:将链接中的 type 参数替换为对应的事件类型(默认为 act 激活)

回调示例

激活事件

callback_activate
http://chelaile.tracking.biddingads.com/ad-action/click/callback?uid=820634
  ×tamp=1767196800000&ip=116.236.101.90&os=ios
  &idfa=63557E56-67E6-4359-9F28-998736FA28B7
  &type=act

付费事件

callback_pay
http://chelaile.tracking.biddingads.com/ad-action/click/callback?uid=820634
  ×tamp=1767196800000&ip=116.236.101.90&os=ios
  &idfa=63557E56-67E6-4359-9F28-998736FA28B7
  &type=pay&pay_amount=68.00
重要
  • 除 type 外,不要修改回调链接中的其他参数
  • 每个转化事件都需要单独回调一次
  • 如有多个事件类型(如激活 + 付费),每个类型都需要分别回调

回调 API 参考

基本信息

GET http://chelaile.tracking.biddingads.com/ad-action/click/callback

请求参数

参数类型必填说明
typestring是事件类型,见事件类型列表
timestamplong是转化时间戳(毫秒)
ipstring否用户 IP 地址
oaidstring否Android 设备 ID
idfastring否iOS 设备 ID
pay_amountstring否付费金额(元),仅 type=pay 时有效

响应格式

成功返回 HTTP 200,响应体如下:

response.json
{
    "type": "SUCCESS",
    "text": null,
    "data": null,
    "errors": []
}

渠道包场景回调

如果您投放的是 APK/EXE 渠道包,或落地页带渠道跟踪参数,可使用以下回调方式:

GET http://chelaile.tracking.biddingads.com/ad-action/click/callback

渠道包专属参数

参数类型必填说明
trackIdstring是渠道追踪 ID(请联系商务获取)
uastring否用户设备 User Agent

请求示例

cURL 示例
curl --location 'http://chelaile.tracking.biddingads.com/ad-action/click/callback?
  type=pay×tamp=1767196800000&trackId=682940157&ip=114.80.33.18
  &oaid=a557ce7503c8396ebe77367b54dc7651&pay_amount=6.48'

宏参数完整列表

以下是点击监测链接支持的所有宏参数:

宏参数类型说明
_CALLBACK_URL_string必须添加。回调链接,已 URL 编码
_TS_long点击时间戳(毫秒)
_IP_string用户公网 IP
_OS_string操作系统:ios 或 android
_IDFA_stringiOS 设备 ID
_IDFA_MD5_stringIDFA 的 MD5 值
_OAID_stringAndroid 设备 ID(Android Q+)
_OAID_MD5_stringOAID 的 MD5 值
_ANDROIDID_stringAndroid ID 原值
_IMEI_MD5_stringIMEI 的 MD5 值
_CAID_stringiOS 14+ 设备 ID(32 位)
_CAID2_stringiOS 14+ 设备 ID(备用,32 位)
_CAIDV_string含版本号的 CAID 值
_UA_string用户设备 User Agent
_CID_string点击标识 ID
_MODEL_string设备型号
_TASK_ID_long广告组 ID
_TASK_NAME_string广告组名称
_PLAN_ID_long计划 ID
_PLAN_NAME_string计划名称
_MATERIAL_ID_long创意 ID
_MATERIAL_NAME_string创意名称
_ACCOUNT_ID_string账户 ID

事件类型列表

回传转化事件时,type 参数需使用以下枚举值:

取值事件名称定义附加参数
act激活用户下载安装后首次打开应用—
register注册用户完成账号注册—
leave次留用户激活后次日再次打开应用—
active首活用户当日首次打开应用—
pay付费 用户在应用内完成付费 pay_amount(付费金额,单位元)
对接完成

恭喜!完成以上步骤后,您的转化跟踪对接就已完成。如有问题,请联系您的商务经理或技术支持。