跳转到主要内容

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 属性

属性类型描述
PlacementNamestring创建/加载广告时使用的广告位名称。
PlacementIdstring唯一广告位标识符。
BidderNamestring获胜竞价方网络的名称。
ExternalPlacementIdstring?外部广告位 ID(可空)。
Revenuedouble此广告展示产生的收入(美元)。

CloudXError 属性

属性类型描述
errorCodeNamestring错误代码名称(例如 “NO_FILL”、“NETWORK_ERROR”)。
errorCodeValueint数字错误代码。
messagestring?可选错误消息。

AdViewPosition 枚举

横幅和 MREC 广告的位置选项(3x3 网格):
描述
TopLeft屏幕左上角。
TopCenter屏幕顶部中央。
TopRight屏幕右上角。
CenterLeft屏幕左侧中央。
Centered屏幕中央。
CenterRight屏幕右侧中央。
BottomLeft屏幕左下角。
BottomCenter屏幕底部中央。
BottomRight屏幕右下角。

事件回调参考

横幅回调

事件类型描述
CloudXAdsCallbacks.Banner.OnAdLoadSuccessAction<CloudXAd>横幅广告加载成功。
CloudXAdsCallbacks.Banner.OnAdLoadFailedAction<CloudXError>横幅广告加载失败。
CloudXAdsCallbacks.Banner.OnAdClickedAction<CloudXAd>横幅广告被点击。
CloudXAdsCallbacks.Banner.OnAdRevenuePaidAction<CloudXAd>横幅广告收入已记录。

MREC 回调

事件类型描述
CloudXAdsCallbacks.Mrec.OnAdLoadSuccessAction<CloudXAd>MREC 广告加载成功。
CloudXAdsCallbacks.Mrec.OnAdLoadFailedAction<CloudXError>MREC 广告加载失败。
CloudXAdsCallbacks.Mrec.OnAdClickedAction<CloudXAd>MREC 广告被点击。
CloudXAdsCallbacks.Mrec.OnAdRevenuePaidAction<CloudXAd>MREC 广告收入已记录。

插屏回调

事件类型描述
CloudXAdsCallbacks.Interstitial.OnAdLoadSuccessAction<CloudXAd>插屏广告加载成功。
CloudXAdsCallbacks.Interstitial.OnAdLoadFailedAction<CloudXError>插屏广告加载失败。
CloudXAdsCallbacks.Interstitial.OnAdShowSuccessAction<CloudXAd>插屏广告展示成功。
CloudXAdsCallbacks.Interstitial.OnAdShowFailedAction<CloudXError>插屏广告展示失败。
CloudXAdsCallbacks.Interstitial.OnAdHiddenAction<CloudXAd>插屏广告已关闭。
CloudXAdsCallbacks.Interstitial.OnAdClickedAction<CloudXAd>插屏广告被点击。
CloudXAdsCallbacks.Interstitial.OnAdRevenuePaidAction<CloudXAd>插屏广告收入已记录。

激励广告回调

事件类型描述
CloudXAdsCallbacks.Rewarded.OnAdLoadSuccessAction<CloudXAd>激励广告加载成功。
CloudXAdsCallbacks.Rewarded.OnAdLoadFailedAction<CloudXError>激励广告加载失败。
CloudXAdsCallbacks.Rewarded.OnAdShowSuccessAction<CloudXAd>激励广告展示成功。
CloudXAdsCallbacks.Rewarded.OnAdShowFailedAction<CloudXError>激励广告展示失败。
CloudXAdsCallbacks.Rewarded.OnAdHiddenAction<CloudXAd>激励广告已关闭。
CloudXAdsCallbacks.Rewarded.OnAdClickedAction<CloudXAd>激励广告被点击。
CloudXAdsCallbacks.Rewarded.OnAdRewardedAction<CloudXAd>用户获得奖励。
CloudXAdsCallbacks.Rewarded.OnAdRevenuePaidAction<CloudXAd>激励广告收入已记录。