Funlink Android SDK 接入说明

前置说明

使用Funlink SDK前必须满足以下条件。

参数申请

目前聚合广告SDK需要的参数为各广告联盟平台的APPID和各广告位对应ID，请在广告联盟官方指定平台申请或联系具体负责人！

支持的广告联盟和广告类型

Funlink平台配置

接入方需事先在各三方广告联盟SDK平台申请相关广告参数，然后在Funlink聚合平台进行配置。在Funlink聚合平台配置之后，才能正常使用本SDK的聚合功能。

一、准备工作

1.SDK 导入依赖

app目录下的build.gradle文件添加依赖

​x

android {
    ...
    defaultConfig {
        ...

        // 向下兼容版本为21
        minSdkVersion 21
        ...
    }
}

// 引用 aar
repositories {
    flatDir {
        dirs 'libs'
    }
}

dependencies {
    // 广告
    implementation fileTree(include: ['*.jar', '*.aar'], dir: 'libs_yd/ad')
    //美数(汇盈)需要
    implementation 'com.squareup.okhttp3:okhttp:3.12.1'
    implementation 'com.google.code.gson:gson:2.8.5'
    implementation 'com.googlecode.android-query:android-query:0.25.9'
    implementation 'com.android.support:cardview-v7:27.1.1'
    
    //优推需要
    implementation 'com.squareup.okhttp3:okhttp:3.12.1'
    implementation 'com.squareup.okhttp3:logging-interceptor:3.12.0'
    implementation 'com.google.code.gson:gson:2.8.5'
    implementation 'com.github.bumptech.glide:glide:4.8.0'
    implementation 'com.google.android.exoplayer:exoplayer-core:2.13.3'
    implementation 'com.google.android.exoplayer:exoplayer-ui:2.13.3'
    implementation 'commons-codec:commons-codec:1.15'
    
    //快手需要
    implementation 'com.android.support:design:28.0.0'
    implementation 'com.android.support:recyclerview-v7:28.0.0'

    //oppo需要，如使用oppo广告需要引用
    implementation 'androidx.appcompat:appcompat:1.0.2'//注意500版本之后强要求依赖
    implementation 'androidx.recyclerview:recyclerview:1.0.0'//注意500版本之后强要求依赖
    implementation 'androidx.legacy:legacy-support-v4:1.0.0'
    implementation 'com.squareup.okio:okio:2.5.0'
    implementation 'org.jetbrains.kotlin:kotlin-android-extensions-runtime:1.3.72'
    implementation 'android.arch.persistence:db-framework:1.1.1'//410版本新增
    implementation 'androidx.palette:palette:1.0.0'//490版本新增
    //由于可能与接入业务产生冲突，故由开发者决定依赖的版本，wechat sdk区分wechat-sdk-android与wechat-sdk-android-without-mta,由开发者决定依赖版本
    implementation "com.tencent.mm.opensdk:wechat-sdk-android-without-mta:5.5.8"//注意480版本新增，可以提升广告效果
    
    //米盟需要，如使用米盟广告需要引用
    implementation 'com.google.code.gson:gson:2.8.5'
 }

2.权限和架构说明

2.1权限

SDK所需权限如下：

xxxxxxxxxx
<!--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" />

2、以下权限为可选权限，申请以下权限用于防作弊功能以及有助于广告平台投放广告

xxxxxxxxxx
<!--可选权限，申请后用于防作弊功能以及有助于广告平台投放广告-->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

2.2架构

部分广告平台的SDK中带有so库，各平台使用的so文件支持的架构如下：（开发者按需选择以下架构）

穿山甲：arm64-v8a、armeabi-v7a

快手广告：armeabi、arm64-v8a、armeabi-v7a、x86_64、x86 (3.3.15后不支持armeabi)

建议：在build.gradle中添加如下配置，可基本支持大部分手机架构：

xxxxxxxxxx
defaultConfig {
    ...
    ndk{
        abiFilters 'armeabi-v7a','arm64-v8a'
    }
}

3. 代码初始化

请在用户授权后在合适的位置进行初始化，请求广告前必须先执行初始化。

xxxxxxxxxx
public class MyApplication extends Application {
       @Override
       public void onCreate() {
           super.onCreate();
            // 参数1：上下文 Context
            // 参数2：appid，Funlink平台创建应用时获取，必填
           YdConfig.getInstance().init(this,appid);
            // 参数1：上下文 Context
            // 参数2：appid，Funlink平台创建应用时获取,必填
            // 参数3：渠道ID String，和后台对应渠道后可以分渠道配置流量，如不需要传空字符串
            // 参数4：是否开启Debug Boolean，建议在开发阶段打开Debug，方便定位问题。正式环境请关闭
            //YdConfig.getInstance().init(this,appid, "渠道id", false);
            ...
       }
   }    

4.SDK说明

二、广告接入

下面广告请求中需要传入Context的地方都需要传入activity。

1. 开屏广告

展示开屏页的位置：冷启动进入应用时，加载开屏页广告，广告展示完毕，根据各应用的逻辑跳转到相应页面。建议将应用的logo放到广告页的下面，高度不超过200个像素（详见demo），或者将logo页作为广告的背景，有广告返回时广告盖住logo，无广告返回时继续展示logo。

特别注意:当用户点击广告跳转到广告详情页面后onAdclose()方法仍然会被调用，此时开发者还不能打开自己的App主页，当从广告落地页返回以后才可以跳转。所以使用canJump字段配合页面生命周期辅助判断正确的跳转时机。

接入代码示例

xxxxxxxxxx
private YdSpread ydSpread;
private boolean canJump;
/**
* 加载开屏页
* 
* context 上下文
* setKey 运营分配的媒体位
* setScreenPercentage 开屏广告展示区域占屏幕高度的比例，不设置默认为1即全屏高度。
*                     取值范围为0.75到1。如果设计的开屏不是铺满全屏需要计算此值传入。
* setSpreadLoadListener 请求成功监听
* setSpreadListener 回调监听
*/

private void loadSplashAd() {
        ydSpread = new YdSpread.Builder(this)
                .setKey(String)
                .setScreenPercentage(1)//此方法可不调用，具体说明见上面注释
                .setSpreadLoadListener(new SpreadLoadListener() {
                    @Override
                    public void onADLoaded(final SpreadAd spreadAd) {
                        // 广告请求成功回调该方法
                        spreadAd.show(mAdContainer);
                    }
                })
                .setSpreadListener(new AdViewSpreadListener() {
                    @Override
                    public void onAdDisplay() {
                        // 广告展示时回调该方法
                    }

                    @Override
                    public void onAdFailed(YdError error) {
                        // 广告异常、失败，回调该方法
                    }

                    @Override
                    public void onAdClick() {
                        // 广告被点击时回调该方法
                    }
                    
                    @Override
                    public void onAdClose() {
                        // 广告关闭时回调该方法
                        jumpToMain();
                    }
                })
                .build();
        ydSpread.requestSpread();
    }

/**
 * 先判断canJump的值，如果为false说明当前页面已不可见不进行跳转
 * 修改canJump值为true等再次返回此页面后再跳转
 */
private void jumpToMain() {
        if (canJump) {
            doJump();
        } else {
            canJump = true;
        }
}

/**
* 通过onPause()和onResume()方法和canJump变量，控制广告关闭后
* 以及从广告详情返回时页面的跳转
*/
@Override
protected void onPause() {
    super.onPause();
    canJump = false;
}

