此页面由 Cloud Translation API 翻译。

开始使用

根据 Google 欧盟地区用户意见征求政策，您必须向欧洲经济区 (EEA) 内的用户披露某些信息，与英国用户签订协议，并就使用 Cookie 或其他本地存储方式征得用户同意；以及使用个人数据（如 AdID）来投放广告。此政策反映了欧盟《电子隐私指令》和一般数据保护条例 (GDPR)。

为了帮助发布商履行此政策规定的职责，Google 提供了 User Messaging Platform (UMP) SDK。UMP SDK 已更新，可支持最新 IAB 标准现在，所有这些配置隐私权和 Interactive Media Ads 消息。

您可在以下位置找到借助 UMP SDK 实现的 IMA 实现 Objective-C 或 Swift UMP 示例应用。

前提条件

完成入门指南

如果您正在努力满足 GDPR 的相关要求，请阅读 IAB 要求对欧盟地区用户意见征求的影响消息

创建消息类型

使用以下任一方式创建用户消息：可用的用户消息类型 隐私权和消息功能标签页 Ad Manager 。UMP SDK 会尝试显示根据 Interactive Media Ads 应用 ID 创建用户消息。如果没有为您的应用配置消息，SDK 返回一个错误。

有关详情，请参阅隐私权和消息简介。

导入 SDK

UMP SDK 未作为 IMA 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 中，前往 文件 >添加软件包...。

在显示的提示中，搜索 UMP SDK Swift Package 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 添加到您的 Info.plist 替换为以下代码段：

<key>UMPApplicationIdentifier</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 consent 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 consent form.
          }];
}

根据需要加载并显示用户意见征求表单

获得最新的意见征求状态后，请调用 loadAndPresentIfRequiredFromViewController:completionHandler: 在 UMPConsentForm 类来加载用户意见征求表单。如果必须提供用户同意情况，SDK 会加载表单并立即显示 view controller。 completion handler 在关闭表单后调用。如果不要求征得用户同意， completion handler 时，系统会立即调用。

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.canRequestAds。有两个在征求用户意见时应检查以下事项：

在当前会话中收集用户意见后。
致电 requestConsentInfoUpdateWithParameters:completionHandler:后立即。可能已在上一次会话中征得用户同意。作为延迟时间我们建议您不要等待回调完成在应用启动后尽快开始加载广告。

如果在征求用户意见的过程中出现错误，您仍应来请求广告。UMP SDK 会使用之前的会话。

Swift

class ViewController: UIViewController {

  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.startImaSdk()
        }
      }
    }
    
    // Check if you can initialize the IMA 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 {
      startImaSdk()
    }
  }
  
  private func startImaSdk() {
    // Create an IMAAdsLoader instance.
    adsLoader = IMAAdsLoader(settings: nil)

    // TODO: Create an IMAAdDisplayContainer and IMAAdsRequest, then make
    // a request for ads.
  }
}

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 startImaSdk];
                  }
                }];
          }];

  // Check if you can initialize the Google IMA 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 startImaSdk];
  }
}

- (void)startImaSdk {
  static dispatch_once_t onceToken;
  dispatch_once(&onceToken, ^{
    // Create an IMAAdsLoader instance.
    self.adsLoader = [[IMAAdsLoader alloc] init];

    // TODO: Create an IMAAdDisplayContainer and IMAAdsRequest, then make
    // a request for ads.
  });
}

隐私设置选项

有些用户意见征求表单会要求用户随时修改同意情况。遵守按照以下步骤，根据需要实现隐私权选项按钮。

要实现这一目标，需要完成以下步骤：

实现界面元素，例如应用的设置页面中的按钮；可触发隐私权选项表单的应用
loadAndPresentIfRequiredFromViewController:completionHandler: 完成后，请检查 privacyOptionsRequirementStatus 来确定是否展示可显示隐私选项表单的界面元素。
当用户与界面元素交互时，调用 presentPrivacyOptionsFormFromViewController:completionHandler: 显示表单，以便用户随时更新其隐私权选项。

以下示例展示了如何从一个 UIBarButtonItem。

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.
                                  }
                                }];
}

测试

如果您想在开发过程中测试应用中的集成情况，请按照这些步骤以程序化方式注册测试设备。请务必移除代码，在您发布应用之前设置这些测试设备 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 提供了一种方法来测试应用行为，就好像设备被位于欧洲经济区 (EEA) 或英国境内的用户使用 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 提供了 reset 方法。

Swift

UMPConsentInformation.sharedInstance.reset()

Objective-C

[UMPConsentInformation.sharedInstance reset];

GitHub 上的示例

UMP SDK 集成示例： |

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

开始使用

前提条件

创建消息类型

导入 SDK

CocoaPods（首选）

Swift Package Manager

添加应用 ID

征求用户同意

Swift

Objective-C

根据需要加载并显示用户意见征求表单

Swift

Objective-C

提出广告请求

Swift

Objective-C

隐私设置选项

Swift

Objective-C

测试

Swift

Objective-C

强制指定地理位置

Swift

Objective-C

重置同意情况

Swift

Objective-C

GitHub 上的示例