This is the public iOS API for Unity Ads SDK 2.0.

• UnityAds Class
  • Enumerations
  • Static Methods
    • getDebugMode
    • getListener
    • getPlacementState
    • getPlacementStateWithPlacementId
    • getVersion
    • initialize
    • isInitialized
    • isReady
    • isSupported
    • setDebugMode
    • setListener
    • show
• UnityAdsDelegate Protocol
  • Callback Methods
    • unityAdsDidError
    • unityAdsDidFinish
    • unityAdsDidStart
    • unityAdsReady

---

下面是几个在UnityAds里用到的迭代器.

• UnityAdsError
• UnityAdsFinishState
• UnityAdsPlacementState

⇧ Back to top

(BOOL)getDebugMode;

如果调试模式开启了的话, 则返回true.

⇧ Back to top

(id<UnityAdsDelegate>)getDelegate;

返回当前指定 (assign) 的 Unity Ads delegate

参考 UnityAdsDelegate.

⇧ Back to top

(UnityAdsPlacementState)getPlacementState;
(UnityAdsPlacementState)getPlacementState:(NSString *)placementId;

返回指定广告位ID(placementId)的状态. 如果没有显式指定广告位ID, 则使用默认 (default) 广告位.

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

See UnityAdsPlacementState.

⇧ Back to top

(NSString *)getVersion;

返回 string 类型的 Unity Ads SDK 版本号

⇧ Back to top

(void)initialize:(NSString *)gameId delegate:(nullable id<UnityAdsDelegate>)delegate;
(void)initialize:(NSString *)gameId delegate:(nullable id<UnityAdsDelegate>)delegate testMode:(BOOL)testMode;

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

参数	描述
gameId	这个游戏当前平台对应的Game ID. 这个值可以在 Unity Ads dashboard 上找到.
delegate	实现 UnityAdsDelegate 的对象.
testMode	设置成true可以打开测试模式(Test Mode). 在没有显式指定的情况下, 测试模式默认是关闭的. 一旦开启了测试模式, 就只能看到测试广告了, 测试广告并不会计入统计也不会给开发者带来收入.

⇧ Back to top

(BOOL)isInitialized;

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

⇧ Back to top

(BOOL)isReady;
(BOOL)isReady:(NSString *)placementId;

如果指定的广告位已经准备好展示广告了, 则返回true, 如果没有指定广告位 ID, 则当做询问默认(default)的广告位.

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

⇧ Back to top

(BOOL)isSupported;

如果当前设备支持 Unity Ads, 则返回true. 请在初始化之前询问这个值.

⇧ Back to top

(void)setDebugMode:(BOOL)enableDebugMode;

参数	描述
enableDebugMode	如果设成true的话会打印很过log, 设成falselog就被限制在最小了.

⇧ Back to top

(void)setDelegate:(id<UnityAdsDelegate>)delegate;

参数	描述
delegate	实现了 UnityAdsDelegate 的对象.

⇧ Back to top

(void)show:(UIViewController *)viewController;
(void)show:(UIViewController *)viewController placementId:(NSString *)placementId;`

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

广告展示结束后, unityAdsDidFinish 方法会被调用. 这个回调可用于给与玩家一定的 (reward).

参数	描述
viewController	调用这个方法的ViewController
placementId	广告位ID. 这个可以在 Unity Ads dashboard 上, 指定游戏的指定平台中找到.

⇧ Back to top

---

(void)unityAdsDidError:(UnityAdsError)error withMessage:(NSString *)message;

除了错误日志(error log)之外, 在发生错误的时候, 这个方法也会被调用. 这个方法可以辅助用于调试, 也可以用于统计错误数据用于分析排查问题.

参数	描述
error	产生的错误, 参见 UnityAdsError.
message	对于发生的错误的描述.

⇧ Back to top

(void)unityAdsDidFinish:(NSString *)placementId withFinishState:(UnityAdsFinishState)state;

广告被关闭的时候被调用. 对于任何一个show的调用, 都会对应一个unityAdsDidFinish, 即便是错误的情况也不例外.

参数	描述
placementId	广告位ID. 可以从 Unity Ads dashboard 上找到.
state	广告结束的状态. 参考 UnityAdsFinishState.

⇧ Back to top

(void)unityAdsDidStart:(NSString *)placementId;

在视频播放开始时会被调用的方法.

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

Note: 如果在调用show之后视频没能成功开始, 则这个方法也许不会被调用, 在这种情况下, Unity Ads会直接跳到unityAdsDidFinish并携带一个kUnityAdsFinishStateError错误.

⇧ Back to top

(void)unityAdsReady:(NSString *)placementId;

这个方法在指定广告位准备好展示广告后会被调用.

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

⇧ Back to top