将 Unity Ads 与中介集成

本指南介绍了如何使用 Google 移动广告 SDK 使用 中介加载和展示 Unity Ads 中的广告，涵盖广告瀑布流集成。其中介绍了如何将 Unity Ads 添加到广告单元的中介配置，以及如何将 Unity Ads SDK 和适配器集成到 Android 应用中。

支持的集成和广告格式

适用于 Unity Ads 的中介适配器具有以下功能：

集成
出价  1
瀑布
表现形式
横幅
插页式广告
激励广告
原生

1 出价功能集成目前处于封闭式 Beta 版阶段，请与您的客户经理联系，申请访问权限。

要求

  • Android API 级别 21 或更高级别

第 1 步：在 Unity Ads 界面中设置配置

注册或登录 Unity Ads。

创建项目

在 Unity Ads 信息中心内，前往 Projects（项目），然后点击 Create Project（创建项目）。

填写表单，然后点击创建项目以添加项目。

依次前往创收 > 开始，然后点击开始。

在项目设置模态窗口中，选择我打算使用中介，针对中介合作伙伴选择 Google AdMob，然后点击下一步。

选择广告设置，然后点击下一步。

填写表单，然后点击添加项目。

记下游戏 ID。

创建广告单元

依次前往创收 > 广告单元，然后点击添加广告单元。

输入广告单元名称，然后选择平台和广告格式。

最后，点击创建以保存您的广告单元。

添加展示位置

出价

请与您的 Google 客户经理联系，以创建出价展示位置。

瀑布

创建项目后，依次前往创收 > 展示位置。如需创建新的展示位置，请点击广告单元的添加展示位置。

填写必要的详细信息，然后点击添加展示位置。

记下展示位置 ID。

找到 Unity Ads Reporting API 密钥

出价

出价集成不需要执行此步骤。

瀑布

除了游戏 ID 和展示位置 ID 之外，您还需要 Unity Ads API 密钥和组织核心 ID 才能设置 AdMob 广告单元 ID。

依次前往创收 > 设置 > API 管理，并记下 Monetize Stats API Access Key（创收统计信息 API 访问密钥）。

然后，依次前往创收 > 组织设置，记下组织核心 ID。

开启测试模式

您可以通过 Unity Ads 信息中心启用测试模式。在项目的设置下，选择测试标签页。

如需为应用强制启用测试模式，请点击 Google Play 商店旁边的“修改”按钮，选中替换客户端测试模式，然后选择为所有设备强制启用测试模式（即使用测试广告）。

或者，您也可以点击 Add Test Device 按钮来为特定设备启用测试模式。

填写表单并点击保存。

第 2 步：在 Ad Manager 界面中设置 Unity Ads 需求来源

将 Unity Ads 添加到 GDPR 和美国州级法规广告合作伙伴名单

请按照 GDPR 设置和 美国州级法规设置中的步骤，将 Unity Ads 添加到 AdMob 界面中的 GDPR 和美国州级法规广告合作伙伴名单中。

第 3 步：导入 Unity Ads SDK 和适配器

在应用级 build.gradle.kts 文件中，添加以下实现依赖项和配置。使用最新版本的 Unity Ads SDK 和适配器：

dependencies {
    implementation("com.google.android.gms:play-services-ads:23.5.0")
    implementation("com.unity3d.ads:unity-ads:4.12.4")
    implementation("com.google.ads.mediation:unity:4.12.4.0")
}

手动集成

  1. 从其 GitHub 代码库下载最新的 Unity Ads SDK (unity-ads.aar)，并将其添加到您的项目中。

  2. 前往 Google 的 Maven 制品库中的 Unity Ads 适配器工件。选择最新版本，下载 Unity Ads 适配器的 .aar 文件，然后将其添加到您的项目中。

第 4 步：在 Unity Ads SDK 上实现隐私设置

