API 说明 2.2 - uc-union/union-ads-sdk-demo GitHub Wiki

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

主要接口及参数说明：

public static void start(Context context)

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

参数：

Context： Android应用的Application Context

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

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

public static Builder pub(String pub)

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

参数：

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

返回值： AdRequest.Builder实例对象。

public static Builder testDeviceId(String testDeviceId)

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

参数：

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

返回值： AdRequest.Builder实例对象。

public static Builder withOption(AdRequestOption option)

使用：设置广告请求需要的附加参数

参数：

options： 要请求的广告所需的附加参数。目前只有Native广告需要设置附加参数，使用AdRequestOption.newNativeBuilder()构建NativeAdRequestOptionBuilder，并进一步构建参数选项。

返回值：AdRequest.Builder实例对象。

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

主要接口及参数说明：

void setAdListener(AdListener adListener)

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

参数：

adListener： 广告加载监听器。

void loadAd(AdRequest adRequest)

使用：开始加载广告。

参数：

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

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

主要接口及参数说明：

void onAdLoaded(UnionAd ad)

使用：广告被成功加载。

参数：

ad： 被成功加载的广告对象。

void onAdClosed(UnionAd ad)

使用：广告被关闭。

参数：

ad： 被关闭的广告。

void onAdShowed(UnionAd ad)

使用：广告被展示。

参数：

ad： 被展示的广告。

void onAdClicked(UnionAd ad)

使用：广告被点击。

参数：

ad： 被点击的广告。

void onAdError(UnionAd ad, AdError error)

使用：广告加载出错。

参数：

ad： 广告加载出错的广告
error： 广告出错信息对象

广告出错的错误信息。包括错误码和详细的错误信息。 主要错误码如下：

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

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

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

原生广告返回的数据，包括广告的标题，详细描述，一个图标和一张封面图。图片以Image对象的形式返回，可以通过Image.getUrl()获取图片地址。

主要接口及参数说明：

public String getCallToAction()

使用：获取CTA描述。

返回值：CTA描述。

public String getTitle()

使用：获取原生广告的标题。

返回值：原生广告的标题。

public String getDescription()

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

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

public Image getIcon()

使用：获取原生广告图标。

返回值：原生广告的图标。

public Double getRating()

使用：获取评分。

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

public String getPrice()

使用：获取价格信息。

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

public Image getCover()

使用：获取原生广告的封面大图。(一个）

返回值：原生广告的封面大图。

public List<Image> getCovers()

使用：获取原生广告的封面大图信息。（多个）

返回值：原生广告的封面大图信息。

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

原生广告请求参数的构建类，用来方便的构建原生广告请求中除了通用广告请求参数(pub, testDeviceId)之外的其他参数。

主要接口及参数说明：

public NativeAdRequestParamBuilder requestCoverImageSize(int width, int height)

使用：只用设置请求封面大图的最佳尺寸。

参数：

width: 宽度(像素)。

height: 高度(像素)。