Konfiguracja interfejsu Topics API

Przygotuj środowisko do używania, testowania i tworzenia aplikacji internetowych za pomocą interfejsu Topics API.

.

Kompilowanie i testowanie lokalnie

W tej sekcji opisujemy, jak skonfigurować środowisko lokalne, aby wypróbować interfejs Topics API jako indywidualny deweloper. Zanim przejdziesz do implementacji, zapoznaj się z demonstracjami, aby dowiedzieć się, jak działa interfejs Topics.

Włączanie interfejsu Topics API w przeglądarce

Aby włączyć interfejs Topics API we własnej instancji Chrome na potrzeby testów lokalnych, masz 2 opcje:

  1. Włącz wszystkie interfejsy API ochrony prywatności w reklamach w sekcji chrome://settings/adPrivacy.
  2. (Zalecane) Uruchom Chrome z wiersza poleceń za pomocą flag Chromium, używając parametrów specyficznych dla interfejsu Topics API, aby skonfigurować go zgodnie z potrzebami. Uruchamiając Chrome z wiersza poleceń, możesz precyzyjniej kontrolować funkcje Topics. Możesz na przykład ustawić epoki tematyczne (okres, którego interfejs API używa do obliczania zainteresowań użytkowników) i skonfigurować działanie interfejsu API zgodnie ze swoimi potrzebami.

Najważniejsze rekomendacje

  1. Zanim uruchomisz nowy proces za pomocą flag, zamknij i zatrzymaj wszystkie procesy Chrome.
  2. Sprawdź, czy wszystkie interfejsy API związane z prywatnością w reklamach są włączone w sekcji chrome://settings/adPrivacy.
  3. Jeśli interfejs API nie działa zgodnie z oczekiwaniami, wypróbuj nasze wskazówki dotyczące rozwiązywania problemów.
  4. Jeśli masz pytania, zapoznaj się z problemami na GitHubie dotyczącymi wyjaśnienia.

Kontrolowanie interfejsu Topics API za pomocą flag Chrome

Flagi Chrome mogą modyfikować działanie interfejsu Topics API. Uruchom Chrome z wiersza poleceń z określonymi parametrami, aby ułatwić testowanie. Na przykład w demonstracji nagłówków zalecamy użycie tych flag:

--enable-features=BrowsingTopics,BrowsingTopicsParameters:time_period_per_epoch/15s/max_epoch_introduction_delay/3s,PrivacySandboxAdsAPIsOverride,PrivacySandboxSettings3,OverridePrivacySandboxSettingsLocalTesting

W tabeli poniżej znajdziesz opis każdego parametru, jego wartość domyślną i przeznaczenie.

