Guide pour les vendeurs et les acheteurs sur la génération de rapports sur les enchères de l'API Protected Audience.
Cet article est une référence technique pour générer des rapports sur les enchères remportées par l'API Protected Audience, telle qu'elle est utilisée dans l'itération actuelle de l'API Protected Audience expérimentale.
Consultez le guide du développeur pour découvrir le cycle de vie complet de l'API Protected Audience. Pour en savoir plus sur les rapports au niveau des événements (temporaires), consultez la présentation de l'API Protected Audience.
Vous n'êtes pas développeur ? Consultez la présentation de l'API Protected Audience.
Que contient le rapport sur l'API Protected Audience ?
Deux rapports sur l'API Protected Audience sont disponibles :
- Rapport du vendeur : informe le vendeur du gagnant de l'enchère publicitaire.
- Rapport sur les acheteurs : disponible uniquement pour les acheteurs gagnants, pour les informer qu'ils ont remporté une enchère.
L'objectif à long terme est de permettre au navigateur de communiquer les résultats des enchères pour le vendeur et les acheteurs avec les API Private Aggregation.
En tant que mécanisme temporaire de création de rapports au niveau des événements, le code implémentant reportResult() pour le vendeur et reportWin() pour l'enchérisseur gagnant peut appeler la fonction sendReportTo(). Cette fonction prend un seul argument : une chaîne représentant une URL récupérée une fois l'enchère terminée, qui encode les informations au niveau de l'événement à signaler.
Fonctions de l'API
Vendeur : reportResult()
Le code JavaScript du vendeur fourni dans decisionLogicUrl (qui fournit également scoreAd()) peut inclure une fonction reportResult() pour signaler le résultat de l'enchère.
reportResult(auctionConfig, browserSignals) {
...
return signalsForWinner;
}
Les arguments transmis à cette fonction sont les suivants :
auctionConfig
Objet de configuration des enchères transmis à navigator.runAdAuction().
browserSignals
Objet construit par le navigateur et fournissant des informations sur l'enchère. Exemple :
{
'topWindowHostname': 'publisher.example',
'interestGroupOwner': 'https://dsp.example',
'renderUrl': 'https://cdn.example/url-of-winning-creative.wbn',
'bid': <bidValue>,
'desirability': <winningAdScore>
}
La valeur renvoyée par cette fonction est utilisée comme argument sellerSignals pour la fonction reportWin() de l'enchérisseur gagnant.
Acheteur : reportWin()
Le JavaScript de l'enchérisseur gagnant (qui a également fourni generateBid()) peut inclure une fonction reportWin() pour signaler le résultat de l'enchère.
reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals) {
...
}
Les arguments transmis à cette fonction sont les suivants :
auctionSignals et perBuyerSignals
Les mêmes valeurs sont transmises à generateBid() pour l'enchérisseur gagnant.
sellerSignals
La valeur de retour de reportResult(), qui permet au vendeur de transmettre des informations à l'acheteur.
browserSignals
Objet construit par le navigateur et fournissant des informations sur l'enchère. Exemple :
{
'topWindowHostname': 'publisher.example',
'seller': 'https://ssp.example',
'interestGroupOwner': 'https://dsp.example',
'interestGroupName': 'custom-bikes',
'renderUrl': 'https://cdn.example/winning-creative.wbn',
'bid': <bidValue>
}
Implémentation temporaire des rapports
Deux méthodes sont temporairement disponibles dans Chrome pour les rapports sur les enchères :
forDebuggingOnly.reportAdAuctionLoss()forDebuggingOnly.reportAdAuctionWin()
Chacune de ces méthodes prend un seul argument : une URL à récupérer une fois l'enchère terminée. Elles peuvent être appelées plusieurs fois, à la fois dans scoreAd() et generateBid(), avec différents arguments d'URL.
Chrome n'envoie des rapports de débogage sur les pertes/gains que lorsqu'une enchère est exécutée jusqu'à son terme. Si une enchère est annulée (par exemple, en raison d'une nouvelle navigation), aucun rapport ne sera généré.
Ces méthodes sont disponibles par défaut dans Chrome lorsque vous activez toutes les API Ad Privacy sous chrome://settings/adPrivacy. Si vous exécutez Chrome avec des indicateurs de ligne de commande pour activer l'API Protected Audience, vous devrez activer explicitement les méthodes en incluant l'indicateur BiddingAndScoringDebugReportingAPI. Si l'indicateur n'est pas activé, les méthodes seront toujours disponibles, mais n'auront aucun effet.
Toutes les références de l'API Protected Audience
Des guides de référence de l'API sont disponibles:
- Guide du développeur de l'API Protected Audience
- Guide des acheteurs d'annonces pour les groupes de centres d'intérêt et la génération d'enchères de l'API Protected Audience
- Guide des vendeurs publicitaires pour les enchères publicitaires Protected Audience
- Guide sur la création de rapports sur les résultats des enchères
- Bonnes pratiques concernant la latence des enchères publicitaires Protected Audience
- Résoudre les problèmes liés à Protected Audience
L'article explicatif de l'API Protected Audience fournit également des informations détaillées sur la compatibilité des fonctionnalités et les contraintes.
Étape suivante
Nous souhaitons discuter avec vous d'une API adaptée à tous les utilisateurs.
Discuter de l'API
Comme d'autres API de la Privacy Sandbox, cette API est documentée et consultée publiquement.
Tester l'API
Vous pouvez tester l'API Protected Audience et y participer.