API 参考
初始化
| 方法 | 返回类型 | 描述 |
|---|---|---|
InitializeAsync(string appKey, bool testMode) | Task<CloudXError?> | 初始化 SDK。成功返回 null,失败返回 CloudXError。 |
配置
在InitializeAsync 之前调用这些方法:
| 方法 | 描述 |
|---|---|
SetHashedUserId(string hashedUserId) | 设置用于定向的哈希用户标识符。 |
SetUserKeyValue(string key, string value) | 设置自定义用户级键值对。 |
SetAppKeyValue(string key, string value) | 设置自定义应用级键值对。 |
ClearAllKeyValues() | 清除所有自定义键值对。 |
横幅方法
| 方法 | 描述 |
|---|---|
CreateBanner(string placementName, CloudXAdViewConfiguration config) | 创建横幅广告视图。 |
ShowBanner(string placementName) | 显示横幅广告。 |
HideBanner(string placementName) | 隐藏横幅广告。 |
LoadBanner(string placementName) | 手动加载横幅广告(仅在禁用自动刷新时)。 |
StartBannerAutoRefresh(string placementName) | 启动自动横幅刷新。 |
StopBannerAutoRefresh(string placementName) | 停止自动横幅刷新。 |
DestroyBanner(string placementName) | 销毁横幅广告视图。 |
MREC 方法
| 方法 | 描述 |
|---|---|
CreateMrec(string placementName, CloudXAdViewConfiguration config) | 创建 MREC 广告视图。 |
ShowMrec(string placementName) | 显示 MREC 广告。 |
HideMrec(string placementName) | 隐藏 MREC 广告。 |
LoadMrec(string placementName) | 手动加载 MREC 广告(仅在禁用自动刷新时)。 |
StartMrecAutoRefresh(string placementName) | 启动自动 MREC 刷新。 |
StopMrecAutoRefresh(string placementName) | 停止自动 MREC 刷新。 |
DestroyMrec(string placementName) | 销毁 MREC 广告视图。 |
插屏方法
| 方法 | 返回类型 | 描述 |
|---|---|---|
LoadInterstitial(string placementName) | void | 加载插屏广告。 |
ShowInterstitial(string placementName) | void | 展示插屏广告。 |
IsInterstitialReady(string placementName) | bool | 检查插屏是否准备好展示。 |
激励广告方法
| 方法 | 返回类型 | 描述 |
|---|---|---|
LoadRewarded(string placementName) | void | 加载激励广告。 |
ShowRewarded(string placementName) | void | 展示激励广告。 |
IsRewardedReady(string placementName) | bool | 检查激励广告是否准备好展示。 |
CloudXAd 属性
| 属性 | 类型 | 描述 |
|---|---|---|
PlacementName | string | 创建/加载广告时使用的广告位名称。 |
PlacementId | string | 唯一广告位标识符。 |
BidderName | string | 获胜竞价方网络的名称。 |
ExternalPlacementId | string? | 外部广告位 ID(可空)。 |
Revenue | double | 此广告展示产生的收入(美元)。 |
CloudXError 属性
| 属性 | 类型 | 描述 |
|---|---|---|
errorCodeName | string | 错误代码名称(例如 “NO_FILL”、“NETWORK_ERROR”)。 |
errorCodeValue | int | 数字错误代码。 |
message | string? | 可选错误消息。 |
AdViewPosition 枚举
横幅和 MREC 广告的位置选项(3x3 网格):| 值 | 描述 |
|---|---|
TopLeft | 屏幕左上角。 |
TopCenter | 屏幕顶部中央。 |
TopRight | 屏幕右上角。 |
CenterLeft | 屏幕左侧中央。 |
Centered | 屏幕中央。 |
CenterRight | 屏幕右侧中央。 |
BottomLeft | 屏幕左下角。 |
BottomCenter | 屏幕底部中央。 |
BottomRight | 屏幕右下角。 |
事件回调参考
横幅回调
| 事件 | 类型 | 描述 |
|---|---|---|
CloudXAdsCallbacks.Banner.OnAdLoadSuccess | Action<CloudXAd> | 横幅广告加载成功。 |
CloudXAdsCallbacks.Banner.OnAdLoadFailed | Action<CloudXError> | 横幅广告加载失败。 |
CloudXAdsCallbacks.Banner.OnAdClicked | Action<CloudXAd> | 横幅广告被点击。 |
CloudXAdsCallbacks.Banner.OnAdRevenuePaid | Action<CloudXAd> | 横幅广告收入已记录。 |
MREC 回调
| 事件 | 类型 | 描述 |
|---|---|---|
CloudXAdsCallbacks.Mrec.OnAdLoadSuccess | Action<CloudXAd> | MREC 广告加载成功。 |
CloudXAdsCallbacks.Mrec.OnAdLoadFailed | Action<CloudXError> | MREC 广告加载失败。 |
CloudXAdsCallbacks.Mrec.OnAdClicked | Action<CloudXAd> | MREC 广告被点击。 |
CloudXAdsCallbacks.Mrec.OnAdRevenuePaid | Action<CloudXAd> | MREC 广告收入已记录。 |
插屏回调
| 事件 | 类型 | 描述 |
|---|---|---|
CloudXAdsCallbacks.Interstitial.OnAdLoadSuccess | Action<CloudXAd> | 插屏广告加载成功。 |
CloudXAdsCallbacks.Interstitial.OnAdLoadFailed | Action<CloudXError> | 插屏广告加载失败。 |
CloudXAdsCallbacks.Interstitial.OnAdShowSuccess | Action<CloudXAd> | 插屏广告展示成功。 |
CloudXAdsCallbacks.Interstitial.OnAdShowFailed | Action<CloudXError> | 插屏广告展示失败。 |
CloudXAdsCallbacks.Interstitial.OnAdHidden | Action<CloudXAd> | 插屏广告已关闭。 |
CloudXAdsCallbacks.Interstitial.OnAdClicked | Action<CloudXAd> | 插屏广告被点击。 |
CloudXAdsCallbacks.Interstitial.OnAdRevenuePaid | Action<CloudXAd> | 插屏广告收入已记录。 |
激励广告回调
| 事件 | 类型 | 描述 |
|---|---|---|
CloudXAdsCallbacks.Rewarded.OnAdLoadSuccess | Action<CloudXAd> | 激励广告加载成功。 |
CloudXAdsCallbacks.Rewarded.OnAdLoadFailed | Action<CloudXError> | 激励广告加载失败。 |
CloudXAdsCallbacks.Rewarded.OnAdShowSuccess | Action<CloudXAd> | 激励广告展示成功。 |
CloudXAdsCallbacks.Rewarded.OnAdShowFailed | Action<CloudXError> | 激励广告展示失败。 |
CloudXAdsCallbacks.Rewarded.OnAdHidden | Action<CloudXAd> | 激励广告已关闭。 |
CloudXAdsCallbacks.Rewarded.OnAdClicked | Action<CloudXAd> | 激励广告被点击。 |
CloudXAdsCallbacks.Rewarded.OnAdRewarded | Action<CloudXAd> | 用户获得奖励。 |
CloudXAdsCallbacks.Rewarded.OnAdRevenuePaid | Action<CloudXAd> | 激励广告收入已记录。 |