一、导入SDK依赖

1.1、压缩包目录结构

1.2、导入SDK文件

1. 在 app 目录下新建 libs 文件夹
2. 将工程libs目录下aar文件拷贝实际项目的libs文件夹下
3. 在 app/build.gradle 添加如下代码：

repositories {
    flatDir {
        dirs 'libs'
    }
}

dependencies {
    // 非常重要，adprof-sdk中 使用了kotlin代码，媒体务必要依赖 kotlin 否则运行时会崩
    implementation 'org.jetbrains.kotlin:kotlin-stdlib:1.7.10'
    
    implementation(name: 'adprof-sdk-x.x.x', ext: 'aar')
}

1.3、AndroidManifest配置

添加访问权限：在 AndroidManifest.xml 文件中添加，建议在您的隐私协议中向开发者声明 Adprof SDK 会获取下述权限并应用于广告投放

<!--必要权限-->
<uses-permission android:name="android.permission.INTERNET" />

<!--可选权限-->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

<uses-permission android:name="android.permission.READ_PHONE_STATE" />

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
<uses-permission android:name="android.permission.QUERY_ALL_PACKAGES"/>

注意：Adprof SDK不强制获取可选权限，即使没有获取可选权限SDK也能正常运行

1.4、混淆配置

为了保证 Adprof SDK 正常⼯作，请务必添加以下 ProGuard 配置打包：

# Adprof混淆
-dontwarn com.adprof.sdk.**
-keep class com.adprof.sdk.** {*;}
-keep interface com.adprof.**{ *;}

二、SDK初始化

2.1、代码实现

// 个性化广告开关设置
AdprofSdk.getInstance().setPersonalRecommend(true);

AdprofSdk.getInstance().init(this, new AdprofSdkConfig.Builder()
        .appId("")       //必填
        .appSecret("")   // 必填
        .userId("")      // 用户ID，有就填, 非必须
        .useHttps(true)      // 是否使用 https 发起广告请求
        .showLog(false)   // 是否展示adsdk内部日志，正式环境务必为false
        .addCustomData(new HashMap<>())  //自定义数据

        // 媒体自行控制sdk可以采集哪些信息
        // 初始化时 不收集信息，若媒体允许前提下才会在加载广告时再收集
        .customController(new CustomController() {  
       

                    @Override
                    public boolean canUsePhoneState() {
                        return super.canUsePhoneState();
                    }

                    @Override
                    public boolean canUseAndroidId() {
                        return super.canUseAndroidId();
                    }

                    @Override
                    public boolean canUseWifiState() {
                        return super.canUseWifiState();
                    }

                    @Override
                    public boolean canUseIMEI() {
                        return super.canUseIMEI();
                    }

                    @Override
                    public boolean canUseMac() {
                        return super.canUseMac();
                    }

                    @Override
                    public boolean canReadLocation() {
                        return super.canReadLocation();
                    }

                    @Override
                    public boolean canReadDiskSpace() {
                        return super.canReadDiskSpace();
                    }

                    @Override
                    public boolean canUseSensor() {
                        return super.canUseSensor();
                    }


                    @Override
                    public String getMacAddress() {
                        return super.getMacAddress();
                    }

                    @Override
                    public Location getLocation() {
                        return super.getLocation();
                    }

                    @Override
                    public String getImei() {
                        return "";
                    }

                    @Override
                    public String getAndroidId() {
                        return "";
                    }

                    @Override
                    public String getOaid() {
                        return "";
                    }

                    @Override
                    public long getDiskTotalBytes() {
                        return super.getDiskTotalBytes();
                    }


        })
        
        .setInitCallback(new InitCallback() {
            // 初始化成功回调，初始化成功后才可以加载广告
            @Override
            public void onSuccess() {
                Log.d(ConstantsDemo.LOG_TAG, "init---onSuccess---");
            }

            // 初始化失败回调
            @Override
            public void onFail(int code, String msg) {
                Log.d(ConstantsDemo.LOG_TAG, "init---onFail---" + code + ":" + msg);
            }
        }).build());

