Эта страница переведена с помощью Cloud Translation API.

Начать

SDK платформы обмена сообщениями Google (UMP) — это инструмент для управления настройками конфиденциальности и обмена сообщениями. Дополнительную информацию см. в разделе «О конфиденциальности и обмене сообщениями» .

Предварительные требования

Android API уровня 21 или выше (для Android)

Создайте тип сообщения

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

Более подробную информацию см. в разделе «О конфиденциальности и обмене сообщениями» .

Установите SDK.

Следуйте инструкциям для установки Firebase C++ SDK . UMP C++ SDK входит в состав Firebase C++ SDK.
Перед продолжением убедитесь, что вы настроили идентификатор приложения AdMob в проекте.

В вашем коде инициализируйте UMP SDK, вызвав ConsentInfo::GetInstance() .

На Android необходимо передать JNIEnv и Activity предоставляемые NDK. Это нужно сделать только при первом вызове GetInstance() .
В качестве альтернативы, если вы уже используете Firebase C++ SDK в своем приложении, вы можете передать объект firebase::App при первом вызове метода GetInstance() .

#include "firebase/ump/ump.h"

namespace ump = ::firebase::ump;

// Initialize using a firebase::App
void InitializeUserMessagingPlatform(const firebase::App& app) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance(app);
}

// Initialize without a firebase::App
#ifdef ANDROID
void InitializeUserMessagingPlatform(JNIEnv* jni_env, jobject activity) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance(jni_env, activity);
}
#else  // non-Android
void InitializeUserMessagingPlatform() {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();
}
#endif

Последующие вызовы метода ConsentInfo::GetInstance() возвращают один и тот же экземпляр.

Если вы завершили использование UMP SDK, вы можете остановить его работу, удалив экземпляр ConsentInfo :

void ShutdownUserMessagingPlatform() {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();
  delete consent_info;
}

Используйте `Future` для мониторинга асинхронных операций.

firebase::Future предоставляет способ определить статус завершения асинхронных вызовов методов.

Все асинхронные функции и вызовы методов UMP C++ возвращают Future , а также предоставляют функцию «последний результат» для получения Future из последней операции.

Существует два способа получить результат из Future :

Вызовите OnCompletion() , передав в него свою собственную функцию обратного вызова, которая будет вызвана по завершении операции.
Периодически проверяйте status() объекта Future . Когда статус меняется с kFutureStatusPending на kFutureStatusCompleted , операция завершена.

После завершения асинхронной операции следует проверить вызов error() объекта Future , чтобы получить код ошибки. Если код ошибки равен 0 ( kConsentRequestSuccess или kConsentFormSuccess ), операция завершилась успешно; в противном случае проверьте код ошибки и error_message() чтобы определить причину сбоя.

Обратный вызов завершения

Вот пример использования OnCompletion для установки функции обратного вызова завершения, которая вызывается после завершения асинхронной операции.

void MyApplicationStart() {
  // [... other app initialization code ...]

  ump::ConsentInfo *consent_info = ump::ConsentInfo::GetInstance();

  // See the section below for more information about RequestConsentInfoUpdate.
  firebase::Future<void> result = consent_info->RequestConsentInfoUpdate(...);

  result.OnCompletion([](const firebase::Future<void>& req_result) {
    if (req_result.error() == ump::kConsentRequestSuccess) {
      // Operation succeeded. You can now call LoadAndShowConsentFormIfRequired().
    } else {
      // Operation failed. Check req_result.error_message() for more information.
    }
  });
}

Обновление цикла опроса

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

ump::ConsentInfo *g_consent_info = nullptr;
bool g_waiting_for_request = false;

void MyApplicationStart() {
  // [... other app initialization code ...]

  g_consent_info = ump::ConsentInfo::GetInstance();
  // See the section below for more information about RequestConsentInfoUpdate.
  g_consent_info->RequestConsentInfoUpdate(...);
  g_waiting_for_request = true;
}

// Elsewhere, in the game's update loop, which runs once per frame:
void MyGameUpdateLoop() {
  // [... other game logic here ...]

  if (g_waiting_for_request) {
    // Check whether RequestConsentInfoUpdate() has finished.
    // Calling "LastResult" returns the Future for the most recent operation.
    firebase::Future<void> result =
      g_consent_info->RequestConsentInfoUpdateLastResult();

    if (result.status() == firebase::kFutureStatusComplete) {
      g_waiting_for_request = false;
      if (result.error() == ump::kConsentRequestSuccess) {
        // Operation succeeded. You can call LoadAndShowConsentFormIfRequired().
      } else {
        // Operation failed. Check result.error_message() for more information.
      }
    }
  }
}

