API 说明 3.x - uc-union/union-ads-sdk-demo GitHub Wiki

UnionAdsSdk是广告SDK的初始化控制类，主要用于对SDK的初始化， 必须在程序Application的onCreate()中调用。

主要接口及参数说明:

public static void start(Context context, String appKey)

使用: 广告SDK的初始化函数， 在Android应用程序Application的onCreate里调用

参数:

context: Android应用的Application Context

appKey: 应用的唯一标识

AdRequest标识一个广告请求，用户可以通过AdReques.Builder设置广告请求的参数并生成。

AdRequest.Builder主要接口及参数说明:

public Builder pub(String pub)

使用: 设置广告请求对应的pub

参数:

pub: 要请求的广告对应的pub标识

返回值: AdRequest.Builder实例对象

public Builder testDeviceId(String testDeviceId)

使用: 设置广告请求需要的testDeviceId

参数:

testDeviceId: 通常是第三方广告SDK（Facebook等）的测试请求参数，一般第三方SDK会从Logcat输出相关testDeviceId的提示信息。

返回值: AdRequest.Builder实例对象

public AdRequest build()

使用: 构建AdRequest

返回值: AdRequest实例对象

标识一个广告，可以通过一个AdRequest加载广告内容。在使用中我们使用的是它的子类BannerAdView(Banner), InterstitialAd(插屏广告）, NativeAd（原生广告）。

主要接口及参数说明:

void setAdListener(AdListener adListener)

使用: 设置广告事件监听器，用来监听广告加载的状态，广告是否被点击或展示等

参数:

adListener: 广告加载监听器

void loadAd(AdRequest adRequest)

使用: 开始加载广告

参数:

adRequest: 广告请求对象，包含着广告请求的参数

广告事件监听器，监听广告加载的过程和结果，比如广告加载是否成功，广告是否被点击等。

主要接口及参数说明:

void onAdLoaded(Ad ad)

使用: 广告被成功加载

参数:

ad: 被成功加载的广告对象

void onAdClosed(Ad ad)

使用: 广告被关闭

参数:

ad: 被关闭的广告

void onAdShowed(Ad ad)

使用: 广告被展示

参数:

ad: 被展示的广告

void onAdClicked(Ad ad)

使用: 广告被点击

参数:

ad: 被点击的广告

void onAdError(Ad ad, AdError error)

使用: 广告加载出错

参数:

ad: 广告加载出错的广告

error: 广告出错信息对象

广告出错的错误信息。包括错误码和详细的错误信息。

主要错误码如下:

条幅广告，接口描述见 Ad。

插屏广告，接口描述见 Ad，需要注意的是在onAdLoaded的时候调用其show()方法。

原生广告，接口描述见 Ad。

原生广告在被加载之后，会以NativeAdAssets的形式将原生数据返回，相关的接口说明见 NativeAdAssets。

原生广告模板，接口描述见 Ad。

原生广告模板的配色方案是可以自定义的，相关的接口说明见NativeTemplateAdRequestOptionBuilder。

原生广告返回的数据，包括广告的标题、详细描述、图标和封面图等。

主要接口及参数说明:

public String getCallToAction()

使用: 获取CTA描述

返回值: CTA描述

public String getTitle()

使用: 获取原生广告的标题

返回值: 原生广告的标题

public String getDescription()

使用: 获取原生广告的广告详细描述信息

返回值: 原生广告的广告详细描述信息

public Image getIcon()

使用: 获取原生广告图标

返回值: 原生广告的图标Image对象

public Double getRating()

使用: 获取评分

返回值: 原生广告的评分信息，一般对应应用型广告

public String getPrice()

使用: 获取价格信息

返回值: 原生广告的价格信息

public Image getCover()

使用: 获取原生广告的第一个封面大图

返回值: 原生广告的封面大图Image对象

public List<Image> getCovers()

使用: 获取原生广告的全部封面大图

返回值: 原生广告的全部封面大图Image对象列表。

注意: getCover()与getCovers()都是用来获取封面图片，如果返回的只有一张封面图片，则从这两个接口可以获取同样的封面图片信息，如果返回的有多张封面图片，则getCover()获取多张中的其中一张，getCovers()则可以获取所有封面图片。getCovers()的使用场景通常为开发者希望展示多张封面或者自己从多张封面中决策出最符合自己展示条件的。

public View getAdMarkView()

使用: 获取U盟广告标识View。

返回值: U盟广告标识View

注意：　U盟广告标识是用来标识该广告是来自U盟的重要依据，开发者必须将该标识添加到原生广告中（建议放在某个角落，便于清晰标识).不添加该角标是无法通过审核的。

