开屏广告

一、需要实现的抽象方法

• 开发者只需要继承TPSplashAdapter并重写相关方法：
  • 开发者调用TP SDK的loadAd() API时，会调用到自定义Adapter的loadCustomAd()方法
  • 开发者调用TP SDK的isReady() API时，会调用到自定义Adapter的isReady()方法
  • 开发者调用TP SDK的showAd() API时，会依次调用到自定义Adapter的isReady()、showAd()方法

抽象方法	参数说明	返回值	作用
loadCustomAd()	context 上下文； userParams 本地配置参数；tpParams 服务器下发参数	Context；Map；Map	用于获取服务器下发和本地配置的参数，实现自定义广告的加载逻辑
showAd()	-----	-----	实现展示自定义广告的逻辑。用于直接弹出activity的源。
mAdContainerView		ViewGroup	实现展示自定义广告的逻辑。用于提供view的源，开发者可把view直接add到该容器中
isReady()	-----	boolean	用于展示广告前判断自定义广告是否过期。
clean()	-----	-----	用于释放资源
getNetworkVersion()	-----	String	自定义三方广告的版本号
getNetworkName()	-----	String	自定义三方广告的名称

---

二、开屏广告事件回调

（1）mLoadAdapterListener实现广告事件的回调

方法	说明
loadAdapterLoadFailed(TPError)	实现广告事件的加载失败回调。TPError见下面介绍。
loadAdapterLoaded(TPBaseAd)	实现广告事件加载成功回调，该类型直接传null

（2）mShowListener实现展示广告事件的回调

方法	说明
onAdVideoStart()	实现广告事件的展示回调。
onAdVideoEnd()	实现广告事件的关闭回调。
onAdVideoError(TPError)	实现广告事件的展示失败回调。TPError见下面介绍。
onAdVideoClicked()	实现广告事件的点击回调。

---

三、其他API说明

• TPError方法

 TPError tpError = new TPError(NETWORK_NO_FILL);
 tpError.setErrorCode(adError.getErrorCode() +"");
 tpError.setErrorMessage(adError.getErrorMessage());

TPError方法	说明
setTpErrorCode()	设置三方的ErrorCode错误码。
setErrorMessage()	设置三方的ErrorMsg错误信息。
NETWORK_NO_FILL	自定义广告平台NOFILL。
ADAPTER_CONFIGURATION_ERROR	自定义广告平台服务器下发参数错误。
SHOW_FAILED	自定义广告平台展示失败。

• loadCustomAd()中本地配置参数常量

常量	说明
AppKeyManager.GDPR_CONSENT	GDPR,了解更多见政策合规,下同
AppKeyManager.KEY_GDPR_CHILD	GDPRChild，GDPR儿童
AppKeyManager.KEY_COPPA	COPPA，美国儿童在线隐私权保护法
AppKeyManager.KEY_CCPA	CPPA，加州消费者隐私法案

---

四、示例代码

/*
 * 开屏类型需要继承TPSplashAdapter,并重写以下几个方法
 * loadCustomAd() 用于获取服务器下发和本地配置的参数，实现自定义广告平台的加载逻辑
 * showAd()  实现展示自定义广告平台激励视频的逻辑
 * isReady() 用于展示广告前判断自定义广告是否过期
 * clean() 用于释放资源
 * getNetworkVersion() 自定义三方源的版本号
 * getNetworkName 自定义三方源的名称
 * */
public class AdmobSplashAdapter extends TPSplashAdapter {
    public static final String TAG = "AdmobSplashAdapter";
    private AppOpenAd mAppOpenAd;
    private String placementId;
    private AdRequest request;

