通过

安装 Microsoft 广告 SDK

  • 项目

警告

自 2020 年 6 月 1 日起，适用于 Windows UWP 应用的 Microsoft 广告盈利平台将关闭。 了解详细信息

若要在适用于 Windows 10 和 Windows 11 的 UWP 应用中显示广告，请安装Microsoft 广告 SDK。 此 SDK 是 Visual Studio 2015 及更高版本的扩展。

注意

如果开发的是 JavaScript/HTML UWP 应用，则除了安装 Windows 10 SDK 版本 (10.0.14393)（周年更新） 或更高版本以外，还必须安装 WinJS 库。 此库以前包含在 Windows 10 SDK 的早期版本中，但从 Windows 10 SDK 版本 10.0.14393（周年更新）开始，必须单独安装此库。

通过 MSI 安装

若要通过 MSI 安装程序安装Microsoft 广告 SDK，请执行以下操作：

  1. 关闭 Visual Studio 的所有实例。

  2. 如果以前安装了任何以前版本的 Microsoft 广告 SDK、通用 Ad 客户端 SDK、Ad Mediator 扩展或 Microsoft Store Engagement 和货币化 SDK，请立即卸载这些 SDK 版本。 （可选）打开 命令提示符 窗口并运行以下命令以清除可能随 Visual Studio 一起安装的任何较旧的广告 SDK 版本，但可能不会显示在计算机上的已安装程序列表中：

    MsiExec.exe /x{5C87A4DB-31C7-465E-9356-71B485B69EC8}
MsiExec.exe /x{6AB13C21-C3EC-46E1-8009-6FD5EBEE515B}
MsiExec.exe /x{6AC81125-8485-463D-9352-3F35A2508C11}

  3. 下载并安装Microsoft 广告 SDK。 安装可能需要几分钟时间。 确保并等待进程完成。

  4. 重新启动 Visual Studio。

  5. 如果有一个现有项目引用来自任何早期版本的 Microsoft 广告 SDK、通用广告客户端 SDK 或 Microsoft Store Engagement 和盈利 SDK 的广告库，建议在 Visual Studio 中打开项目并清理并重新生成项目（在解决方案资源管理器中，右键单击项目节点并选择“清理干净”，然后再次右键单击项目节点，然后选择“重新生成”。

否则，如果在项目中首次使用Microsoft 广告 SDK，则现在可以添加对Microsoft 广告 SDK的引用。

通过 NuGet 安装

若要通过 NuGet 在特定 UWP 项目中安装Microsoft 广告 SDK，请执行以下操作：

  1. 关闭 Visual Studio 的所有实例。

  2. 如果以前安装了任何以前版本的 Microsoft 广告 SDK、通用 Ad 客户端 SDK、Ad Mediator 扩展或 Microsoft Store Engagement 和货币化 SDK，请立即卸载这些 SDK 版本。 （可选）打开 命令提示符 窗口并运行以下命令以清除可能随 Visual Studio 一起安装的任何较旧的广告 SDK 版本，但可能不会显示在计算机上的已安装程序列表中：

    MsiExec.exe /x{5C87A4DB-31C7-465E-9356-71B485B69EC8}
MsiExec.exe /x{6AB13C21-C3EC-46E1-8009-6FD5EBEE515B}
MsiExec.exe /x{6AC81125-8485-463D-9352-3F35A2508C11}

  3. 启动 Visual Studio 并打开要使用的项目Microsoft 广告 SDK。

    注意

    如果项目已包含早期 MSI 安装的 SDK 中的库引用，请从项目中删除这些引用。 这些引用旁边会显示警告图标，因为它们引用的库已在前面的步骤中删除。

  4. 在 Visual Studio 中，依次单击项目和管理 NuGet 包。

  5. 在搜索框中，键入 Microsoft.Advertising.XAML（适用于 XAML 项目）或 Microsoft.Advertising.JS （适用于 JavaScript/HTML 项目），并安装相应的包。 安装完包后，保存解决方案。

    注意

    如果“输出”窗口报告一个“安装包”错误，指示指定的路径太长，则可能需要将 NuGet 配置为将包提取到路径比默认位置短的备用位置。 为此，请将 repositoryPath 该值添加到计算机上的 nuget.config 文件，并将其分配给可以提取 NuGet 包的短文件夹路径。 有关详细信息，请参阅 NuGet 文档中的本文 。 或者，可以尝试将 Visual Studio 项目移动到具有较短路径的备用文件夹。

  6. 关闭解决方案，然后重新打开它。

  7. 如果你的项目已经引用了早期版本的通过 NuGet 安装的Microsoft 广告 SDK库，并且你已将项目更新为较新版本的 SDK，我们建议你清理并重新生成项目（在解决方案资源管理器中，右键单击项目节点并选择“清理”，然后再次右键单击项目节点并选择“重新生成”。

否则，如果在项目中首次使用 SDK，则现在可以添加对Microsoft 广告 SDK的引用。

添加对Microsoft 广告 SDK的引用

安装Microsoft 广告 SDK后，请按照这些说明在项目中引用 SDK，以便可以使用广告 API。

  1. 在 Visual Studio 中打开项目。

    注意

    如果你的项目面向任何 CPU，请更新你的项目以使用特定于体系结构的生成输出（例如，x86）。 如果项目面向任何 CPU，则无法在以下步骤中成功添加对Microsoft 广告 SDK的引用。 有关详细信息，请参阅项目中由面向任何 CPU 引起的引用错误。

  2. 在“解决方案资源管理器”中，右键单击“引用”，然后选择“添加引用…”

  3. 在引用管理器中，展开通用 Windows，单击“扩展”，然后选择 XAML（适用于 XAML 应用）Microsoft 广告 SDK旁边的复选框，或为 JavaScript Microsoft 广告 SDK（对于使用 JavaScript 和 HTML 生成的应用）。

  4. 在引用管理器中，单击“确定”。

有关演示如何开始使用广告 API 的演练，请参阅以下文章：

了解Microsoft 广告 SDK中的框架包

适用于 UWP 应用的 Microsoft 广告 SDK 中的 Microsoft.Advertising.dll 库已配置为框架包。 此库包含 Microsoft.Advertising 和 Microsoft.Advertising.WinRT.UI 命名空间中的广告 API。

由于此库是框架包，这意味着在用户安装使用此库的应用版本后，每当我们发布具有修补程序和性能改进的新版本库时，此库都会在其设备上自动更新Windows 更新。 这有助于确保客户始终在其设备上安装最新版本的库。

如果我们发布引入此库中新 API 或功能的 SDK 新版本，则需要安装最新版本的 SDK 才能使用这些功能。 在此方案中，还需要将更新的应用发布到应用商店。