根据 Google 《欧盟地区用户意见征求政策》，您必须确保向位于欧洲经济区 (EEA) 的用户披露相关信息并征求他们的意见，说明您将如何使用设备标识符和个人数据。此政策反映了欧盟《电子隐私指令》和《一般数据保护条例》(GDPR) 的要求。在征求用户意见时，您必须指明中介链中可能会收集、接收或使用个人数据的每个广告联盟，并提供有关每个广告联盟使用情况的信息。Google 目前无法将用户意见征求结果自动传递给此类广告联盟。

在 SDK 2.0.0 版中，Unity Ads 添加了一个 API 来支持隐私设置。以下示例代码展示了如何将此意见征求信息传递给 Unity Ads SDK。如果您选择手动将意见征求信息传递给 Unity Ads SDK，建议您先调用此代码，然后再通过 Google 移动广告 SDK 请求广告。

Java

import com.unity3d.ads.metadata.MetaData;
// ...

MetaData gdprMetaData = new MetaData(this);
gdprMetaData.set("gdpr.consent", true);
gdprMetaData.commit();

Kotlin

import com.unity3d.ads.metadata.MetaData
// ...

val gdprMetaData = MetaData(this)
gdprMetaData["gdpr.consent"] = true
gdprMetaData.commit()

如需了解详情以及每种方法中可以提供的值，请参阅 Unity Ads 的隐私权意见征求和数据 API 以及遵守 GDPR指南。

美国州级隐私保护法律

美国各州隐私保护法律 要求向用户提供选择不“出售”其“个人信息”（该法律对这些术语进行了定义）的权利，并要求“出售”方在首页醒目位置提供“不出售我的个人信息”链接，以供用户选择。根据美国州级隐私保护法律合规性指南，您可以为 Google 广告投放启用受限的数据处理，但 Google 无法将此设置应用于中介链中的每个广告联盟。因此，您必须识别中介链中可能参与销售个人信息的每个广告网络，并遵循每个广告网络的指南，以确保合规。

在 SDK 2.0.0 版中，Unity Ads 添加了一个 API 来支持隐私设置。以下示例代码展示了如何将此意见征求信息传递给 Unity Ads SDK。如果您选择手动将意见征求信息传递给 Unity Ads SDK，建议您先调用此代码，然后再通过 Google 移动广告 SDK 请求广告。

Java

import com.unity3d.ads.metadata.MetaData;
// ...

MetaData ccpaMetaData = new MetaData(this);
ccpaMetaData.set("privacy.consent", true);
ccpaMetaData.commit();

Kotlin

import com.unity3d.ads.metadata.MetaData
// ...

val ccpaMetaData = MetaData(this)
ccpaMetaData["privacy.consent"] = true
ccpaMetaData.commit()

如需了解详情以及可在每种方法中提供的值，请参阅 Unity Ads 的隐私权许可和数据 API 和 遵守 CCPA 指南。

第 5 步：添加所需代码

Unity Ads 集成无需其他代码。

第 6 步：测试您的实现

错误代码

如果适配器未能从 Unity Ads 收到广告，发布商可以使用以下类下的ResponseInfo.getAdapterResponses()检查广告响应的根本错误：

在以下类下添加了 
com.google.ads.mediation.unity.UnityAdapter
com.google.ads.mediation.unity.UnityMediationAdapter

以下是 UnityAds 适配器在广告加载失败时抛出的代码和随附消息：

错误代码 原因
0-10 UnityAds SDK 返回了错误。如需了解详情，请参阅代码。
101 在 Ad Manager 界面中配置的 UnityAds 服务器参数缺失/无效。
102 UnityAds 返回了状态为 NO_FILL 的展示位置。
103 UnityAds 返回了状态为“已停用”的展示位置。
104 UnityAds 尝试展示上下文为 null 的广告。
105 用于初始化、加载和/或展示 Unity Ads 广告的上下文不是 activity 实例。
106 UnityAds 尝试展示尚未准备好展示的广告。
107 该设备不支持 UnityAds。
108 UnityAds 一次只能为每个展示位置加载 1 个广告。
109 UnityAds 以 ERROR 状态结束。
200-204 UnityAds 横幅广告专用错误。如需了解详情，请参阅代码。

