Guía para vendedores y compradores para generar informes de subastas de la API de Protected Audience
Este artículo es una referencia técnica para generar informes sobre el éxito de las subastas de la API de Protected Audience, como se usa en la iteración actual de la API experimental de la API de Protected Audience.
Lee la guía para desarrolladores para ver el ciclo de vida completo de la API de Protected Audience y consulta la explicación de la API de Protected Audience para obtener un análisis detallado de los informes a nivel del evento (temporal).
¿No eres desarrollador? Consulta la descripción general de la API de Protected Audience.
¿Qué informa la API de Protected Audience?
Hay dos informes disponibles de la API de Protected Audience:
- Informe del vendedor: Informa al vendedor sobre el ganador de la subasta de anuncios.
- Informe del comprador: Disponible solo para los compradores ganadores, para 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 los compradores con las APIs de Private Aggregation.
Como mecanismo de informe temporal a nivel del evento, el código que implementa reportResult() para el vendedor y reportWin() para el ofertante ganador puede llamar a la función sendReportTo(). Esto 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 debe informar.
Funciones de API
Vendedor: reportResult()
El código JavaScript del vendedor que se proporciona en decisionLogicUrl (que también proporciona scoreAd()) puede incluir una función reportResult() para informar el resultado de la subasta.
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
Es 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 incluir 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() para el ofertante ganador.
sellerSignals
El valor que se muestra de reportResult(), que le da al vendedor la oportunidad de pasar información al comprador
browserSignals
Es 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
Existen dos métodos disponibles temporalmente en Chrome para los informes de subastas:
forDebuggingOnly.reportAdAuctionLoss()forDebuggingOnly.reportAdAuctionWin()
Cada uno de estos métodos toma un solo argumento: una URL para recuperar después de que se completa la subasta. Se pueden llamar varias veces, tanto en scoreAd() como en generateBid(), con diferentes argumentos de URL.
Chrome solo envía informes de pérdidas o ganancias de depuración cuando se completa una subasta. Si se cancela una subasta (por ejemplo, debido a una nueva navegación), no se generarán informes.
Estos métodos están disponibles de forma predeterminada en Chrome si
chrome://flags/#privacy-sandbox-ads-apis está habilitado. Sin embargo, si ejecutas Chrome con marcas de línea de comandos para habilitar la API de Protected Audience, deberás habilitar los métodos de forma explícita con la marca BiddingAndScoringDebugReportingAPI. Si la marca no está habilitada, los métodos seguirán estando disponibles, pero no realizarán ninguna acción.
Todas las referencias de la API de Protected Audience
Las guías de referencia de la API están disponibles:
- Guía para desarrolladores sobre la API de Protected Audience
- Guía para compradores de anuncios sobre los grupos de interés y la generación de ofertas de Protected Audience.
- Guía para vendedores de anuncios sobre las subastas de anuncios de Protected Audience.
- Guía para informar los resultados de las subastas
- Prácticas recomendadas para la latencia de subasta de anuncios de Protected Audience
- Cómo solucionar problemas de Protected Audience
La explicación de la API de Protected Audience también proporciona detalles sobre la compatibilidad y las restricciones de funciones.
¿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.