请求地址
https://cb-use.digibid.com/tracking
Digibid 支持客户使用 API 上报事件转化,通过 Digibid 提供的接口发送有效负载,将用户在广告主网站上发生的操作直接共享给 Digibid,从而进行更好的优化。
POST 请求和 GET 请求均支持。
POST 和 GET 的请求地址均为:
GET 请求示例:
GETGET https://cb-use.digibid.com/tracking?click_id=<click_id>&pixel_id=<pixel_id>&type=<事件类型>&event_time=<事件发生时间>&ip=<用户IP>&ua=<用户User-Agent>&device_id=<设备号>&adv_app_bundle=<App Bundle>&purchase=<总金额>¤cy=<币种>&event_id=<充值订单号>&order_id=<商城订单号>&content_id=<商品id>&price=<单价>&quantity=<数量>
POST 请求示例:
POST · JSONPOST https://cb-use.digibid.com/tracking
Content-Type: application/json
{
"click_id": "<click_id>",
"pixel_id": "<pixel_id>",
"type": 29,
"event_time": "<事件发生时间>",
"ip": "<用户IP>",
"ua": "<用户User-Agent>",
"device_id": "<设备号>",
"adv_app_bundle": "<App Bundle>",
"purchase": 199.8,
"currency": "USD",
"event_id": "<充值订单号>",
"order_id": "<商城订单号>",
"content_id": "<商品id>",
"price": 99.9,
"quantity": 2
}
或
POST · JSONPOST https://cb-use.digibid.com/tracking
Content-Type: application/json
{
"click_id": "<click_id>",
"pixel_id": "<pixel_id>",
"type": 13,
"ip": "<用户IP>",
"ua": "<用户User-Agent>",
"device_id": "<设备号>",
"event_id": "payment_20261019_0001",
"purchase": 9.99,
"currency": "USD"
}
POST 请求时用 JSON body,字段名与 GET 一致。
| 参数 | 是否必填 | 类型 / 格式 | 长度上限 | 说明 | 示例 |
|---|---|---|---|---|---|
click_id | 有就必填 | 字符串,原样传入;GET 时 URL 编码,每个请求都会有不同的 click_id | 1024 | 落地页 URL 上的 click_id。取不到时(例如用户不是从广告进来的、中途跳转丢失)传空值或不传。服务端上报不限制 click_id 的时间。 | click_id=AbC123... |
pixel_id | 必填,每次都传 | 字符串,UI 上显示的 pixel key,每个落地页的 pixel id 都是固定的,不会变动。 | 255 | UI 上显示的 Pixel Key,与落地页 URL 上的 pixel_id 相同。 | dg_test123 |
type | 必填 | 整数 | — | 事件类型,见下方「type 取值对照」 | 13 |
event_time | 选填,延迟或批量上报时强烈建议 | 整数,Unix 时间戳,单位秒(13 位毫秒也接受) | — | 事件实际发生的时间。不传就用 Digibid 收到请求的时间。早于 30 天前或晚于当前 10 分钟以上的值视为无效,按不传处理(后续支持,可先照常传) | 1760320800 |
ip | 强烈建议 | IPv4 或 IPv6 | 64 | 用户发生转化时的 IP。 | 203.0.113.7 |
ua | 强烈建议 | 字符串;GET 时 URL 编码 | 1024 | 用户浏览器或 App 的 User-Agent。 | Mozilla%2F5.0%20(Linux%3B%20Android%2013)... |
device_id | 选填 | 字符串 | 64 | 用户设备号(GAID / IDFA),能拿到时填 | 38400000-8cf0-11bd-b23e-10b96e40000d |
purchase | 19 / 13 / 29 必填;38 选填 | 数字,≥ 0,以元为单位(主币单位),可带小数 | 不超过 1e12 | 本次总金额。 | 9.99 |
currency | 选填 | ISO 4217 三位大写字母 | 16 | purchase 和 price 的币种,不填按 USD | BRL |
event_id | 19 / 13 强烈建议 | 字符串 | 256 | 充值订单号,用于对账。首充时 19 和 13 用同一个 | order-123 |
order_id | 29 强烈建议 | 字符串 | 128 | 商城订单号,用于对账 | SO-10086 |
content_id | 29 / 36 / 37 / 38 建议 | 字符串 | 128 | 商品 id(SKU)(后续支持,可先照常传) | sku-1 |
price | 29 / 36 / 37 / 38 建议 | 数字,≥ 0,以元为单位 | 不超过 1e12 | 商品单价(后续支持,可先照常传) | 19.9 |
quantity | 29 / 37 / 38 建议 | 整数,≥ 1 | — | 商品数量(后续支持,可先照常传) | 2 |
adv_app_bundle | 可选 | 字符串 | 256 | 填写被推广 App 的 bundle / package name(最长 256 字符) | test.app |
click_id 从 URL 读取,pixel_id 由 Digibid 提供。当用户反复点击广告进入落地页时,请读取新的 click_id 覆盖旧的。encodeURIComponent)。Content-Type: application/json,body 是一层平铺的 JSON 对象,字段名和上表一致,不要嵌套。数字字段传数字或字符串都可以。$9.99)时按 0 处理,事件仍会记录。| type | 事件 | 品类 | 是否作为转化回传 |
|---|---|---|---|
| 12 | 注册 | 通用 | 是 |
| 21 | 下载 / 点击 Get App | 通用 | 否,只做统计 |
| 19 | 首充 | 游戏 | 是 |
| 13 | 充值(每一笔,包括首充那一笔) | 游戏 | 是 |
| 29 | 下单成功 | 购物 | 是 |
| 36 | 查看商品 | 购物 | 否,只做统计 |
| 37 | 加购 | 购物 | 否,只做统计 |
| 38 | 发起结账 | 购物 | 否,只做统计 |
Event API 还支持 8(安装 / 打开,作为转化)、18(登录,作为转化)和 17(拒绝安装,仅记录)。其他未列出的 type 不予以开放。
200,不需要解析返回内容。接口不需要 token。ip、ua、device_id 属于用户个人信息,请确保您已按当地法规(如 GDPR、巴西 LGPD)告知用户并取得必要的同意。1. App 安装:建议同时携带 pixel_id 和 adv_app_bundle
GETGET https://cb-use.digibid.com/tracking?click_id=<click_id>&pixel_id=<pixel_id>&type=8&adv_app_bundle=com.example.app&ip=203.0.113.7&ua=<URL编码的UA>
2. 游戏:用户首充 9.99 美元,按首充的标准事件回传要求需要调用两次
GETGET https://cb-use.digibid.com/tracking?click_id=<click_id>&pixel_id=<pixel_id>&type=19&ip=203.0.113.7&ua=<URL编码的UA>&purchase=9.99¤cy=USD&event_id=order-123
GET https://cb-use.digibid.com/tracking?click_id=<click_id>&pixel_id=<pixel_id>&type=13&ip=203.0.113.7&ua=<URL编码的UA>&purchase=9.99¤cy=USD&event_id=order-123
3. 购物:用户加购 1 件商品 sku-1,单价 19.9 美元
GETGET https://cb-use.digibid.com/tracking?click_id=<click_id>&pixel_id=<pixel_id>&type=37&ip=203.0.113.7&ua=<URL编码的UA>&content_id=sku-1&price=19.9&quantity=1¤cy=USD
4. 购物:订单 SO-10086 支付成功,2 件 sku-1,单价 19.9 美元,总价 39.8 美元
GETGET https://cb-use.digibid.com/tracking?click_id=<click_id>&pixel_id=<pixel_id>&type=29&ip=203.0.113.7&ua=<URL编码的UA>&order_id=SO-10086&content_id=sku-1&price=19.9&quantity=2&purchase=39.8¤cy=USD
POST 的 JSON 里 ua 不需要 URL 编码。
1. 购物:订单 SO-10086 支付成功,2 件 sku-1,单价 19.9 美元,总价 39.8 美元
【等价 GET 案例 4,另外带上了事件发生时间 event_time】
POST · JSONPOST https://cb-use.digibid.com/tracking
Content-Type: application/json
{"click_id": "<click_id>", "pixel_id": "test123", "type": 29, "event_time": 1760320800,
"ip": "203.0.113.7", "ua": "Mozilla/5.0 (Linux; Android 13) ...",
"order_id": "SO-10086", "content_id": "sku-1", "price": 19.9, "quantity": 2,
"purchase": 39.8, "currency": "USD"}
请使用 Digibid 提供的 Pixel id 构建有效负载并发送 API 请求。若事件成功发送,Digibid 终端将收到事件,并同步给您。