Unity Ads Android SDK API 参考

本文包含以下 API 文档

类

枚举

接口

类

UnityAds

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

initialize

initialize(final Context context, final String gameId, final boolean testMode, final IUnityAdsInitializationListener initializationListener)

使用指定的 游戏 ID、测试模式 状态和初始化监听器初始化广告服务。

参数

描述

context

当前 Android Context。

gameId

您项目的平台特定 Unity 游戏标识符，在 Unity Ads Monetization 仪表板 上找到。

testMode

使用测试模式在不提供实时广告的情况下测试您的集成。使用 true 以测试模式初始化。

initializationListener

使用 IUnityAdsInitializationListener 回调（版本 3.7.0 及更高版本）可选地启用 SDK。

load

public static void load(final String adUnitId, final UnityAdsLoadOptions loadOptions, final IUnityAdsLoadListener listener)

为指定的 广告单元 加载广告内容。您必须在调用 show 之前调用 load。

参数

描述

adUnitId

要使用广告内容加载的广告单元的标识符。

loadOptions

修改广告行为的选项集合。

listener

使用 IUnityAdsLoadListener 回调（版本 3.7.0 及更高版本）可选地加载广告内容。

show

public static void show(final Activity activity, final String adUnitId, final UnityAdsShowOptions options, final IUnityAdsShowListener showListener)

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

参数

描述

activity

当前 Android Activity。

adUnitId

要显示的广告单元的标识符。

options

修改广告行为的 选项 集合。

showListener

使用 IUnityAdsShowListener 回调（版本 3.7.0 及更高版本）可选地显示内容。

addListener

在 SDK 版本 4.0 中移除。有关更多信息，请参阅 已弃用的 API 类。

public static void addListener(IUnityAdsListener listener)

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

参数

描述

listener

Unity Ads 回调的 监听器。

removeListener

在 SDK 版本 4.0 中移除。有关更多信息，请参阅 已弃用的 API 类。

public static void removeListener(IUnityAdsListener listener)

删除活动的 IUnityAdsListener。

参数

描述

listener

Unity Ads 回调的监听器。

getVersion

public static String getVersion()

返回当前 Ads SDK 版本。

getPlacementState

public static PlacementState getPlacementState(String adUnitId)

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

参数

描述
adUnitId

要查询的广告单元的标识符。

setDebugMode

public static void setDebugMode(boolean debugMode)

控制 SDK 的日志输出量。设置为 true 以获得更强大的日志记录。

getDebugMode

public static boolean getDebugMode()

如果 SDK 处于调试模式，则返回 true。

isInitialized

public static boolean isInitialized()

如果 SDK 成功初始化，则返回 true；如果未成功初始化，则返回 false。

isSupported

public static bool isSupported()

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

UnityAdsLoadOptions

public class UnityAdsLoadOptions extends UnityAdsBaseOptions

此类包含要与 load 方法一起使用的可选元数据。在第三方中介中使用标头竞价的客户应在 Unity 网络的竞价者赢得广告拍卖的情况下使用此方法。

setAdMarkup

public void setAdMarkup(String adMarkup)

此方法获取从竞价者服务返回的广告标记。当 Unity 的广告网络的竞价者赢得标头竞价拍卖时，Unity Ads SDK 会从中介交易所接收广告标记。广告标记字符串包含 Unity 加载和显示广告所需的信息。

setObjectId

public void setObjectId(String objectId)

此方法将已加载的广告对象 ID 设置为要显示的广告对象 ID。

BannerView

public BannerView(Activity activity, String adUnitId, UnityBannerSize size)

String mObjectId = UUID.randomUUID().toString(); UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions(); loadOptions.setAdMarkup(markup); loadOptions.setObjectId(mObjectId); UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

参数

描述

activity

当前 Android Activity。

adUnitId

要显示的广告单元的标识符。

size

横幅对象的 大小。

getPlacementId

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

返回横幅广告单元的 广告单元 ID。

getSize

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

横幅的 大小。

setListener

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

设置横幅的活动监听器。

getListener

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

检索横幅的活动监听器。

load

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

用于为横幅请求广告的基本方法。

destroy

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

当您不再使用横幅时，调用此方法以将其从视图层次结构中删除。

UnityBannerSize

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

使用此类定义 横幅对象 的高度和宽度。

getWidth

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

返回 横幅对象 的宽度（以像素为单位）。

getHeight

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

返回 横幅对象 的高度（以像素为单位）。

枚举

PlacementState

广告单元 的枚举状态。

值

描述

READY

广告单元已准备好显示广告。

NOT_AVAILABLE

广告单元不可用。

DISABLED

广告单元已被禁用。

WAITING

广告单元正在等待准备就绪。

NO_FILL

广告单元没有要显示的广告。

FinishState

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

值

描述

ERROR

表示由于 Unity 服务错误，广告无法完成。

SKIPPED

表示用户跳过了广告。

COMPLETED

表示用户已成功完成观看广告。

UnityAdsInitializationError

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

值

描述

INTERNAL_ERROR

由于环境或内部服务，发生了错误。

INVALID_ARGUMENT

由于 initialize 方法中的无效参数，发生了错误。

