SDK 集成说明
DeepAdx 提供 iOS、Android 原生 SDK 以及 Flutter 跨端插件,支持 Banner、插屏、激励视频、开屏、信息流等常见广告位,并可按需接入国内/海外广告渠道。
文档导航
| 文档 | 说明 |
|---|---|
| Flutter | Flutter Plugin 集成、初始化、五种广告形态示例(开屏/插屏/激励/横幅/原生) |
| AI 接入 Skill | 给 AI 编程助手的接入规范(版本、渠道代码、成对依赖、china/global) |
| iOS | CocoaPods 集成、初始化、各广告位示例 |
| Swift | Swift 项目接入指引 |
| Android | Maven / AAR 集成、初始化、各广告位示例 |
| 示例测试 ID | iOS / Android / Flutter 示例工程测试 App ID、广告位 ID |
| 错误码汇总 | iOS / Android / Flutter 聚合层与渠道透传错误码说明 |
| SDK 版本记录 | iOS / Android / Flutter 发版历史、Breaking Change 与升级对照 |
| 激励视频服务端回调 | 服务端发奖回调协议 |
| Q&A | 常见问题 |
接入前准备
- 联系商务获取开发者账号并创建应用。
- 获取 App ID 与各广告位的 广告单元 ID(
placement_id)。 - 创建广告单元后获取 placementId(
placement_id),初始化各广告位时必须传入。 - 未上架应用请先联系商务添加 测试设备,再进行联调。
完整平台操作见 开始使用。
接入流程概览
注册后台 → 创建应用 / 广告单元 → 添加 SDK 依赖 → 配置 Manifest → 隐私同意后初始化 → 按广告位 load/show → 测试设备联调| 步骤 | iOS | Android |
|---|---|---|
| 1. 添加依赖 | CocoaPods DeepAdxSDK | Maven com.deepadx.sdk:* 或本地 AAR |
| 2. 按需选渠道 | subspecs:CSJ / GDT / KS / BD / GG / PAG | 各 deepadx-adapter-* 模块 |
| 3. 三方 SDK | 随 subspec 自动拉取 | BD、Pangle 海外 须额外依赖(见下) |
| 4. 初始化 | 隐私同意后 registerAppID: | 隐私同意后 DeepAdx.init() |
| 5. 广告位 | 传入 placementId 构造各 Ad 类 | 同上 |
iOS 快速接入
当前版本: DeepAdxSDK 2.0.6
ruby
# Podfile
platform :ios, '12.0'
pod 'DeepAdxSDK', '2.0.6', :subspecs => ['Core', 'CSJ', 'GDT', 'KS', 'BD', 'GG', 'PAG']- 执行
pod install,打开.xcworkspace。 - 在
Info.plist配置各渠道所需 Key(AdMobGADApplicationIdentifier等)。 - 用户同意隐私政策后调用
[DeepAdx registerAppID:...]。 - 按广告位使用
DeepAdxBanner、DeepAdxRewardVideo等 API。
详见 iOS 接入文档、Swift 接入文档。
Android 快速接入
当前版本: com.deepadx.sdk:* 2.1.8
1. 配置 Maven 仓库
gradle
dependencyResolutionManagement {
repositories {
maven { url "https://maven.deepadx.com/repository/maven-releases/" }
mavenCentral()
google()
// Pangle 海外
maven { url 'https://artifact.bytedance.com/repository/pangle' }
}
}2. 添加依赖(成对引入,按需保留)
每一组为 adapter + 三方 SDK 成对依赖;Demo 示例含全渠道,客户请只保留用到的组。
gradle
dependencies {
def sdkVer = '2.1.8'
implementation "com.deepadx.sdk:deepadx-core:${sdkVer}"
// ===== 国内:CSJ / GDT / BD / KS =====
chinaImplementation "com.deepadx.sdk:deepadx-adapter-csj:${sdkVer}"
chinaImplementation 'com.pangle_beta.cn:mediation-sdk:7.4.1.4'
chinaImplementation "com.deepadx.sdk:deepadx-adapter-gdt:${sdkVer}"
chinaImplementation 'com.deepadx.thirdparty:gdt-union-normal:4.640.1510'
chinaImplementation "com.deepadx.sdk:deepadx-adapter-bd:${sdkVer}"
chinaImplementation 'com.deepadx.thirdparty:baidu-mobads-sdk:9.432'
chinaImplementation "com.deepadx.sdk:deepadx-adapter-ks:${sdkVer}"
chinaImplementation 'com.deepadx.thirdparty:kssdk-ad:5.1.20.1'
// ===== 海外:GG / PAG(与 CSJ 二选一)=====
globalImplementation "com.deepadx.sdk:deepadx-adapter-gg:${sdkVer}"
globalImplementation 'com.google.android.gms:play-services-ads:24.9.0'
globalImplementation "com.deepadx.sdk:deepadx-adapter-pag:${sdkVer}"
globalImplementation 'com.pangle.global:ads-sdk:6.5.1.2'
}成对表详见 Android 文档 §2。漏三方包会导致对应渠道无法运行。
3. AndroidManifest
配置 INTERNET、AdMob APPLICATION_ID 等,详见 Android 文档 §5。
4. 初始化与广告位
java
// 用户同意隐私政策后
DeepAdx.init(activity, "YOUR_APP_ID", initCallBack);
DeepAdxRewardVideo reward = new DeepAdxRewardVideo(activity, "YOUR_PLACEMENT_ID", listener);
reward.loadOnly();详见 Android 接入文档。
Flutter 快速接入
当前版本: deepadx_sdk 1.0.3(默认桥接 Android 2.1.8、iOS 2.0.6)
yaml
dependencies:
deepadx_sdk: ^1.0.3bash
flutter pub add deepadx_sdk插件已自动引入双端核心 SDK。渠道 adapter 仍须在宿主工程按需追加(Android Maven deepadx-adapter-*、iOS DeepAdxSDK subspec),详见 Flutter 接入文档。
示例工程
| 平台 | 源码 | 当前版本 | 在线体验(蒲公英) |
|---|---|---|---|
| Android 原生 | deepadx-android-sdk Example | 2.1.8 | 国内 · 海外 |
| iOS 原生 | deepadx-ios-sdk Example | 2.0.6 | 切本地地区 |
| Flutter | deepadx-flutter-sdk example | 1.0.3 | Android 国内 · Android 海外 · iOS 切本地地区 |
iOS 包为内测签名,请在已登记的测试设备上安装;国内 / 海外随系统地区切换。
Android(原生 / Flutter)用 Flavor 区分国内 / 海外,包名不同,可同时安装。详见 示例测试 ID。
版本说明
文档中的 SDK 版本号为发布示例,实际集成请以 CocoaPods / Maven / pub 仓库最新版本为准:
- Flutter:
deepadx_sdk1.0.3(pub.dev / Gitee 示例工程) - iOS:
DeepAdxSDK2.0.6(CocoaPods / Gitee 示例工程) - Android:
com.deepadx.sdk:*2.1.8(Maven / Gitee 示例工程)
完整发版说明与升级对照见 SDK 版本记录。
