本頁面由 Cloud Translation API 翻譯而成。

開始使用

Google User Messaging Platform (UMP) SDK 是一項隱私權與訊息工具，協助您管理隱私權選擇若需更多資訊，請參閲關於隱私權與訊息。

建立訊息類型

使用以下其中一則文字建立使用者訊息：可用的使用者訊息類型中，隱私權與訊息分頁 AdMob 讓他們使用服務帳戶UMP SDK 會嘗試顯示從應用程式 ID AdMob 建立的隱私權訊息您在專案中設定的內容

匯入 SDK

CocoaPods (建議)

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

pod 'GoogleUserMessagingPlatform'

接著執行下列指令：

pod install --repo-update

如果您是 CocoaPods 新手，請參閱使用 CocoaPods：建立及使用 Podfiles

Swift 套件管理工具

UMP SDK 也支援 Swift 套件管理工具。請按照以下步驟匯入 Swift 套件

在 Xcode 中前往以下網址，安裝 UMP SDK Swift 套件： 檔案 >新增套件...。

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

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

選取您要使用的 UMP SDK Swift 套件版本。如為新的專案時，建議使用下一個主要版本。

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

手動下載

匯入 SDK 的另一種方式則是手動進行。

下載 SDK

然後將架構拖曳至 Xcode 專案，確認已選取「Copy」(複製) 項目。

然後，您可以使用下列任何所需檔案加入架構：

Swift

import UserMessagingPlatform

Objective-C

#include <UserMessagingPlatform/UserMessagingPlatform.h>

新增應用程式 ID

您可以在「 AdMob UI：將身分證件新增至 Info.plist 替換為下列程式碼片段：

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

在每個應用程式中，應要求使用者更新同意聲明資訊使用 requestConsentInfoUpdateWithParameters:completionHandler:啟動。這項要求會檢查包括：

是否必須取得同意聲明。舉例來說，或先前的同意聲明決定失效
是否需提供隱私權選項進入點。部分隱私權訊息應用程式必須允許使用者隨時修改隱私權選項。

以下範例說明如何從 UIViewController viewDidLoad() 方法。

Swift

override func viewDidLoad() {
  super.viewDidLoad()

  // Request an update for the consent information.
  UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: nil) {
    [weak self] requestConsentError in
    guard let self else { return }

    if let consentError = requestConsentError {
      // Consent gathering failed.
      return print("Error: \(consentError.localizedDescription)")
    }

    // TODO: Load and present the privacy message form.
  }
}

Objective-C

- (void)viewDidLoad {
  [super viewDidLoad];

  // Request an update for the consent information.
  [UMPConsentInformation.sharedInstance
      requestConsentInfoUpdateWithParameters:nil
          completionHandler:^(NSError *_Nullable requestConsentError) {
            if (requestConsentError) {
              // Consent gathering failed.
              NSLog(@"Error: %@", requestConsentError.localizedDescription);
              return;
            }

            // TODO: Load and present the privacy message form.
          }];
}

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

收到最新的同意聲明狀態後，請致電 loadAndPresentIfRequiredFromViewController:completionHandler: 即可載入任何必要的表單，收集使用者同意聲明表單載入後會立即顯示。

Swift

override func viewDidLoad() {
  super.viewDidLoad()

  // Request an update for the consent information.
  UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: nil) {
    [weak self] requestConsentError in
    guard let self else { return }

    if let consentError = requestConsentError {
      // Consent gathering failed.
      return print("Error: \(consentError.localizedDescription)")
    }

    UMPConsentForm.loadAndPresentIfRequired(from: self) {
      [weak self] loadAndPresentError in
      guard let self else { return }

      if let consentError = loadAndPresentError {
        // Consent gathering failed.
        return print("Error: \(consentError.localizedDescription)")
      }

      // Consent has been gathered.
    }
  }
}

Objective-C