Unity Ads Android 中介适配器更新日志

版本 4.12.4.0

  • 已经验证与 Unity Ads SDK 4.12.4 兼容。

构建和测试所需版本：

  • Google 移动广告 SDK 23.3.0 版。
  • Unity Ads SDK 4.12.4 版。

版本 4.12.3.0

  • 已经验证与 Unity Ads SDK 4.12.3 兼容。

构建和测试所需版本：

  • Google 移动广告 SDK 23.3.0 版。
  • Unity Ads SDK 版本 4.12.3。

版本 4.12.2.0

  • 已经验证与 Unity Ads SDK 4.12.2 的兼容性。

构建和测试所需版本：

  • Google 移动广告 SDK 23.2.0 版。
  • Unity Ads SDK 版本 4.12.2。

版本 4.12.1.0

  • 已经验证与 Unity Ads SDK 4.12.1 兼容。

构建和测试所需版本：

  • Google 移动广告 SDK 23.2.0 版。
  • Unity Ads SDK 版本 4.12.1。

4.12.0.0 版

  • 已验证与 Unity Ads SDK 4.12.0 的兼容性。

构建和测试所需版本：

  • Google 移动广告 SDK 23.1.0 版。
  • Unity Ads SDK 版本 4.12.0。

版本 4.11.3.0

  • 添加了对横幅广告、插页式广告和激励广告格式的出价支持。
  • 已经验证与 Unity Ads SDK 4.11.3 的兼容性。

构建和测试所需版本：

  • Google 移动广告 SDK 23.1.0 版。
  • Unity Ads SDK 版本 4.11.3。

4.11.2.0 版

  • 已经验证与 Unity Ads SDK 4.11.2 兼容。

构建和测试所需系统：

  • Google 移动广告 SDK 23.0.0 版。
  • Unity Ads SDK 版本 4.11.2。

版本 4.10.0.0

  • 将最低要求的 Google 移动广告 SDK 版本更新为 23.0.0。
  • 已经验证与 Unity Ads SDK 4.10.0 兼容。

构建和测试所需版本：

  • Google 移动广告 SDK 版本 23.0.0。
  • Unity Ads SDK 版本 4.10.0。

版本 4.9.3.0

  • 已验证与 Unity Ads SDK 4.9.3 的兼容性。

构建和测试所需版本：

  • Google 移动广告 SDK 22.6.0 版。
  • Unity Ads SDK 版本 4.9.3。

版本 4.9.2.0

  • 已经验证与 Unity Ads SDK 4.9.2 的兼容性。

构建和测试所需系统：

  • Google 移动广告 SDK 22.3.0 版。
  • Unity Ads SDK 4.9.2 版。

4.9.1.0 版

  • 将最低要求的 Google 移动广告 SDK 版本更新为 22.3.0。
  • 已验证与 Unity Ads SDK 4.9.1 的兼容性。

构建和测试所需版本：

  • Google 移动广告 SDK 22.3.0 版。
  • Unity Ads SDK 版本 4.9.1。

版本 4.8.0.0

  • 在 Unity Ads SDK 调用其新的 onBannerShown() 回调方法时报告广告展示次数。
  • 已验证与 Unity Ads SDK 4.8.0 的兼容性。

构建和测试所需版本：

  • Google 移动广告 SDK 22.2.0 版。
  • Unity Ads SDK 版本 4.8.0。

版本 4.7.1.0

  • 已经验证与 Unity Ads SDK 4.7.1 的兼容性。

构建和测试所需系统：

  • Google 移动广告 SDK 22.1.0 版。
  • Unity Ads SDK 版本 4.7.1。

4.7.0.0 版

  • 已经验证与 Unity Ads SDK 4.7.0 兼容。

构建和测试所需版本：

  • Google 移动广告 SDK 22.0.0 版。
  • Unity Ads SDK 版本 4.7.0。

版本 4.6.1.1

  • 更新了适配器，以使用新的 VersionInfo 类。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 22.0.0。

