安裝 Microsoft Advertising SDK

警告

自 2020 年 6 月 1 日起,Windows UWP 應用程式的 Microsoft 廣告收益平台將會關閉。 深入了解

若要在適用於 Windows 10 和 Windows 11 的 UWP 應用程式中顯示廣告,請安裝 Microsoft Advertising 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 Advertising SDK:

  1. 關閉所有 Visual Studio 執行個體。

  2. 如果您先前已安裝任何舊版的 Microsoft Advertising SDK、Universal Ad Client SDK、Ad Mediator 延伸模組,或 Microsoft Store Engagement 和 Monetization SDK,請立即解除安裝這些 SDK 版本。 或者,開啟 [命令提示字元] 視窗並執行下列命令,以清除任何舊版廣告 SDK 版本,這些版本可能已隨 Visual Studio 一起安裝但可能未出現在您電腦上的已安裝程式清單中:

    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 Advertising SDK。 安裝可能需要幾分鐘的時間。 請確定並等到程序完成為止。

  4. 重新啟動 Visual Studio。

  5. 如果您有參考任何舊版 Microsoft Advertising SDK、Universal Ad Client SDK 或 Microsoft Store Engagement 和 Monetization SDK 之廣告庫的現有專案,建議您在 Visual Studio 中開啟專案,然後清除和重建您的專案 (在 [方案總管] 中,以滑鼠右鍵按一下您的專案節點,然後選擇 [清除],然後再次以滑鼠右鍵按一下您的專案節點,然後選擇 [重建])。

否則,如果您是在專案中第一次使用 Microsoft Advertising SDK,您現在已準備好新增 Microsoft Advertising SDK 的參考

透過 NuGet 安裝

若要透過 NuGet 在特定 UWP 專案中安裝 Microsoft Advertising SDK:

  1. 關閉所有 Visual Studio 執行個體。

  2. 如果您先前已安裝任何舊版的 Microsoft Advertising SDK、Universal Ad Client SDK、Ad Mediator 延伸模組,或 Microsoft Store Engagement 和 Monetization SDK,請立即解除安裝這些 SDK 版本。 或者,開啟 [命令提示字元] 視窗並執行下列命令,以清除任何舊版廣告 SDK 版本,這些版本可能已隨 Visual Studio 一起安裝但可能未出現在您電腦上的已安裝程式清單中:

    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 Advertising SDK 的專案。

    注意

    如果您的專案已經包含 SDK 舊版 MSI 安裝的程式庫參考,請從專案中移除這些參考。 這些參考旁邊會有警告圖示,因為它們參考的程式庫已在先前的步驟中移除。

  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 Advertising SDK 程式庫,而且您已將專案更新為較新版本的 SDK,建議您清除並重建專案 (在 [方案總管] 中,以滑鼠右鍵按一下您的專案節點,然後選擇 [清除],然後再次以滑鼠右鍵按一下您的專案節點,然後選擇 [重建])。

否則,如果您是在專案中第一次使用 SDK,您現在已準備好新增 Microsoft Advertising SDK 的參考

新增 Microsoft Advertising SDK 的參考

安裝 Microsoft Advertising SDK 之後,請遵循這些指示來參考專案中的 SDK,以便使用廣告 API。

  1. 在 Visual Studio 中,開啟您的專案。

    注意

    如果您的專案以 [任何 CPU] 為目標,請更新您的專案以使用架構特定的組建輸出 (例如 x86)。 如果您的專案以 [任何 CPU] 為目標,您將無法在下列步驟中成功新增 Microsoft Advertising SDK 的參考。 如需詳細資訊,請參閱在專案中以任何 CPU 為目標所造成的參考錯誤

  2. 在 [方案總管] 中,以滑鼠右鍵按一下 [參考],然後選取 [新增參考...]

  3. 在 [參考管理員] 中,展開 [通用 Windows],按一下 [延伸模組],然後選取 [適用於 XAML 的 Microsoft Advertising SDK] 旁的核取方塊 (適用於 XAML 應用程式) 或 [適用於 JavaScript 的 Microsoft Advertising SDK] (適用於使用 JavaScript 和 HTML 建置的應用程式)。

  4. 在 [參考管理員] 中,按一下 [確定]。

如需示範如何開始使用廣告 API 的逐步解說,請參閱下列文章:

了解 Microsoft Advertising SDK 中的架構套件

Microsoft Advertising SDK (適用於 UWP 應用程式) 中的 Microsoft.Advertising.dll 程式會設定為「架構套件」。 此程式庫包含 Microsoft.AdvertisingMicrosoft.Advertising.WinRT.UI 命名空間中的廣告 API。

因為此程式庫是架構套件,這表示在使用者安裝使用此程式庫的應用程式版本之後,每當我們發佈包含修正和效能改善的新版本程式庫時,都會透過 Windows Update 在其裝置上自動更新此程式庫。 這有助於確保您的客戶一律在其裝置上安裝最新可用的程式庫版本。

如果我們在此程式庫中發行引進新 API 或功能的新版本 SDK,您必須安裝最新版本的 SDK,才能使用這些功能。 在這種情況下,您也需要將更新的應用程式發佈至市集。