Configuration de l'API Topics

Préparez votre environnement pour utiliser, tester et développer des applications Web avec l'API Topics.

Compiler et tester en local

Cette section explique comment configurer votre environnement local pour tester l'API Topics en tant que développeur individuel. Nous vous recommandons d'explorer les démonstrations pour comprendre comment fonctionne Topics avant de vous lancer dans l'implémentation.

Activer Topics dans votre navigateur

Pour activer l'API Topics dans votre propre instance Chrome pour les tests locaux, vous avez deux options :

  1. Activez toutes les API de confidentialité des annonces sous chrome://settings/adPrivacy.
  2. (Recommandé) Exécutez Chrome à partir de la ligne de commande avec des indicateurs Chromium à l'aide de paramètres spécifiques à l'API Topics pour configurer selon vos besoins. Vous pouvez contrôler plus précisément les fonctionnalités Thèmes en exécutant Chrome à partir de la ligne de commande. Par exemple, il est possible de définir des époques Topics (période utilisée par l'API pour calculer les centres d'intérêt des utilisateurs) et de configurer le comportement de l'API en fonction de vos besoins.

Principales recommandations

  1. Veillez à fermer et à arrêter tous les processus Chrome avant de démarrer le nouveau à l'aide des indicateurs.
  2. Assurez-vous que toutes les API de confidentialité des annonces sont activées sous chrome://settings/adPrivacy.
  3. Si l'API ne fonctionne pas comme prévu, essayez nos conseils de dépannage.
  4. Si vous avez des questions, consultez les demandes GitHub concernant l'explication.

Contrôler l'API Topics avec les flags Chrome

Les indicateurs Chrome peuvent modifier le comportement de l'API Topics. Exécutez Chrome à partir de la ligne de commande avec les paramètres spécifiés pour faciliter les tests. Par exemple, la démonstration des en-têtes recommande d'utiliser les indicateurs suivants :

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

Le tableau suivant explique chaque paramètre, sa valeur par défaut et son objectif.

Nom d'indicateur Valeur par défaut Description
BrowsingTopics activé Indique si l'API Topics est activée.
PrivacySandboxAdsAPIsOverride activé Active les API publicitaires : Attribution Reporting, Protected Audience, Topics et Fenced Frames.
PrivacySandboxSettings4 désactivé Active la quatrième version des paramètres de l'UI Privacy Sandbox.
OverridePrivacySandboxSettingsLocalTesting activé Si cette option est activée, le navigateur n'a plus besoin que les paramètres sous-jacents soient activés pour que les fonctionnalités Privacy Sandbox le soient.
BrowsingTopicsBypassIPIsPubliclyRoutableCheck désactivé Si cette option est activée, la vérification de l'acheminement public de l'adresse IP sera ignorée lors de la détermination de l'éligibilité d'une page à être incluse dans le calcul des thèmes.
BrowsingTopics:number_of_epochs_to_expose 3 Nombre d'époques à partir desquelles calculer les thèmes à fournir à un contexte de requête. Le navigateur conservera en interne jusqu'à N+1 époques.
BrowsingTopics:time_period_per_epoch 7d-0h-0m-0s Durée de chaque époque. Pour le débogage, il peut être utile de définir cette valeur sur 15 secondes, par exemple, plutôt que sur les sept jours par défaut.
BrowsingTopics:number_of_top_topics_per_epoch 5 Nombre de thèmes calculés par époque.
BrowsingTopics:use_random_topic_probability_percent 5 Probabilité qu'un thème individuel au sein d'une époque soit renvoyé de manière aléatoire à partir de l'ensemble de la taxonomie des thèmes. L'aléatoire est associé à une époque et à un site.
BrowsingTopics:number_of_epochs_of_observation_data_to_use_for_filtering 3 Nombre d'époques de données d'utilisation de l'API (c'est-à-dire d'observations de thèmes) qui seront utilisées pour filtrer les thèmes d'un contexte d'appel.
BrowsingTopics:max_number_of_api_usage_context_domains_to_keep_per_topic 1000 Nombre maximal de domaines de contexte "observé par" à conserver pour chaque sujet principal. L'objectif est de limiter la mémoire en cours d'utilisation.
BrowsingTopics:max_number_of_api_usage_context_entries_to_load_per_epoch 100000 Nombre maximal d'entrées pouvant être récupérées à partir de la base de données pour chaque requête concernant les contextes d'utilisation de l'API. La requête sera exécutée une fois par époque au moment du calcul des thèmes. L'objectif est de limiter l'utilisation maximale de la mémoire.
BrowsingTopics:max_number_of_api_usage_context_domains_to_store_per_page_load 30 Nombre maximal de domaines de contexte d'utilisation de l'API pouvant être stockés par chargement de page.
BrowsingTopics:config_version 1 Encode les paramètres de configuration de l'API Topics. Chaque numéro de version ne doit être associé qu'à un seul ensemble de configurations. La mise à jour des paramètres de configuration sans mise à jour de config_version devrait généralement fonctionner pour les tests locaux, mais dans certaines situations, elle pourrait laisser le navigateur dans un état incohérent et entraîner un plantage du navigateur, par exemple lors de la mise à jour de number_of_top_topics_per_epoch.
BrowsingTopics:taxonomy_version 1 Version de la taxonomie utilisée par l'API.

Avant de commencer l'implémentation

Avant de commencer l'implémentation, nous vous recommandons de consulter ces ressources pour vous familiariser avec l'API Topics.

  1. Consultez la documentation pour les développeurs :
    1. Comprendre l'objectif de l'API Topics et son rôle dans la publicité ciblée par centres d'intérêt
    2. Comprendre le fonctionnement de Topics sur le Web
    3. Essayez les démos et regardez la vidéo de présentation des démos, des notebooks Colab et des outils Topics.
    4. Explorez les démos et exécutez-les depuis votre propre site.
    5. Pour en savoir plus, consultez l'explication de l'API.
  2. Comprendre le rôle de l'API pour améliorer la pertinence des annonces à l'avenir, lorsque les cookies tiers ne seront plus disponibles pour une proportion croissante d'utilisateurs
  3. Pour être informé des changements d'état dans l'API, rejoignez la liste de diffusion pour les développeurs et restez informé des dernières actualités concernant Topics.
  4. Participez à la conversation sur les problèmes GitHub ou les appels W3C.
  5. Si vous rencontrez des termes inconnus, consultez le glossaire Privacy Sandbox.
  6. Pour en savoir plus sur les concepts Chrome, tels que les indicateurs Chrome, consultez les courtes vidéos et les articles disponibles sur goo.gle/cc.

Étapes suivantes

Découvrez les détails de l'implémentation et des exemples de code permettant aux appelants d'observer et d'accéder aux sujets.
Découvrez comment déployer, tester et faire évoluer des solutions basées sur Topics.