构建和测试所需系统：

  • Google 移动广告 SDK 22.0.0 版。
  • Unity Ads SDK 版本 4.6.1。

版本 4.6.1.0

  • 已经验证与 Unity Ads SDK 4.6.1 兼容。

构建和测试所需版本：

  • Google 移动广告 SDK 21.5.0 版
  • Unity Ads SDK 版本 4.6.1。

4.6.0.0 版

  • 新增了对将 COPPA 信息转发到 Unity Ads SDK 的支持。
  • 已经验证与 Unity Ads SDK 4.6.0 的兼容性。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 21.5.0。

构建和测试所需系统：

  • Google 移动广告 SDK 21.5.0 版
  • Unity Ads SDK 版本 4.6.0。

4.5.0.0 版

  • 已经验证与 Unity Ads SDK 4.5.0 的兼容性。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 21.4.0。

构建和测试所需版本：

  • Google 移动广告 SDK 版本 21.4.0
  • Unity Ads SDK 版本 4.5.0。

版本 4.4.1.0

  • 已经验证与 Unity Ads SDK 4.4.1 兼容。

构建和测试所需系统：

  • Google 移动广告 SDK 版本 21.2.0
  • Unity Ads SDK 版本 4.4.1。

4.4.0.0 版

  • 已经验证与 Unity Ads SDK 4.4.0 的兼容性。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 21.2.0。

构建和测试所需版本：

  • Google 移动广告 SDK 21.2.0 版
  • Unity Ads SDK 4.4.0 版。

版本 4.3.0.0

  • 已验证与 Unity Ads SDK 4.3.0 的兼容性。
  • 现在，在插页式广告和激励广告开始播放时，系统会转发 onAdOpened() 回调。

构建和测试所需系统：

  • Google 移动广告 SDK 21.1.0 版
  • Unity Ads SDK 版本 4.3.0。

4.2.1.1 版

  • 将 compileSdkVersion 和 targetSdkVersion 更新到了 API 31。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 21.0.0。

构建和测试所需版本：

  • Google 移动广告 SDK 21.0.0 版。
  • Unity Ads SDK 版本 4.2.1。

版本 4.2.1.0

  • 已经验证与 Unity Ads SDK 4.2.1 兼容。

构建和测试所需版本：

  • Google 移动广告 SDK 20.6.0 版。
  • Unity Ads SDK 版本 4.2.1。

版本 4.1.0.0

  • 已经验证与 Unity Ads SDK 4.1.0 兼容。

构建和测试所需版本：

  • Google 移动广告 SDK 20.6.0 版。
  • Unity Ads SDK 版本 4.1.0。

版本 4.0.1.0

  • 已经验证与 Unity Ads SDK 4.0.1 的兼容性。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 20.6.0。

构建和测试所需版本：

  • Google 移动广告 SDK 20.6.0 版。
  • Unity Ads SDK 4.0.1 版。

4.0.0.0 版

  • 已经验证与 Unity Ads SDK 4.0.0 兼容。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 20.5.0。

构建和测试所需版本：

  • Google 移动广告 SDK 20.5.0 版。
  • Unity Ads SDK 版本 4.0.0。

版本 3.7.5.0

  • 已经验证与 Unity Ads SDK 3.7.5 的兼容性。

构建和测试所需版本：

  • Google 移动广告 SDK 20.2.0 版。
  • Unity Ads SDK 版本 3.7.5。

版本 3.7.4.0

  • 已经验证与 Unity Ads SDK 3.7.4 的兼容性。

构建和测试所需版本：

  • Google 移动广告 SDK 20.2.0 版。
  • Unity Ads SDK 版本 3.7.4。

版本 3.7.2.0

  • 已验证与 Unity Ads SDK 3.7.2 的兼容性。
  • 将所需的最低 Google 移动广告 SDK 版本更新为 20.2.0。

构建和测试所需版本：

  • Google 移动广告 SDK 20.2.0 版。
  • Unity Ads SDK 版本 3.7.2。

