รายงานเกี่ยวกับผลการประมูล Protected Audience API

คำแนะนำเกี่ยวกับผู้ขายและผู้ซื้อในการสร้างรายงานการประมูล Protected Audience API

บทความนี้จะเป็นข้อมูลอ้างอิงทางเทคนิคสำหรับการสร้างรายงานสำหรับ ชนะการประมูลของ Protected Audience API ตามที่ใช้ในการทำซ้ำการทดสอบในปัจจุบัน Protected Audience API

อ่านคู่มือนักพัฒนาซอฟต์แวร์จนจบ ของ Protected Audience API และดูคำอธิบาย Protected Audience API สำหรับการพูดคุยอย่างละเอียดเกี่ยวกับ การรายงานระดับเหตุการณ์ (ชั่วคราว)

หากคุณไม่ใช่นักพัฒนาซอฟต์แวร์ โปรดดูภาพรวม Protected Audience API

รายงาน Protected Audience API คืออะไร

รายงาน Protected Audience API มีอยู่ 2 ประเภทดังนี้

• รายงานผู้ขาย: แจ้งผู้ขายของผู้ที่ชนะการประมูลเพื่อแสดงโฆษณา
• รายงานผู้ซื้อ: พร้อมใช้งานสำหรับผู้ซื้อที่ชนะเท่านั้น หากต้องการทราบว่าผู้ซื้อชนะการประมูล

แผนระยะยาวคือการอนุญาตให้เบราว์เซอร์รายงานผลการประมูล ผู้ขายและผู้ซื้อที่ใช้ Private Aggregation API API ในฐานะกลไกการรายงานระดับเหตุการณ์ชั่วคราว การใช้โค้ด reportResult() สำหรับผู้ขาย และ reportWin() สำหรับผู้เสนอราคาที่ชนะ เรียกฟังก์ชัน sendReportTo() ค่านี้ใช้อาร์กิวเมนต์เดียว นั่นคือสตริง แสดง URL ที่ดึงมาหลังจากการประมูลเสร็จสิ้น ซึ่งเข้ารหัส ข้อมูลระดับเหตุการณ์ที่จะรายงาน

ฟังก์ชัน API

ผู้ขาย: reportResult()

JavaScript ของผู้ขายที่ให้ไว้ใน decisionLogicUrl (ซึ่งยังมี scoreAd()) สามารถมีฟังก์ชัน reportResult() เพื่อรายงานการประมูลได้ ผลลัพธ์

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

อาร์กิวเมนต์ที่ส่งผ่านไปยังฟังก์ชันนี้มีดังนี้

auctionConfig

ออบเจ็กต์การกำหนดค่าการประมูลที่ส่งไปยัง navigator.runAdAuction()

browserSignals

ออบเจ็กต์ที่สร้างขึ้นโดยเบราว์เซอร์ซึ่งให้ข้อมูลเกี่ยวกับการประมูล เช่น

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

ค่าที่แสดงผลของฟังก์ชันนี้ใช้เป็นอาร์กิวเมนต์ sellerSignals สำหรับ ฟังก์ชัน reportWin() ของผู้เสนอราคาที่ชนะ

ผู้ซื้อ: reportWin()

JavaScript ของผู้เสนอราคาที่ชนะ (ซึ่งให้ generateBid() ด้วย) สามารถ มีฟังก์ชัน reportWin() เพื่อรายงานผลการประมูล

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

อาร์กิวเมนต์ที่ส่งผ่านไปยังฟังก์ชันนี้มีดังนี้

auctionSignals และ perBuyerSignals

ค่าเดียวกันที่ส่งไปยัง generateBid() สำหรับผู้ชนะ ผู้เสนอราคา

sellerSignals

ผลลัพธ์ที่ปรากฏของ reportResult() ซึ่งทำให้ผู้ขาย โอกาสที่จะส่งข้อมูลไปให้ผู้ซื้อ

browserSignals

ออบเจ็กต์ที่สร้างขึ้นโดยเบราว์เซอร์ซึ่งให้ข้อมูลเกี่ยวกับการประมูล เช่น

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

การใช้การรายงานชั่วคราว

การรายงานการประมูลของ Chrome ทำได้ 2 วิธีชั่วคราวดังนี้

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

วิธีการเหล่านี้แต่ละวิธีจะใช้อาร์กิวเมนต์เดียว นั่นคือ URL ที่จะดึงข้อมูลหลังจากการประมูล เสร็จสมบูรณ์แล้ว อาจมีการเรียกบุคคลนี้หลายครั้ง ทั้งใน scoreAd() และ generateBid() มีอาร์กิวเมนต์ URL ที่ต่างกัน

Chrome จะส่งรายงานปัญหาแพ้/ชนะเมื่อการประมูลทำงานจนเสร็จสิ้นเท่านั้น ถ้า การประมูลถูกยกเลิก (เช่น เนื่องจากมีการนําทางใหม่) รายงานใดก็ตามจะไม่ ได้

วิธีการเหล่านี้พร้อมใช้งานโดยค่าเริ่มต้นใน Chrome เมื่อคุณเปิดใช้ API ความเป็นส่วนตัวเกี่ยวกับโฆษณาทั้งหมดภายใต้ chrome://settings/adPrivacy หากคุณกำลังวิ่ง Chrome ที่มีการแฟล็กบรรทัดคำสั่งเพื่อเปิดใช้ Protected Audience API คุณจะต้องเปิดใช้เมธอดอย่างชัดแจ้งโดยรวม Flag BiddingAndScoringDebugReportingAPI หากไม่ได้เปิดใช้การทำเครื่องหมายไว้ เมธอดต่างๆ จะยังใช้ได้อยู่แต่ไม่ต้องดําเนินการใดๆ

ข้อมูลอ้างอิงทั้งหมดของ 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.