注册
在使用广告功能之前,请先完成注册。
创建 Platform
Platform 代表着您的 APP 或者 Website,创建 Platform 后需要由 Ton AI 进行审核,审核通过后才可以成为 Ton AI 的流量主
- App name: 您的 APP 名称
- Telegram direct link: 您的 Telegram 应用的直接链接
- Web app url: 您的应用的 URL
相关信息
App owner 可以通过 BotFather 使用命令 /myapps
获取 Telegram direct link
禁止赌博类广告
通过联系我们 Telegram 账号 @Ton_AI_Admin,您可以请求在您的网站上禁用赌博类广告的展示。
创建 Block
Block 代表着广告位,你可以创建多个广告位,来对比不同位置的效果
- Name: Block 的名称
- Reward Webhook URL: 当用户点击广告后(广告系统收到点击事件),Ton AI 会向这个 URL 发送请求,您可以在这里实现奖励发放
提示
如果您希望在您的网站上展示多个广告,我们建议您创建多个 Block,这样可以对比每个 Block的 转化效果。
审核
每个 Platform 都需要经过 Ton AI 的审核,审核通过后才可以成为 Ton AI 的流量主
提示
在通过审核之前只能获取到测试广告,审核通过后才可以获取到正式广告
获取 BlockId
在 Platform 详情页面,可以看到每个 Block 的信息,其中有一列 BlockId, 旁边有个复制按钮,点击复制即可
Reward Webhook
当用户点击广告后(广告系统收到点击事件),Ton AI 会向这个 URL 发送请求,您可以在这里实现奖励发放
请求方法
POST
请求参数
参数名 | 位置 | 类型 | 描述 |
---|---|---|---|
adBlockId | query | string | 广告位 ID,从平台 -> 广告位 -> ID 获取 |
openId | query | string | 用户的唯一标识,例如 telegramUserId |
type | query | string | openId 对应的类型,目前仅支持 'telegram' |
campaignId | query | string | 广告活动 ID |
x-api-key | header | string | 您账户的 App Key,请对比校验该 Key,防止伪造 |
eventType | query | string | 事件类型,支持 click、complete、conversion |
eventId | query | string | 事件 ID ,用于幂等处理 |
注意,eventType 的值可以是:
- click : 用户点击了广告(注意:触发 click 事件,将不会继续发送 complete 事件)
- complete : 用户看完了 15s 的广告(未点击)
- conversion : 用户进入了广告主的页面(大部分情况下,你可以忽略该事件)
您可以根据产品的需求,来决定根据哪种事件发放奖励。
如果用户看完了广告就可以获得奖励,处理逻辑如下:
if (eventType === 'complete' || eventType === 'click') {
// 发放奖励
}
如果用户必须点击广告才能获得奖励,处理逻辑如下:
if (eventType === 'click') {
// 发放奖励
}
注意事项
- 系统可能会多次请求 Reward Webhook,请确保您的逻辑是幂等的,可以根据 eventId 进行幂等判断
- 您应该对比校验 App Key,防止伪造