AD_BLOCKER_DETECTED

由于 URL 被阻止，发生了错误。

UnityAdsShowCompletionState

广告完成的枚举原因。

值

描述

SKIPPED

表示用户跳过了广告。

COMPLETED

表示广告已完整播放。这通常表示用户可以获得观看完整广告的奖励。

UnityAdsLoadError

广告单元 无法加载的枚举原因。

值

描述

INITIALIZE_FAILED

由于 SDK 未初始化，广告无法加载。

INTERNAL_ERROR

由于内部 Unity Ads 服务错误，广告无法加载。

INVALID_ARGUMENT

由于 load 方法中的无效参数，广告无法加载。

NO_FILL

由于网络不可用，广告无法加载。

TIMEOUT

广告无法在指定的时间范围内加载。

UnityAdsShowError

列举了广告单元无法显示的原因。

值

描述

NOT_INITIALIZED

广告无法显示，因为 SDK 未初始化。

NOT_READY

广告无法显示，因为广告单元尚未准备好。

VIDEO_PLAYER_ERROR

广告无法显示，因为媒体播放器出现错误。

INVALID_ARGUMENT

广告无法显示，因为show方法中的参数无效。

NO_CONNECTION

广告无法显示，因为网络连接出现错误。

ALREADY_SHOWING

广告无法显示，因为已经显示了一个广告。

INTERNAL_ERROR

广告无法显示，因为 Unity Ads 服务出现内部错误。

UnityAdsError

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

列举了广告无法显示的原因。

接口

IUnityAdsInitializationListener

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

实现此接口以处理initialize结果。

onInitializationComplete

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

onInitializationFailed

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

参数

描述

error

导致初始化失败的UnityAdsInitializationError。

message

与错误相关的消息。

IUnityAdsLoadListener

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

实现此接口以处理load结果。

onUnityAdsAdLoaded

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

参数

描述

adUnitId

加载内容的广告单元标识符。

onUnityAdsFailedToLoad

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

参数

描述

adUnitId

加载内容失败的广告单元标识符。

error

导致加载失败的UnityAdsLoadError。

message

与错误相关的消息。

IUnityAdsShowListener

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

实现此接口以处理show结果。

onUnityAdsShowFailure

此回调方法处理广告单元无法显示的逻辑。

参数

描述

adUnitId

无法显示内容的广告单元标识符。

error

导致显示失败的UnityAdsShowError。

message

与错误相关的消息。

onUnityAdsShowStart

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

参数

描述

adUnitId

显示内容的广告单元标识符。

onUnityAdsShowClick

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

参数

描述

adUnitId

显示内容的广告单元标识符。

onUnityAdsShowComplete

此回调方法处理广告结束的逻辑。

参数

描述

adUnitId

显示内容的广告单元标识符。

showCompletionState

指示广告是否已跳过或完成。

IUnityAdsListener

在 SDK 版本 4.0 中移除。有关更多信息，请参阅 已弃用的 API 类。

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

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

onUnityAdsReady

在 SDK 版本 4.0 中移除。有关更多信息，请参阅 已弃用的 API 类。

指定通过指定的广告单元显示广告内容的逻辑。

参数

描述

adUnitId

已准备好的广告单元标识符。

onUnityAdsDidError

在 SDK 版本 4.0 中移除。有关更多信息，请参阅 已弃用的 API 类。

指定因错误导致广告内容无法显示的逻辑。

参数

描述

error

导致广告失败的错误。

message

与错误相关的消息。

onUnityAdsDidStart

在 SDK 版本 4.0 中移除。有关更多信息，请参阅 已弃用的 API 类。

指定播放器触发广告显示的逻辑。

参数

描述

adUnitId

显示广告的广告单元标识符。

OnUnityAdsDidFinish

在 SDK 版本 4.0 中移除。有关更多信息，请参阅 已弃用的 API 类。

指定播放器完整观看广告的逻辑。

参数

描述

adUnitId

完成显示的广告单元标识符。

result

广告显示的结果用户事件。

IListener

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

此接口提供对横幅生命周期事件的访问权限。此外，您可以实现以下覆盖方法

String mObjectId = UUID.randomUUID().toString();
				UnityAdsLoadOptions loadOptions = new UnityAdsLoadOptions();
				loadOptions.setAdMarkup(markup);
				loadOptions.setObjectId(mObjectId);
			UnityAds.load(mPlacementId, loadOptions, mUnityLoadListener);

onBannerLoaded

横幅完成加载广告后，此回调将被触发。view 参数引用应插入视图层次结构的横幅。

参数

描述

bannerAdView

加载的横幅对象。

onBannerClick

点击横幅时，此回调将被触发。

参数

描述

bannerAdView

加载的横幅对象。

onBannerError

显示横幅时出现错误，此回调将被触发。

参数

描述

bannerAdView

加载的横幅对象。

errorInfo

包含有关横幅加载错误的信息的类。

onBannerLeftApplication

横幅链接到应用程序外部时，此回调将被触发。

参数

描述

bannerAdView

加载的横幅对象。

Unity logo Documentation
Copyright © 2024 Unity Technologies
"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.