開始學習

Google User Messaging Platform (UMP) SDK 是隱私權和訊息工具，可協助您管理隱私權選項。詳情請參閱「關於隱私權與訊息」一文。

建立訊息類型

在 Ad Manager 帳戶的「隱私權與訊息」分頁中，使用任一可用的使用者訊息類型建立使用者訊息。UMP SDK 會嘗試顯示從專案中 Ad Manager 應用程式 ID 設定建立的隱私權訊息。

詳情請參閱隱私權和訊息功能簡介。

匯入 SDK

CocoaPods (建議)

如要將 SDK 匯入 iOS 專案，最簡單的方法是使用 CocoaPods。開啟專案的 Podfile，然後將這行程式碼新增至應用程式的目標：

pod 'GoogleUserMessagingPlatform'

然後執行下列指令：

pod install --repo-update

如果您是 CocoaPods 新手，請參閱「使用 CocoaPods」一文，進一步瞭解如何建立及使用 Podfile。

Swift Package Manager

UMP SDK 也支援 Swift Package Manager。請按照下列步驟匯入 Swift 套件。

1. 在 Xcode 中，依序前往「File」>「Add Packages...」，安裝 UMP SDK Swift Package。

2. 在隨即顯示的提示中，搜尋 UMP SDK Swift Package GitHub 存放區：

   https://github.com/googleads/swift-package-manager-google-user-messaging-platform.git
   

3. 選取要使用的 UMP SDK Swift 套件版本。對於新專案，建議您使用升級至下一個主要版本。

接著，Xcode 會解析套件依附元件，並在背景下載這些依附元件。如要進一步瞭解如何新增套件依附元件，請參閱 Apple 的文章。

手動下載

您也可以手動匯入 SDK。

下載 SDK

接著，將架構拖曳至 Xcode 專案，並確保選取「Copy items if needed」。

接著，您可以使用以下方式，在所需的任何檔案中加入架構：

import UserMessagingPlatform

#include <UserMessagingPlatform/UserMessagingPlatform.h>

新增應用程式 ID

您可以在 Ad Manager UI 中找到應用程式 ID。使用下列程式碼片段，將 ID 新增至 Info.plist：

<key>GADApplicationIdentifier</key>
<string>ca-app-pub-xxxxxxxxxxxxxxxx~yyyyyyyyyy</string>

取得使用者的同意聲明資訊

您應使用 requestConsentInfoUpdate(with:completionHandler:)，在每次啟動應用程式時要求更新使用者的同意聲明資訊。這項要求會檢查以下項目：

• 是否需要取得同意聲明。例如，首次使用時需要取得同意聲明，或是先前的同意聲明已過期。
• 是否需要隱私權選項進入點。部分隱私權訊息要求應用程式允許使用者隨時修改隱私權選項。

// Requesting an update to consent information should be called on every app launch.
UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: parameters) {
  requestConsentError in
  // ...
}
GoogleMobileAdsConsentManager.swift

// Requesting an update to consent information should be called on every app launch.
UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: parameters) {
  requestConsentError in
  // ...
}
GoogleMobileAdsConsentManager.swift

// Requesting an update to consent information should be called on every app launch.
[UMPConsentInformation.sharedInstance
    requestConsentInfoUpdateWithParameters:parameters
                         completionHandler:^(NSError *_Nullable requestConsentError) {
                           // ...
                         }];
GoogleMobileAdsConsentManager.m

載入並顯示隱私權訊息表單

收到最新的同意聲明狀態後，請呼叫 loadAndPresentIfRequired(from:) 載入收集使用者同意聲明所需的任何表單。載入後，表單會立即顯示。

try await UMPConsentForm.loadAndPresentIfRequired(from: viewController)
GoogleMobileAdsConsentManager.swift

try await UMPConsentForm.loadAndPresentIfRequired(from: nil)
GoogleMobileAdsConsentManager.swift

[UMPConsentForm
    loadAndPresentIfRequiredFromViewController:viewController
                             completionHandler:^(NSError *_Nullable loadAndPresentError) {
                                 // Consent gathering process is complete.
                                }];
GoogleMobileAdsConsentManager.m

隱私權選項

部分隱私權訊息表單會透過發布商算繪的隱私權選項進入點顯示，讓使用者隨時管理隱私權選項。如要進一步瞭解使用者在隱私權選項入口處看到的訊息，請參閱「可用的使用者訊息類型」。

檢查是否需要隱私權選項進入點

呼叫 requestConsentInfoUpdate(with:completionHandler:) 後，請檢查 UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus，判斷應用程式是否需要隱私權選項進入點。如果需要進入點，請在應用程式中新增可見且可互動的 UI 元素，以便顯示隱私權選項表單。如果不需要隱私權入口點，請將 UI 元素設為不可見且無法互動。

var isPrivacyOptionsRequired: Bool {
  return UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus == .required
}
GoogleMobileAdsConsentManager.swift

- (BOOL)isPrivacyOptionsRequired {
  return UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus ==
         UMPPrivacyOptionsRequirementStatusRequired;
}
GoogleMobileAdsConsentManager.m

如需完整的隱私權選項需求狀態清單，請參閱 UMPPrivacyOptionsRequirementStatus。

