Report sui risultati dell'asta dell'API Protected Audience

Guida al venditore e agli acquirenti per generare report sulle aste dell'API Protected Audience.

Questo articolo è un riferimento tecnico per generare report sulle vittorie nell'asta dell'API Protected Audience, come utilizzato nell'attuale iterazione dell'API sperimentale Protected Audience.

Leggi la guida per gli sviluppatori per l'intero ciclo di vita dell'API Protected Audience e consulta il messaggio esplicativo dell'API Protected Audience per un'analisi approfondita dei report a livello di evento (temporanei).

Non sei uno sviluppatore? Consulta la panoramica dell'API Protected Audience.

Che cosa segnala l'API Protected Audience?

Sono disponibili due report dell'API Protected Audience:

  • Report sul venditore: informa il venditore sul vincitore dell'asta dell'annuncio.
  • Report sugli acquirenti: disponibile solo per gli acquirenti vincitori, per scoprire che hanno vinto un'asta.

Il piano a lungo termine prevede che il browser possa generare report sui risultati delle aste per il venditore e gli acquirenti tramite le API dell'API Private Aggregation. Come meccanismo temporaneo di generazione di report a livello di evento, il codice che implementa reportResult() per il venditore e reportWin() per l'offerente vincente può chiamare la funzione sendReportTo(). Prende un singolo argomento: una stringa che rappresenta un URL recuperato al termine dell'asta, che codifica le informazioni a livello di evento da inserire nel report.

Funzioni API

Venditore: reportResult()

Il codice JavaScript del venditore fornito in decisionLogicUrl (che fornisce anche scoreAd()) può includere una funzione reportResult(), per segnalare il risultato dell'asta.

reportResult(auctionConfig, browserSignals) {
  ...
  return signalsForWinner;
}

Gli argomenti passati a questa funzione sono:

auctionConfig

L'oggetto di configurazione dell'asta passato a navigator.runAdAuction().

browserSignals

Un oggetto costruito dal browser che fornisce informazioni sull'asta. Ad esempio:

  {
    'topWindowHostname': 'publisher.example',
    'interestGroupOwner': 'https://dsp.example',
    'renderUrl': 'https://cdn.example/url-of-winning-creative.wbn',
    'bid': <bidValue>,
    'desirability': <winningAdScore>
  }

Il valore restituito di questa funzione viene utilizzato come argomento sellerSignals per la funzione reportWin() dell'offerente vincente.

Acquirente: reportWin()

Il codice JavaScript dell'offerente vincente (che ha fornito anche generateBid()) può includere una funzione reportWin() per segnalare il risultato dell'asta.

reportWin(auctionSignals, perBuyerSignals, sellerSignals, browserSignals) {
  ...
}

Gli argomenti passati a questa funzione sono:

auctionSignals e perBuyerSignals

Gli stessi valori passati a generateBid() per l'offerente vincente.

sellerSignals

Il valore restituito di reportResult(), che offre al venditore l'opportunità di trasmettere informazioni all'acquirente.

browserSignals

Un oggetto costruito dal browser che fornisce informazioni sull'asta. Ad esempio:

{
  'topWindowHostname': 'publisher.example',
  'seller': 'https://ssp.example',
  'interestGroupOwner': 'https://dsp.example',
  'interestGroupName': 'custom-bikes',
  'renderUrl': 'https://cdn.example/winning-creative.wbn',
  'bid': <bidValue>
}

Implementazione di report temporanei

Esistono due metodi temporaneamente disponibili in Chrome per i report sulle aste:

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

Questi metodi prendono ognuno un singolo argomento: un URL da recuperare dopo il completamento dell'asta. Possono essere richiamati più volte, in scoreAd() e generateBid(), con argomenti URL diversi.

Chrome invia report sulla perdita o sulle vincite di debug solo quando un'asta viene eseguita fino al completamento. Se un'asta viene annullata (ad esempio a causa di una nuova navigazione), non verrà generato report.

Questi metodi sono disponibili per impostazione predefinita in Chrome quando attivi tutte le API di privacy per gli annunci in chrome://settings/adPrivacy. Se esegui Chrome con flag della riga di comando per abilitare l'API Protected Audience, dovrai abilitare esplicitamente i metodi includendo il flag BiddingAndScoringDebugReportingAPI. Se il flag non è abilitato, i metodi saranno ancora disponibili, ma non faranno nulla.

Tutti i riferimenti all'API Protected Audience

Sono disponibili guide di riferimento API:

Il messaggio esplicativo dell'API Protected Audience fornisce anche dettagli sul supporto e sui vincoli delle funzionalità.

Passaggi successivi

Vogliamo interagire con te per assicurarci di creare un'API che funzioni per tutti.

Informazioni sull'API

Come altre API di Privacy Sandbox, questa API è documentata e spiegata pubblicamente.

Sperimenta con l'API

Puoi sperimentare e partecipare alla conversazione sull'API Protected Audience.