Unity Ads SDK API 参考#

使用 Advertisements 命名空间可以实现基本广告内容，例如奖励或非奖励视频广告、插页式广告或横幅广告。

using UnityEngine.Advertisements;

本文包含以下 API 文档：

类

• Advertisement
• Banner
• BannerLoadOptions
• BannerOptions
• ShowOptions

枚举

• ShowResult
• UnityAdsInitializationError
• UnityAdsLoadError
• UnityAdsShowError
• UnityAdsShowCompletionState
• BannerPosition

接口

• IUnityAdsInitializationListener
• IUnityAdsLoadListener
• IUnityAdsShowListener

类#

Advertisement#

Initialize#

public static void Initialize(string gameId, bool testMode, IUnityAdsInitializationListener initializationListener)

使用指定的 Game ID（游戏 ID）、测试模式状态以及广告单元加载设置来初始化广告服务。

Load#

public static void Load (string adUnitId, IUnityAdsLoadListener loadListener)

加载指定广告单元的广告内容。

IsReady#

[!WARNING]已在 SDK 4.0 版本中移除。有关详细信息，请参阅已弃用的 API 类。

static bool IsReady (string adUnitId)

如果指定的广告单元已准备好展示广告，返回 true。如果在启用 enablePerPlacementLoad 的情况下初始化了 SDK，则必须在调用 Show 之前先调用 Load。

Show#

public static void Show(string adUnitId, ShowOptions showOptions, IUnityAdsShowListener showListener)

显示指定广告单元中加载的广告内容。

AddListener#

[!WARNING]已在 SDK 4.0 版本中移除。有关详细信息，请参阅已弃用的 API 类。

public static void AddListener(IUnityAdsListener listener)

添加一个用于接收 Unity Ads 回调的监听器。在 3.1.0 及更高版本中，您可以注册多个监听器。这对于聚合客户特别有用。

RemoveListener#

[!WARNING]已在 SDK 4.0 版本中移除。有关详细信息，请参阅已弃用的 API 类。

public static void RemoveListener(IUnityAdsListener listener)

移除活动 IUnityAdsListener。

GetPlacementState#

[!WARNING]已在 SDK 4.0 版本中移除。有关详细信息，请参阅已弃用的 API 类。

public static PlacementState GetPlacementState(string adUnitId)

返回指定广告单元的状态。

isInitialized#

public static bool isInitialized

如果 SDK 已初始化，返回 true，否则返回 false。

isSupported#

public static bool isSupported

如果 SDK 在当前平台上受支持，返回 true，否则返回 false。

debugMode#

public static bool debugMode

如果 SDK 处于调试模式，返回 true，否则返回 false。调试模式控制 SDK 输出的日志记录级别。

version#

public static string version

返回当前 SDK 版本。

isShowing#

public static bool isShowing

如果当前正在展示广告，返回 true，否则返回 false。

横幅广告#

使用此类可实现横幅广告。

Load#

public static void Load(string adUnitId, BannerLoadOptions options)

加载指定横幅广告单元的广告内容。如果在启用 enablePerPlacementLoad 的情况下初始化了 SDK，则必须在调用 Show 之前先调用 Load。

Show#

public static void Show(string adUnitId, BannerOptions options)

展示指定横幅广告单元的广告内容。必须在调用 Show 之前先调用 Load。

Hide#

public static void Hide(bool destroy = false)

允许隐藏横幅广告，而不完全将其销毁。

SetPosition#

public void SetPosition (BannerPosition bannerPosition)

设置横幅广告在设备上的位置。

isLoaded#

public static bool isLoaded

如果当前加载了要展示的横幅广告，返回 true，否则返回 false。

ShowOptions#

实现这些选项可以在广告单元中展示内容时向 SDK 通知相关事件。当广告结束时，使用 ShowOptions.resultCallback 将 ShowResult 枚举返回给 Show。

resultCallback#

public ShowResult resultCallback { get; set; }

此回调接收广告的结果。

gamerSid#

public string gamerSid { get; set; }

为游戏中的特定用户指定标识符。

BannerLoadOptions#

实现这些选项可以在加载横幅广告时向 SDK 通知相关事件。

loadCallback#

public LoadCallback loadCallback { get; set; }

横幅广告单元成功加载已准备好展示的内容时触发此回调。

