开始使用

请选择平台： Android iOS Unity Flutter

Google User Messaging Platform (UMP) SDK 是一款隐私权和消息工具，可帮助您管理隐私选项。如需了解详情，请参阅“隐私权和消息”页面简介。

创建消息类型

在 Ad Manager 账号的隐私权和消息标签页下，使用可用的用户消息类型之一创建用户消息。UMP SDK 会尝试显示根据项目中设置的 Ad Manager 应用 ID 创建的隐私权消息。

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

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

  • 是否需要征得用户同意。例如，用户是首次需要提供意见征求结果，或者之前的意见征求结果已过期。
  • 是否需要隐私设置选项入口点。某些隐私权消息要求应用允许用户随时修改其隐私权选项。
void Start()
{
    // Create a ConsentRequestParameters object.
    ConsentRequestParameters requestParameters = new ConsentRequestParameters();

    // Request an update of the user's consent information.
    ConsentInformation.Update(requestParameters, OnConsentInfoUpdated);
}
UMPSnippets.cs

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

在收到最新的用户同意情况后，请调用 LoadAndShowConsentFormIfRequired() 以加载收集用户同意情况所需的任何表单。加载后，表单会立即显示。

ConsentForm.LoadAndShowConsentFormIfRequired((FormError formError) =>
{
    if (formError != null)
    {
        // Consent gathering failed.
        Debug.LogError("Error loading/showing consent form: " + formError.Message);
    }

    // ...
});
UMPSnippets.cs

隐私设置选项

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

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

调用 Update() 后，请检查 PrivacyOptionsRequirementStatus 以确定您的应用是否需要隐私选项入口点。如果需要入口点，请向应用添加一个可见且可互动的界面元素，用于显示隐私选项表单。如果不需要隐私权入口点，请将界面元素配置为不可见且可互动。

void UpdatePrivacyButton()
{
    if (_privacyButton != null)
    {
        // Enable the button only if a privacy options entry point is required.
        _privacyButton.interactable =
            ConsentInformation.PrivacyOptionsRequirementStatus == PrivacyOptionsRequirementStatus.Required;
    }
}
UMPSnippets.cs

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

显示隐私设置选项表单

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

public void ShowPrivacyOptionsForm()
{
    ConsentForm.ShowPrivacyOptionsForm((FormError showError) =>
    {
        if (showError != null)
        {
            Debug.LogError("Error showing privacy options form: " + showError.Message);
        }
    });
}
UMPSnippets.cs

征得用户同意后请求广告

在请求广告之前，请使用 CanRequestAds() 检查您是否已征得用户同意：

ConsentInformation.CanRequestAds()

以下列出了在征得用户同意的同时，您可以检查是否可以请求广告的位置：

  • 在 UMP SDK 在当前会话中征得用户同意后。
  • 在您调用 Update() 后立即调用。UMP SDK 可能已在之前的应用会话中征得用户同意。

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

防止出现冗余的广告请求工作

在征得用户同意后以及在调用 Update() 后检查 CanRequestAds() 时，请确保您的逻辑可防止冗余的广告请求，以免两次检查都返回 true。例如，使用布尔值变量。

测试

如果您希望在应用开发过程中测试集成，请按照以下步骤以编程方式注册您的测试设备。在发布应用之前，请务必移除用于设置这些测试设备 ID 的代码。

  1. 欢迎致电Update()。

  2. 检查日志输出，以查找类似于以下示例的消息，其中会显示您的设备 ID 以及如何将设备添加为测试设备：

    Android

    Use new ConsentDebugSettings.Builder().addTestDeviceHashedId("33BE2250B43518CCDA7DE426D04EE231")
to set this as a debug device.

    iOS

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

  3. 将测试设备 ID 复制到剪贴板。

  4. 修改代码，以便调用 DebugGeography.TestDeviceHashedIds 并传入您的测试设备 ID 列表。

    void Start()
{
    var debugSettings = new ConsentDebugSettings
    {
        TestDeviceHashedIds =
        new List<string>
        {
            "TEST-DEVICE-HASHED-ID"
        }
    };

    // Create a ConsentRequestParameters object.
    ConsentRequestParameters request = new ConsentRequestParameters
    {
        ConsentDebugSettings = debugSettings,
    };

    // Check the current consent information status.
    ConsentInformation.Update(request, OnConsentInfoUpdated);
}

强制调试地理位置

UMP SDK 提供了一种方法：使用 DebugGeography 测试您的应用行为，就像设备位于欧洲经济区 (EEA) 或英国等各种区域境内一样。请注意，调试设置仅适用于测试设备。

void Start()
{
    var debugSettings = new ConsentDebugSettings
    {
        // Geography appears as in EEA for debug devices.
        DebugGeography = DebugGeography.EEA,
        TestDeviceHashedIds = new List<string>
        {
            "TEST-DEVICE-HASHED-ID"
        }
    };

    // Create a ConsentRequestParameters object.
    ConsentRequestParameters request = new ConsentRequestParameters
    {
        ConsentDebugSettings = debugSettings,
    };

    // Check the current consent information status.
    ConsentInformation.Update(request, OnConsentInfoUpdated);
}

通过 UMP SDK 测试应用时，您可能会发现重置 SDK 的状态很实用，因为您可以模拟用户的首次安装体验。该 SDK 提供的 Reset() 方法可实现此目的。

ConsentInformation.Reset();

GitHub 上的示例

如需查看本页中介绍的 UMP SDK 集成的完整示例，请参阅 HelloWorld。