- (void)viewDidLoad {
  [super viewDidLoad];

  __weak __typeof__(self) weakSelf = self;
  // Request an update for the consent information.
  [UMPConsentInformation.sharedInstance
      requestConsentInfoUpdateWithParameters:nil
          completionHandler:^(NSError *_Nullable requestConsentError) {
            if (requestConsentError) {
              // Consent gathering failed.
              NSLog(@"Error: %@", requestConsentError.localizedDescription);
              return;
            }

            __strong __typeof__(self) strongSelf = weakSelf;
            if (!strongSelf) {
              return;
            }

            [UMPConsentForm loadAndPresentIfRequiredFromViewController:strongSelf
                completionHandler:^(NSError *loadAndPresentError) {
                  if (loadAndPresentError) {
                    // Consent gathering failed.
                    NSLog(@"Error: %@", loadAndPresentError.localizedDescription);
                    return;
                  }

                  // Consent has been gathered.
                }];
          }];
}

您需要在使用者做出選擇或關閉廣告後執行任何動作請將該邏輯放在 completion handler中。

隱私權選項

部分隱私權訊息表單是由發布商顯示的隱私權提供選項進入點，讓使用者隨時管理自己的隱私權選項。進一步瞭解使用者可透過隱私權選項看到的訊息進入點，請參閱可用的使用者訊息類型：

如要實作隱私權選項進入點，請完成下列步驟：

請檢查 UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus。
如果隱私權選項進入點您必須在應用程式中加入可見且可互動的 UI 元素。
使用以下程式碼觸發隱私權選項表單： presentPrivacyOptionsFormFromViewController:completionHandler:。

以下程式碼範例會示範這些步驟：

Swift

@IBOutlet weak var privacySettingsButton: UIBarButtonItem!

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

override func viewDidLoad() {
  // ...

  // Request an update for the consent information.
  UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: parameters) {
    // ...

    UMPConsentForm.loadAndPresentIfRequired(from: self) {
      //...

      // Consent has been gathered.

      // Show the button if privacy options are required.
      self.privacySettingsButton.isEnabled = isPrivacyOptionsRequired
    }
  }
  // ...
}

// Present the privacy options form when a user interacts with the
// privacy settings button.
@IBAction func privacySettingsTapped(_ sender: UIBarButtonItem) {
  UMPConsentForm.presentPrivacyOptionsForm(from: self) {
    [weak self] formError in
    guard let self, let formError else { return }

    // Handle the error.
  }
}

Objective-C

@interface ViewController ()
@property(weak, nonatomic) IBOutlet UIBarButtonItem *privacySettingsButton;
@end

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

- (void)viewDidLoad {
  // ...

  __weak __typeof__(self) weakSelf = self;
  // Request an update for the consent information.
  [UMPConsentInformation.sharedInstance
      requestConsentInfoUpdateWithParameters:parameters
          completionHandler:^(NSError *_Nullable requestConsentError) {
            // ...

            [UMPConsentForm loadAndPresentIfRequiredFromViewController:strongSelf
                completionHandler:^(NSError *loadAndPresentError) {
                  // ...

                  // Consent has been gathered.

                  // Show the button if privacy options are required.
                  strongSelf.privacySettingsButton.enabled = isPrivacyOptionsRequired;
                }];
          }];
}

// Present the privacy options form when a user interacts with your
// privacy settings button.
- (IBAction)privacySettingsTapped:(UIBarButtonItem *)sender {
  [UMPConsentForm presentPrivacyOptionsFormFromViewController:self
                                completionHandler:^(NSError *_Nullable formError) {
                                  if (formError) {
                                    // Handle the error.
                                  }
                                }];
}

請求廣告

在應用程式中請求廣告前，請確認您已取得同意聲明透過 UMPConsentInformation.sharedInstance.canRequestAds存取。這裡共有兩個收集同意聲明時的檢查地點：

在目前的工作階段中收集到同意聲明後。
呼叫 requestConsentInfoUpdateWithParameters:completionHandler:後立即執行。您可能已在上一個工作階段取得同意聲明。一段延遲時間最佳做法，建議您不要等待回呼完成在應用程式啟動後盡快載入廣告。

如果在收集同意聲明的過程中發生錯誤，請求廣告UMP SDK 會使用上一個會很有幫助

Swift

class ViewController: UIViewController {

  // Use a boolean to initialize the Google Mobile Ads SDK and load ads once.
  private var isMobileAdsStartCalled = false

