主题
文档中心
文档跟着 SDK 版本走:每个版本一套,地址里带版本号。 Android 离线包 docs/ 目录里的那一份,与这里同版本的页面是同一份内容(iOS 走 CocoaPods,没有离线包)。
uni-app 项目的接入文档不在文档中心
文档中心是原生 SDK(Android / iOS)的文档。uni-app 项目用的是封装原生 SDK 的 UTS 插件, 它的接入文档只有一页:uni-app 版(当前 1.0.0,支持 App-Android 与 App-iOS), 与插件包里的 readme.md 是同一份内容。 插件页只讲插件自己的 API 与写法,错误码、合规与隐私、服务端对接这些与平台无关的内容仍然看这里。
当前版本 v1.2.0
入门
| 文档 | 给谁看 | 内容 |
|---|---|---|
| 概览 | 所有人 | 平台能力、环境要求、调度流程、三种「位」与三类凭证的区分、文档导航 |
| 快速开始:Android · iOS | 接入时先看这份 | 跑通第一个广告的最短路径:引依赖、清单冲突、两步初始化、一个广告位、确认跑通 |
接入指南
| 文档 | 给谁看 | 内容 |
|---|---|---|
| 引入依赖:Android · iOS | 开发 | Maven 与离线包两种方式、聚合坐标、广告 SDK 版本锁定、按需集成单家、清单合并冲突、ABI 与混淆 |
| 初始化:Android · iOS | 开发 | init 与 start 两步、可选项、按需初始化广告平台、Kotlin 写法、日志排查 |
| 开屏广告:Android · iOS | 开发 | 完整示例、三段兜底放行、预加载、Kotlin 写法、交互样式 |
| 激励视频广告:Android · iOS | 开发 | 完整示例、onReward 与 onVideoComplete 的区别、关闭行为、服务端发奖验证的入口 |
| Banner 广告:Android · iOS | 开发 | 完整示例、聚合层驱动刷新、尺寸规格、生命周期与泄漏 |
| 预加载与缓存:Android · iOS | 开发 | preload 接口、各广告位的缓存行为、进程被杀后清空、过期与自动补位 |
服务端与配置
| 文档 | 给谁看 | 内容 |
|---|---|---|
| 服务端对接 | 服务端开发 | 激励视频服务端发奖验证:链路、请求头与请求体、验签规则、重试策略、Java / Python 示例 |
| 配置与凭证 | 开发 | 三类凭证与能否进 APK、更换 App 密钥、配置拉取行为、拉不到配置的排查、客户端时钟校正 |
| 策略配置格式 | 平台运营 | 下发配置的结构、每个字段的含义、调度规则、价格怎么配才不会把竞价压死、穿山甲后台怎么配 |
数据与合规
| 文档 | 给谁看 | 内容 |
|---|---|---|
| 数据与事件 | 开发 / 数据 | 十种埋点事件、两条容易被误读的口径、事件回调、上报与不丢数据的保证、报表口径 |
| 合规与隐私 | 合规 / 法务 | 内嵌第三方 SDK 清单、权限逐条来源、合规控制能力、已知问题、AdMix 自身的埋点采集清单 |
参考
| 文档 | 给谁看 | 内容 |
|---|---|---|
| 错误码参考 | 开发 | AdMix 错误码与穿山甲 / 优量汇错误码一张总表,含每一条的处置办法 |
| 常见问题 | 开发 | 接入自检清单,以及按现象组织的排查:构建失败、没有广告、白屏、包体积、报表对不上 |
全部版本
Android
| 版本 | 发布日期 | 文档 | 发布说明 |
|---|---|---|---|
| 1.2.0(最新) | 2026-10-25 | 进入 | 更新日志 |
| 1.1.0 | 2026-10-17 | 离线包内 | 更新日志 |
| 1.0.0 | 2026-09-20 | 离线包内 | 更新日志 |
iOS
| 版本 | 发布日期 | 文档 | 发布说明 |
|---|---|---|---|
| 1.0.0(最新) | 2026-10-17 | 进入 | 更新日志 |
/docs/latest/… 永远指向最新版:例如 /docs/latest/quickstart 会跳到当前最新版的那一页,地址栏里显示确切版本号,便于确认当前看的是哪一版。
版本与兼容约定
- 配置字段只增不删。SDK 逐个键取值、忽略不认识的键,所以平台加字段对老版本 SDK 是安全的; 需要新版 SDK 才支持的能力由服务端按「最低 SDK 版本」裁剪后再下发,不需要在 App 里做判断。
- 对外 API 的破坏性改动会升主版本号,并写进 更新日志 里该版本顶部的「升级注意」。
- 对外 API 的范围是文档列出的那些类:
AdMix、AdMixConfig、AdError、AdnType、com.admix.api下的广告类与监听器、AdPreloader.PreloadListener、AdEvent/AdEventListener/AdEventType。其余包是内部实现,标了@RestrictTo,随版本变化且不保证兼容。
需要的东西没在文档里?见 关于与联系。