    @Override
    public void loadCustomAd(Context context, Map<String, Object> userParams, Map<String, String> tpParams) {
        // tpParams 获取从服务器端下发的字段
        if (tpParams.size() > 0 && tpParams.containsKey("placemntId")) {
            placementId = tpParams.get("placemntId");
        } else {
            /*
             * mLoadAdapterListener在oadCustomAd重写时同步生成
             * 回调方法loadAdapterLoaded ：广告加载成功
             * 回调方法loadAdapterLoadFailed ：广告加载失败
             *          构造TPError方法，ADAPTER_CONFIGURATION_ERROR 服务器下发参数错误
             *          方法setTpErrorCode 设置三方的ErrorCode错误码
             *          方法setErrorMessage 设置三方的ErrorMsg错误信息
             *
             * */
            if (mLoadAdapterListener != null) {
                mLoadAdapterListener.loadAdapterLoadFailed(new TPError(ADAPTER_CONFIGURATION_ERROR));
            }
            return;
        }

        request = new AdRequest.Builder().build();
        MobileAds.disableMediationAdapterInitialization(context);
        MobileAds.initialize(context, new OnInitializationCompleteListener() {
            @Override
            public void onInitializationComplete(InitializationStatus initializationStatus) {
                Log.i(TAG, "onInitializationComplete: ");
                AppOpenAd.load(context, placementId, request, AppOpenAd.APP_OPEN_AD_ORIENTATION_PORTRAIT, appOpenAdLoadCallback);
            }
        });
    }

    private final AppOpenAd.AppOpenAdLoadCallback appOpenAdLoadCallback = new AppOpenAd.AppOpenAdLoadCallback() {

        @Override
        public void onAdLoaded(@NonNull AppOpenAd appOpenAd) {
            Log.i(TAG, "onAdLoaded: ");
            mAppOpenAd = appOpenAd;
            if (mLoadAdapterListener != null) {
                //使用mLoadAdapterListener，实现广告事件加载成功回调
                mLoadAdapterListener.loadAdapterLoaded(null);
            }
        }

        @Override
        public void onAdFailedToLoad(@NonNull LoadAdError loadAdError) {
            Log.i(TAG, "onAdFailedToLoad message: " + loadAdError.getMessage() + ":code:" + loadAdError.getCode());
            TPError tpError = new TPError(NETWORK_NO_FILL);
            tpError.setErrorCode(String.valueOf(loadAdError.getCode()));
            tpError.setErrorMessage(loadAdError.getMessage());
            //使用mLoadAdapterListener，实现广告事件加载失败回调
            if (mLoadAdapterListener != null)
                mLoadAdapterListener.loadAdapterLoadFailed(tpError);
        }

    };

    @Override
    public void showAd() {
        Activity activity = GlobalTradPlus.getInstance().getActivity();
        if (activity == null) {
            if (mShowListener != null) {
                //使用mShowListener，实现广告事件展示失败回调
                mShowListener.onAdVideoError(new TPError(ADAPTER_ACTIVITY_ERROR));
            }
            return;
        }

        if (mAppOpenAd == null) {
            if (mShowListener != null) {
                mShowListener.onAdVideoError(new TPError(UNSPECIFIED));
            }
            return;
        }

        mAppOpenAd.setFullScreenContentCallback(fullScreenContentCallback);
        mAppOpenAd.show(activity);
    }

    final FullScreenContentCallback fullScreenContentCallback = new FullScreenContentCallback() {
        @Override
        public void onAdDismissedFullScreenContent() {
            Log.i(TAG, "onAdDismissedFullScreenContent: ");
            //使用mShowListener实现广告事件的关闭回调
            if (mShowListener != null) {
                mShowListener.onAdClosed();
            }
        }

        @Override
        public void onAdFailedToShowFullScreenContent(AdError adError) {
            Log.i(TAG, "onAdFailedToShowFullScreenContent msg : " + adError.getMessage() + ":code:" + adError.getCode());
            TPError tpError = new TPError(NETWORK_NO_FILL);
            tpError.setErrorCode(String.valueOf(adError.getCode()));
            tpError.setErrorMessage(adError.getMessage());
            if (mLoadAdapterListener != null)
                mLoadAdapterListener.loadAdapterLoadFailed(tpError);
        }

        @Override
        public void onAdShowedFullScreenContent() {
            Log.i(TAG, "onAdShowedFullScreenContent: ");
            //使用mShowListener实现广告事件的展示回调
            if (mShowListener != null) {
                mShowListener.onAdShown();
            }
        }
    };


    @Override
    public void clean() {
        //释放资源
        if (mAppOpenAd != null) {
            mAppOpenAd.setFullScreenContentCallback(null);
            mAppOpenAd = null;
        }
    }

    @Override
    public boolean isReady() {
        // 用于判断广告是否过期
        return true;
    }

    @Override
    public String getNetworkName() {
        // 自定义三方广告源的名称
        return "Admob";
    }

    @Override
    public String getNetworkVersion() {
        // 自定义三方广告源的版本号
        return MobileAds.getVersionString();
    }
}