版本 3.7.1.0

  • 已经验证与 Unity Ads SDK 3.7.1 兼容。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 20.1.0。

构建和测试所需版本：

  • Google 移动广告 SDK 20.1.0 版。
  • Unity Ads SDK 3.7.1 版。

版本 3.6.2.0

  • 已验证与 Unity Ads SDK 3.6.2 的兼容性。
  • 修复了激励广告未转发点击回调的问题。
  • 已从捆绑的适配器 build 中移除 UnityAds SDK。 现在，发布商需要手动将 UnityAds SDK 添加为额外的依赖项。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 19.8.0。

构建和测试所需系统：

  • Google 移动广告 SDK 19.8.0 版。
  • Unity Ads SDK 版本 3.6.2。

版本 3.6.0.0

  • 已经验证与 Unity Ads SDK 3.6.0 的兼容性。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 19.6.0。

构建和测试所需版本：

  • Google 移动广告 SDK 19.6.0 版。
  • Unity Ads SDK 版本 3.6.0。

版本 3.5.1.1

  • 修复了在尝试请求多个插页式广告和激励广告时出现的问题。

构建和测试所需版本：

  • Google 移动广告 SDK 19.5.0 版。
  • Unity Ads SDK 版本 3.5.1。

版本 3.5.1.0

  • 已验证与 Unity Ads SDK 3.5.1 的兼容性。
  • 修复了导致智能横幅广告请求失败的问题。

构建和测试所需版本：

  • Google 移动广告 SDK 19.5.0 版。
  • Unity Ads SDK 版本 3.5.1。

版本 3.5.0.0

  • 已经验证与 Unity Ads SDK 3.5.0 的兼容性。
  • 添加了对自适应横幅广告的支持。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 19.5.0。

构建和测试所需系统：

  • Google 移动广告 SDK 19.5.0 版。
  • Unity Ads SDK 3.5.0 版。

版本 3.4.8.0

  • 修复了在横幅广告被销毁时发生的 NullPointerException 错误。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 19.3.0。

构建和测试所需版本：

  • Google 移动广告 SDK 19.3.0 版。
  • Unity Ads SDK 3.4.8 版。

版本 3.4.6.1

  • 创建了不包含捆绑的 Unity Ads SDK 的适配器 build。 这样，发布商便可以在 Unity 中进行中介时选择使用 Unity Ads 服务，以避免出现依赖项冲突问题。
    • 发布商可以选择在应用级 build.gradle 文件中添加 com.google.ads.mediation:unity-adapter-only:x.y.z.p 依赖项，以便使用此功能。

构建和测试所需版本：

  • Google 移动广告 SDK 19.1.0 版。
  • Unity Ads SDK 版本 3.4.6。

版本 3.4.6.0

  • 已经验证与 Unity Ads SDK 3.4.6 兼容。
  • 现在，适配器会在用户点击横幅广告时转发 onAdOpened() 回调。

构建和测试所需版本：

  • Google 移动广告 SDK 19.1.0 版。
  • Unity Ads SDK 3.4.6 版。

版本 3.4.2.3

  • 添加了描述性错误代码和适配器加载/显示失败的原因。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 19.1.0。

构建和测试所需系统：

  • Google 移动广告 SDK 19.1.0 版。
  • Unity Ads SDK 版本 3.4.2。

版本 3.4.2.2

  • 修复了在 Unity Ads 返回错误时发生的 ConcurrentModificationException 崩溃问题。

构建和测试所需版本：

  • Google 移动广告 SDK 19.0.1 版。
  • Unity Ads SDK 版本 3.4.2。

版本 3.4.2.1

  • 改进了 Unity 错误的转发功能，以便更早地识别初始化和广告加载故障，并减少超时。
  • 将要求的最低 Google 移动广告 SDK 版本更新为 19.0.1。

构建和测试所需版本：

  • Google 移动广告 SDK 19.0.1 版。
  • Unity Ads SDK 版本 3.4.2。