/**
* 通过onPause()和onResume()方法和canJump变量，控制广告关闭后
* 以及从广告详情返回时页面的跳转
*/
@Override
protected void onResume() {
    super.onResume();
    if (canJump) {
        doJump();
    }
    canJump = true;
}


@Override
protected void onDestroy() {
    super.onDestroy();
    if (ydSpread != null) {
        ydSpread.destroy();
    }
}

//禁止用户返回键退出APP，以免影响广告的曝光和计费
@Override
public boolean onKeyDown(int keyCode, KeyEvent event) {
    if (keyCode == KeyEvent.KEYCODE_BACK || keyCode == KeyEvent.KEYCODE_HOME) {
        return true;
    }
    return super.onKeyDown(keyCode, event);
}

备注：自定义跳过按钮样式时，不要将跳过按钮置于展示广告的容器内，否则会被移除。应该将跳过按钮与展示广告的容器平级设置，可参考Demo的布局方式

2. 插屏广告

插屏广告一般用于离开当前页时或者游戏角色死亡时弹出的广告，可自行传入宽高值，但最终插屏广告的宽高只能接近传入的数值，并不是1：1完全符合。请求插屏广告的时间相对较久（2s左右），为了更好的体验，所以请提前请求，展示的时候只需要show即可

xxxxxxxxxx
YdInterstitial ydInterstitial;
   /**
* 请求插屏广告
* context 上下文
* setKey 运营分配的媒体位
* setWidth 请求广告的宽，单位dp，最终以实际宽度为准
* setHeight 请求广告的高，单位dp，最终以实际高度为准
* setIconListener 回调监听
*/
private void loadAd() {
        ydInterstitial = new YdInterstitial.Builder(this)
                .setKey(String)
                .setWidth(Integer)
                .setHeight(Integer)
                .setInterstitialListener(new AdViewInterstitialListener() {
                    @Override
                    public void onAdReady() {
                        //请求成功时回调。可以在此处调用展示
                         showAd();
                    }

                    @Override
                    public void onAdDisplay() {
                        //广告展示时回调
                    }

                    @Override
                    public void onAdClick() {
                        //广告被点击时回调
                    }

                    @Override
                    public void onAdClosed() {
                        //广告关闭时回调
                    }

                    @Override
                    public void onAdFailed(YdError error) {
                        //广告请求失败时回调
                    }

                })
                .build();
        ydInterstitial.requestInterstitial();
    }

// 展示广告。展示方法只在onAdReady回调后调用有效
private void showAd() {
    if (ydInterstitial != null && ydInterstitial.isReady()) {
         ydInterstitial.show(activity);
    }
}

@Override
protected void onDestroy() {
    super.onDestroy();
    ydInterstitial.destroy();
}

3. Banner广告

Banner的宽度一般是屏幕的宽度，高度在100-150像素之间。Banner广告请求成功后，会有View返回，接入方将其展示在屏幕中即可

xxxxxxxxxx
YdBanner ydBanner;
   /**
* 加载banner
* context 上下文
* setKey 运营分配的媒体位
* setBannerListener 回调监听
*/
private void loadBannerAd() {
        ydBanner = new YdBanner.Builder(Activity)
                .setKey(String)
                // 设置banner的宽度，单位dp，默认值为屏幕宽度，采用默认值时可不用设置
                // .setExpressWidth(int) 
                // 设置banner的高度，单位dp，默认值为宽度1/6.4，采用默认值时可不用设置
                // .setExpressHeight(int) 
                .setBannerListener(new AdViewBannerListener() {
                    @Override
                    public void onReceived(View view) {
                        // 请求广告成功，返回banner
                      
                    }

                    @Override
                    public void onAdClick() {
                        // 广告被点击时回调该方法
                    }

                    @Override
                    public void onAdFailed(YdError error) {
                        // 广告加载出错时回调该方法
                    }
                })
                .build();
        ydBanner.requestBanner();
    }

@Override
protected void onDestroy() {
    super.onDestroy();
    ydBanner.destroy();
}

4. 激励视频

激励视频是一种收益较高的广告类型，广告播放过程中，不能中途关闭，只有广告播放完毕后才会出现关闭按钮，选择使用时需慎重

xxxxxxxxxx

/**
* 请求激励视频
* @param String 运营分配的key
* @param AdViewVideoListener 回调
*/

private void loadRewardVideoAd() {
  ydVideo = new YdVideo.Builder(this)
    .setKey(String)
     //不使用服务端校验无须设置，如使用服务端校验必须设置,且此值不能为空
    .setUserId("唯一id")
    .setCustomData("自定义数据")//不使用服务端校验无须设置，如使用服务端校验选择设置
     //不使用服务端校验无须设置，如使用服务端校验必须设置
    .setAdViewVideoCheckListener(new AdViewVideoCheckListener() {
        @Override
        public void onVideoCheckReward(String transID) {
        //返回校验用订单id,如开启服务端校验，会在onVideoReward回调前给此回调，如未开启服务端校验无需设  置此监听
        }               
    })
    .setVideoListener(new AdViewVideoListener() {

      @Override
      public void onAdShow() {
            // 视频展示回调
      }

      @Override
      public void onAdClose() {
            // 视频关闭回调
      }

      @Override
      public void onVideoPrepared() {
            // 视频加载完成回调
            // 需要在此回调后调用视频播放方法
            showVideo();
      }

      @Override
      public void onVideoReward() {
            // 视频播放奖励回调
      }

      @Override
      public void onVideoCompleted() {
            // 视频播放完毕回调
      }

      @Override
      public void onAdClick() {
            // 视频点击回调
      }

      @Override
      public void onAdFailed(YdError error) {
            // 视频请求失败回调
      }
    })
    .build();
  ydVideo.requestRewardVideo();
}

/**
* 播放视频广告
*/

public void showVideo() {
  if (ydVideo != null && ydVideo.isReady()) {
    ydVideo.show();
  }
}

@Override
protected void onDestroy() {
    super.onDestroy();
    if (ydVideo != null) {
        ydVideo.destroy();
    }
}

5.全屏视频

全屏视频在广告形式上类似激励视频，区别在于广告播放开始或者几秒钟后可以选择关闭，全屏视频没有额外获取奖励的回调。

xxxxxxxxxx
     private YdFullVideo ydFullVideo;

     ydFullVideo = new YdFullVideo.Builder(this)
                .setKey(String)//广告id
                .setVideoListener(new AdViewFullVideoListener() {

                    @Override
                    public void onAdFailed(YdError error) {
                       //请求失败时调用
                    }

                    @Override
                    public void onAdClicked() {
                       //广告点击时调用
                    }

                    @Override
                    public void onPageDismiss() {
                        //广告关闭时调用
                    }

                    @Override
                    public void onVideoPrepared() {
                        // 视频加载完成时调用
                        
                        //可以在视频加载完成回调后择机展示
                        if (ydFullVideo != null && ydFullVideo.isReady()) {
                            ydFullVideo.show();//展示全屏视频
                        }
                    }

                    @Override
                    public void onVideoPlayStart() {
                         // 视频展示时调用
                    }


                })
                .build();
        ydFullVideo.requestFullVideo();//请求全屏视频广告

6.原生混合广告

原生混合广告是将自渲染信息流广告，模版信息流广告，Draw信息流广告封装到同一个API中的广告请求方式。开发者可以在同一个广告位中配置上述不同的广告样式混用。

1. API说明

广告请求

