Ads3Ads3
广告网络原理
Advertiser 广告主
Publisher 流量主
Quest
  • Telegram
  • Twitter
  • Discord
  • 宣传物料
  • English
  • 简体中文
广告网络原理
Advertiser 广告主
Publisher 流量主
Quest
  • Telegram
  • Twitter
  • Discord
  • 宣传物料
  • English
  • 简体中文
  • Exchange 换量合作文档

  • Get Started

    • 简介
    • 创建 Exchange 换量任务
    • 导出流量
    • 流量导入
  • Code Integration

    • SDK 广告集成
    • SDK 广告集成(高级)
  • Reference

    • SDK 安装
    • 获取 App Id
    • Glossary 术语表

什么是 Conversion

Conversion 是转化,项目方都希望能通过换量获取新用户,为了得到更好的换量效果,您需要将新用户上报给 Ads3,Ads3 称之为 Conversion 事件。

服务 Host 地址

测试环境:https://staging.ton.ai/

生产环境:https://app.ton.ai/

上报转化事件 API

请求方法

POST /api/v2/openapi/exchange/event/report/conversion

请求参数

参数名位置类型必填描述
x-api-keyheaderstring是如何获取 APP Key

请求体应为 JSON 格式,包含以下字段:

字段名类型必填描述
eventTypestring是事件类型,固定值为 "conversion"
eventDataobject是事件数据,包含以下字段

eventData 对象包含以下字段:

字段名类型必填描述
telegramUserIdstring是用户的唯一 Telegram ID

完整请求示例

发起请求:

curl --request POST \
     --url https://staging.ton.ai/api/v2/openapi/exchange/event/report/conversion \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: YOUR_API_KEY_HERE' \
     --data '
{
  "eventType": "conversion",
  "eventData": {
    "telegramUserId": "1728125519"
  }
}
'

成功响应会返回上传成功的状态,状态码为 200。响应格式如下:

{
  "status": "success"
}

注意事项

  1. 请确保在用户实际完成转化行为时才调用此 API。
  2. 如果遇到网络问题导致上报失败,可以在短时间内重试,但不要过度重试。
  3. telegramUserId 应该是用户的唯一 Telegram ID,不要使用其他标识符。
  4. 请注意保护用户隐私,只传输必要的信息。

提示

建议您实现错误处理和重试机制,以确保重要的转化事件数据能够成功上报。