Подготовьте свою среду для использования, тестирования и разработки веб-приложений с помощью API тем.
Сборка и тестирование локально.
В этом разделе описывается, как настроить локальную среду для тестирования API Topics в качестве индивидуального разработчика. Мы рекомендуем изучить демонстрационные примеры , чтобы понять, как работает Topics, прежде чем приступать к реализации.
Включите темы в вашем браузере
Чтобы включить API тем в вашем собственном экземпляре Chrome для локального тестирования, у вас есть два варианта:
- Включите все API для защиты конфиденциальности рекламы по адресу
chrome://settings/adPrivacy. - (Рекомендуется) Запускайте Chrome из командной строки с флагами Chromium , используя параметры, специфичные для API тем, для настройки по мере необходимости. Запуск Chrome из командной строки обеспечивает более точный контроль над функциями тем. Например, можно установить эпохи тем (временной интервал, используемый API для расчета интересов пользователей) и настроить поведение API в соответствии с вашими потребностями.
Ключевые рекомендации
- Перед запуском нового процесса Chrome, используя соответствующие флаги, обязательно закройте и остановите все существующие процессы Chrome.
- Убедитесь, что все API для защиты конфиденциальности рекламы включены в разделе
chrome://settings/adPrivacy. - Если API работает не так, как ожидается, воспользуйтесь нашими советами по устранению неполадок .
- Если у вас возникнут вопросы, ознакомьтесь с пояснениями в разделе Issues на GitHub .
Управление API тем с помощью флагов Chrome
Флаги Chrome могут изменять поведение API тем. Для упрощения тестирования запустите Chrome из командной строки с указанными параметрами. Например, в демонстрации заголовков рекомендуется использовать следующие флаги:
--enable-features=BrowsingTopics,BrowsingTopicsParameters:time_period_per_epoch/15s/max_epoch_introduction_delay/3s,PrivacySandboxAdsAPIsOverride,PrivacySandboxSettings3,OverridePrivacySandboxSettingsLocalTesting
В таблице ниже приведено описание каждого параметра, его значение по умолчанию и назначение.
| Название флага | Значение по умолчанию | Описание |
|---|---|---|
BrowsingTopics | включено | Включен ли API тем. |
PrivacySandboxAdsAPIsOverride | включено | Включает API для работы с рекламой: отчеты по атрибуции, защищенная аудитория, темы, фреймы с ограниченным доступом. |
PrivacySandboxSettings4 | неполноценный | Включает четвертую версию настроек пользовательского интерфейса «Песочницы конфиденциальности». |
OverridePrivacySandboxSettingsLocalTesting | включено | Если эта функция включена, браузеру больше не потребуется включать соответствующие базовые настройки для активации функций «Песочницы конфиденциальности». |
BrowsingTopicsBypassIPIsPubliclyRoutableCheck | неполноценный | Если эта функция включена, проверка доступности IP-адреса для публичной маршрутизации будет пропущена при определении возможности включения страницы в расчет тем. |
BrowsingTopics:number_of_epochs_to_expose | 3 | Количество эпох, с которых следует рассчитывать темы для запрашиваемого контекста. Браузер будет внутренне хранить до N+1 эпох. |
BrowsingTopics:time_period_per_epoch | 7d-0h-0m-0s | Длительность каждой эпохи. Для отладки может быть полезно установить это значение, например, на 15 секунд, вместо стандартных семи дней. |
BrowsingTopics:number_of_top_topics_per_epoch | 5 | Количество тем, рассчитанное за эпоху. |
BrowsingTopics:use_random_topic_probability_percent | 5 | Вероятность того, что отдельная тема в рамках эпохи является одной из случайно выбранных из всей таксономии тем. Случайность сохраняется в рамках эпохи и сайта. |
BrowsingTopics:number_of_epochs_of_observation_data_to_use_for_filtering | 3 | Сколько эпох данных об использовании API (т.е. наблюдений за темами) будет использовано для фильтрации тем в контексте вызова? |
BrowsingTopics:max_number_of_api_usage_context_domains_to_keep_per_topic | 1000 | Максимальное количество контекстных доменов, наблюдаемых в рамках данной темы, которое следует сохранять для каждой основной темы. Цель состоит в том, чтобы ограничить объем используемой памяти. |
BrowsingTopics:max_number_of_api_usage_context_entries_to_load_per_epoch | 100000 | Максимальное количество записей, разрешенных для извлечения из базы данных для каждого запроса в контексте использования API. Запрос будет выполняться один раз за эпоху во время вычисления тем. Цель состоит в том, чтобы ограничить пиковое использование памяти. |
BrowsingTopics:max_number_of_api_usage_context_domains_to_store_per_page_load | 30 | Максимальное количество доменов контекста использования API, которое можно сохранить за одну загрузку страницы. |
BrowsingTopics:config_version | 1 | Кодирует параметры конфигурации API тем. Каждый номер версии должен соответствовать только одному набору конфигураций. Обновление параметров конфигурации без обновления config_version обычно допустимо для локального тестирования, но в некоторых ситуациях может привести к несогласованному состоянию браузера и вызвать сбой, например, при обновлении number_of_top_topics_per_epoch . |
BrowsingTopics:taxonomy_version | 1 | Версия таксономии, используемая API. |
Прежде чем приступить к внедрению
Прежде чем приступить к внедрению, рекомендуем ознакомиться с этими ресурсами, чтобы понять принцип работы API тем.
- Ознакомьтесь с документацией для разработчиков:
- Разберитесь в назначении API тем и его роли в рекламе, основанной на интересах пользователей.
- Разберитесь, как работают разделы «Темы» в Интернете.
- Попробуйте демоверсии и посмотрите демонстрационные ролики по темам, а также видеообзор Colab и инструментов.
- Создайте форк демонстрационных версий и запустите их на своем сайте.
- Для более подробного понимания ознакомьтесь с описанием API.
- Поймите роль API в обеспечении релевантности рекламы в будущем, когда сторонние файлы cookie будут недоступны для все большего числа пользователей.
- Чтобы получать уведомления об изменениях статуса API, подпишитесь на рассылку для разработчиков и следите за последними обновлениями раздела «Темы» .
- Примите участие в обсуждении в GitHub Issues или в призывах W3C .
- Если вы столкнетесь с незнакомыми терминами, ознакомьтесь со словарем терминов в разделе «Песочница конфиденциальности» .
- Для получения дополнительной информации о концепциях Chrome, таких как флаги Chrome, ознакомьтесь с короткими видеороликами и статьями, доступными по адресу goo.gle/cc .