Guía para vendedores y compradores para generar informes de subasta de la API de Protected Audience.
Este artículo es una referencia técnica para generar informes para Gana la subasta de la API de Protected Audience, como se usa en la iteración actual de la prueba experimental API de Protected Audience.
Consulta la guía para desarrolladores para obtener información sobre la vida completa. de la API de Protected Audience, y consulte la explicación de la API de Protected Audience para obtener un análisis detallado de informes a nivel del evento (temporales).
¿No eres desarrollador? Consulta la descripción general de la API de Protected Audience.
¿Qué informa la API de Protected Audience?
Hay dos informes de la API de Protected Audience disponibles:
- Informe del vendedor: Informa al vendedor sobre el ganador de la subasta de anuncios.
- Informe de compradores: Disponible solo para los compradores ganadores, con el fin de saber que ganaron una subasta.
El plan a largo plazo es permitir que el navegador informe los resultados de la subasta para el
vendedor y compradores con las APIs de la API de Private Aggregation
Como mecanismo temporal de informes a nivel del evento, el código que implementa
Se pueden utilizar reportResult() para el vendedor y reportWin() para el ofertante ganador
llama a la función sendReportTo(). Toma un solo argumento: una cadena
que representa una URL que se recupera después de que se completa la subasta, que codifica
la información a nivel del evento que se informará.
Funciones de API
Vendedor: reportResult()
El código JavaScript del vendedor que se proporcionó en decisionLogicUrl (que también incluye
scoreAd()) puede incluir una función reportResult() para informar la subasta.
resultado.
reportResult(auctionConfig, browserSignals) {
...
return signalsForWinner;
}
Los argumentos que se pasan a esta función son los siguientes:
auctionConfig
El objeto de configuración de la subasta que se pasa a navigator.runAdAuction().
browserSignals
Un objeto construido por el navegador que proporciona información sobre la subasta. Por ejemplo:
{
'topWindowHostname': 'publisher.example',
'interestGroupOwner': 'https://dsp.example',
'renderUrl': 'https://cdn.example/url-of-winning-creative.wbn',
'bid': <bidValue>,
'desirability': <winningAdScore>
}
El valor que se muestra de esta función se usa como el argumento sellerSignals para
la función reportWin() del ofertante ganador
Comprador: reportWin()
El JavaScript del ofertante ganador (que también proporcionó generateBid()) puede
Incluye una función reportWin() para informar el resultado de la subasta.
reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals) {
...
}
Los argumentos que se pasan a esta función son los siguientes:
auctionSignals y perBuyerSignals
Se pasan los mismos valores a generateBid() del ganador
ofertante.
sellerSignals
El valor que se muestra de reportResult(), que le da al vendedor
la oportunidad de pasar información al comprador.
browserSignals
Un objeto construido por el navegador que proporciona información sobre la subasta. Por ejemplo:
{
'topWindowHostname': 'publisher.example',
'seller': 'https://ssp.example',
'interestGroupOwner': 'https://dsp.example',
'interestGroupName': 'custom-bikes',
'renderUrl': 'https://cdn.example/winning-creative.wbn',
'bid': <bidValue>
}
Implementación de informes temporales
Hay dos métodos disponibles temporalmente en Chrome para los informes de subastas:
forDebuggingOnly.reportAdAuctionLoss()forDebuggingOnly.reportAdAuctionWin()
Cada uno de estos métodos tiene un solo argumento: una URL para recuperar después de la subasta
el proyecto se completó. Se pueden llamar varias veces, tanto en scoreAd() como en
generateBid(), con diferentes argumentos de URL.
Chrome solo envía informes de pérdida/adquisición de depuración cuando se completa una subasta. Si se cancela una subasta (por ejemplo, debido a una nueva navegación), ningún informe que se generará.
Estos métodos están disponibles de forma predeterminada en Chrome cuando habilitas todas las APIs de privacidad en los anuncios en chrome://settings/adPrivacy. Si publicas
Chrome con marcas de línea de comandos para habilitar la API de Protected Audience, deberás habilitar explícitamente los métodos incluyendo la marca BiddingAndScoringDebugReportingAPI. Si la marca no está habilitada, los métodos seguirán estando disponibles, pero no harán nada.
Todas las referencias de la API de Protected Audience
API reference guides are available:
- Developer guide for the Protected Audience API.
- Ad buyer guide to Protected Audience interest groups and bid generation.
- Ad seller guide to Protected Audience ad auctions.
- Guide to reporting auction results
- Best practices for Protected Audience ad auction latency
- Troubleshoot Protected Audience
The Protected Audience API explainer also provides detail about feature support and constraints.
¿Qué sigue?
Queremos conversar contigo a fin de asegurarnos de compilar una API que funcione para todos.
Debate sobre la API
Al igual que otras APIs de Privacy Sandbox, esta API se documenta y se analiza públicamente.
Experimenta con la API
Puedes experimentar y participar en las conversaciones sobre la API de Protected Audience.