图片素材的数据，包括图片地址，图片长宽等信息。

主要接口及参数说明:

public String getUrl()

使用: 获取图片下载地址

返回值: 图片下载地址

public int getWidth()

使用: 获取图片宽度

返回值: 图片宽度(像素)

public int getHeight()

使用: 获取图片高度

返回值: 图片高度(像素)

按照指定尺寸过滤图片。

主要接口及参数说明:

public static NativeAdAssets.Image filter(List<NativeAdAssets.Image> images,
                                          int widthInDip,
                                          int heightInDip)

使用: 根据指定尺寸过滤图片集,指定的宽度,高度参数单位为dip. 如果没有匹配的图片,则返回null; 否则,返回匹配度最高的图片

参数:

images: 待过滤的图片集

widthInDip: 期望的图片宽度,以dip为单位

heightInDip: 期望的图片高度,以dip为单位

用于下载以及展示图片.

主要接口及参数说明:

public static void downloadImage(NativeAdAssets.Image image, 
                                 Delegate delegate)

使用: 下载一个图片,并通过Delegate回调通知下载成功与否

参数:

image: 要下载的图片信息(主要是其中的图片url信息)

delegate: 图片下载回调接口

public static void downloadAndDisplayImage(NativeAdAssets.Image image, 
                                           final ImageView imageView)

使用: 下载一个图片,如果下载成功,将其展示在指定的ImageView上

参数:

image: 要下载的图片信息(主要是其中的图片url信息)

imageView: 用于展示图片的ImageView

public static void downloadAndDisplayImage(NativeAdAssets.Image image,
                                           final ImageView imageView,
                                           final Drawable fallback)

使用: 下载一个图片,如果下载成功,将其展示在指定的ImageView上,否则,将fallback展示在指定的ImageView上

参数:

image: 要下载的图片信息(主要是其中的图片url信息)

imageView: 用于展示图片的ImageView

fallback: 下载失败的时候展示在ImageView上的图片资源

##NativeTemplateAdRequestOptionBuilder

原生广告模板属性自定义设置接口。

主要接口及参数说明:

public NativeTemplateAdRequestOptionBuilder smallSize()

使用: 设置要请求的原生广告模板为小尺寸广告(360X80).

public NativeTemplateAdRequestOptionBuilder mediumSize()

使用: 设置要请求的原生广告模板为中尺寸广告(360X146).

public NativeTemplateAdRequestOptionBuilder largeSize()

使用: 设置要请求的原生广告模板为大尺寸广告(360X324).

public NativeTemplateAdRequestOptionBuilder typeFace(Typeface typeface)

使用: 设置字体，该字体会应用到广告中的所有文字.

public NativeTemplateAdRequestOptionBuilder backgroundColor(int color)

使用: 设置广告背景色.

public NativeTemplateAdRequestOptionBuilder titleTextColor(int color)

使用: 设置标题文字颜色.

public NativeTemplateAdRequestOptionBuilder descriptionTextColor(int color)

使用: 设置描述文字颜色.

public NativeTemplateAdRequestOptionBuilder btnBackgroundColor(int color)

使用: 设置按钮背景颜色.

public NativeTemplateAdRequestOptionBuilder btnTextColor(int color)

使用: 设置按钮文字颜色