版本 3.4.2.0

  • 已经验证与 Unity Ads SDK 3.4.2 的兼容性。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 18.3.0。

构建和测试所需版本：

  • Google 移动广告 SDK 18.3.0 版。
  • Unity Ads SDK 版本 3.4.2。

版本 3.4.0.0

  • 已验证与 Unity Ads SDK 3.4.0 的兼容性。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 18.3.0。

构建和测试所需版本：

  • Google 移动广告 SDK 18.3.0 版。
  • Unity Ads SDK 3.4.0 版。

版本 3.3.0.0

  • 已经验证与 Unity Ads SDK 3.3.0 兼容。

构建和测试所需版本：

  • Google 移动广告 SDK 18.2.0 版。
  • Unity Ads SDK 版本 3.3.0。

版本 3.2.0.1

  • 修复了在调用 UnityAds.initialize() 之前调用 loadAd() 时发生的 null 指针异常崩溃问题。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 18.2.0。

版本 3.2.0.0

  • 修复了导致横幅广告请求失败的问题。
  • 已经验证与 Unity Ads SDK 3.2.0 兼容。
  • 将适配器迁移到了 AndroidX。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 18.1.1。

版本 3.1.0.0

  • 新增了对灵活横幅广告尺寸的支持。
  • 如果请求的尺寸与任何 Unity Ads 横幅广告尺寸不兼容，适配器会拒绝广告请求
  • 已经验证与 Unity Ads SDK 3.1.0 兼容。

版本 3.0.1.0

  • 已验证与 Unity Ads SDK 3.0.1 的兼容性。
  • 修复了在展示插页式广告时导致“NPE”的 bug。

版本 3.0.0.2

  • 更新了适配器，以支持新的公开 Beta 版激励广告 API。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 17.2.0。

版本 3.0.0.1

  • 添加了对 Unity Ads 横幅广告的支持。

版本 3.0.0.0

  • 已经验证与 Unity Ads SDK 3.0.0 兼容。

版本 2.3.0.0

  • 已经验证与 Unity Ads SDK 2.3.0 兼容。

版本 2.2.1.1

  • 更新了适配器以调用 onRewardedVideoComplete() 广告事件。

版本 2.2.1.0

  • 已经验证与 Unity Ads SDK 2.2.1 兼容。

版本 2.2.0.0

  • 已经验证与 Unity Ads SDK 2.2.0 兼容。

版本 2.1.2.0

  • 已验证与 Unity Ads SDK 2.1.2 的兼容性。

版本 2.1.1.0

  • 已经验证与 Unity Ads SDK 2.1.1 的兼容性。

版本 2.1.0.0

  • 更新了适配器，使其与 Unity Ads SDK 2.1.0 兼容。

版本 2.0.8.0

  • 已经验证与 Unity Ads SDK 2.0.8 兼容。

版本 2.0.7.0

  • 使用 Unity Ads 的点击报告（AdMob 和 Unity Ads 点击统计信息将保持一致）。
  • 添加了 onAdLeftApplication 回调支持。

版本 2.0.6.0

  • 已验证与 Unity Ads SDK 2.0.6 的兼容性。

版本 2.0.5.0

  • 现在，您可以通过将以下代码添加到 build.gradle 文件的 dependencies 标记中，将适配器添加为编译依赖项：compile 'com.google.ads.mediation:unity:2.0.5.0'
  • 改为以 aar 文件（而非 jar 文件）分发适配器（如需了解更多说明，请参阅自述文件）。

版本 2.0.4.0

  • 修复了导致激励视频广告在先加载插页式广告时无法加载的 bug。

版本 2.0.2.0

  • 将版本命名系统更改为 [Unity Ads SDK 版本].[适配器补丁版本]。
  • 将所需的最低 Unity Ads SDK 版本更新为 v2.0.2。
  • 将最低要求的 Google 移动广告 SDK 版本更新为 v9.0.0。
  • 应用不再需要调用 UnityAds.changeActivity(this)。

版本 1.0.0

  • 初始版本。支持激励视频广告和插页式广告。