  override func viewDidLoad() {
    super.viewDidLoad()

    // Request an update for the consent information.
    UMPConsentInformation.sharedInstance.requestConsentInfoUpdate(with: nil) {
      [weak self] requestConsentError in
      guard let self else { return }

      if let consentError = requestConsentError {
        // Consent gathering failed.
        return print("Error: \(consentError.localizedDescription)")
      }

      UMPConsentForm.loadAndPresentIfRequired(from: self) {
        [weak self] loadAndPresentError in
        guard let self else { return }

        if let consentError = loadAndPresentError {
          // Consent gathering failed.
          return print("Error: \(consentError.localizedDescription)")
        }

        // Consent has been gathered.
        if UMPConsentInformation.sharedInstance.canRequestAds {
          self.startGoogleMobileAdsSDK()
        }
      }
    }
    
    // Check if you can initialize the Google Mobile Ads SDK in parallel
    // while checking for new consent information. Consent obtained in
    // the previous session can be used to request ads.
    if UMPConsentInformation.sharedInstance.canRequestAds {
      startGoogleMobileAdsSDK()
    }
  }
  
  private func startGoogleMobileAdsSDK() {
    DispatchQueue.main.async {
      guard !self.isMobileAdsStartCalled else { return }

      self.isMobileAdsStartCalled = true

      // Initialize the Google Mobile Ads SDK.
      GADMobileAds.sharedInstance().start()

      // TODO: Request an ad.
      // GADInterstitialAd.load(...)
    }
  }
}

Objective-C

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];

  __weak __typeof__(self) weakSelf = self;
  // Request an update for the consent information.
  [UMPConsentInformation.sharedInstance
      requestConsentInfoUpdateWithParameters:nil
          completionHandler:^(NSError *_Nullable requestConsentError) {
            if (requestConsentError) {
              // Consent gathering failed.
              NSLog(@"Error: %@", requestConsentError.localizedDescription);
              return;
            }
            __strong __typeof__(self) strongSelf = weakSelf;
            if (!strongSelf) {
              return;
            }

            [UMPConsentForm loadAndPresentIfRequiredFromViewController:strongSelf
                completionHandler:^(NSError *loadAndPresentError) {
                  if (loadAndPresentError) {
                    // Consent gathering failed.
                    NSLog(@"Error: %@", loadAndPresentError.localizedDescription);
                    return;
                  }

                  // Consent has been gathered.
                  __strong __typeof__(self) strongSelf = weakSelf;
                  if (!strongSelf) {
                    return;
                  }

                  if (UMPConsentInformation.sharedInstance.canRequestAds) {
                    [strongSelf startGoogleMobileAdsSDK];
                  }
                }];
          }];

  // Check if you can initialize the Google Mobile Ads SDK in parallel
  // while checking for new consent information. Consent obtained in
  // the previous session can be used to request ads.
  if (UMPConsentInformation.sharedInstance.canRequestAds) {
    [self startGoogleMobileAdsSDK];
  }
}

- (void)startGoogleMobileAdsSDK {
  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^{
    // Initialize the Google Mobile Ads SDK.
    [GADMobileAds.sharedInstance startWithCompletionHandler:nil];

    // TODO: Request an ad.
    // [GADInterstitialAd loadWithAdUnitID...];
  });
}

測試

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

呼叫 requestConsentInfoUpdateWithParameters:completionHandler:。

查看記錄輸出中是否有類似以下範例的訊息，顯示您的裝置 ID 以及如何將其新增為測試裝置：

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

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

修改程式碼以 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 可讓您測試應用程式行為，就像測試裝置地址在歐洲經濟區或英國境內，並使用 the debugGeography property of type UMPDebugGeography on UMPDebugSettings。請注意，偵錯設定僅適用於測試裝置。

Swift

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
      ...
    })

Objective-C

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 方法可以執行這項操作。

Swift

UMPConsentInformation.sharedInstance.reset()

Objective-C

[UMPConsentInformation.sharedInstance reset];

GitHub 上的範例

UMP SDK 整合範例： Swift | Objective-C

開始使用

建立訊息類型

匯入 SDK

CocoaPods (建議)

Swift 套件管理工具

手動下載

Swift

Objective-C

新增應用程式 ID

要求同意聲明資訊

Swift

Objective-C

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

Swift

Objective-C

隱私權選項

Swift

Objective-C

請求廣告

Swift

Objective-C

測試

Swift

Objective-C

強迫一個地理

Swift

Objective-C

重設同意聲明狀態

Swift

Objective-C

GitHub 上的範例