Для получения дополнительной информации о firebase::Future см. документацию Firebase C++ SDK и документацию GMA C++ SDK .

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

При каждом запуске приложения следует запрашивать обновление информации о согласии пользователя, используя RequestConsentInfoUpdate() . Этот запрос проверяет следующее:

Требуется ли согласие ? Например, требуется ли согласие впервые, или истек срок действия предыдущего решения о согласии.
Необходимо ли указывать точку входа в настройки конфиденциальности ? Некоторые сообщения о конфиденциальности требуют от приложений предоставления пользователям возможности изменять свои настройки конфиденциальности в любое время.

#include "firebase/ump/ump.h"

namespace ump = ::firebase::ump;

void MyApplicationStart(ump::FormParent parent) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();

  // Create a ConsentRequestParameters struct..
  ump::ConsentRequestParameters params;
  // Set tag for under age of consent. False means users are NOT under age of consent.
  params.tag_for_under_age_of_consent = false;

  consent_info->RequestConsentInfoUpdate(params).OnCompletion(
    [*](const Future<void>& req_result) {
      if (req_result.error() != ump::kConsentRequestSuccess) {
        // req_result.error() is a kConsentRequestError enum.
        LogMessage("Error requesting consent update: %s", req_result.error_message());
      }
      // Consent information is successfully updated.
    });
}

Загрузите и отобразите форму сообщения о конфиденциальности.

После получения самой актуальной информации о согласии пользователя вызовите функцию LoadAndShowConsentFormIfRequired() чтобы загрузить все необходимые формы для сбора согласия пользователя. После загрузки формы отобразятся немедленно.

#include "firebase/ump/ump.h"

namespace ump = ::firebase::ump;

void MyApplicationStart(ump::FormParent parent) {
  ump::ConsentInfo* consent_info = ump::ConsentInfo::GetInstance();

  // Create a ConsentRequestParameters struct..
  ump::ConsentRequestParameters params;
  // Set tag for under age of consent. False means users are NOT under age of consent.
  params.tag_for_under_age_of_consent = false;

  consent_info->RequestConsentInfoUpdate(params).OnCompletion(
    [*](const Future<void>& req_result) {
      if (req_result.error() != ump::kConsentRequestSuccess) {
        // req_result.error() is a kConsentRequestError enum.
        LogMessage("Error requesting consent update: %s", req_result.error_message());
      } else {
        consent_info->LoadAndShowConsentFormIfRequired(parent).OnCompletion(
        [*](const Future<void>& form_result) {
          if (form_result.error() != ump::kConsentFormSuccess) {
            // form_result.error() is a kConsentFormError enum.
            LogMessage("Error showing privacy message form: %s", form_result.error_message());
          } else {
            // Either the form was shown and completed by the user, or consent was not required.
          }
        });
      }
    });
}

Пример проверки завершения с использованием цикла обновления и опроса, а не функции обратного вызова завершения, приведен выше .

Если вам необходимо выполнить какие-либо действия после того, как пользователь сделал выбор или закрыл форму, поместите эту логику в код, обрабатывающий объект Future возвращаемый функцией LoadAndShowConsentFormIfRequired() .

Параметры конфиденциальности

Некоторые формы для отправки сообщений о конфиденциальности отображаются через точку входа параметров конфиденциальности, предоставляемую издателем, что позволяет пользователям управлять своими настройками конфиденциальности в любое время. Чтобы узнать больше о том, какие сообщения видят ваши пользователи в точке входа параметров конфиденциальности, см. раздел «Доступные типы сообщений для пользователей» .

Запрос рекламы с согласия пользователя.

Перед запросом рекламы используйте ConsentInfo::GetInstance()‑> CanRequestAds() чтобы проверить, получили ли вы согласие пользователя:

Ниже перечислены места, где можно проверить, можно ли запрашивать рекламу, одновременно получая согласие на ее показ:

После того, как UMP SDK получит согласие в текущей сессии.
Сразу после вызова RequestConsentInfoUpdate() , SDK UMP мог получить согласие в предыдущей сессии приложения.

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

Предотвращение избыточной работы по запросу рекламы.

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

В приведенном ниже полном примере используется опрос в цикле обновления, но вы также можете использовать коллбэки OnCompletion для мониторинга асинхронных операций. Используйте тот метод, который лучше подходит для вашей структуры кода.

#include "firebase/future.h"
#include "firebase/gma/gma.h"
#include "firebase/ump/ump.h"

namespace gma = ::firebase::gma;
namespace ump = ::firebase::ump;
using firebase::Future;

ump::ConsentInfo* g_consent_info = nullptr;
// State variable for tracking the UMP consent flow.
enum { kStart, kRequest, kLoadAndShow, kInitGma, kFinished, kErrorState } g_state = kStart;
bool g_ads_allowed = false;

