全部产品

API参考

布局界面属性

用于在布局中直接配置广告位,广告View上支持以下几种属性:

属性

类型

含义

备注

cloud_code_cc_slot_id

字符串

广告位ID。

如果使用xml配置,必填。

cloud_code_cc_slot_type

枚举

splash:开屏广告位banner:banner广告位。

部分广告位可以不用配置,具体参考各广告位接入文档。

cloud_code_cc_loop_interval

整型

轮播间隔单位毫秒,最低30000ms。

仅支持轮播的广告位有效。

cloud_code_cc_ratio_width

整型

广告View宽度占比。

用于固定广告View大小,如果使用,必须同时设置宽高比例。

cloud_code_cc_ratio_height

整型

广告View高度占比。

用于固定广告View大小,如果使用,必须同时设置宽高比例。

AdSlotType

广告位类型枚举类。

枚举值

含义

备注

UNKNOWN

未知广告位。

异常情况,不需要使用。

SPLASH

开屏广告位。

无。

INTERSTITIAL

插屏广告位。

无。

BANNER

banner广告位。

无。

AdSlot

广告位配置类,通过Builder构建。

方法

含义

备注

public Builder slotId(String id)

配置广告位ID。

无。

public Builder slotType(AdSlotType slotType)

配置广告位类型,具体请参考AdSlotType

无。

public Builder loopInterval(int loopInterval)

配置广告位轮播间隔,单位ms。

仅支持轮播的广告位需要,默认30秒,最小间隔为30秒。

AdLoadListener

广告加载结果回调接口。

方法

含义

备注

void loadSuccess();

加载成功回调。

此时可以把广告View展示出来(添加到布局、隐藏改展示、或者类似插屏等需要的时候再展示)。

void loadFail(String code, String msg);

加载失败回调。

此时需要处理广告加载失败的情况,比如直接跳转到下一页或者保持广告view隐藏,不再展示。

错误码,详见错误码参考

SplashAdView

开屏广告View。

方法

含义

备注

public void setAdSlot(AdSlot adSlot)

配置广告位信息,具体请参考AdSlot

无。

public void setAdLoadListener(AdLoadListener adLoadListener)

设置加载回调,具体请参考AdLoadListener

无。

public void loadAd()

开始加载广告。

无。

public void setAdInteractListener(SplashAdInteractListener interactListener)

设置交互回调,具体请参考SplashAdView.SplashAdInteractListener

无。

public void setRatioWidth(int ratioWidth)

设置view宽度占比。

如果使用,必须同时设置宽高比例。

public void setRatioHeight(int ratioHeight)

设置view高度占比。

如果使用,必须同时设置宽高比例。

SplashAdView.SplashAdInteractListener

开屏广告的交互回调接口。

方法

含义

备注

void onTimeOver()

倒计时结束回调。

此时需要处理跳转下一个界面的逻辑。

void jump()

用户点击跳过回调。

此时需要处理跳转下一个界面的逻辑。

void onShowed()

广告曝光通知回调。

无。

void onClicked()

用户点击广告时通知回调。

无。

void onAction(int action, int event)

广告操作回调。

  • action:

    表示此广告点击时是应用内打开一个网络url。

  • event:

    表示网络url加载完成。

InterstitialAdLoader

插屏广告加载器。

方法

含义

备注

public InterstitialAdLoader(Context context)

构建插屏广告加载器。

context是展示插屏广告的界面上下文。

public void setAdSlot(AdSlot adSlot)

配置广告位信息,具体请参考AdSlot

无。

public void setAdLoadListener(AdLoadListener adLoadListener)

设置加载回调,具体请参考AdLoadListener

无。

public void loadAd()

开始加载广告。

无。

public boolean isReadyToShow()

主动判断广告是否加载完成可以展示。

无。

public void show()

展示插屏广告。

无。

public void hide()

隐藏插屏广告。

无。

public void release()

释放插屏广告。

在不需要插屏广告的时候调用,避免泄露资源。

public void setAdInteractListener(AdInteractListener adInteractListener)

设置交互回调,具体请参考InterstitialAdLoader.AdInteractListener

无。

InterstitialAdLoader.AdInteractListener

插屏广告的交互回调接口。

方法

含义

备注

void onClosed()

用户点击关闭回调。

无。

void onShowed()

广告曝光通知回调。

无。

void onClicked()

用户点击广告时通知回调。

无。

void onAction(int action, int event)

广告操作回调。

  • action:

    1.表示此广告点击时是应用内打开一个网络url。

  • event:

    1.表示网络url加载完成。

BannerAdView

banner广告View。

方法

含义

备注

public void setAdSlot(AdSlot adSlot)

配置广告位信息,具体请参考AdSlot

无。

public void setAdLoadListener(AdLoadListener adLoadListener)

设置加载回调,具体请参考AdLoadListener

无。

public void loadAd()

开始加载广告。

无。

public void setAdInteractListener(AdInteractListener interactListener)

设置交互回调,具体请参考BannerAdView.AdInteractListener

无。

BannerAdView.AdInteractListener

开屏广告的交互回调接口。

方法

含义

备注

void close()

用户点击关闭回调。

此时需要处理广告View隐藏。

void onShowed()

广告曝光通知回调。

无。

void onClicked()

用户点击广告时通知回调。

无。

void onAction(int action, int event)

广告操作回调。

  • action:

    1.表示此广告点击时是应用内打开一个网络url。

  • event:

    1.表示网络url加载完成。

CloudCodeInitializer

云码SDK初始化类。

方法

含义

备注

public static void init(Context context)

初始化。

渠道ID、媒体ID从manifest中读取

需要主动调用。

请在用户签署相关隐私协议之后调用,请在使用广告相关api之前调用。

初始化只能执行一次。

public static void init(Context context, String channelId, String mediaId)

初始化,并代码设置渠道ID、媒体ID。

需要主动调用。

请在用户签署相关隐私协议之后调用,请在使用广告相关api之前调用。

初始化只能执行一次。

public static String getDeviceId(Context context)

获取设备标识。

用于定位问题时,获取SDK使用的设备标识。

public static String getSdkVersion()

获取SDK版本。

用于定位问题时,获取SDK的版本。

CloudCodeLog

云码SDK日志接口类。

方法

含义

备注

public static void setILogger(ILogger logger)

设置默认的日志输出接口ILogger

默认输出到logcat。

public static void enable(boolean enableLog)

设置默认的日志输出接口是否输出日志。

默认输出。

public static void setLevel(LogLevel level)

设置默认的日志输出接口输出的日志级别。

默认输出warn级别日志。

public static void addILogger(ILogger logger)

添加额外的日志输出接口。

注意额外的日志输出接口,会输出全部日志,日志开关和过滤需要自己控制。

public static void removeILogger(ILogger logger)

移除额外的日志输出接口。

无。

ILogger

日志输出接口。

方法

含义

备注

void print(LogLevel level, String tag, String message)

输出日志。

用于自定义日志如何输出。

LogLevel

日志级别的枚举类。

枚举值

含义

DEBUG

debug级别日志。

INFO

info级别日志。

WARN

warn级别日志。

ERROR

error级别日志。