Configuration de l'API Topics

Préparez votre environnement à 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émos pour comprendre le fonctionnement de Topics avant de vous lancer dans l'implémentation.

Activer Topics dans votre navigateur

Pour activer l'API Topics dans votre propre instance Chrome à des fins de test local, 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 en ajoutant des indicateurs Chromium à l'aide de paramètres spécifiques à l'API Topics pour procéder à la configuration selon vos besoins. Vous pouvez contrôler de façon plus précise les fonctionnalités Topics en exécutant Chrome à partir de la ligne de commande. Par exemple, il est possible de définir des époques Topics (la 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 d'en démarrer un nouveau à l'aide des indicateurs.
  2. Assurez-vous que toutes les API Ad Privacy sont activées sous chrome://settings/adPrivacy.
  3. Si l'API ne fonctionne pas comme prévu, suivez nos conseils de dépannage.
  4. Si vous avez des questions, consultez les explications sur les problèmes GitHub.

Contrôler l'API Topics avec les indicateurs 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 options suivantes :

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

Le tableau suivant décrit chaque paramètre, sa valeur par défaut et son rôle.

Nom de l'option Valeur par défaut Description
BrowsingTopics activé Indique si l'API Topics est activée.
PrivacySandboxAdsAPIsOverride activé Active les API d'annonces: Attribution Reporting, Protected Audience, Topics et Fenced Frames.
PrivacySandboxSettings4 désactivé Active la quatrième version des paramètres de l'UI de la Privacy Sandbox.
OverridePrivacySandboxSettingsLocalTesting activé Si cette option est activée, le navigateur n'a plus besoin d'activer les paramètres sous-jacents pour activer les fonctionnalités de la Privacy Sandbox.
BrowsingTopicsBypassIPIsPubliclyRoutableCheck désactivé Si cette option est activée, la vérification de l'accessibilité publique de l'adresse IP sera ignorée pour déterminer si une page peut être incluse dans le calcul des thèmes.
BrowsingTopics:number_of_epochs_to_expose 3 Nombre d'époques à partir duquel calculer les thèmes à transmettre à un contexte de requête. Le navigateur conserve 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 durée sur 15 secondes, par exemple, au lieu des sept jours par défaut.
BrowsingTopics:number_of_top_topics_per_epoch 5 Nombre de sujets calculés par époque.
BrowsingTopics:use_random_topic_probability_percent 5 Probabilité qu'un thème spécifique d'une époque soit renvoyé de manière aléatoire dans l'ensemble de la taxonomie des thèmes. Le caractère aléatoire est persistant par rapport à une époque et à un site.
BrowsingTopics:number_of_epochs_of_observation_data_to_use_for_filtering 3 Nombre d'époques des données d'utilisation de l'API (c'est-à-dire les observations sur les thèmes) qui seront utilisées pour filtrer les thèmes en vue 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és à 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 dans la base de données pour chaque requête pour les contextes d'utilisation de l'API. La requête sera exécutée une fois par epoch, 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 mappé qu'à un seul ensemble de configuration. La mise à jour des paramètres de configuration sans mettre à jour config_version devrait généralement suffire pour les tests locaux, mais dans certains cas, le navigateur peut rester dans un état incohérent et peut planter, 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. Découvrez le fonctionnement de Topics sur le Web.
    3. Essayez les démonstrations et regardez la vidéo de présentation des démonstrations, de Colab et des outils Topics.
    4. Dupliquez les démos et exécutez-les à partir de votre propre site.
    5. Consultez l'explication sur l'API pour en savoir plus.
  2. Comprendre le rôle de l'API dans la promotion de 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 des développeurs et tenez-vous informé des dernières actualités de Topics.
  4. Participez à la conversation sur les problèmes GitHub ou les appels W3C.
  5. Si vous rencontrez des termes inconnus, consultez le glossaire de la Privacy Sandbox.
  6. Pour en savoir plus sur les concepts Chrome, tels que les indicateurs Chrome, regardez les courtes vidéos et consultez 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.