顯示隱私權選項表單

當使用者與元素互動時，請顯示隱私權選項表單：

try await UMPConsentForm.presentPrivacyOptionsForm(from: viewController)
GoogleMobileAdsConsentManager.swift

try await UMPConsentForm.presentPrivacyOptionsForm(from: nil)
GoogleMobileAdsConsentManager.swift

[UMPConsentForm presentPrivacyOptionsFormFromViewController:viewController
                                          completionHandler:completionHandler];
GoogleMobileAdsConsentManager.m

要求使用者同意放送廣告

在要求廣告前，請使用 UMPConsentInformation.sharedInstance.canRequestAds 檢查是否已取得使用者的同意聲明：

UMPConsentInformation.sharedInstance.canRequestAds

UMPConsentInformation.sharedInstance.canRequestAds;

您可以查看下列位置，瞭解是否可以在收集同意聲明時要求顯示廣告：

• UMP SDK 在目前的工作階段中收集同意聲明後。
• 呼叫 requestConsentInfoUpdate(with:completionHandler:) 後立即執行。UMP SDK 可能在先前的應用程式工作階段中取得同意聲明。

如果在同意聲明收集程序中發生錯誤，請檢查是否可以要求廣告。UMP SDK 會使用先前應用程式工作階段的同意聲明狀態。

避免重複的廣告請求工作

在收集同意聲明後，以及呼叫 requestConsentInfoUpdate(with:completionHandler:) 後，請檢查 UMPConsentInformation.sharedInstance.canRequestAds，確保邏輯可防止重複的廣告要求導致兩次檢查都傳回 true。例如，使用布林變數。

測試

如果您想在開發時測試應用程式中的整合功能，請按照下列步驟以程式輔助方式註冊測試裝置。請務必在發布應用程式前，移除設定這些測試裝置 ID 的程式碼。

1. 歡迎致電 requestConsentInfoUpdate(with:completionHandler:)。

2. 檢查記錄輸出內容，找出類似下列範例的訊息，其中會顯示裝置 ID 和如何將其新增為測試裝置：

   <UMP SDK>To enable debug mode for this device, set: UMPDebugSettings.testDeviceIdentifiers = @[2077ef9a63d2b398840261c8221a0c9b]
   

3. 將測試裝置 ID 複製到剪貼簿。

4. 修改程式碼以呼叫 UMPDebugSettings().testDeviceIdentifiers，並傳入測試裝置 ID 清單。

   Swift

   let parameters = UMPRequestParameters()
   let debugSettings = UMPDebugSettings()
   
   debugSettings.testDeviceIdentifiers = ["TEST-DEVICE-HASHED-ID"]
   parameters.debugSettings = debugSettings
   
   // Include the UMPRequestParameters in your consent request.
   UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(
       with: parameters,
       completionHandler: { error in
         // ...
       })
   

   Objective-C

   UMPRequestParameters *parameters = [[UMPRequestParameters alloc] init];
   UMPDebugSettings *debugSettings = [[UMPDebugSettings alloc] init];
   
   debugSettings.testDeviceIdentifiers = @[ @"TEST-DEVICE-HASHED-ID" ];
   parameters.debugSettings = debugSettings;
   
   // Include the UMPRequestParameters in your consent request.
   [UMPConsentInformation.sharedInstance
       requestConsentInfoUpdateWithParameters:parameters
                           completionHandler:^(NSError *_Nullable error){
                             // ...
   }];
   

強制指定地理區域

UMP SDK 提供一種方法，可使用 geography 測試應用程式的行為，就像該裝置位於歐洲經濟區或英國境內一樣。請注意，偵錯設定只適用於測試裝置。

let parameters = UMPRequestParameters()
let debugSettings = UMPDebugSettings()

debugSettings.testDeviceIdentifiers = ["TEST-DEVICE-HASHED-ID"]
debugSettings.geography = .EEA
parameters.debugSettings = debugSettings

// Include the UMPRequestParameters in your consent request.
UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(
    with: parameters,
    completionHandler: { error in
      // ...
    })

UMPRequestParameters *parameters = [[UMPRequestParameters alloc] init];
UMPDebugSettings *debugSettings = [[UMPDebugSettings alloc] init];

debugSettings.testDeviceIdentifiers = @[ @"TEST-DEVICE-HASHED-ID" ];
debugSettings.geography = UMPDebugGeographyEEA;
parameters.debugSettings = debugSettings;

// Include the UMPRequestParameters in your consent request.
[UMPConsentInformation.sharedInstance
    requestConsentInfoUpdateWithParameters:parameters
                         completionHandler:^(NSError *_Nullable error){
                           // ...
}];

重設同意聲明狀態

使用 UMP SDK 測試應用程式時，建議您重設 SDK 狀態，以模擬使用者首次安裝的體驗。SDK 提供 reset 方法來執行這項操作。

UMPConsentInformation.sharedInstance.reset()

[UMPConsentInformation.sharedInstance reset];

GitHub 上的範例

如要查看本頁所述 UMP SDK 整合功能的完整範例，請前往

• Swift AdManagerBannerExample
• SwiftUIDemo
• Objective-C AdManagerBannerExample