รายงานเกี่ยวกับผลการประมูล 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 หากเปิดใช้ chrome://flags/#privacy-sandbox-ads-apis แต่หากใช้ Chrome พร้อมแฟล็กบรรทัดคำสั่งเพื่อเปิดใช้ Protected Audience API คุณจะต้องเปิดใช้เมธอดเหล่านี้อย่างชัดแจ้งด้วยการใส่แฟล็ก BiddingAndScoringDebugReportingAPI หากไม่ได้เปิดใช้แฟล็ก วิธีการต่างๆ จะยังคงใช้ได้แต่ไม่ต้องดำเนินการใดๆ

เอกสารอ้างอิงทั้งหมดของ Protected Audience API

มีคู่มืออ้างอิง API ดังต่อไปนี้

ตัวอธิบาย Protected Audience API ยังให้รายละเอียดเกี่ยวกับการรองรับและข้อจำกัดต่างๆ ของฟีเจอร์ด้วย

ขั้นตอนถัดไปคือ

เราต้องการพูดคุยกับคุณเพื่อให้แน่ใจว่าเราได้สร้าง API ที่เหมาะสำหรับทุกคน

พูดคุยเกี่ยวกับ API

API นี้จะได้รับการจัดทำเอกสารและอภิปรายต่อสาธารณะเช่นเดียวกับ Privacy Sandbox API อื่นๆ

ทดลองใช้ API

คุณจะทดสอบและเข้าร่วมในการพูดคุยเกี่ยวกับ Protected Audience API ได้