xxxxxxxxxx
public class YdSDK {
    /**
     * 加载原生混合广告请求对象
     *
     * @param context  请使用Activity作为上下文
     * @param params   广告请求的参数配置
     * @param listener 广告加载回调监听
     */
    public static void loadMixNative(Context context, AdParams params, NativeLoadListener listener)
}


/**
 * 原生混合广告请求的参数配置
 */
public class AdParams {

    /**
     * 原生混合广告配置构造器
     */
    public static class Builder {

        /**
         * 构造函数
         *
         * @param posId 广告位Id
         */
        public Builder(String posId)

        /**
         * 设置模板广告的期望宽度，优量汇、穿山甲、京准通、OPPO、Vivo等广告联盟需要。
         * 优量汇可配置为宽度适配父控件宽度，参见{@link #setExpressFullWidth}方法。
         *
         * @param width 模板广告的期望宽度，单位dp
         * @return {@link AdParams.Builder}
         */
        public Builder setExpressWidth(float width)

        /**
         * 设置模板广告的期望高度，优量汇、穿山甲、京准通、OPPO、Vivo等广告联盟需要。
         * 优量汇、穿山甲、Vivo支持高度自适应，参见{@link #setExpressAutoHeight}方法。
         *
         * @param height 模板广告的期望高度，单位dp
         * @return {@link AdParams.Builder}
         */
        public Builder setExpressHeight(float height)

        /**
         * 设置自渲染广告期望的图片素材宽度。穿山甲，京准通需要。
         *
         * @param width 渲染广告期望的图片素材宽度，单位px
         * @return {@link AdParams.Builder}
         */
        public Builder setImageAcceptedWidth(int width)

        /**
         * 设置自渲染广告期望的图片素材高度。穿山甲，京准通需要。
         *
         * @param height 渲染广告期望的图片素材高度，单位px
         * @return {@link AdParams.Builder}
         */
        public Builder setImageAcceptedHeight(int height)

        /**
         * 模板广告高度自适应，优量汇、穿山甲、Vivo支持。
         *
         * @return {@link AdParams.Builder}
         */
        public Builder setExpressAutoHeight()

        /**
         * 模板广告宽度最大程度的使用其父控件给予的宽度，优量汇支持。
         *
         * @return {@link AdParams.Builder}
         */
        public Builder setExpressFullWidth()

        /**
         * 生成{@link AdParams}对象。
         *
         * @return {@link AdParams}
         */
        public AdParams build()
    }
}


/**
 * 原生混合广告加载监听回调
 */
public interface NativeLoadListener {
    /**
     * 广告请求成功
     * @param nativeAd 请求成功的原生混合广告对象
     */
    void onNativeAdLoaded(NativeAd nativeAd);
    
    /**
     * 广告请求错误
     * @param error 错误原因
     */
    void onAdFailed(YdError error);
}

广告渲染

xxxxxxxxxx
/**
 * 原生混合广告对象，广告请求成功返回此对象
 */
public interface NativeAd {
    /**
     * 是否为模板渲染类型的广告
     *
     * @return false：自渲染广告，ture：模板广告
     */
    boolean isNativeExpress();

    /**
     * 绑定展示广告的容器
     *
     * @param nativeAdView   展示广告的容器，广告必须在此容器中，必须为{@link NativeAdView}
     * @param selfRenderView {@link #isNativeExpress()}返回false时（即自渲染广告）需传入开发者自定义的广告view；
     *                       返回ture时（即模板广告）可传null。
     */
    void renderAdContainer(NativeAdView nativeAdView, View selfRenderView);

    /**
     * 渲染展示广告
     *
     * @param prepareInfo 自渲染广告需绑定广告组件配置，用于配置广告点击控件、关闭按钮等等。
     *                    <p>
     *                    {@link #isNativeExpress()}返回ture时（即模板广告）可传null。
     *                    对于模板广告，穿山甲广告需要处理关闭按钮必须设置Activity
     */
    void prepare(NativePrepareInfo prepareInfo);

    /**
     * 绑定视频控件的状态，在Activity的onResume时调用（主要针对部分广告平台的视频广告）
     */
    void onResume();

    /**
     * 绑定视频控件的状态，在Activity的onPause时调用（主要针对部分广告平台的视频广告）
     */
    void onPause();

    /**
     * 获取广告素材或广告view
     */
    NativeMaterial getAdMaterial();

    /**
     * 获取广告的ECPM
     *
     * @return ECPM值，单位：分。
     */
    int getECPM();

    /**
     * 设置广告事件监听
     * @param listener 广告事件监听器
     */
    void setNativeEventListener(NativeEventListener listener);

    /**
     * 销毁当前的广告对象（执行之后该广告无法再进行展示）
     */
    void destroy();
}


/**
 * 自渲染广告需绑定广告组件配置
 */
public class NativePrepareInfo {
    
    /**
     * 可为null，设置关闭按钮，仅穿山甲、京准通支持。设置后支持{@link NativeEventListener}中的广告关闭回调。
     * 在支持的广告联盟渲染后调用方不可对其设置点击事件监听。
     *
     * @param closeView 关闭按钮
     */
    public void setCloseView(View closeView)

    /**
     * 设置创意点击区(Action)，点击事件将有SDK处理，渲染后调用方不可对其设置点击事件监听。
     *
     * @param ctaViews 创意点击区(Action)View
     */
    public void setCtaView(View... ctaViews)

    /**
     * 设置可点击View，点击事件将有SDK处理，渲染后调用方不可对其设置点击事件监听。
     *
     * @param clicks 可点击View
     */
    public void setClickView(View... clicks)

    /**
     * 设置图片展示控件
     *
     * @param views 图片展示控件
     */
    public void setImageView(View... views)

    /**
     * 设置展示广告时的Activity
     *
     * @param activity 广告时的Activity
     */
    public void setActivity(Activity activity)
}

广告事件监听

xxxxxxxxxx
/**
 * 原生混合广告的事件监听回调
 */
public interface NativeEventListener {
    /**
     * 广告展示回调
     */
    void onAdImpressed(NativeAdView adView);

    /**
     * 广告点击回调
     */
    void onAdClicked(NativeAdView adView);

    /**
     * 广告视频播放开始
     */
    void onAdVideoStart(NativeAdView adView);

    /**
     * 用户点击关闭按钮，收到需调用方将广告View{@link NativeAdView}移除界面，部分广告联盟会自动移除广告View。
     * 模板广告均支持此回调，穿山甲广告渲染时需绑定Activity后支持；
     * 自渲染广告仅穿山甲、京准通绑定closeView后，支持此回调。
     */
    void onAdClose(NativeAdView adView);

    /**
     * 广告视频播放开始
     */
    void onAdVideoEnd(NativeAdView adView);

    /**
     * 广告视频播放进度，仅部分广告联盟支持
     */
    void onAdVideoProgress(NativeAdView adView, long progress);

    /**
     * 广告渲染异常或视频播放异常
     */
    void onAdFailed(NativeAdView adView, YdError error);
}

广告素材定义

xxxxxxxxxx
/**
 * 原生混合广告的素材对象
 */
public interface NativeMaterial {

    /**
     * 获取素材类型：
     * {@link NativeAdConst#AD_TYPE_UNKNOWN}：未知类型；
     * {@link NativeAdConst#AD_TYPE_SINGLE_IMG}：单图；
     * {@link NativeAdConst#AD_TYPE_GROUP_IMG}：组图；
     * {@link NativeAdConst#AD_TYPE_VIDEO}：视频。
     *
     * @return 素材类型
     */
    int getAdType();