void MyApplicationStart() {
  g_consent_info = ump::ConsentInfo::GetInstance(...);

  // Create a ConsentRequestParameters struct..
  ump::ConsentRequestParameters params;
  // Set tag for under age of consent. False means users are NOT under age of consent.
  params.tag_for_under_age_of_consent = false;

  g_consent_info->RequestConsentInfoUpdate(params);
  // CanRequestAds() can return a cached value from a previous run immediately.
  g_ads_allowed = g_consent_info->CanRequestAds();
  g_state = kRequest;
}

// This function runs once per frame.
void MyGameUpdateLoop() {
  // [... other game logic here ...]

  if (g_state == kRequest) {
    Future<void> req_result = g_consent_info->RequestConsentInfoUpdateLastResult();

    if (req_result.status() == firebase::kFutureStatusComplete) {
      g_ads_allowed = g_consent_info->CanRequestAds();
      if (req_result.error() == ump::kConsentRequestSuccess) {
        // You must provide the FormParent (Android Activity or iOS UIViewController).
        ump::FormParent parent = GetMyFormParent();
        g_consent_info->LoadAndShowConsentFormIfRequired(parent);
        g_state = kLoadAndShow;
      } else {
        LogMessage("Error requesting consent status: %s", req_result.error_message());
        g_state = kErrorState;
      }
    }
  }
  if (g_state == kLoadAndShow) {
    Future<void> form_result = g_consent_info->LoadAndShowConsentFormIfRequiredLastResult();

    if (form_result.status() == firebase::kFutureStatusComplete) {
      g_ads_allowed = g_consent_info->CanRequestAds();
      if (form_result.error() == ump::kConsentRequestSuccess) {
        if (g_ads_allowed) {
          // Initialize GMA. This is another asynchronous operation.
          firebase::gma::Initialize();
          g_state = kInitGma;
        } else {
          g_state = kFinished;
        }
        // Optional: shut down the UMP SDK to save memory.
        delete g_consent_info;
        g_consent_info = nullptr;
      } else {
        LogMessage("Error displaying privacy message form: %s", form_result.error_message());
        g_state = kErrorState;
      }
    }
  }
  if (g_state == kInitGma && g_ads_allowed) {
    Future<gma::AdapterInitializationStatus> gma_future = gma::InitializeLastResult();

    if (gma_future.status() == firebase::kFutureStatusComplete) {
      if (gma_future.error() == gma::kAdErrorCodeNone) {
        g_state = kFinished;
        // TODO: Request an ad.
      } else {
        LogMessage("Error initializing GMA: %s", gma_future.error_message());
        g_state = kErrorState;
      }
    }
  }
}

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

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

Вызовите функцию RequestConsentInfoUpdate() .
Проверьте журнал событий на наличие сообщения, похожего на следующий пример, в котором указан идентификатор вашего устройства и инструкция по его добавлению в качестве тестового устройства:
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]
```
Скопируйте идентификатор вашего тестового устройства в буфер обмена.

Измените свой код, чтобы установить значение ConsentRequestParameters.debug_settings.debug_device_ids равным списку идентификаторов ваших тестовых устройств.

void MyApplicationStart() {
  ump::ConsentInfo consent_info = ump::ConsentInfo::GetInstance(...);

  ump::ConsentRequestParameters params;
  params.tag_for_under_age_of_consent = false;
  params.debug_settings.debug_device_ids = {"TEST-DEVICE-HASHED-ID"};

  consent_info->RequestConsentInfoUpdate(params);
}

Принудительное использование географии

UMP SDK предоставляет возможность тестировать поведение вашего приложения, как если бы устройство находилось в различных регионах, например, в ЕЭЗ или Великобритании, используя debug_settings.debug_geography . Обратите внимание, что параметры отладки работают только на тестовых устройствах.

void MyApplicationStart() {
  ump::ConsentInfo consent_info = ump::ConsentInfo::GetInstance(...);

  ump::ConsentRequestParameters params;
  params.tag_for_under_age_of_consent = false;
  params.debug_settings.debug_device_ids = {"TEST-DEVICE-HASHED-ID"};
  // Geography appears as EEA for debug devices.
  params.debug_settings.debug_geography = ump::kConsentDebugGeographyEEA

  consent_info->RequestConsentInfoUpdate(params);
}

Сбросить состояние согласия

При тестировании вашего приложения с помощью UMP SDK вам может быть полезно сбросить состояние SDK, чтобы имитировать первый опыт установки для пользователя. Для этого SDK предоставляет метод Reset() .

  ConsentInfo::GetInstance()->Reset();