Как настроить UMP SDK

Выберите платформу: Android iOS Unity Flutter Android (устаревшая версия)

Google User Messaging Platform (UMP) SDK – это инструмент для управления настройками конфиденциальности и сообщениями. Дополнительную информацию вы найдете в статье О странице "Конфиденциальность и сообщения".

Как создать тип сообщения

Создайте сообщения для пользователей, выбрав один из доступных типов на вкладке Конфиденциальность и сообщения в аккаунте AdMob. UMP SDK пытается показать сообщение о конфиденциальности, созданное на основе идентификатора приложения AdMob, заданного в вашем проекте.

Подробнее о странице "Конфиденциальность и сообщения"…

Как получить информацию о согласии пользователя

Запрашивайте обновление информации о согласии пользователя при каждом запуске приложения с помощью метода 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 получил согласие в предыдущем сеансе приложения.

Важно! CanRequestAds() всегда возвращает false, пока вы не вызовете Update().

Если в процессе получения согласия возникает ошибка, проверьте, можете ли вы запрашивать объявления. UMP SDK использует статус согласия из предыдущего сеанса приложения.

Как избежать лишних запросов объявлений

При проверке CanRequestAds() после получения согласия и вызова Update() убедитесь, что ваша логика предотвращает избыточные запросы объявлений, которые могут привести к тому, что обе проверки вернут true. Например, с помощью логической переменной.

Тестирование

Чтобы протестировать интеграцию в приложении во время разработки, выполните следующие действия для программной регистрации тестового устройства. Перед публикацией приложения не забудьте удалить код, который задает эти идентификаторы тестовых устройств.

1. Позвоните в компанию "Update()".

2. Найдите в журнале сообщение, похожее на приведенное ниже. В нем будет указан идентификатор устройства и инструкции по его добавлению в качестве тестового.

   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. Скопируйте идентификатор тестового устройства в буфер обмена.

4. Измените код, чтобы вызвать DebugGeography.TestDeviceHashedIds и передать список идентификаторов тестовых устройств.

   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. Обратите внимание, что настройки отладки работают только на тестовых устройствах.

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();

Внимание! Этот метод предназначен только для тестирования. Не вызывайте Reset() в рабочем коде.

Примеры на GitHub

Полный пример интеграции UMP SDK, описанной на этой странице, можно найти в разделе HelloWorld.