主题
Banner广告
1. 主要API
1.1 ApexAdxBanner
com.apex.adx.ApexAdxBanner
| 方法名 | 方法介绍 |
|---|---|
| ApexAdxBanner(Activity activity, ApexAdxBannerListener apexAdxBannerListener) | 构造方法。参数说明:activity(请求广告的 activity)。 apexAdxBannerListener:回调监听。广告相关状态会通过 listener 通知开发者。 |
| loadBannerAd(ApexAdxBannerRequest request) | 拉取广告。参数说明:request(广告请求对象)。 |
| showBannerAd(ViewGroup adContainer) | 展示广告。参数说明:adContainer(广告显示的容器)。 |
| showBannerAd(ViewGroup adContainer, ViewGroup.LayoutParams layoutParams) | 展示广告。参数说明:adContainer(广告显示的容器)。layoutParams:布局参数 |
| isReady() | 广告是否准备好,未准备好广告将无法展示。 |
| destroy() | 销毁广告。 |
1.2 ApexAdxBannerRequest
com.apex.adx.req.ApexAdxBannerRequest
| 方法名 | 方法介绍 |
|---|---|
| ApexAdxBannerRequest(String pid, String userId, Map<String, Object> options) | 构造方法。参数说明:pid(广告位Id)、userId(用户Id可选)、options(扩展参数,可传任意)。 |
1.3 ApexAdxBannerListener
com.apex.adx.listener.ApexAdxBannerListener
| 方法名 | 方法介绍 |
|---|---|
| onLoadSuccess(String pid) | 广告成功加载。参数说明:pid(广告位Id)。 |
| onLoadError(ApexAdxError error, String pid) | 广告加载失败。参数说明:error(报错信息,具体可看其内部code和msg)、pid(报错的广告位Id)。 |
| onShown() | 广告成功展示,媒体可在此记录曝光。 |
| onClicked() | 广告被点击。 |
| onClosed() | 广告关闭。 |
| onAutoRefreshed() | 广告刷新成功。 |
| onAutoRefreshFail(ApexAdxError error, String pid) | 广告刷新失败。参数说明:error(报错信息,具体可看其内部code和msg)、pid(报错的广告位Id)。 |
2. 接入代码示例
2.1 设置监听回调
java
private ApexAdxBanner apexAdxBanner;
apexAdxBanner = new ApexAdxBanner(this, new ApexAdxBannerListener() {
@Override
public void onLoadSuccess(String pid) {
}
@Override
public void onLoadError(ApexAdxError error, String pid) {
}
@Override
public void onShown() {
}
@Override
public void onClicked() {
}
@Override
public void onClosed() {//开发者可以在此回调中移除bannerView
}
@Override
public void onAutoRefreshed() {
}
@Override
public void onAutoRefreshFail(ApexAdxError error, String pid) {
}
});2.2 Banner广告加载
java
/**
* PID 必填
* USER_ID 可选
* OPTIONS 自定义参数 可选
*/
ApexAdxBannerRequest request = new ApexAdxBannerRequest(PID, USER_ID, OPTIONS);
if (apexAdxBanner != null) {
apexAdxBanner.loadBannerAd(request);
}2.3 Banner广告展示
java
/**
* 收到onLoadSuccess回调代表广告已ready
*/
if (apexAdxBanner != null && apexAdxBanner.isReady()) {
//媒体最终将要展示广告的容器
if (adContainer != null) {
apexAdxBanner.showBannerAd(adContainer);
}
}