    /**
     * 获取主图，可能为null，仅部分广告联盟有值。
     *
     * @return 图片的URL地址
     */
    @Nullable
    String getMainImageUrl();

    /**
     * 获取图片列表，部分广告联盟可能返回null或空列表。
     *
     * @return 图片的URL地址List
     */
    List<String> getImageUrlList();

    /**
     * 获取广告标题
     *
     * @return 广告标题
     */
    String getTitle();

    /**
     * 获取广告描述
     *
     * @return 广告描述
     */
    String getDescription();
    
    /**
     * 获取广告的创意文案，部分广告联盟可能返回null。
     *
     * @return 返回创意文案
     */
    String getCallToAction();

    /**
     * 获取广告的ICON图标URL地址，部分广告联盟可能返回null。
     *
     * @return 广告的ICON图标URL地址
     */
    String getIconUrl();

    /**
     * 获取广告的MediaView
     *
     * @return 自渲染广告返回视频的View，模板广告返回广告的View
     */
    View getAdMediaView();

    /**
     * 获取视频的URL地址，请优先使用{@link #getAdMediaView()}展示视频
     *
     * @return 视频的URL地址
     */
    String getVideoUrl();

    /**
     * 已过时
     * 获取广告标示，可能为null，仅部分广告联盟有值
     *
     * @return 广告标示的Bitmap对象
     */
    @Deprecated
    Bitmap getAdLogo();

    /**
     * 获取广告标示，标识中不带广告二字，可能为null，仅部分广告联盟有值
     * 预先判断此方法，如果此方法没有返回再通过getAdLogoUrl获取
     *
     * @return 广告标示的Bitmap对象
     */
    Bitmap getAdLogoBitmap();

    /**
     * 获取广告标示，可能为null，仅部分广告联盟有值
     *
     * @return 广告标示的URL地址
     */
    String getAdLogoUrl();

    /**
     * 返回视频时长，不支持获取视频时长的广告联盟返回0。
     *
     * @return 视频时长
     */
    double getVideoDuration();

    /**
     * 返回合规六要素。
     *
     * @return 应用信息对象
     */
    NativeAdAppInfo getAdAppInfo();
}

xxxxxxxxxx
/**
 * 合规六要素对象
 */
public interface NativeAdAppInfo {
  /**
   * @return 应用名称
   */
  String getAppName();

  /**
   * @return 开发者公司名称
   */
  String getPublisher();

  /**
   * @return 应用版本号
   */
  String getAppVersion();

  /**
   * @return 隐私协议url
   */
  String getAppPrivacyUrl();

  /**
   * @return 权限列表url
   */
  String getAppPermissionUrl();

  /**
   * @return 产品功能url
   */
  String getFunctionUrl();

  /**
   * @return 权限列表点击
   */
  ClickEvent getPermissonClick();

  /**
   * @return 隐私点击
   */
  ClickEvent getPrivacyClick();

  /**
   * @return 功能页面点击
   */
  ClickEvent getFunctionClick();

  interface ClickEvent {
    void onClick();
  }
}

2. 接入代码示例

xxxxxxxxxx
// 1. 构造请求参数
int width = DeviceUtil.px2dip(container.getWidth());
int imageW = DeviceUtil.dip2px(240);
int imageH = DeviceUtil.dip2px(130);

AdParams params = new AdParams.Builder(BuildConfig.MixNative)
                // 期望模板宽高，优量汇、穿山甲、京准通、OPPO、Vivo等广告联盟需要
                // 优量汇可配置为宽度适配父控件宽度，优量汇、穿山甲、Vivo支持高度自适应
                .setExpressHeight(100) // 期望模板高度
                .setExpressWidth(width) // 期望模板宽度
                .setExpressAutoHeight() // 模板高度自适应，优量汇、穿山甲、Vivo支持
                .setExpressFullWidth() // 模板宽度适配父控件宽度，优量汇支持
                // 自渲染广告期望的图片素材宽高，穿山甲，京准通需要
                .setImageAcceptedHeight(imageH)
                .setImageAcceptedWidth(imageW)
                .build();
// 2. 发起请求
YdSDK.loadMixNative(this, params, new NativeLoadListener() {
    @Override
    public void onNativeAdLoaded(NativeAd nativeAd) {
        // 3. 渲染请求成功广告
        inflateAd(nativeAd);
    }
    
    @Override
    public void onAdFailed(YdError error) {
        // 4. 请求失败处理
        String msg = String.format(Locale.getDefault(), "onAdFailed, code:%d,msg:%s", error.getCode(), error.getMsg());
        Toast.makeText(MixNativeActivity.this, msg, Toast.LENGTH_LONG).show();
    }
});

// 渲染广告
private void inflateAd(NativeAd nativeAd) {
    setNativeEvent(nativeAd);
    
    FrameLayout container = findViewById(R.id.container_ad);
    container.removeAllViews();
    
    // 构造NativeAdViewd对象，广告View均需在此ViewGroup中
    NativeAdView nativeAdView = new NativeAdView(this);
    container.addView(nativeAdView, new FrameLayout.LayoutParams(WRAP_CONTENT, WRAP_CONTENT));
    
    // 判断是否为模板广告
    if (nativeAd.isNativeExpress()) {
        // 对于模板广告只需获取MediaView填充到广告容器中即可
        View mediaView = nativeAd.getAdMaterial().getAdMediaView();
        nativeAdView.addView(mediaView, new FrameLayout.LayoutParams(MATCH_PARENT, MATCH_PARENT));
        // 绑定模板广告容器，对于模板广告，第二参数selfRenderView可为null
        nativeAd.renderAdContainer(nativeAdView, null);
        NativePrepareInfo prepareInfo = new NativePrepareInfo();
        // 渲染模板需绑定Activity
        prepareInfo.setActivity(this);
        // 渲染模板广告
        nativeAd.prepare(prepareInfo);
        return;
    }
    
    // 以下为自渲染广告
    
    // 媒体自定义的广告View
    View adView = View.inflate(this, R.layout.ad, null);
    nativeAdView.addView(adView, new FrameLayout.LayoutParams(MATCH_PARENT, MATCH_PARENT));
    
    // 绑定广告容器，第一个参数NativeAdView必须为广告的父容器；第二参数为自定义的广告view，不可为空
    nativeAd.renderAdContainer(nativeAdView, adView);

    // 获取自定义广告的展示控件
    ImageView ivLogo = adView.findViewById(R.id.img_logo);
    TextView tvTitle = adView.findViewById(R.id.text_name);
    TextView tvDesc = adView.findViewById(R.id.text_desc);
    ImageView pic = adView.findViewById(R.id.img_poster);
    TextView btnOperate = adView.findViewById(R.id.btn_text);
    FrameLayout flMediaView = adView.findViewById(R.id.fl_mediaview);
    
    // 获取广告素材，并填充广告素材
    NativeMaterial nativeMaterial = nativeAd.getAdMaterial();
    tvTitle.setText(nativeMaterial.getTitle());
    tvDesc.setText(nativeMaterial.getDescription());
    if (!TextUtils.isEmpty(nativeMaterial.getIconUrl())) {
        Glide.with(getApplicationContext()).load(nativeMaterial.getIconUrl()).into(ivLogo);
    }
    
    // 判断广告素材类型，对于视频广告需获取MediaView填充
    if (nativeMaterial.getAdType() == AD_TYPE_VIDEO && nativeMaterial.getAdMediaView() != null) {
        pic.setVisibility(View.GONE);
        flMediaView.addView(nativeMaterial.getAdMediaView(), new FrameLayout.LayoutParams(MATCH_PARENT, MATCH_PARENT));
    } else {
        flMediaView.setVisibility(View.GONE);
        if (!TextUtils.isEmpty(nativeMaterial.getMainImageUrl())) {
            Glide.with(getApplicationContext()).load(nativeMaterial.getMainImageUrl()).into(pic);
        } else {
            String imgUrl = Check.findFirstNonNull(nativeMaterial.getImageUrlList());
            if (!TextUtils.isEmpty(imgUrl)) {
                Glide.with(getApplicationContext()).load(imgUrl).into(pic);
            }
        }
    }
    
    if (nativeMaterial.getAdLogo() != null) {
        adLogo.setImageBitmap(nativeMaterial.getAdLogo());
    } else if (!TextUtils.isEmpty(nativeMaterial.getAdLogoUrl())) {
        Glide.with(getApplicationContext()).load(nativeMaterial.getAdLogoUrl()).into(adLogo);
    }
    
    // 准备渲染广告时需要绑定的控件
    NativePrepareInfo prepareInfo = new NativePrepareInfo();
    prepareInfo.setActivity(this);
    prepareInfo.setCtaView(btnOperate);
    prepareInfo.setClickView(adView);
    prepareInfo.setImageView(pic);
    
    // 渲染广告
    nativeAd.prepare(prepareInfo);
}

