API参考
布局界面属性
用于在布局中直接配置广告位,广告View上支持以下几种属性:
属性 | 类型 | 含义 | 备注 |
---|---|---|---|
cloud_code_cc_slot_id | 字符串 | 广告位ID。 | 如果使用xml配置,必填。 |
cloud_code_cc_slot_type | 枚举 | splash:开屏广告位banner:banner广告位。 | 部分广告位可以不用配置,具体参考各广告位接入文档。 |
cloud_code_cc_loop_interval | 整型 | 轮播间隔单位毫秒,最低30000毫秒。 | 仅支持轮播的广告位有效。 |
cloud_code_cc_ratio_width | 整型 | 广告View宽度占比。 | 用于固定广告View大小,如果使用,必须同时设置宽高比例。 |
cloud_code_cc_ratio_height | 整型 | 广告View高度占比。 | 用于固定广告View大小,如果使用,必须同时设置宽高比例。 |
AdSlotType
广告位类型枚举类。
枚举值 | 含义 | 备注 |
---|---|---|
UNKNOWN | 未知广告位。 | 异常情况,不需要使用。 |
SPLASH | 开屏广告位。 | 无。 |
INTERSTITIAL | 插屏广告位。 | 无。 |
BANNER | banner广告位。 | 无。 |
FEEDS | feeds广告位。 | 无。 |
AdStyleType
广告样式枚举类。
枚举值 | 含义 | 备注 |
---|---|---|
UNKNOWN | 未知广告样式。 | 异常情况,不需要使用。 |
BANNER_640_100 | banner广告样式,左图右文。 | 无。 |
INTERSTITIAL_v_1_1 | 插屏广告样式,广告大小1比1。 | 无。 |
INTERSTITIAL_v_3_2 | 插屏广告样式,广告大小3比2。 | 无。 |
INTERSTITIAL_v_2_3 | 插屏广告样式,广告大小2比3。 | 无。 |
INTERSTITIAL_h_16_9 | 插屏广告样式,广告大小16比9。 | 无。 |
INTERSTITIAL_v_full | 插屏广告样式,广告大小竖屏全屏。 | 无。 |
SPLASH_HALF | 开屏广告样式,上面广告,底部logo | 无。 |
SPLASH_V_FULL | 开屏广告样式,全屏 | 无。 |
FEEDS_LEFT_IMAGE_RIGHT_TEXT | feeds广告样式,左图右文。 | 无。 |
FEEDS_LEFT_TEXT_RIGHT_IMAGE | feeds广告样式,左文右图。 | 无。 |
FEEDS_UP_IMAGE_DOWN_TEXT | feeds广告样式,上图下文。 | 无。 |
FEEDS_UP_TEXT_DOWN_IMAGE | feeds广告样式,上文下图。 | 无。 |
FEEDS_UP_IMAGE_DOWN_TEXT_FLOAT_TEXT | feeds广告样式,上图下文带文字浮层。 | 无。 |
FEEDS_UP_TEXT_DOWN_IMAGE_FLOAT_TEXT | feeds广告样式,上文下图带文字浮层。 | 无。 |
FEEDS_DOUBLE_IMAGE_TEXT | feeds广告样式,图文带icon和标题。 | 无。 |
FEEDS_SINGLE_IMAGE_TEXT_FLOAT_TEXT | feeds广告样式,单图带文字浮层。 | 无。 |
FEEDS_VERTICAL_IMAGE | feeds广告样式,竖版纯图。 | 无。 |
FEEDS_HORIZONTAL_IMAGE | feeds广告样式,横版纯图。 | 无。 |
FEEDS_THREE_IMAGE_TEXT | feeds广告样式,带三个小图。 | 无。 |
FEEDS_VERTICAL_IMAGE_TEXT | feeds广告样式,竖版图文。 | 无。 |
FEEDS_VERTICAL_IMAGE_TEXT_FLOAT_TEXT | feeds广告样式,竖版图文带文字浮层。 | 无。 |
AdSlot
广告位配置类,通过Builder构建。
方法 | 含义 | 备注 |
---|---|---|
public Builder slotId(String id) | 配置广告位ID。 | 无。 |
public Builder slotType(AdSlotType slotType) | 配置广告位类型,具体请参考AdSlotType。 | 无。 |
public Builder loopIntervalMillis(int loopInterval) | 配置广告位轮播间隔,单位毫秒。 | 仅支持轮播的广告位需要,默认30 * 1000毫秒,最小间隔为30 * 1000毫秒。 |
public Builder selectStyle(AdStyleType styleType) | 新增此广告位支持的广告样式。 | 可以多次调用,配置多个广告样式 |
public Builder styles(List<AdStyleType> styleTypeList) | 一次性配置此广告位支持的广告样式 | 会移除之前配置的广告样式 |
public Builder minVideoLength(int length) | 配置视频广告素材最小的时长 | 如果广告位支持视频广告,才会生效 |
public Builder maxVideoLength(int length) | 配置视频广告素材最大的时长 | 如果广告位支持视频广告,才会生效 |
public Builder mute(boolean enable) | 配置视频广告素材是否静音播放 | 默认静音 |
CloudCodeLoader.AdLoadListener
广告加载结果回调接口。
方法 | 含义 | 备注 |
---|---|---|
void loadSuccess(List<CloudCodeAd> cloudCodeAds) | 加载成功回调。cloudCodeAds为请求到的广告 | 此时可以获取广告View并展示出来(添加到布局、隐藏改展示、或者类似插屏等需要的时候再展示)。 |
void loadFail(String code, String msg); | 加载失败回调。 | 此时需要处理广告加载失败的情况,比如直接跳转到下一页或者保持广告view隐藏,不再展示。 |
错误码,详见错误码参考。
CloudCodeAd
广告数据包装类。
方法 | 含义 | 备注 |
---|---|---|
public <T extends View> T getAdView() | 获取广告View,用于View类型广告 | 开屏广告返回SplashAdView; banner返回BannerAdView; feeds返回FeedsAdView; |
public <T extends ICloudCodeAdController> T getAdController() | 获取广告控制器,用于弹窗类型广告 | 插屏返回InterstitialAdLoader; |
SplashAdView
开屏广告View。
方法 | 含义 | 备注 |
---|---|---|
public void setAdInteractListener(SplashAdInteractListener interactListener) | 设置交互回调,具体请参考SplashAdView.SplashAdInteractListener。 | 无。 |
SplashAdView.SplashAdInteractListener
开屏广告的交互回调接口。
方法 | 含义 | 备注 |
---|---|---|
void onTimeOver() | 倒计时结束回调。 | 此时需要处理跳转下一个界面的逻辑。 |
void jump() | 用户点击跳过回调。 | 此时需要处理跳转下一个界面的逻辑。 |
void onShowed() | 广告曝光通知回调。 | 无。 |
void onClicked() | 用户点击广告时通知回调。 | 无。 |
void onAction(int action, int event) | 广告操作回调。 |
|
SplashAdView.SplashAdInteractListener2
继承自SplashAdView.SplashAdInteractListener,用于V+模式下监听用户点击关闭操作。
方法 | 含义 | 备注 |
---|---|---|
void close() | 用户点击小窗的关闭按钮 | 此时需要处理移除广告View逻辑。 |
InterstitialAdLoader
插屏广告加载器。
方法 | 含义 | 备注 |
---|---|---|
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) | 广告操作回调。 |
|
BannerAdView
banner广告View。
方法 | 含义 | 备注 |
---|---|---|
public void setAdInteractListener(AdInteractListener interactListener) | 设置交互回调,具体请参考BannerAdView.AdInteractListener。 | 无。 |
BannerAdView.AdInteractListener
开屏广告的交互回调接口。
方法 | 含义 | 备注 |
---|---|---|
void close() | 用户点击关闭回调。 | 此时需要处理广告View隐藏。 |
void onShowed() | 广告曝光通知回调。 | 无。 |
void onClicked() | 用户点击广告时通知回调。 | 无。 |
void onAction(int action, int event) | 广告操作回调。 |
|
CloudCodeInitializer
智能营销引擎SDK初始化类。
方法 | 含义 | 备注 |
---|---|---|
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的版本。 |
public static void setOAID(String oaid) | 设置用户设备的oaid | 用于广告的精准推荐 |
CloudCodeLoader
广告加载器,单例,用于加载各种广告。
方法 | 含义 | 备注 |
---|---|---|
public static CloudCodeLoader getInstance() | 获取加载器 | 无。 |
public abstract void load(Context context, AdSlot adSlot, AdLoadListener listener) | 为广告位adSlot请求一个广告 | 无。 |
public abstract void load(final Context context, final AdSlot adSlot, final int count, final AdLoadListener listener) | 为广告位adSlot请求多个广告 | 无。 |
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级别日志。 |