跳转到主要内容

核心类

CloudX

用于初始化和广告创建的主 SDK 单例类。 包: io.cloudx.sdk

初始化

fun initialize(
    initParams: CloudXInitializationParams,
    listener: CloudXInitializationListener?
)
初始化 CloudX SDK。 参数:
  • initParams - 配置参数(appKey、testMode)
  • listener - 初始化结果的可选回调

广告创建方法

fun createBanner(placementName: String): CloudXAdView
fun createMREC(placementName: String): CloudXAdView
fun createInterstitial(placementName: String): CloudXInterstitialAd
fun createRewardedInterstitial(placementName: String): CloudXRewardedInterstitialAd
fun createNativeAdSmall(placementName: String): CloudXAdView
fun createNativeAdMedium(placementName: String): CloudXAdView

隐私与定向

fun setPrivacy(privacy: CloudXPrivacy)
fun setHashedUserId(hashedUserId: String)
fun setUserKeyValue(key: String, value: String)
fun setAppKeyValue(key: String, value: String)
fun clearAllKeyValues()

日志

fun setLoggingEnabled(isEnabled: Boolean)
fun setMinLogLevel(minLogLevel: CloudXLogLevel)

数据类

CloudXInitializationParams

data class CloudXInitializationParams(
    val appKey: String,
    val testMode: Boolean = false
)

CloudXPrivacy

data class CloudXPrivacy(
    val isUserConsent: Boolean? = null,
    val isAgeRestrictedUser: Boolean? = null
)

广告类

CloudXAdView

横幅、MREC 和原生广告视图。 方法:
fun load()
fun startAutoRefresh()
fun stopAutoRefresh()
fun destroy()
var listener: CloudXAdViewListener?

CloudXInterstitialAd

全屏插屏广告。 方法:
fun load()
fun show()
fun destroy()
val isAdReady: Boolean
var listener: CloudXInterstitialListener?

CloudXRewardedInterstitialAd

全屏激励视频广告。 方法:
fun load()
fun show()
fun destroy()
val isAdReady: Boolean
var listener: CloudXRewardedInterstitialListener?

监听器接口

CloudXAdListener

基础广告事件监听器。
interface CloudXAdListener {
    fun onAdLoaded(cloudXAd: CloudXAd)
    fun onAdDisplayed(cloudXAd: CloudXAd)
    fun onAdHidden(cloudXAd: CloudXAd)
    fun onAdClicked(cloudXAd: CloudXAd)
    fun onAdLoadFailed(cloudXError: CloudXError)
    fun onAdDisplayFailed(cloudXError: CloudXError)
}

CloudXAdViewListener

横幅和原生广告监听器(扩展 CloudXAdListener)。
interface CloudXAdViewListener : CloudXAdListener {
    fun onAdExpanded(cloudXAd: CloudXAd)
    fun onAdCollapsed(cloudXAd: CloudXAd)
}

CloudXInterstitialListener

插屏广告监听器(扩展 CloudXAdListener)。
interface CloudXInterstitialListener : CloudXAdListener

CloudXRewardedInterstitialListener

激励广告监听器(扩展 CloudXAdListener)。
interface CloudXRewardedInterstitialListener : CloudXAdListener {
    fun onUserRewarded(cloudXAd: CloudXAd)
}

CloudXInitializationListener

SDK 初始化回调。
interface CloudXInitializationListener {
    fun onInitialized()
    fun onInitializationFailed(cloudXError: CloudXError)
}

模型类

CloudXAd

传递给回调的广告元数据。
interface CloudXAd {
    val placementName: String
    val placementId: String
    val bidderName: String
    val externalPlacementId: String?
    val revenue: Double
}

CloudXError

错误信息。
data class CloudXError(
    val code: CloudXErrorCode,
    val message: String?,
    val cause: Throwable?
) {
    val effectiveMessage: String
}

枚举

CloudXErrorCode

enum class CloudXErrorCode(val value: Int) {
    // 初始化 (100-199)
    NOT_INITIALIZED(100),
    INITIALIZATION_IN_PROGRESS(101),
    NO_ADAPTERS_FOUND(102),
    INITIALIZATION_TIMEOUT(103),
    INVALID_APP_KEY(104),

    // 网络 (200-299)
    NETWORK_ERROR(200),
    NETWORK_TIMEOUT(201),
    INVALID_RESPONSE(202),

    // 广告加载 (300-399)
    NO_FILL(300),
    INVALID_REQUEST(301),
    INVALID_PLACEMENT(302),
    LOAD_TIMEOUT(303),
    LOAD_FAILED(304),

    // 广告展示 (400-499)
    AD_NOT_READY(400),
    AD_ALREADY_SHOWN(401),
    AD_EXPIRED(402),
    SHOW_FAILED(404),

    // 配置 (500-599)
    INVALID_AD_UNIT(500),
    PERMISSION_DENIED(501),
    UNSUPPORTED_AD_FORMAT(502),

    // 通用 (700-799)
    UNEXPECTED_ERROR(700)
}

CloudXLogLevel

enum class CloudXLogLevel {
    VERBOSE,
    DEBUG,
    INFO,
    WARN,
    ERROR
}

适配器类

Meta 适配器

包: io.cloudx.adapter.meta
fun enableMetaAudienceNetworkTestMode(enabled: Boolean)

Maven 坐标

dependencies {
    implementation("io.cloudx:sdk:0.6.1")
    implementation("io.cloudx:adapter-cloudx:0.6.1")
    implementation("io.cloudx:adapter-meta:0.6.1")
}
当前版本: 0.6.1 最低 SDK: 21 (Android 5.0) 目标 SDK: 35