Laporan hasil lelang Protected Audience API

Panduan penjual dan pembeli untuk membuat laporan lelang Protected Audience API.

Artikel ini adalah referensi teknis untuk membuat laporan kemenangan lelang Protected Audience API, seperti yang digunakan dalam iterasi Protected Audience API eksperimental saat ini.

Baca panduan developer untuk mengetahui siklus proses lengkap Protected Audience API, dan lihat penjelasan Protected Audience API untuk mengetahui pembahasan mendalam tentang pelaporan tingkat peristiwa (sementara).

Bukan developer? Lihat Ringkasan API Protected Audience API.

Apa yang dilaporkan oleh Protected Audience API?

Ada dua laporan Protected Audience API yang tersedia:

• Laporan penjual: Memberi tahu penjual tentang pemenang lelang iklan.
• Laporan pembeli: Hanya tersedia untuk pembeli yang menang, untuk mengetahui bahwa mereka telah memenangkan lelang.

Rencana jangka panjangnya adalah mengizinkan browser melaporkan hasil lelang untuk penjual dan pembeli dengan API Private Aggregation API. Sebagai mekanisme pelaporan tingkat peristiwa sementara, kode yang menerapkan reportResult() untuk penjual, dan reportWin() untuk bidder yang menang, dapat memanggil fungsi sendReportTo(). Fungsi ini memerlukan satu argumen: string yang merepresentasikan URL yang diambil setelah lelang selesai, yang mengenkode informasi tingkat peristiwa yang akan dilaporkan.

Fungsi API

Penjual: reportResult()

JavaScript penjual yang disediakan di decisionLogicUrl (yang juga menyediakan scoreAd()) dapat menyertakan fungsi reportResult(), untuk melaporkan hasil lelang.

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

Argumen yang diteruskan ke fungsi ini adalah:

auctionConfig

Objek konfigurasi lelang yang diteruskan ke navigator.runAdAuction().

browserSignals

Objek yang dibuat oleh browser yang memberikan informasi tentang lelang. Contoh:

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

Nilai yang ditampilkan fungsi ini digunakan sebagai argumen sellerSignals untuk fungsi reportWin() penawar yang menang.

Pembeli: reportWin()

JavaScript bidder pemenang (yang juga menyediakan generateBid()) dapat mencakup fungsi reportWin() untuk melaporkan hasil lelang.

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

Argumen yang diteruskan ke fungsi ini adalah:

auctionSignals dan perBuyerSignals

Nilai yang sama diteruskan ke generateBid() untuk penawar yang menang.

sellerSignals

Nilai yang ditampilkan dari reportResult(), yang memberi penjual peluang untuk meneruskan informasi kepada pembeli.

browserSignals

Objek yang dibuat oleh browser yang memberikan informasi tentang lelang. Contoh:

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

Penerapan pelaporan sementara

Ada dua metode yang tersedia sementara di Chrome untuk pelaporan lelang:

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

Setiap metode ini mengambil satu argumen: URL yang akan diambil setelah lelang selesai. Fungsi ini dapat dipanggil beberapa kali, baik di scoreAd() maupun generateBid(), dengan argumen URL yang berbeda.

Chrome hanya mengirimkan laporan kerugian/kemenangan debug saat lelang berjalan hingga selesai. Jika lelang dibatalkan (misalnya, karena navigasi baru), tidak ada laporan yang dibuat.

Metode ini tersedia secara default di Chrome saat Anda mengaktifkan semua API privasi Iklan di bagian chrome://settings/adPrivacy. Jika Anda menjalankan Chrome dengan tanda command line untuk mengaktifkan Protected Audience API, Anda harus mengaktifkan metode secara eksplisit dengan menyertakan tanda BiddingAndScoringDebugReportingAPI. Jika tanda tidak diaktifkan, metode akan tetap tersedia, tetapi tidak melakukan apa pun.

Semua referensi API Protected Audience API

Panduan referensi API tersedia:

• Panduan developer untuk Protected Audience API.
• Panduan pembeli iklan untuk grup minat dan pembuatan bid Protected Audience.
• Panduan penjual iklan untuk lelang iklan Protected Audience.
• Panduan melaporkan hasil lelang
• Praktik terbaik untuk latensi lelang iklan Protected Audience
• Memecahkan Masalah Protected Audience

Penjelasan Protected Audience API juga memberikan detail tentang dukungan dan batasan fitur.

Apa selanjutnya?

Kami ingin berbincang dengan Anda untuk memastikan bahwa kami membangun API yang berlaku untuk semua orang.

Diskusikan API

Seperti API Privacy Sandbox lainnya, API ini didokumentasikan dan dibahas secara publik.

Bereksperimen dengan API

Anda dapat bereksperimen dan berpartisipasi dalam percakapan tentang Protected Audience API.