概述
CloudX 移动端 SDK 提供了将移动广告集成到您应用中的全面 API。SDK 可用于 Android 和 iOS 平台,具有一致的功能和命名约定。平台特定文档
Android API 参考
完整的 Android SDK API 文档包:
io.cloudx.sdk版本: 0.6.1语言: Kotlin / JavaiOS API 参考
完整的 iOS SDK API 文档框架:
CloudXCore版本: 1.1.57语言: Swift / Objective-CSDK 版本
当前版本
| 平台 | 版本 | 发布日期 | 最低版本 |
|---|---|---|---|
| Android | 0.6.1 | 最新 | Android 5.0 (API 21) |
| iOS | 1.1.57 | 最新 | iOS 14.0 |
安装
- Android (Gradle)
- iOS (CocoaPods)
build.gradle.kts
支持的广告格式
两个平台支持相同的广告格式,行为一致:| 广告格式 | 描述 | 尺寸 |
|---|---|---|
| 横幅 | 标准横幅广告 | 320x50 |
| MREC | 中等矩形 | 300x250 |
| 插屏 | 全屏广告 | 全屏 |
| 激励 | 激励视频广告 | 全屏 |
| 原生小 | 原生广告小 | 320x90 |
| 原生中 | 原生广告中 | 320x250 |
核心功能
初始化
两个 SDK 都需要在加载广告之前使用 CloudX 控制台的应用密钥进行初始化。广告生命周期
- 加载 - 从网络请求广告
- 展示 - 向用户展示广告(仅全屏)
- 回调 - 接收事件(已加载、失败、点击等)
- 销毁 - 清理资源
隐私与合规
- GDPR - IAB TCF 2.0 支持
- CCPA - US Privacy String 支持
- GPP - 全球隐私平台支持
定向
- 自定义键值对
- 用户级定向
- 应用级定向
- 哈希用户 ID
网络适配器
- CloudX - 原生 CloudX 网络
- Meta - Facebook Audience Network
- Vungle - Vungle/Liftoff(仅 iOS)
- InMobi - InMobi 网络(仅 iOS)
平台要求
Android
- 最低 SDK: 21 (Android 5.0)
- 目标 SDK: 35
- 编译 SDK: 35
- Kotlin: 1.9.0+
- Java: 8+
- Gradle: 8.0+
iOS
- 最低 iOS: 14.0
- Xcode: 12.0+
- Swift: 5.0+
- Objective-C: 完全支持
- CocoaPods: 1.10+
API 设计理念
一致性
两个 SDK 遵循相似的模式:- 单例初始化
- 代理/监听器回调
- 相似的方法名称
- 一致的错误代码
类型安全
- Kotlin 和 Swift 中的强类型
- 错误代码和日志级别的枚举
- 配置的数据类
错误处理
- 标准化错误代码(100-799 范围)
- 详细的错误消息
- 基于回调的错误报告
常见错误代码
两个平台使用相同的错误代码范围:| 代码范围 | 类别 | 描述 |
|---|---|---|
| 100-199 | 初始化 | SDK 初始化错误 |
| 200-299 | 网络 | 网络连接问题 |
| 300-399 | 广告加载 | 广告请求和加载错误 |
| 400-499 | 广告展示 | 广告展示和呈现错误 |
| 500-599 | 配置 | SDK 配置错误 |
| 600-699 | 适配器 | 网络适配器错误 |
| 700-799 | 通用 | 通用/意外错误 |