Générer des rapports sur les résultats des enchères de l'API Protected Audience

Guide du vendeur et de l'acheteur pour générer des rapports sur les enchères de l'API Protected Audience.

Cet article est une référence technique permettant de générer des rapports pour L'enchère de l'API Protected Audience l'emporte, comme utilisé dans l'itération actuelle de l'interface API Protected Audience.

Lisez le guide du développeur pour en savoir plus de l'API Protected Audience, et reportez-vous à la vidéo d'explication de l'API Protected Audience pour une discussion approfondie sur création de rapports au niveau des événements (temporaire).

Vous n'êtes pas développeur ? Consultez la présentation de l'API Protected Audience.

Que renvoie l'API Protected Audience ?

Deux rapports de l'API Protected Audience sont disponibles:

• Rapport sur le vendeur: informe le vendeur du gagnant de l'enchère publicitaire.
• Rapport sur les acheteurs: uniquement disponible pour les acheteurs gagnants, afin de savoir s'ils ont remporté une mise aux enchères.

L'objectif à long terme est de permettre au navigateur de communiquer les résultats des enchères pour pour les vendeurs et les acheteurs à l'aide des API de l'API Private Aggregation. En tant que mécanisme temporaire de création de rapports au niveau des événements, le code qui implémente reportResult() pour le vendeur et reportWin() pour l'enchérisseur gagnant appeler la fonction sendReportTo(). Elle n'accepte qu'un seul argument: une chaîne représentant une URL qui est récupérée une fois la mise aux enchères terminée, et qui encode des informations au niveau des événements à 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 l'enchère. résultat.

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 code JavaScript de l'enchérisseur gagnant (qui a également fourni generateBid()) peut Incluez une fonction reportWin() pour indiquer 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 ont été transmises à generateBid() pour l'enchère gagnante de l'enchérisseur.

sellerSignals

La valeur renvoyée de reportResult(), qui donne au vendeur une 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 de rapports

Pour créer des rapports sur les enchères, deux méthodes sont disponibles temporairement dans Chrome:

• forDebuggingOnly.reportAdAuctionLoss()
• forDebuggingOnly.reportAdAuctionWin()

Ces méthodes n'acceptent chacune qu'un seul argument: une URL à récupérer après l'enchère terminé. Elles peuvent être appelées plusieurs fois, à la fois dans scoreAd() et generateBid(), avec des arguments d'URL différents.

Chrome n'envoie des rapports de débogage de perte/gagnement que lorsqu'une enchère est terminée. Si l'annulation d'une enchère (en raison d'une nouvelle navigation, par exemple), aucun rapport ne être générées.

Ces méthodes sont disponibles par défaut dans Chrome lorsque vous activez toutes les API de confidentialité des annonces sous chrome://settings/adPrivacy. Si vous exécutez Chrome avec des indicateurs de ligne de commande pour activer l'API Protected Audience, vous devez activer explicitement les méthodes en incluant l'indicateur BiddingAndScoringDebugReportingAPI. Si l'indicateur n'est pas activé, les méthodes restent disponibles, mais ne font rien.

Toutes les documentations de référence de l'API Protected Audience

以下是 API 参考指南：

• Protected Audience API 开发者指南。
• 有关 Protected Audience 兴趣群体和出价生成的广告买方指南。
• Protected Audience 广告竞价广告卖方指南。
• 关于报告竞价结果的指南
• Protected Audience 广告竞价延迟时间方面的最佳实践
• 对 Protected Audience 进行问题排查

Protected Audience API 说明信息还详细介绍了功能支持和限制条件。

É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.