此页面由 Cloud Translation API 翻译。

开始使用

Google User Messaging Platform (UMP) SDK 是一款隐私权和消息工具，可帮助您管理隐私选项。如需了解详情，请参阅“隐私权和消息”页面简介。您可以在 Objective-C 或 Swift UMP 示例应用中查看使用 UMP SDK 的有效 IMA 实现。

创建消息类型

在 Ad Manager 账号的隐私权和消息标签页下，使用其中一种可用的用户消息类型创建用户消息。UMP SDK 会尝试显示根据您在项目中设置的互动式媒体广告应用 ID 创建的隐私权消息。

如需了解详情，请参阅隐私权和消息简介。

导入 SDK

UMP SDK 未作为 IMA SDK 的依赖项包含在内，因此您必须自行明确添加该 SDK。

CocoaPods（首选）

如要将该 SDK 导入 iOS 项目，最简单的方法就是使用 CocoaPods。请打开项目的 Podfile 并将下面这行代码添加到应用的目标中：

pod 'GoogleUserMessagingPlatform'

然后运行以下命令：

pod install --repo-update

如果您刚开始接触 CocoaPods，请参阅如何使用 CocoaPods，详细了解如何创建和使用 Podfile。

Swift Package Manager

UMP SDK 还支持 Swift Package Manager。请按照以下步骤导入 Swift 软件包。

在 Xcode 中，依次前往 File（文件）> Add Packages（添加软件包），安装 UMP SDK Swift 软件包。

在显示的提示中，搜索 UMP SDK Swift 软件包的 GitHub 代码库：

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

选择要使用的 UMP SDK Swift 软件包版本。对于新项目，我们建议使用 Up to Next Major Version。

然后，Xcode 会解析您的软件包依赖项，并在后台下载它们。如需详细了解如何添加软件包依赖项，请参阅 Apple 的文章。

添加应用 ID

您可以在 Ad Manager 界面中找到您的应用 ID。使用以下代码段将 ID 添加到 Info.plist：

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

获取用户的意见征求信息

每次启动应用时，您都应使用 requestConsentInfoUpdateWithParameters:completionHandler: 请求更新用户的意见征求信息。此请求会检查以下内容：

是否需要征得用户同意。例如，首次需要征得用户同意，或者之前的用户意见征求结果已过期。
是否必须提供隐私设置选项入口点。某些隐私权消息要求应用允许用户随时修改其隐私选项。

Swift


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

Objective-C


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

加载并显示隐私权消息表单

收到最新的意见征求状态后，调用 loadAndPresentIfRequiredFromViewController:completionHandler: 以加载收集用户意见征求所需的所有表单。加载后，表单会立即显示。

Swift


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

Objective-C


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

隐私选项

某些隐私权消息表单会通过发布商呈现的隐私权选项入口点显示，以便用户随时管理其隐私权选项。如需详细了解您的用户会在隐私权选项入口点看到哪条消息，请参阅可用的用户消息类型。

检查是否需要隐私设置选项入口点

调用 requestConsentInfoUpdateWithParameters:completionHandler: 后，请检查 UMPConsentInformation.sharedInstance.privacyOptionsRequirementStatus，以确定您的应用是否需要隐私选项入口点。如果需要入口点，请向应用添加可见且可交互的界面元素，以显示隐私选项表单。如果不需要隐私权入口点，请将界面元素配置为不可见且不可互动。

Swift


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

Objective-C


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

- (void)gatherConsentFromConsentPresentationViewController:(UIViewController *)viewController
                                  consentGatheringComplete:
                                      (void (^)(NSError *_Nullable))consentGatheringComplete {
  UMPRequestParameters *parameters = [[UMPRequestParameters alloc] init];
  // Set tag for under age of consent. Use NO constant to indicate that the user is not under age.
  parameters.tagForUnderAgeOfConsent = NO;

  UMPDebugSettings *debugSettings = [[UMPDebugSettings alloc] init];
  // Uncomment the following line to simulate a consent request from users in the
  // European Economic Area (EEA) for testing purposes.
  // debugSettings.geography = UMPDebugGeographyEEA;
  parameters.debugSettings = debugSettings;

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

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

- (void)presentPrivacyOptionsFormFromViewController:(UIViewController *)viewController
                                  completionHandler:
                                      (void (^)(NSError *_Nullable))completionHandler {
  [UMPConsentForm presentPrivacyOptionsFormFromViewController:viewController
                                            completionHandler:completionHandler];
}

@end
ConsentManager.m

如需查看隐私权选项要求状态的完整列表，请参阅 UMPPrivacyOptionsRequirementStatus。

显示隐私选项表单

当用户与您的元素互动时，显示隐私选项表单：

Swift


UMPConsentForm.presentPrivacyOptionsForm(
  from: viewController, completionHandler: completionHandler)ConsentManager.swift

Objective-C


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

在征得用户同意后请求展示广告

在请求展示广告之前，请使用 UMPConsentInformation.sharedInstance.canRequestAds 检查您是否已征得用户同意：

Swift

UMPConsentInformation.sharedInstance.canRequestAds

Objective-C

UMPConsentInformation.sharedInstance.canRequestAds;

您可以查看以下位置，了解自己是否可以在征求用户意见时请求展示广告：

UMP SDK 在当前会话中收集用户意见后。
在调用 requestConsentInfoUpdateWithParameters:completionHandler: 后立即调用。UMP SDK 可能已在上一应用会话中征得用户同意。

如果在征求用户意见的过程中出现错误，请检查您是否可以请求展示广告。UMP SDK 会使用上一个应用会话中的意见征求状态。

防止重复的广告请求工作

在征得用户同意后以及调用 requestConsentInfoUpdateWithParameters:completionHandler: 后，请检查 UMPConsentInformation.sharedInstance.canRequestAds，确保您的逻辑可防止发出多余的广告请求，这可能会导致这两次检查都返回 true。例如，使用布尔值变量。

测试

如果您希望在应用开发过程中测试集成，请按照以下步骤以编程方式注册您的测试设备。在发布应用之前，请务必移除用于设置这些测试设备 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 提供了一种方法：使用 UMPDebugGeography 测试您的应用行为，就像设备位于欧洲经济区 (EEA) 或英国境内一样。请注意，调试设置仅适用于测试设备。

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 UmpExample 和 Objective-C UmpExample。

欧盟地区用户意见征求和 GDPR