TCF v2.0 Consent

Внимание.

Это архивная версия документации. Актуальная документация по всем платформам находится здесь.

Если вы реализовали CMP (Consent Management Platform), которая соответствует IAB TCF v2.0 (Transparency & Consent Framework) для пользовательского сценария выдачи разрешения на передачу данных (user consent flow), Yandex Mobile Ads SDK поддерживает отправку TCF v2.0 значений.

Yandex Mobile Ads SDK считывает TCF v2.0 значения разрешения (consent strings) из SharedPreferences по следующим ключам:

IABTCF_TCString String Полная закодированная TC строка
IABTCF_gdprApplies Number
  • 1 — GDPR применим в текущем контексте;
  • 0 — GDPR не применим в текущем контексте;
  • Unset — не определено (значение по умолчанию перед инициализацией).
IABTCF_CmpSdkID Number Целое число без знака, идентификатор (ID) используемого CMP SDK
IABTCF_PurposeConsents Binary String

«0» или «1» на позиции n, где отсчет n начинается с 0 — отображает статус разрешения (consent) для цели (purpose) с идентификатором (ID) n+1. «0» соответствует false, «1» — true. Например, «1» на позиции 0 — это выданное разрешение для цели с идентификатором 1.
IABTCF_VendorConsents Binary String

«0» или «1» на позиции n, где отсчет n начинается с 0 — отображает статус разрешения (consent) для вендора с идентификатором (ID) n+1. «0» соответствует false, «1» — true. Например, «1» на позиции 0 — это выданное разрешение для вендора с идентификатором 1.
IABTCF_TCString String Полная закодированная TC строка
IABTCF_gdprApplies Number
  • 1 — GDPR применим в текущем контексте;
  • 0 — GDPR не применим в текущем контексте;
  • Unset — не определено (значение по умолчанию перед инициализацией).
IABTCF_CmpSdkID Number Целое число без знака, идентификатор (ID) используемого CMP SDK
IABTCF_PurposeConsents Binary String

«0» или «1» на позиции n, где отсчет n начинается с 0 — отображает статус разрешения (consent) для цели (purpose) с идентификатором (ID) n+1. «0» соответствует false, «1» — true. Например, «1» на позиции 0 — это выданное разрешение для цели с идентификатором 1.
IABTCF_VendorConsents Binary String

«0» или «1» на позиции n, где отсчет n начинается с 0 — отображает статус разрешения (consent) для вендора с идентификатором (ID) n+1. «0» соответствует false, «1» — true. Например, «1» на позиции 0 — это выданное разрешение для вендора с идентификатором 1.

Подробное описание можно найти в документации IAB.

Передача значений в SharedPreferences

Передать значения по ключам необходимо перед походами за рекламой. Сделать это можно одним из способов:

Вручную

Самостоятельно положите значения по ключам из таблицы выше в SharedPreferences. Пример:

Kotlin
val sharedPref = activity?.getPreferences(Context.MODE_PRIVATE) ?: return
with (sharedPref.edit()) {
    putInt("IABTCF_gdprApplies", 1)
    apply()
}
Java
SharedPreferences sharedPref = getActivity().getPreferences(Context.MODE_PRIVATE);
SharedPreferences.Editor editor = sharedPref.edit();
editor.putInt("IABTCF_gdprApplies", newHighScore);
editor.apply();
Примечание.

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

Через SDK для управления CMP

Используйте готовые SDK для управления CMP. Такие SDK автоматически передадут необходимые значения в SharedPreferences и Yandex Mobile SDK сможет их использовать.