2.1.1 AdprofSdkConfig

com.adprof.sdk.api.AdprofSdkConfig.Builder

2.1.2 CustomController

com.adprof.sdk.api.CustomController

2.1.3 InitCallback

com.adprof.sdk.api.InitCallback

2.2、个性化广告设置（可选）

AdprofSdk.getInstance().setPersonalRecommend(boolean personal);

三、插屏广告

3.1 插屏广告加载

AdRequest adRequest = new AdRequest.Builder()
        .setCodeId(codeId)
        .setBidFloor(1)
        .setExtOption(options)
        .build();
mInterstitialAd = new InterstitialAd(adRequest, listener);
mInterstitialAd.loadAd();

3.2 插屏广告展示

if (interstitialAd != null && interstitialAd.isReady()) {
    interstitialAd.showAd(activity);
}

3.3 InterstitialAdListener回调

InterstitialAdListener listener = new InterstitialAdListener() {
    @Override
    public void onInterstitialAdLoadError(AdError error) { }

    @Override
    public void onInterstitialAdLoadSuccess() { }

    @Override
    public void onInterstitialAdLoadCached() { }

    @Override
    public void onInterstitialAdShow() { }

    @Override
    public void onInterstitialAdPlayEnd() { }

    @Override
    public void onInterstitialAdClick() { }

    @Override
    public void onInterstitialAdClosed() { }

    @Override
    public void onInterstitialAdShowError(AdError error) { }
};

3.4 插屏广告销毁

if (interstitialAd != null) {
    interstitialAd.destroyAd();
    interstitialAd = null;
}

3.5 插屏API介绍

3.5.1 InterstitialAd

com.adprof.sdk.api.InterstitialAd

3.5.2 AdRequest

com.adprof.sdk.api.AdRequest.Builder

3.5.3 InterstitialAdListener

com.adprof.sdk.api.InterstitialAdListener

四、激励广告

4.1 激励视频加载

AdRequest adRequest = new AdRequest.Builder()
        .setCodeId(codeId)
        .setBidFloor(1)
        .setExtOption(options)
        .build();
RewardAd mRewardAd = new RewardAd(adRequest, listener);
mRewardAd.loadAd();

4.2 激励广告展示

if (mRewardAd != null && mRewardAd.isReady()) {
    mRewardAd.showAd(activity);
}

4.3 RewardAdListener回调

RewardAdListener listener = new RewardAdListener() {
    @Override
    public void onRewardAdLoadSuccess() { }

    @Override
    public void onRewardAdLoadCached() { }

    @Override
    public void onRewardAdShow() { }

    @Override
    public void onRewardAdPlayStart() { }

    @Override
    public void onRewardAdPlayEnd() { }

    @Override
    public void onRewardAdClick() { }

    @Override
    public void onRewardAdClosed() { }

    @Override
    public void onRewardAdLoadError(AdError error) { }

    @Override
    public void onRewardAdShowError(AdError error) { }

    @Override
    public void onRewardVerify() { }

    @Override
    public void onAdSkip() { }
};

4.4 激励视频广告销毁

if (mRewardAd != null) {
    mRewardAd.destroyAd();
    mRewardAd = null;
}

4.5 激励视频API介绍

4.5.1 RewardAd

com.adprof.sdk.api.RewardAd

4.5.2 AdRequest

com.adprof.sdk.api.AdRequest.Builder

4.5.3 RewardAdListener

com.adprof.sdk.api.RewardAdListener

五、开屏广告

5.1 开屏广告加载

AdRequest adRequest = new AdRequest.Builder()
        .setCodeId(ConstantsDemo.SPLASH_SLOTID)  // 广告位ID
        .setExtOption(new HashMap())   // 透传自定义数据
        .build();

splashAd = new SplashAd(adRequest, mSplashAdListener, 5 * 1000);
splashAd.loadAd();

5.2 开屏广告展示

// 展示前先判断是否ready
if (splashAd != null && splashAd.isReady()) {
    splashAd.showAd(splashLY);
}

5.3 SplashAdListener回调

