รายงานเกี่ยวกับผลการประมูล 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 ดังต่อไปนี้

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

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

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

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

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

ทดลองใช้ API

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