Настройка API тем

Подготовьте свою среду к использованию, тестированию и разработке веб-приложений с помощью API Topics.

Сборка и тестирование локально

В этом разделе описывается, как настроить локальную среду, чтобы опробовать Topics API в качестве индивидуального разработчика. Мы рекомендуем изучить демо-версии , чтобы понять, как работают темы, прежде чем углубляться в реализацию.

Включите темы в вашем браузере

Чтобы включить API тем в своем экземпляре Chrome для локального тестирования, у вас есть два варианта:

  1. Включите все API конфиденциальности рекламы в chrome://settings/adPrivacy .
  2. (Рекомендуется) Запустите Chrome из командной строки с флагами Chromium, используя параметры API Topics для настройки по мере необходимости. Вы получаете более детальный контроль над функциями тем, запустив Chrome из командной строки. Например, можно установить эпохи тем (период времени, используемый API для расчета интересов пользователей) и настроить поведение API в соответствии с вашими потребностями.

Ключевые рекомендации

  1. Обязательно закройте и остановите все процессы Chrome, прежде чем запускать новый с использованием флагов.
  2. Убедитесь, что все API конфиденциальности рекламы включены в chrome://settings/adPrivacy .
  3. Если API не работает должным образом, воспользуйтесь нашими советами по устранению неполадок .
  4. Если у вас есть вопросы, ознакомьтесь с пояснениями на 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 неполноценный Включает четвертый выпуск настроек пользовательского интерфейса Privacy Sandbox.
OverridePrivacySandboxSettingsLocalTesting включено Если этот параметр включен, браузер больше не требует включения базовых настроек для включения функций Privacy Sandbox.
BrowsingTopicsBypassIPIsPubliclyRoutableCheck неполноценный Если этот параметр включен, проверка того, является ли IP-адрес общедоступным, будет пропущена при определении возможности включения страницы в расчет тем.
BrowsingTopics:number_of_epochs_to_expose 3 Количество эпох, на основе которого можно рассчитать темы для передачи запрашивающему контексту. Браузер внутренне поддерживает до N+1 эпох.
BrowsingTopics:time_period_per_epoch 7д-0ч-0м-0с Продолжительность каждой эпохи. Для отладки может быть полезно установить это значение, скажем, на 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 тем.

  1. Просмотрите документацию разработчика:
    1. Понять назначение Topics API и его роль в рекламе на основе интересов.
    2. Поймите , как работают темы в Интернете.
    3. Попробуйте демо-версии и посмотрите демонстрационные ролики Topics, совместную работу и обучающее видео по инструментам.
    4. Формируйте демо-версии и запускайте их со своего сайта.
    5. Прочтите объяснение API, чтобы понять больше деталей.
  2. Поймите роль API в поддержке релевантности рекламы в будущем, когда сторонние файлы cookie не будут доступны для все большего числа пользователей.
  3. Чтобы получать уведомления об изменениях статуса API, присоединитесь к списку рассылки для разработчиков и следите за последними обновлениями тем .
  4. Участвуйте в обсуждении проблем GitHub или вызовов W3C .
  5. Если вы встретите незнакомые термины, просмотрите глоссарий Privacy Sandbox .
  6. Для получения дополнительной информации о концепциях Chrome, таких как флаги Chrome, просмотрите короткие видеоролики и статьи, доступные на странице goo.gle/cc .

Следующие шаги

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