private void setNativeEvent(NativeAd nativeAd) {
    // 设置广告事件监听
    nativeAd.setNativeEventListener(new NativeEventListener() {
        @Override
        public void onAdImpressed(NativeAdView adView) {
            // 广告展示成功
        }
        
        @Override
        public void onAdClicked(NativeAdView adView) {
            // 广告被点击
        }
        
        /**
         * 用户点击关闭按钮，收到需调用方将广告View{@link NativeAdView}移除界面，部分广告联盟会自动移除广告View。
         * 模板广告均支持此回调，穿山甲广告渲染时需绑定Activity后支持；
         * 自渲染广告仅穿山甲、京准通绑定closeView后，支持此回调。
         */
        @Override
        public void onAdClose(NativeAdView adView) {
            // 广告被关闭，
        }
        
        @Override
        public void onAdVideoStart(NativeAdView adView) {
            // 视频播放开始
        }
        
        @Override
        public void onAdVideoEnd(NativeAdView adView) {
            // 视频播放结束
        }
        
        @Override
        public void onAdVideoProgress(NativeAdView adView, long progress) {
            // 视频播放进度，仅部分广告联盟支持
        }
        
        @Override
        public void onAdFailed(NativeAdView adView, YdError error) {
            // 广告渲染异常
        }
    });
}

7. 自定义广告源广告

详细实现自定义Adapter的示例可查看Demo

1. 针对实现各个广告形式需要继承的类说明

开发者需要根据自身需求继承相应广告形式的类（参照下表）并重写所有抽象方法，在相应的方法中调用广告平台的API，并通过类成员变量mLoadListener回调加载的结果，通过类成员变量mImpressionEventListener回调广告展示、点击、关闭等事件结果

2. Adapter的使用以及注意事项

2.1 使用流程

• 开发者只需要继承相关类并重写相关方法，自定义Adapter中的所有方法都不需要开发者进行调用，当Funlink后台的广告位下配置好自定义广告平台的广告源后，SDK内部会在合适的时机调用自定义Adapter中的相关方法。

• 开发者调用Funlink SDK的load API加载广告，Funlink SDK会根据后台配置的类名通过反射创建出自定义Adapter的类，并调用loadCustomNetworkAd()进行广告的请求，自定义广告平台的广告加载结果需要通过调用CustomLoadListener的方法通知Funlink SDK，最终Funlink SDK会通过Funlink的回调方法通知开发者

• 自定义广告平台加载广告时所需要的参数（AppID、AppKey、PlacementID等）需以Json字符串的形式配置在Funlink后台的该广告平台的广告源中，例如：

  xxxxxxxxxx
  {
      "appId":"xxxxx",
      "placeId":"xxxxxxxxx"
  }
  

  Funlink SDK拉取到后台策略时，会将此Json字符串转化为Map，传给loadCustomNetworkAd(Context context, Map<String, Object> serverExtra, Map<String, Object> localExtra)方法，开发者可通过serverExtra参数获取到相关参数（AppID、AppKey、PlacementID等）

• 开发者调用Funlink SDK的isAdReady API时，会调用到自定义Adapter的isAdReady()方法

• 开发者调用Funlink SDK的show API时，会调用到自定义Adapter的show()方法

2.2 注意事项

• Funlink后台添加自定义广告平台时，Adapter类名需配置全路径类名（包名+类名），否则加载广告时Adapter类将不能正常被创建

• 因为SDK内部是通过反射new出Adapter的类，所以在构建release包时，必须确保Adapter类不能被混淆。混淆规则示例如下：

  xxxxxxxxxx
  # 将 <Adapter类名> 改为开发者自己的Adapter类名
  -keep class <Adapter类名> { *;}
  -keepclassmembers public class <Adapter类名> {
     public *;
  }
  

8. 预加载广告

2.6.4以上版本支持广告预加载功能。提升广告响应速度。

使用方法：需要在主activity页面，调用相应方法，对广告进行预加载。

接入代码示例

xxxxxxxxxx
YdConfig.getInstance().setActivityAndPreloadAd(this);

三、混淆

以下是所有的混淆规则，但需要根据实际所依赖的aar进行选择配置：

xxxxxxxxxx
-keep class com.fl.** {*;}

四、国际版集成说明

1. 初始化

在调用SDK初始化方法 YdConfig.getInstance().init()前务必先调用YdSDK.setInternationalLocale()方法设置运行环境。

xxxxxxxxxx
// 配置国际化运行环境，务必最先调用
YdSDK.setInternationalLocale();
// SDK 初始化在后
YdConfig.getInstance().init()

2. 配置GDPR

接入方需自行判断用户是否在欧盟地区或是否需要设置GDPR。SDK提供两种方式配置GDPR：

1. 不使用SDK提供的GDPR授权页，直接设置GDPR等级，接入方需自行处理授权页及GDPR状态；
2. 使用SDK提供的GDPR授权页。

xxxxxxxxxx
// GDPR等级
YdGDPRAuth.GDPR_UNKNOWN; // 未知等级
YdGDPRAuth.GDPR_AGREE; // 已授权上报设备信息
YdGDPRAuth.GDPR_REFUSE; // 拒绝上报设备信息

// 方式1，在需要设置GDPR等级时，通过YdSDK.getGDPRLevel()方法获取SDK记录的等级，
// 当为GDPR_UNKNOWN等级时，应展示授权页设置页，并通过YdSDK.setGDPRLevel()方法设置授权结果

// 获取SDK记录的GDPR等级
YdSDK.getGDPRLevel();
// 直接设置GDPR等级
YdSDK.setGDPRLevel();
    

// 方式2，是否需要展示授权页同方式1，当需要展示授权页时通过调用YdSDK.showGdprAuth()方法打开授权页，
// 结果通过YdGDPRAuth.AuthReslut回调给接入方。
YdSDK.showGdprAuth(Activity, YdGDPRAuth.AuthReslut{
    // 用户授权结果
    void onAuthFinish(int reslut);
    
    // 授权页加载失败
    void onPageLoadFail();
});

五、TopOn聚合平台自定义广告接入文档

