外观
DEVELOPER DOCUMENTATION初版 0.1
广告与奖励,
从这里接入。
从应用配置、TypeScript 调用到服务端验签,按步骤完成自有图片与视频广告接入。
HTTP API v1TypeScript 参考客户端图片与视频
从这里开始
快速开始 →
启动本地环境,完成一次广告展示与奖励领取。
从零到首个完整流程TypeScript 客户端 →查看参考客户端的方法、参数和会话恢复方式。
仓库内的协议封装HTTP API 参考 →查询认证方式、请求字段、响应模型与错误码。
适用于不同客户端语言理解一次广告请求
Ad System 负责选择广告、管理观看会话和判断奖励资格。APP 或业务后端负责将奖励兑现为自己的金币、道具或权益。
01准备投放应用 · 广告位 · 素材
→02播放广告会话 · 展示 · 事件
→03确认资格观看规则 · 频控
→04兑现奖励凭证领取 / 后端交付
先在管理后台准备应用、广告位、素材和投放计划,再由客户端取得访问令牌、创建会话、展示广告并上报事件。满足规则后,按照应用配置的交付模式处理奖励。整个流程使用稳定的会话与奖励标识,支持状态查询与安全重试。
第一次接触这些对象?先阅读核心概念 →
选择奖励交付方式
每笔奖励使用一种固定的交付模式。根据应用是否拥有业务后端、如何持久化用户资产,选择对应指南。
01→02→03→
客户端领取
client_claim客户端在线领取奖励凭证,再在本地兑现。适合接受本地存档信任边界的应用。
最终状态:CLAIMED · 凭证已领取业务后端主动领取
server_pull应用后端验证并消费奖励资格,完成幂等入账后向广告系统确认结果。
最终状态:FULFILLED · 业务后端已确认服务端通知
server_webhook广告系统推送签名通知;应用后端验签、幂等入账,并返回约定的确认结果。
最终状态:FULFILLED · 业务后端已确认奖励资格与实际资产分开管理
客户端上报“播放完成”不会直接变成可信的资产入账。自有广告的时间和进度检查只能降低伪造风险;客户端领取凭证也不代表本地资产已可靠入账。了解奖励状态与恢复后,再选择适合应用的兑现方式。
按你的任务继续
| 你正在做的事 | 对应文档 |
|---|---|
| 接入 Web 或其他 APP 客户端 | 客户端接入 · 播放与事件 |
| 处理断网、重试和领取恢复 | 常见接入场景 · 奖励与恢复 |
| 实现有业务后端的奖励闭环 | 业务后端接入 · Webhook 通知 |
| 查询一个接口或字段 | 客户端 API · 应用后端 API · 数据模型 |
| 本地运行或准备部署 | 本地开发 · 环境与部署配置 |
| 排查广告无填充或奖励未到账 | 错误码 · 故障排查 |
下载接入材料
当前版本范围
初版 0.1 提供自有图片与视频投放、HTTP API v1、Web 参考播放器和仓库内 TypeScript 参考客户端。正式的 Cocos、Unity、Android、iOS SDK,以及真实第三方广告平台接入,属于后续范围。