errorCallback#

public ErrorCallback errorCallback { get; set; }

横幅广告单元加载内容失败时触发此回调。

BannerOptions#

实现这些选项可以在展示横幅广告时向 SDK 通知相关事件。

bannerCallback#

public BannerCallback bannerCallback { get; set; }

横幅广告对用户可见时触发此回调。

hideCallback#

public BannerCallback hideCallback { get; set; }

横幅广告对用户不可见时触发此回调。

clickCallback#

public BannerCallback clickCallback { get; set; }

用户点击横幅广告时触发此回调。

枚举#

PlacementState#

[!WARNING]已在 SDK 4.0 版本中移除。有关详细信息，请参阅已弃用的 API 类。

广告单元的状态枚举。

ShowResult#

用户与广告互动的状态枚举。广告播放完成时，SDK 会将此值传递给 OnUnityAdsDidFinish 回调方法。

UnityAdsInitializationError#

SDK 初始化失败的原因枚举。

UnityAdsLoadError#

广告单元加载失败的原因枚举。

UnityAdsShowCompletionState#

广告已结束的原因枚举。

UnityAdsShowError#

广告展示失败的原因枚举。

BannerPosition#

在设备显示屏上锚定横幅广告的位置枚举。

接口#

IUnityAdsInitializationListener#

public interface IUnityAdsInitializationListener {
    void OnInitializationComplete();
    void OnInitializationFailed(UnityAdsInitializationError error, string message);
}

实现此接口可以处理 Initialize 结果。

OnInitializationComplete#

此回调方法处理 SDK 成功初始化的逻辑。

OnInitializationFailed#

此回调方法处理 SDK 初始化失败的逻辑。

IUnityAdsLoadListener#

public interface IUnityAdsLoadListener {
    void OnUnityAdsAdLoaded(string adUnitId);
    void OnUnityAdsFailedToLoad(string adUnitId, UnityAdsLoadError error, string message);
}

实现此接口可以处理 Load 结果。

OnUnityAdsLoaded#

此回调方法处理广告单元成功加载的逻辑。

OnUnityAdsFailedToLoad#

此回调方法处理广告单元加载失败的逻辑。

IUnityAdsShowListener#

public interface IUnityAdsShowListener {
    void OnUnityAdsShowFailure(string adUnitId, UnityAdsShowError error, string message);
    void OnUnityAdsShowStart(string adUnitId);
    void OnUnityAdsShowClick(string adUnitId);
    void OnUnityAdsShowComplete(string adUnitId, UnityAdsShowCompletionState showCompletionState);
}

实现此接口可以处理 Show 结果。

OnUnityAdsShowFailure#

此回调方法处理广告单元展示失败的逻辑。

OnUnityAdsShowStart#

此回调方法处理广告开始播放的逻辑。

OnUnityAdsShowClick#

此回调方法处理用户点击广告的逻辑。

OnUnityAdsShowComplete#

此回调方法处理广告完成的逻辑。

IUnityAdsListener#

[!WARNING]已在 SDK 4.0 版本中移除。有关详细信息，请参阅已弃用的 API 类。

public interface IUnityAdsListener
{
    void OnUnityAdsReady(string adUnitId);
    void OnUnityAdsDidError(string message);
    void OnUnityAdsDidStart(string adUnitId);
    void OnUnityAdsDidFinish(string adUnitId, ShowResult showResult);
}

实现此接口可以处理各种广告状态。在脚本中实现此监听器可以定义奖励广告的逻辑。

OnUnityAdsReady#

[!WARNING]已在 SDK 4.0 版本中移除。有关详细信息，请参阅已弃用的 API 类。

指定已准备好通过指定广告单元展示的广告内容的逻辑。

OnUnityAdsDidError#

[!WARNING]已在 SDK 4.0 版本中移除。有关详细信息，请参阅已弃用的 API 类。

指定由于错误而导致广告内容展示失败的逻辑。

OnUnityAdsDidStart#

[!WARNING]已在 SDK 4.0 版本中移除。有关详细信息，请参阅已弃用的 API 类。

指定玩家触发广告展示的逻辑。

OnUnityAdsDidFinish#

[!WARNING]已在 SDK 4.0 版本中移除。有关详细信息，请参阅已弃用的 API 类。

指定玩家完整观看广告的逻辑。