（特别说明：原生样式中包含有模版和自渲染两种渲染类型，确定好您是按照哪种方式来对接的，在我们平台创建原生混合广告位时后面备注好是自渲染还是模版，然后联系我们配置成对应的形式。否则我们平台默认返回的都是自渲染类型。）

Topon自定义广告接入地址：https://docs.toponad.com/#/zh-cn/android/NetworkAccess/customnetwork/customnetwork

自定义广告源adapter参数

六、ToBid聚合平台自定义广告接入文档

（特别说明：原生样式中包含有模版和自渲染两种渲染类型，确定好您是按照哪种方式来对接的，在我们平台创建原生混合广告位时后面备注好是自渲染还是模版，然后联系我们配置成对应的形式。否则我们平台默认返回的都是自渲染类型。）

自定义广告源adapter参数：

应用维度参数：appId=应用ID（特别注意I为大写）

自定义配置信息：{"placementId":"广告位id"}

七、GroMore聚合平台自定义广告接入文档

（特别说明：原生样式中包含有模版和自渲染两种渲染类型，确定好您是按照哪种方式来对接的，在我们平台创建原生混合广告位时后面备注好是自渲染还是模版，然后联系我们配置成对应的形式。否则我们平台默认返回的都是自渲染类型。）

自定义广告源adapter参数：

八、竞价结果回传

YdSpread,YdInterstitial,YdBanner,YdVideo,YdFullVideo,NativeAd 调用biddingResultUpload(boolean isWinner, int price, int secondPrice)方法回传竞价结果

九、获取ecpm

YdSpread,YdInterstitial,YdBanner,YdVideo,YdFullVideo,NativeAd通过getECPM方法可以获取，单位为分。

十、错误码说明

十一、隐私信息控制设置

xxxxxxxxxx
YdConfig.getInstance().setPersonalizedState(false);//是否支持个性化广告
YdConfig.getInstance().setEnableCollectAppInstallStatus(false);//是否允许获取应用安装列表
YdConfig.getInstance().init(this, BuildConfig.APIKey, "",
        new YdParamConfig.Builder()
                .setCanUseAndroid(false)//是否允许获取AndroidId
                .setCustomAndroidId("测试自定义androidID")
                .setCanUseMac(false)//是否允许获取Mac地址
                .setCustomMac("测试自定义mac")
                .setCanUseIMEI(false)//是否允许获取IMEI
                .setCustomIMEI("测试自定义imei")
                .setCanUseIMSI(false)//是否允许获取IMSI
                .setCanUseBootID(false)//是否允许获取BootID
                .setCanUseLocation(false)//是否允许获取Location
                .setCanUseUserAgent(false)//是否允许获取UserAgent
                .setCanUseSensor(false)//是否允许使用传感器
                .build(), true);//YdParamConfig中各项设置参数true为允许获取，false为不获取

十二、备注

demo仅供参考，具体以文档为准。如有疑问，请联系开发人员，谢谢~

iOS 广告 SDK 接入说明

前置说明

使用本SDK前必须满足以下条件。具体详情请联系官方指定负责人或到指定平台申请！

参数申请

目前聚合广告SDK需要的参数为APPID和各广告位对应ID，请在官方指定平台申请或联系具体负责人！

支持的广告联盟和广告类型

国内支持的广告主：

海外支持的广告主：

平台配置

接入方需事先在各三方SDK平台申请相关广告参数，然后在聚合平台进行配置。在聚合平台配置之后，才能正常使用本SDK的聚合功能。

SDK包体影响

三方SDK导入

聚合SDK依赖于被聚合的三方SDK，故在接入本SDK之前请确保项目已经接入了参与聚合的第三方广告联盟SDK。

国内支持的广告主：

海外支持的广告主：

SDK接入

展示广告接入

1.1 申请应用的应用ID 和 广告位ID

开发者需在平台创建应用和广告位，生成对应的应用ID和广告位ID。

1.2 导入framework

1.2.1 SDK集成

方法1 pod接入

xxxxxxxxxx
  # FLAD主包
  pod 'FLAD/FLAdSaas'
  
  # Adapter插件，根据实际按需拖入:
  # 国内广告主
  # 穿山甲广告主适配包
  pod 'FLAD/FLAdCsjAdapter'
  # 广点通广告主适配包
  pod 'FLAD/FLAdGdtAdapter'
  # 快手广告主适配包
  pod 'FLAD/FLAdKsAdapter'
  # 京准通广告主适配包
  pod 'FLAD/FLAdJztAdapter'
  # 百度广告主适配包
  pod 'FLAD/FLAdBaiduAdapter'
  # 倍孜广告主适配包
  pod 'FLAD/FLAdBeiziAdapter'
  # Sigmob 广告主适配包
  pod 'FLAD/FLAdSigmobAdapter'
  # Tanx 广告主适配包
  pod 'FLAD/FLAdTbAdapter'
  
  # 海外广告主
  # Mintegral 广告主适配包
  pod 'FLAD/FLAdMtgAdapter'
  # AdMob 广告主适配包
  pod 'FLAD/FLAdMobAdapter'
  # Vungle 广告主适配包
  pod 'FLAD/FLAdVungleAdapter'
  # Unity 广告主适配包
  pod 'FLAD/FLAdUnityAdapter'
  # Meta 广告主适配包
  pod 'FLAD/FLAdMetaAdapter'
  # Pangle 广告主适配包
  pod 'FLAD/FLAdPangleAdapter'
  # Applovin 广告主适配包
  pod 'FLAD/FLAdApplovinAdapter'
  # Ironsource 广告主适配包
  pod 'FLAD/FLAdIronsourceAdapter'
  # Inmobi 广告主适配包
  pod 'FLAD/FLAdInmobiAdapter'
  # Bigo 广告主适配包
  pod 'FLAD/FLAdBigoAdapter'

方法2 工程设置导入framework

获取相应版本的framework库，导入项目工程即可。

聚合SDK的framework库结构如下：

聚合SDK:

• FLAdSaas.framework

Adapter插件，根据实际按需拖入：

• FLAdCsjAdapter.xcframework
• FLAdGdtAdapter.xcframework
• FLAdKsAdapter.xcframework
• FLAdJztAdapter.xcframework
• FLAdBaiduAdapter.xcframework
• FLAdSigmobAdapter.xcframework
• FLAdTbAdapter.xcframework
• FLAdMtgAdapter.xcframework
• FLAdMobAdapter.xcframework
• FLAdVungleAdapter.xcframework
• FLAdUnityAdapter.xcframework
• FLAdMetaAdapter.xcframework
• FLAdPangleAdapter.xcframework
• FLAdApplovinAdapter.xcframework
• FLAdInmobiAdapter.xcframework
• FLAdIronsourceAdapter.xcframework
• FLAdBigoAdapter.xcframework

拖入时请按以下方式选择：

1.2.2 Xcode编译选项设置

1.2.2.1 添加权限

注意要添加的系统库

• 工程plist文件设置，点击右边的information Property List后边的 "+" 展开

添加 App Transport Security Settings，先点击左侧展开箭头，再点右侧加号，Allow Arbitrary Loads 选项自动加入，修改值为 YES。 SDK API 已经全部支持HTTPS，但是广告主素材存在非HTTPS情况。

xxxxxxxxxx
<key>NSAppTransportSecurity</key>
    <dict>
         <key>NSAllowsArbitraryLoads</key>
         <true/>
    </dict>

具体操作如图：

• Build Settings中Other Linker Flags 增加参数-ObjC

