Generowanie raportów o wynikach aukcji interfejsu Protected Audience API

Przewodnik dla sprzedawców i kupujących dotyczące generowania raportów aukcji interfejsu Protected Audience API.

Ten artykuł zawiera informacje techniczne na temat generowania raportów na temat: Wygrane aukcje interfejsu Protected Audience API używane w bieżącej wersji eksperymentalnej Protected Audience API.

Całe życie przeczytaj przewodnik dla programistów interfejsu Protected Audience API. Aby dowiedzieć się więcej o tym, jak działa interfejs Protected Audience API, raportowanie na poziomie zdarzenia (tymczasowe) –

Nie jesteś programistą? Zapoznaj się z omówieniem interfejsu Protected Audience API.

Co zawiera raport Protected Audience API?

Dostępne są 2 raporty interfejsu Protected Audience API:

• Raport sprzedawcy: informuje sprzedawcę o zwycięzcy aukcji reklam.
• Raport o kupującym: informacje dostępne tylko dla zwycięskich kupujących. Dzięki nim można się dowiedzieć, że wygrali aukcję.

Planem długoterminowym jest umożliwienie przeglądarce raportowania wyników aukcji sprzedawców i kupujących za pomocą interfejsów Private Aggregation API API. Jako tymczasowy mechanizm raportowania na poziomie zdarzenia, kod implementujący reportResult() w przypadku sprzedawcy i reportWin() w przypadku zwycięskiego licytującego. wywołaj funkcję sendReportTo(). Przyjmuje to pojedynczy argument: ciąg znaków reprezentujący adres URL pobierany po zakończeniu aukcji, który koduje informacje na poziomie zdarzenia, które mają być raportowane.

Funkcje interfejsu API

Sprzedawca: reportResult()

Kod JavaScript sprzedawcy dostępny w języku decisionLogicUrl (który zawiera również scoreAd()) może zawierać funkcję reportResult(), by zgłosić aukcję wyniki.

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

Argumenty przekazywane do tej funkcji to:

auctionConfig

Obiekt konfiguracji aukcji przekazany do navigator.runAdAuction().

browserSignals

Obiekt utworzony przez przeglądarkę, który dostarcza informacji o aukcji. Na przykład:

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

Wartość zwrócona tej funkcji jest używana jako argument sellerSignals dla funkcji funkcji reportWin() zwycięskiego licytującego.

Kupujący: reportWin()

Kod JavaScript zwycięskiego licytującego (który zapewnił też generateBid()) może Uwzględnij funkcję reportWin(), by raportować wynik aukcji.

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

Argumenty przekazywane do tej funkcji to:

auctionSignals i perBuyerSignals

Te same wartości przekazane do funkcji generateBid() w przypadku zwycięskiej licytującego.

sellerSignals

wartość zwrotna reportResult(), która daje sprzedawcy wartość umożliwiają przekazanie informacji kupującemu.

browserSignals

Obiekt utworzony przez przeglądarkę, który dostarcza informacji o aukcji. Na przykład:

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

Tymczasowe wdrożenie raportowania

W Chrome na potrzeby raportowania aukcji są tymczasowo dostępne 2 metody:

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

Każda z tych metod przyjmuje jeden argument: adres URL do pobrania po . Można je wywoływać wiele razy, zarówno w polu scoreAd(), jak i generateBid() z różnymi argumentami adresu URL.

Chrome wysyła raporty debugowania o utratach/wygranych tylko po zakończeniu aukcji. Jeśli aukcja została anulowana (np. z powodu nowej nawigacji). Żadne raporty nie .

Te metody są domyślnie dostępne w Chrome po włączeniu wszystkich interfejsów API prywatności w reklamach w sekcji chrome://settings/adPrivacy. Jeśli biegasz Chrome z flagami wiersza poleceń umożliwiającymi włączenie interfejsu Protected Audience API. Musisz samodzielnie włączyć metody, dodając flagę BiddingAndScoringDebugReportingAPI. Jeśli flaga nie jest włączona, metody nadal będą dostępne, ale nie wymagają żadnych działań.

Wszystkie odwołania do interfejsu Protected Audience API

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.

What's next?

We want to engage in conversations with you to ensure we build an API that works for everyone.

Discuss the API

Like other Privacy Sandbox APIs, this API is documented and discussed publicly.

Experiment with the API

You can experiment and participate in conversation about the Protected Audience API.