API Reference

Publisher 流量主对接

注册

在使用广告功能之前，请先完成注册。

创建 Platform

Platform 代表着您的 APP 或者 Website，创建 Platform 后需要由 Ton AI 进行审核，审核通过后才可以成为 Ton AI 的流量主

填写您的 APP 相关信息即可

创建 Block 任务

Block 代表着广告位，你可以创建多个广告位，来对比不同位置的效果

创建 Block 只需要添加 Name 即可


广告对接

我们提供两种广告嵌入方式，您可以根据 App 类型选择合适的方式。


方案1 通过 API 实现无缝嵌入

我们开放了两个 API

API 获取广告

可以获得多个广告信息，你需要将广告信息嵌入到您的产品中

关键参数：

  • adBlockId 在管理后台创建的 BlockId，从 Platform 详情页面复制，见下图
  • telegramUserId 当前 Telegram用户的 ID


API 上报 Click 事件

用户点击广告时，上报事件


通过 API ，您可以将广告嵌入您产品中的任意界面

效果示例

嵌入效果展示


注意事项

如果您需要配置多个广告位置，建议每个广告位置都配置不同的 BlockId，可以对比不同位置的广告效果。


请勿上报虚假的 Click 事件

广告主和流量主双方的数据都会上报到 Ton AI 平台，如果您上报了虚假的 Click 事件，会导致双边的数据不一致，系统检测到此类行为将会有相应的惩罚措施。


方案2 通过 SDK 实现 Banner 嵌入

要在您的 MiniAPP 中显示横幅广告，首先确保广告位的宽高比为 5:1，例如 400x80。然后，导入必要的 SDK 组件：

import { TonAdBanner } from 'ton-ai-sdk';
import 'ton-ai-sdk/dist/index.css';

接下来，在您的 HTML 中的合适位置嵌入 TonAdBanner 组件：

注意：BlockID 是您在管理控制台中创建的 Platform 下面的 Block 的 ID，可以从那里复制。

<div>
  <!-- 嵌入 SDK 的 div -->
  <TonAdBanner blockId={BlockID}></TonAdBanner>
</div>

SDK 会拉取适合当前用户的广告，并自动上报 Click 事件到 Ton AI。

效果示例

效果展示