具体操作如图：

引入快手SDK编译崩溃怎么办？

您遇到这个崩溃是因为快手sdk为动态库，需要将KSAdSDK.xcframework的Embed修改为Embed&Sign即可

在修改完Embed之后，若是编译还是报错，如下：

解决方法：Build Settings中的Validate Workspace修改为 YES

• 京准通SDK为Swift和OC混编，所以集成时需要配置混编环境！

  1. 如果是OC项目，新建一个.swift文件，Xcode会提示创建桥接文件，点击确认即可
  2. 如果是Swift项目，新建一个OC文件，Xcode会提示创建桥接文件，点击确认即可

• SDK中包含获取IDFA的权限,所以需要在info.plist中添加IDFA权限,如图所示:

xxxxxxxxxx
<key>NSUserTrackingUsageDescription</key>
<string>该标识符将用于向您投放个性化广告</string>

• 将联盟SDK的 SKAdNetwork ID 添加到 info.plist 中，以保证 SKAdNetwork 的正确运行（可自行添加对应联盟SDK的SKAdNetwork）,如图所示:

xxxxxxxxxx
<key>SKAdNetworkItems</key>
    <array>
    <dict>
      <key>SKAdNetworkIdentifier</key>
      // SKAdNetwork方案的穿山甲SKAdNetwork id
      <string>238da6jt44.skadnetwork</string>
    </dict>
    <dict>
      <key>SKAdNetworkIdentifier</key>
      // SKAdNetwork方案的穿山甲SKAdNetwork id
      <string>x2jnk7ly8j.skadnetwork</string>
    </dict>
    <dict>
      <key>SKAdNetworkIdentifier</key>
      // SKAdNetwork方案的穿山甲SKAdNetwork id
      <string>22mmun2rn5.skadnetwork</string>
    </dict>
    <dict>
       <key>SKAdNetworkIdentifier</key>
      // SKAdNetwork方案的优量汇SKAdNetwork id
       <string>f7s53z58qe.skadnetwork</string>
    </dict>
        <dict>
            <key>SKAdNetworkIdentifier</key>
            <string>r3y5dwb26t.skadnetwork</string>
        </dict>
    </array>

• 使用SKAdNetwork跟踪转化

  使用Apple的转化跟踪SKAdNetwork，这意味着即使IDFA不可用，广告平台也可以通过这个获取应用安装归因。请参阅Apple的SKAdNetwork文档，以了解更多信息。

  要启用此功能，您需要在info.plist中添加SKAdNetworkItems。开发者根据集成的情况，可分别添加对应平台的SKAdNetwork标识符。

  【重要说明】 因三方广告平台的SKAdNetwork ID可能不定期更新，为尽可能降低收入损失风险，建议从下述链接处获取各平台最新的SKAdNetwork ID List。 同时，为方便开发者，在SDK下载页面提供了 SKAdNetwork IDs代码，可直接复制使用。

• 三方广告平台SKAdNetwork获取链接

  广告平台	SKAdNetwork获取链接
  穿山甲	https://www.csjplatform.com/union/media/union/download/detail?id=16&docId=27571&osType=ios#19xgk4zkvlb40
  腾讯广告(优量汇)	https://developers.adnet.qq.com/doc/ios/union/union_support_ATT
  快手	https://u.kuaishou.com/access
  Google Admob	https://developers.google.com/admob/ios/ios14
  Pangle	https://www.pangleglobal.com/integration/ios14-readiness
  Mintegral	https://dev.mintegral.com/skadnetworkids.xml
  Sigmob	https://support.sigmob.com/#/sdk%E9%9B%86%E6%88%90/iOS/iOS14%E7%9B%B8%E5%85%B3%E5%86%85%E5%AE%B9/
  Facebook	https://developers.facebook.com/docs/audience-network/guides/SKAdNetwork
  UnityAds	https://skan.mz.unity3d.com/v2/partner/skadnetworks.plist.xml

  【重要说明】UnityAds的SKAdNetwork ID每个项目均不相同，具体以UnityAds后台生成为准，位置参考

  

• 为了提高广告 ADX的收益效果，建议您复制以下代码到您App的info.plist文件：

xxxxxxxxxx
<key>LSApplicationQueriesSchemes</key>
<array>
  <string>tbopen</string>
  <string>openapp.jdmobile</string>
  <string>imeituan</string>
  <string>pinduoduo</string>
  <string>youku</string>
  <string>iqiyi</string>
  <string>alipays</string>
  <string>vipshop</string>
  <string>tmall</string>
  <string>sinaweibo</string>
  <string>zhihu</string>
  <string>jdmobile</string>
  <string>autohome</string>
  <string>taobaolite</string>
  <string>taobaoliveshare</string>
  <string>eleme</string>
</array>

1.2.2.2 运行环境配置

• 支持系统 iOS 12.0 及以上;
• SDK编译环境 Xcode 15.1;
• 支持架构： x86-64, arm64

1.2.2.3 添加依赖库(pod接入可忽略此操作)

以下依赖库已整合所有联盟广告主所需的依赖库 工程需要在TARGETS -> Build Phases中找到Link Binary With Libraries，点击“+”，依次添加下列依赖库

• libresolv.9.tbd
• libc++.tbd
• libc++abi.tbd
• libz.tbd
• libbz2.tbd
• libxml2.tbd
• libiconv.tbd
• libsqlite3.tbd
• StoreKit.framework
• MobileCoreServices.framework
• WebKit.framework
• MediaPlayer.framework
• CoreMedia.framework
• AVFoundation.framework
• CoreLocation.framework
• CoreTelephony.framework
• SystemConfiguration.framework
• AdSupport.framework
• CoreMotion.framework
• Security.framework
• QuartzCore.framework
• CoreGraphics.framework
• SafariServices.framework
• UIKit.framework
• Foundation.framework
• JavaScriptCore.framework
• MapKit.framework
• AssetsLibrary.framework
• AppTrackingTransparency.framework
• MessageUI.framework
• DeviceCheck.framework

具体操作如图所示：

1.2.3. 获取广告标识IDFA

从iOS 14开始，只有在获得用户明确许可的前提下，应用才可以访问用户的IDFA数据并向用户投放定向广告。在应用程序调用 App Tracking Transparency 框架向最终用户提出应用程序跟踪授权请求之前，IDFA将不可用。如果某个应用未提出此请求，则读取到的IDFA将返回全为0的字符串。

1.2.3.1 在info.plist文件里添加跟踪权限请求描述说明

以下提供中英文描述说明示例，开发者可参考添加其中一种即可：

• 中文版：

xxxxxxxxxx
<key>NSUserTrackingUsageDescription</key>
<string>该标识符将用于向您投放个性化广告。</string>

• 英文版：

xxxxxxxxxx
<key>NSUserTrackingUsageDescription</key>
<string>This identifier will be used to deliver personalized ads to you.</string>

1.2.3.2 获取App Tracking Transparency权限

想要获取授权，需要使用requestTrackingAuthorizationWithCompletionHandler:。我们建议您在初始化FLAD SDK之前获取授权，以便如果用户授予允许跟踪权限，FLAD SDK则可以在广告请求中使用IDFA。

xxxxxxxxxx
#import <AppTrackingTransparency/AppTrackingTransparency.h>

if (@available(iOS 14, *)) {
    //iOS 14
    [ATTrackingManager requestTrackingAuthorizationWithCompletionHandler:^(ATTrackingManagerAuthorizationStatus status) {
        //to do something，like preloading
        // load AD
    }];
} else {
    // load AD
}