Nazwa flagi Wartość domyślna Opis
BrowsingTopics włączone Czy interfejs Topics API jest włączony.
PrivacySandboxAdsAPIsOverride włączone Włącza interfejsy API reklam: Attribution Reporting, Protected Audience, Topics i Fenced Frames.
PrivacySandboxSettings4 wyłączono Włącza czwartą wersję ustawień interfejsu Piaskownicy prywatności.
OverridePrivacySandboxSettingsLocalTesting włączone Jeśli ta opcja jest włączona, przeglądarka nie wymaga już włączenia ustawień bazowych, aby włączyć funkcje Piaskownicy prywatności.
BrowsingTopicsBypassIPIsPubliclyRoutableCheck wyłączono Jeśli ta opcja jest włączona, podczas określania, czy strona kwalifikuje się do uwzględnienia w obliczeniach dotyczących tematów, sprawdzanie, czy adres IP jest publicznie przekierowywany, zostanie pominięte.
BrowsingTopics:number_of_epochs_to_expose 3 Liczba epok, na podstawie których obliczane są tematy do przekazania kontekstowi wysyłającemu żądanie. Przeglądarka będzie wewnętrznie przechowywać do N+1 epok.
BrowsingTopics:time_period_per_epoch 7d-0h-0m-0s Czas trwania każdej epoki. Na potrzeby debugowania warto ustawić ten parametr na 15 sekund (zamiast domyślnych 7 dni).
BrowsingTopics:number_of_top_topics_per_epoch 5 Liczba tematów obliczana na epokę.
BrowsingTopics:use_random_topic_probability_percent 5 Prawdopodobieństwo, że pojedynczy temat w epoce jest jednym z tematów zwróconych losowo z całej taksonomii. Losowość jest powiązana z epoką i witryną.
BrowsingTopics:number_of_epochs_of_observation_data_to_use_for_filtering 3 Liczba epok danych o używaniu interfejsu API (czyli obserwacji tematów), które będą używane do filtrowania tematów w kontekście wywołania.
BrowsingTopics:max_number_of_api_usage_context_domains_to_keep_per_topic 1000 Maksymalna liczba domen kontekstowych „obserwowanych przez”, które mają być przechowywane dla każdego najważniejszego tematu. Celem jest ograniczenie wykorzystywanej pamięci.
BrowsingTopics:max_number_of_api_usage_context_entries_to_load_per_epoch 100 000 Maksymalna liczba wpisów, które można pobrać z bazy danych w przypadku każdego zapytania dotyczącego kontekstów użycia interfejsu API. Zapytanie zostanie wykonane raz na epokę w momencie obliczania tematów. Celem jest ograniczenie szczytowego wykorzystania pamięci.
BrowsingTopics:max_number_of_api_usage_context_domains_to_store_per_page_load 30 Maksymalna liczba domen kontekstu użycia interfejsu API, które można przechowywać podczas ładowania strony.
BrowsingTopics:config_version 1 Koduje parametry konfiguracji interfejsu Topics API. Każdy numer wersji powinien być przypisany tylko do jednego zestawu konfiguracji. Aktualizowanie parametrów konfiguracji bez aktualizowania config_version zwykle nie powinno stanowić problemu w przypadku testów lokalnych, ale w niektórych sytuacjach może spowodować, że przeglądarka będzie w niezgodnym stanie i może się zawiesić, np. podczas aktualizowania number_of_top_topics_per_epoch.
BrowsingTopics:taxonomy_version 1 Wersja taksonomii używana przez interfejs API.

Zanim zaczniesz wdrażać

Zanim zaczniesz wdrażać interfejs Topics API, zapoznaj się z tymi materiałami, aby poznać jego działanie.

  1. Zapoznaj się z dokumentacją dla deweloperów:
    1. Poznaj przeznaczenie interfejsu Topics API i jego rolę w wyświetlaniu reklam opartych na zainteresowaniach.
    2. Dowiedz się, jak działa interfejs Topics w internecie.
    3. Wypróbuj wersje demonstracyjne i obejrzyj film z prezentacją interfejsu Topics API, Colab i narzędzi.
    4. Skopiuj wersje demonstracyjne i uruchom je we własnej witrynie.
    5. Więcej informacji znajdziesz w wyjaśnieniu interfejsu API.
  2. Dowiedz się, jaką rolę odgrywa interfejs API w zapewnianiu trafności reklam w przyszłości, gdy pliki cookie innych firm nie będą dostępne dla coraz większej liczby użytkowników.
  3. Aby otrzymywać powiadomienia o zmianach stanu interfejsu API, dołącz do listy adresowej dla programistów i bądź na bieżąco z najnowszymi informacjami o interfejsie Topics API.
  4. Dołącz do dyskusji w problemach na GitHubie lub podczas rozmów W3C.
  5. Jeśli napotkasz nieznane terminy, zapoznaj się z glosariuszem Piaskownicy prywatności.
  6. Więcej informacji o koncepcjach związanych z Chrome, takich jak flagi Chrome, znajdziesz w krótkich filmach i artykułach dostępnych na stronie goo.gle/cc.

Dalsze kroki

Sprawdź szczegóły implementacji i przykłady kodu, które umożliwiają obserwowanie i dostęp do tematów.
Dowiedz się, jak wdrażać, testować i skalować rozwiązania oparte na tematach.