private final SplashAdListener mSplashAdListener = new SplashAdListener() {

    @Override
    public void onAdLoadSuccess() {
        Log.d(ConstantsDemo.LOG_TAG, "--LoadSuc:" + splashAd.isReady() + " " + splashAd.getBidPrice());
    }

    @Override
    public void onAdCacheSuccess() {
        Log.d(ConstantsDemo.LOG_TAG, "----------onAdCacheSuccess-----" + splashAd.isReady());
    }

    @Override
    public void onSplashAdLoadFail(AdError error) {
        Log.d(ConstantsDemo.LOG_TAG, "----------onSplashAdLoadFail----------" + error.toString());
        gotoMainActivity();
    }

    @Override
    public void onSplashAdShow() {
        Log.d(ConstantsDemo.LOG_TAG, "----------onSplashAdShow----------");
    }

    @Override
    public void onSplashAdShowError(AdError error) {
        Log.d(ConstantsDemo.LOG_TAG, "-----onSplashAdShowError----------" + error.toString());
        gotoMainActivity();
    }

    @Override
    public void onSplashAdClick() {
        Log.d(ConstantsDemo.LOG_TAG, "----onSplashAdClick----------");
    }

    @Override
    public void onSplashAdClose(boolean isSkip) {
        Log.d(ConstantsDemo.LOG_TAG, "----------onSplashAdClose---------" + isSkip);
        gotoMainActivity();
    }
};

5.4 开屏API介绍

5.4.1 SplashAd

com.adprof.sdk.api.SplashAd

5.4.2 AdRequest

com.adprof.sdk.api.AdRequest.Builder

5.4.3 SplashAdListener

com.adprof.sdk.api.SplashAdListener

5.5 开屏广告销毁

// 界面销毁时，执行销毁Ad接口
if (splashAd != null) {
    splashAd.destroyAd();
    splashAd = null;
}

六、信息流广告

6.1 信息流加载

AdRequest adRequest = new AdRequest.Builder()
        .setCodeId(codeId)
        .setIsExpressAd(true) // true 模版渲染   false自渲染
        .build();

nativeAd = new NativeAd(adRequest, nativeAdLoadListener);
nativeAd.loadAd();

6.2.1 信息流自渲染

NativeAdData nativeAdData = currentAdDataList.get(0);
// 通过 NativeAdData 获取对应素材地址，Title,AppInfo下载六要素等信息
// 注册绑定：
bindViewForInteraction(view, clickViews, nativeAdEventListener);
// 具体可参考NativeDemoRender

6.2.2 信息流模板

NativeAdData nativeAdData = currentAdDataList.get(0);
View feedView = nativeAdData.getFeedView();
adContainer.addView(data.getFeedView());
nativeAdData.setNativeAdEventListener(listener);
nativeAdData.setNativeAdMediaListener(nativeAdMediaListener);

6.3 NativeAdLoadListener 回调

NativeAdLoadListener loadListener = new NativeAdLoadListener() {
    @Override
    public void onAdError(AdError error) {
        Log.d(ConstantsDemo.LOG_TAG, "----onAdError----------:" + error.toString());
    }

    @Override
    public void onAdLoad(List<NativeAdData> adDataList) {
        if (adDataList != null && !adDataList.isEmpty()) {
            currentAdDataList = adDataList;
        }
    }
};

6.4 信息流广告销毁

if (nativeAd != null) {
    nativeAd.destroyAd();
    nativeAd = null;
}

6.5 原生API介绍

6.5.1 NativeAd

com.adprof.sdk.api.NativeAd

6.5.2 AdRequest

com.adprof.sdk.api.AdRequest.Builder

6.5.3 NativeAdLoadListener

com.adprof.sdk.api.NativeAdLoadListener

6.5.4 NativeAdData

com.adprof.sdk.api.NativeAdData

6.5.5 NativeAdAllEventListener

此类是 NativeAdEventListener 的子类

com.adprof.sdk.api.NativeAdAllEventListener

6.5.6 NativeAdMediaListener

com.adprof.sdk.api.NativeAdData.NativeAdMediaListener