描述说明将会显示在App Tracking Transparency授权对话框中，如下：

注意：

1. 如果有预加载广告需求的，强烈建议把预加载写在requestTrackingAuthorizationWithCompletionHandler的block回调中。
2. 该权限只有Xcode 12及以上版本才有，需要大家更新Xcode 12版本来进行测试使用。

1.2.3.3 iOS 15获取App Tracking Transparency权限说明

iOS 15对 AppTrackingTransparency 框架做了调整，需要满足以下 2 点：

• 应用当前的状态为 UIApplicationStateActive。
• 当前没有其他的授权弹窗。

当满足以上 2 点后，再检查 ATTrackingManagerAuthorizationStatus 和请求授权。因此，可以在以下的选项中选择一个作为调整方案：

• 启动应用后，延时 1~2 秒去检查和申请权限。
• 在主控制器的 “ViewDidAppear” 方法中检查和申请权限。

参考链接：https://developer.apple.com/forums/thread/690607

1.2.4 海外广告集成要求

1.2.4.1 Admob集成要求

集成Admob广告平台SDK，平台要求在xcode项目的Info.plist中添加 GADApplicationIdentifier 配置你们Admob的AppID，否则会crash。参考如下，请使用你们的Admob的identifier进行替换：

xxxxxxxxxx
<key>GADApplicationIdentifier</key>
<string>ca-app-pub-9488501426181082~7319780494</string>
<key>GADIsAdManagerApp</key>
<true/>

1.2.4.2 Meta广告测试要求

因Meta平台的要求，测试Meta广告需要在测试手机中下载并登录Facebook客户端才能填充广告

1.2.5 广告个性化开关设置

1.2.5.1 国内广告个性化开关设置

目前个性化开关设置支持的广告平台如下： （1）国内：穿山甲，优量汇，快手，百度，Sigmob （2）海外：Meta，Admob，Mintegral，Pangle，UnityAds，Vungle

默认情况是全部开启广告个性化推荐，如果手动设置关闭之后则全部广告平台关闭个性化推荐。 针对海外平台，如果关闭个性化推荐，涉及用户隐私的数据将不会被收集，可能会影响广告平台功能的正常使用，请谨慎设置。

xxxxxxxxxx
/// 个性化推荐广告设置  YES:关闭个性化推荐   NO:打开个性化推荐    默认为NO
[FLAdSDKManager setPersonalizedState:NO];

1.2.5.2 海外广告个性化开关设置

建议开发者的集成流程如下

1、 APP启动后，开发者判断用户是否在欧盟(开发者自行实现是否在欧盟的判断方法）

• 不在欧盟，跳到第4步
• 在欧盟，下一步

2、判断[FLAdSDKManager defaultManager]的dataConsentSet是否为FLGDPRConsentSetUnknown

• 为FLGDPRConsentSetUnknown（未设置过GDPR等级），下一步
• 不为FLGDPRConsentSetUnknown（设置过GDPR等级），跳到第4步

3、调用[FLAdSDKManager defaultManager]的presentDataConsentDialogInViewController:dismissalCallback方法(由用户设置GDPR等级）

使用以下代码段设置GDPR:

xxxxxxxxxx
if ([FLAdSDKManager defaultManager].dataConsentSet == FLGDPRConsentSetUnknown) {
    [[FLAdSDKManager defaultManager] presentDataConsentDialogInViewController:self dismissalCallback:^(FLGDPRConsentSet dataConsentSet) {
        // 请求广告
    }];
}

展示如图：

4、初始化SDK

重要提示：

如果你的应用同时获取了App Tracking Transparency授权弹窗，我们强烈建议参考如下图所示流程来获取App Tracking Transparency授权弹窗与GDPR弹窗，否则有提审被拒的风险！

1. 应用启动后，首先获取App Tracking Transparency授权弹窗

• 用户通过授权，接着获取GDPR弹窗，然后进入游戏。
• 用户拒绝授权，直接进入游戏，不再弹出GDPR弹窗。

1.3 SDK接口类介绍与广告接入

1.3.0 全局设置

SDK的开屏广告建议在 AppDelegate 的方法 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 里

当window指定root控制器并显示之后最先进行初始化

xxxxxxxxxx
// 国内环境初始化设置
[FLAdSDKManager registerAppId:@"从后台获取的应用ID"];

// 海外环境初始化设置
[FLAdSDKManager registerAppId:@"从后台获取的应用ID" Environment:FLADEnvironmentOther];

1.3.1 开屏广告

a. 极简对接

在 AppDelegate 的方法 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 里,当window指定rootViewController之后可直接调用：

xxxxxxxxxx
[self.window fl_showSplashADWithConfig:^(FLSplashADConfig * _Nonnull config) {
    UIImage *splashBg = [UIImage imageNamed:@"splashBg"];
    config.mediaID = splash_id;
    config.backgroundImage = splashBg;
    config.backgroundColor = [UIColor whiteColor];
    config.contentMode = UIViewContentModeScaleAspectFit;
    config.timeout = 8.0;
    config.bottomView = [[UIImageView alloc] initWithImage:splashBg];
} completion:^(FLSplashADType type, NSError *error) {
    switch (type) {
        case FLSplashADTypeStart:
        NSLog(@"Block方式：开屏广告请求流程开启");
        break;
        case FLSplashADTypeRequestAD:
        NSLog(@"Block方式：开始请求广告");
        break;
        case FLSplashADTypeLoadAD:
        NSLog(@"Block方式：广告加载成功");
        break;
        case FLSplashADTypeFail:
        NSLog(@"Block方式：广告加载失败");
        break;
        case FLSplashADTypeShow:
        NSLog(@"Block方式：广告展示");
        break;
        case FLSplashADTypeClick:
        NSLog(@"Block方式：广告点击");
        break;
        case FLSplashADTypeClose:
        NSLog(@"Block方式：广告关闭");
        break;

    default:
    break;
    }
}];

b. 普通对接

• 类型说明：开屏广告主要是 APP 启动时展示的全屏广告视图，开发只要按照接入标准就能够展示设计好的视图==(注意：开屏接入代码必须放在window指定rootViewController之后)==。具体可参考Demo中LaunchScreenViewController部分示例代码

1. 导入

xxxxxxxxxx
#import <FLAdSaas/FLAdSaas.h>

2. 遵循代理

xxxxxxxxxx
<FLSplashDelegate>

3. 请求开屏广告

• 全屏示例：

xxxxxxxxxx
_manager = [FLSplashManager new];
_manager.delegate = self;
_manager.mediaId = @"获取的广告位";
_manager.showAdController = self.window.rootViewController;
[_manager loadAdData];

• 非全屏示例：

xxxxxxxxxx
//bottom 为含logo的view
UILabel *bottom = [[UILabel alloc]initWithFrame:CGRectMake(0, 0, [UIScreen mainScreen].bounds.size.width, [UIScreen mainScreen].bounds.size.height * 0.2)];
bottom.text = @"AD Demo";
bottom.textAlignment = NSTextAlignmentCenter;
bottom.font = [UIFont systemFontOfSize:35];
bottom.userInteractionEnabled = YES;
bottom.backgroundColor = [UIColor whiteColor];

_manager = [FLSplashManager new];
_manager.delegate = self;
_manager.mediaId = @"获取的广告位";
_manager.bottomView = bottom;
_manager.showAdController = self.window.rootViewController;
[_manager loadAdData];