Unity Ads SDK 2.0 的 Android 公开(public) API .

• UnityAds Class
  • Enumerations
  • Static Methods
    • UnityAds.getDebugMode
    • UnityAds.getListener
    • UnityAds.getPlacementState
    • UnityAds.getVersion
    • UnityAds.initialize
    • UnityAds.isInitialized
    • UnityAds.isReady
    • UnityAds.isSupported
    • UnityAds.setDebugMode
    • UnityAds.setListener
    • UnityAds.show
• IUnityAdsListener Interface
  • Callback Methods
    • IUnityAdsListener.onUnityAdsError
    • IUnityAdsListener.onUnityAdsFinish
    • IUnityAdsListener.onUnityAdsReady
    • IUnityAdsListener.onUnityAdsStart

---

以下几个是UnityAds支持的几个迭代器.

• UnityAds.FinishState
• UnityAds.PlacementState
• UnityAds.UnityAdsError

⇧ Back to top

public static boolean getDebugMode();

如果 Debug Mode 开启则返回true.

⇧ Back to top

public static IUnityAdsListener getListener();

返回当前指定(assign)的 Unity Ads 监听器(listener).

See IUnityAdsListener.

⇧ Back to top

public static PlacementState getPlacementState();
public static PlacementState getPlacementState(String placementId);

返回指定广告位(ad placement)的状态, 如果没有显式指定, 则当做查询默认(default)广告位.

参数	描述
placementId	可以在Unity Ads dashboard上找到.

See UnityAds.PlacementState.

⇧ Back to top

public static String getVersion();

返回字符串类型的 Unity Ads SDK 版本号

⇧ Back to top

public static void initialize(final Activity activity, final String gameId, final IUnityAdsListener listener );
public static void initialize(final Activity activity, final String gameId, final IUnityAdsListener listener, final boolean testMode);

使用指定的 Game ID 来初始化 Unity Ads SDK.

参数	描述
activity	当前设置的 Android activity.
gameId	当前游戏当前平台的Game ID, 可以在 Unity Ads dashboard 上找到.
listener	IUnityAdsListener接口的实现实例.
testMode	设成 true 的话则开启测试模式(test mode). 测试模式默认是关闭的. 测试模式的广告并不会计入统计报告.

⇧ Back to top

public static boolean isInitialized();

如果 Unity Ads SDK 初始化完成了则返回true.

⇧ Back to top

public static boolean isReady();
public static boolean isReady(String placementId);

如果指定的广告位准备好显示广告了展示广告, 则返回true. 如果没有指定广告位, 则使用默认(default)广告位.

参数	描述
placementId	广告位ID. 可以从 Unity Ads dashboard 上找到.

⇧ Back to top

public static boolean isSupported();

如果当前设备支持 Unity Ads 则返回true. 请在初始化之前使用这个方法.

⇧ Back to top

public static void setDebugMode(boolean debugMode);

参数	描述
debugMode	如果设置成true的话会有很多log, 设成false的话log会被减少到最少.

⇧ Back to top

public static void setListener(IUnityAdsListener listener);

参数	描述
listener	IUnityAdsListener 的示例.

⇧ Back to top

public static void show(final Activity activity);
public static void show(final Activity activity, final String placementId);

展示(show)指定广告位的广告, 如果没有指定广告位ID, 则使用默认(default)广告位.

广告展示完后, 在广告关闭后IUnityAdsListener.onUnityAdsFinish 会被调用. 这个回调方法是用来给玩家提供奖励(reward)的.

参数	描述
activity	当前注册的 Android activity.
placementId	广告位ID. 可以从 Unity Ads dashboard 上找到.

⇧ Back to top

---

void onUnityAdsError(UnityAds.UnityAdsError error, String message);

除了log之外, Unity Ads 出错的时候也会调用这个方法. 这个方法可以用于统计错误发生的情况等.

参数	描述
error	发生的错误常量. 参见 UnityAds.UnityAdsError.
message	一段对发生的错误的描述.

⇧ Back to top

void onUnityAdsFinish(String placementId, UnityAds.FinishState result);

在广告关闭后, 这个方法会被调用. 任何一个UnityAds.show会对应一个IUnityAdsListener.onUnityAdsFinish, 即使失败的情况也适用.

参数	描述
placementId	广告位ID. 可以从 Unity Ads dashboard 上找到.
result	广告结束的状况. 参见 UnityAds.FinishState.

⇧ Back to top

void onUnityAdsReady(String placementId);

这个方法会在指定广告位可以(ready)展示广告时候被调用.

参数	描述
placementId	广告位ID, 可以从 Unity Ads dashboard 找到.

⇧ Back to top

void onUnityAdsStart(String placementId);

这个方法会在视频广告开始播放时被调用.

参数	描述
placementId	广告位ID. 这个 ID 可以在 Unity Ads dashboard 上找到.

Note: If a video fails to start after the call to UnityAds.show, this method may not be called. In this case, Unity Ads will skip ahead to call IUnityAdsListener.onUnityAdsFinish with a result of UnityAds.FinishState.ERROR.

⇧ Back to top