Konfiguracja interfejsu Topics API

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

Kompilowanie i testowanie lokalnie

Z tej sekcji dowiesz się, jak skonfigurować środowisko lokalne, aby indywidualnie deweloper wypróbować interfejs Topics API. Zanim zaczniesz wdrażać funkcje, zapoznaj się z demonstracjami, aby zrozumieć, jak działają tematy.

Włączanie interfejsu Topics w przeglądarce

Aby włączyć interfejs Topics API we własnej instancji Chrome na potrzeby testów lokalnych, masz 2 możliwości:

  1. Włącz wszystkie interfejsy API dotyczące ochrony prywatności w reklamach w sekcji chrome://settings/adPrivacy.
  2. (Zalecany) Uruchom Chrome z wiersza poleceń za pomocą flag Chromium, używając parametrów interfejsu Topics API do konfiguracji w razie potrzeby. Masz większą kontrolę nad funkcjami interfejsu Topics, uruchamiając Chrome z poziomu wiersza poleceń. Możesz na przykład ustawić okresy Topics (okres używany przez interfejs API do obliczania zainteresowań użytkowników) i konfigurować jego działanie zgodnie z potrzebami.

Najważniejsze zalecenia

  1. Zanim rozpoczniesz nowy proces, zamknij i zatrzymaj wszystkie procesy Chrome przy użyciu odpowiednich flag.
  2. Upewnij się, że wszystkie interfejsy Ad Privacy API są włączone w usłudze chrome://settings/adPrivacy.
  3. Jeśli interfejs API nie działa zgodnie z oczekiwaniami, skorzystaj z naszych wskazówek dotyczących rozwiązywania problemów.
  4. Jeśli masz pytania, zapoznaj się z wyjaśnieniem dotyczącym problemów z GitHubem.

Zarządzanie interfejsem Topics API za pomocą flag Chrome

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

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

Tabela poniżej zawiera opis każdego parametru, jego wartości domyślnej i przeznaczenia.

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 Fenceed Frame.
PrivacySandboxSettings4 wyłączone Umożliwia czwartą wersję ustawień interfejsu Piaskownicy prywatności.
OverridePrivacySandboxSettingsLocalTesting włączone Po włączeniu przeglądarka nie będzie już wymagać włączenia ustawień podstawowych, aby włączyć funkcje Piaskownicy prywatności.
BrowsingTopicsBypassIPIsPubliclyRoutableCheck wyłączone Jeśli ta opcja jest włączona, sprawdzanie, czy adres IP można kierować publicznie, jest pomijane podczas określania, czy strona kwalifikuje się do uwzględnienia w obliczeniach tematów.
BrowsingTopics:number_of_epochs_to_expose 3 Liczba epok, z których mają być obliczane tematy do przekazania do kontekstu żądania. Przeglądarka będzie wewnętrznie przechowywać do N + 1 okresów.
BrowsingTopics:time_period_per_epoch 7d-0h-0m-0s Czas trwania każdej ery. Do debugowania może być korzystne ustawienie tego ustawienia na 15 sekund zamiast domyślnych 7 dni.
BrowsingTopics:number_of_top_topics_per_epoch 5 Liczba tematów obliczona na okres.
BrowsingTopics:use_random_topic_probability_percent 5 Prawdopodobieństwo, że dany temat w danej epoki zostanie zwrócony losowo z całej mapy kategorii tematów. Losowość jest zależna od epoki i miejsca.
BrowsingTopics:number_of_epochs_of_observation_data_to_use_for_filtering 3 Liczba epok danych o korzystaniu z interfejsu API (np. obserwacje tematów) używanych do filtrowania tematów pod kątem kontekstu wywołania.
BrowsingTopics:max_number_of_api_usage_context_domains_to_keep_per_topic 1000 Maksymalna liczba domen obserwowanych w kontekście, które mają być przechowywane w przypadku każdego głównego tematu. Intencją jest ograniczenie używanej 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 będzie wykonywane raz na epokę w czasie 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 dozwolona liczba domen kontekstu użycia interfejsu API, które można przechowywać na potrzeby wczytywania strony.
BrowsingTopics:config_version 1 Koduje parametry konfiguracji Topics API. Każdy numer wersji powinien być zmapowany tylko na 1 zbiór konfiguracji. Zaktualizowanie parametrów konfiguracji bez aktualizowania elementu config_version zwykle powinno się sprawdzić w przypadku testów lokalnych, ale w niektórych sytuacjach może pojawić się niespójność w przeglądarce i doprowadzić ją do awarii przeglądarki, np. zaktualizowania pliku number_of_top_topics_per_epoch.
BrowsingTopics:taxonomy_version 1 Wersja taksonomii używana przez interfejs API.

Zanim zaczniesz implementację

Przed rozpoczęciem implementacji zalecamy zapoznanie się z tymi materiałami dotyczącymi interfejsu Topics API.

  1. Przejrzyj dokumentację dla deweloperów:
    1. Poznaj cel interfejsu Topics API i jego rolę w reklamach opartych na zainteresowaniach
    2. Dowiedz się, jak działa interfejs Topics w internecie.
    3. Wypróbuj wersje demonstracyjne i obejrzyj film z instrukcjami dotyczącymi Topics, Colab i narzędzi.
    4. Wykonaj kopie demonstracyjnych wersji aplikacji i uruchom je ze swojej witryny.
    5. Aby dowiedzieć się więcej, przeczytaj artykuł o interfejsie API.
  2. Poznaj rolę interfejsu API w zwiększaniu trafności reklam na wypadek, gdy w przyszłości 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 mailingowej dla programistów i śledź najnowsze informacje o interfejsie Topics.
  4. Dołącz do rozmowy na GitHubie lub w spotkaniach W3C.
  5. Jeśli natrafisz na nieznane terminy, zapoznaj się z słownikiem Piaskownicy prywatności.
  6. Więcej informacji o pojęciach 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.