6.5.7 安卓下载应用六要素信息

com.adprof.sdk.api.AdAppInfo

由于国内监管部门要求，在安卓下载类广告中，需要给用户披露下载的应用的六要素信息。开发者可以通过 getAdAppInfo() 方法获取。六要素信息包括：

6.5.8 信息流模板

1. 通过 isExpressAd() 判断是否为信息流模板，true 模板广告，false 自渲染
2. 信息流模板通过 setNativeAdEventListener 和 setNativeAdMediaListener 对信息流广告交互进行监听

七、横幅广告

7.1 横幅广告加载

AdRequest adRequest = new AdRequest.Builder()
        .setCodeId(codeID)
        .build();

mBannerAd = new BannerAd(adRequest, listener, true, true);
mBannerAd.loadAd();

7.2 横幅广告展示

if (mBannerAd != null && mBannerAd.isReady()) {
    View bannerView = mBannerAd.getBannerView();
    if (bannerView != null) {
        bannerContainer.addView(bannerView);
    }
}

7.3 BannerAdListener回调

BannerAdListener listener = new BannerAdListener() {

    @Override
    public void onBannerAdLoadSuccess() { }

    @Override
    public void onBannerAdShow() { }

    @Override
    public void onBannerAdClick() { }

    @Override
    public void onBannerAdClosed() { }

    @Override
    public void onBannerAdLoadError(AdError error) { }
    
    @Override
    public void onBannerAdShowError(AdError adError) { }
};

7.4 横幅广告销毁

if (mBannerAd != null) {
    mBannerAd.destroyAd();
    mBannerAd = null;
}

7.5 横幅广告API介绍

7.5.1 BannerAd

com.adprof.sdk.api.BannerAd

7.5.2 AdRequest

com.adprof.sdk.api.AdRequest.Builder

7.5.3 BannerAdListener

com.adprof.sdk.api.BannerAdListener

八、错误码及常见问题

8.1 AdprofSDK 错误码信息说明

8.2 targetSdkVersion 28以上可以发送http请求

<manifest>
<application
    android:networkSecurityConfig="@xml/network_security_config"
    android:usesCleartextTraffic="true">
</manifest>

// network_security_config.xml 文件配置

<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
    <base-config cleartextTrafficPermitted="true"/>
</network-security-config>

8.3 系统installProvider失败或者开启MultiDex导致的Not find Class

参考链接：https://developer.android.com/studio/build/multidex

android {
    buildTypes {
        release {
            multiDexKeepProguard file('multidex-config.pro')
            ...
        }
    }
}

8.4 Demo运行问题

如果demo运行不起来，检查Gradle JDK版本

8.5 AndroidX与Android support冲突

在项目根目录下文件gradle.properties，添加以下代码：

android.enableJetifier=true
android.useAndroidX=true

九、竞价回传

竞胜回传

Map<String, Object> map = new HashMap<>();
map.put(IBiddingNotify.WIN_FIRST_PRICE, winPrice);      // 竞胜出价，值类型为Integer
map.put(IBiddingNotify.WIN_HIGHEST_LOSS_PRICE, secondPrice);    // 最大竞败方出价，值类型为Integer

AdprofBaseAd.sendWinNotify(map); // 各类型对象都是AdprofBaseAd 类型

竞败回传

Map<String, Object> map = new HashMap<>();
map.put(IBiddingNotify.LOSS_FIRST_PRICE, winPrice);      // 竞败时，其他家ADN胜出的价格，值类型为Integer
map.put(IBiddingNotify.LOSS_REASON, IBiddingNotify.AdLoseType);    // 竞败原因

AdprofBaseAd.sendLossNotify(map);

十、测试广告位ID

十一、更新日志

v2.2.3

1. 支持广告格式：开屏、插屏、激励、Banner、信息流
2. 信息流格式广告支持自渲染和模版渲染
3. 交互方式：摇一摇、滑动、点击、扭一扭
4. 落地方式：Webview打开落地页、Deeplink、APP下载拉新
5. 广告合规优化
6. 适配 taku 聚合