Protected Audience API की नीलामी के नतीजों की रिपोर्ट

Protected Audience API की नीलामी रिपोर्ट जनरेट करने के लिए, सेलर और खरीदार के लिए गाइड.

इस लेख में, Protected Audience API की नीलामी जीतने की रिपोर्ट जनरेट करने का तकनीकी रेफ़रंस दिया गया है. इसका इस्तेमाल, प्रयोग के तौर पर Protected Audience API के मौजूदा बदलाव में किया जाता है.

Protected Audience API की पूरी लाइफ़साइकल के बारे में जानने के लिए, डेवलपर गाइड पढ़ें. साथ ही, इवेंट लेवल की रिपोर्टिंग (कुछ समय के लिए) के बारे में गहराई से चर्चा करने के लिए, Protected Audience API की जानकारी देखें.

क्या आप डेवलपर नहीं हैं? Protected Audience API API की खास जानकारी देखें.

Protected Audience API की रिपोर्ट क्या होती है?

Protected Audience API की दो रिपोर्ट उपलब्ध हैं:

  • सेलर रिपोर्ट: इससे विज्ञापन नीलामी के विजेता के सेलर को जानकारी मिलती है.
  • खरीदार की रिपोर्ट: यह सुविधा सिर्फ़ जीतने वाले खरीदारों के लिए उपलब्ध है. इससे उन्हें पता चलता है कि उन्होंने नीलामी जीत ली है.

लंबे समय का प्लान यह है कि ब्राउज़र, Private एग्रीगेशन API एपीआई की मदद से, सेलर और खरीदारों के लिए नीलामी के नतीजों की रिपोर्ट कर सके. इवेंट-लेवल पर रिपोर्टिंग के अस्थायी तरीके के तौर पर, सेलर के लिए reportResult() और बिड जीतने वाली बिडर के लिए reportWin() लागू करने वाला कोड, sendReportTo() फ़ंक्शन को कॉल कर सकता है. इसके लिए सिर्फ़ एक तर्क की ज़रूरत होती है: नीलामी पूरी होने के बाद फ़ेच किए गए यूआरएल को दिखाने वाली स्ट्रिंग, जो रिपोर्ट करने के लिए इवेंट-लेवल की जानकारी को कोड में बदल देती है.

एपीआई फ़ंक्शन

विक्रेता: reportResult()

नीलामी के नतीजे की रिपोर्ट करने के लिए, decisionLogicUrl में दिए गए सेलर के JavaScript में reportResult() फ़ंक्शन शामिल हो सकता है. यह फ़ंक्शन scoreAd() भी उपलब्ध कराता है.

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>
  }

इस फ़ंक्शन की रिटर्न वैल्यू का इस्तेमाल, बोली जीतने वाले बोली लगाने वाले के reportWin() फ़ंक्शन के sellerSignals तर्क के तौर पर किया जाता है.

खरीदार: 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 में दो तरीके कुछ समय के लिए उपलब्ध हैं:

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

इन तरीकों में से हर एक के लिए एक तर्क होता है: नीलामी पूरी होने के बाद फ़ेच किया जाने वाला यूआरएल. इन्हें scoreAd() और generateBid(), दोनों में अलग-अलग यूआरएल आर्ग्युमेंट के साथ एक से ज़्यादा बार कॉल किया जा सकता है.

Chrome, किसी नीलामी के पूरा होने तक ही, डीबग नुकसान/विनिंग की रिपोर्ट भेजता है. अगर कोई नीलामी रद्द हो जाती है, तो कोई भी रिपोर्ट जनरेट नहीं होगी. उदाहरण के लिए, नए नेविगेशन की वजह से.

chrome://flags/#privacy-sandbox-ads-apis के चालू होने पर, Chrome में ये तरीके डिफ़ॉल्ट रूप से उपलब्ध होते हैं. हालांकि, अगर Protected Audience API को चालू करने के लिए, कमांड लाइन फ़्लैग के साथ Chrome का इस्तेमाल किया जा रहा है, तो आपको BiddingAndScoringDebugReportingAPI फ़्लैग शामिल करके इन तरीकों को साफ़ तौर पर चालू करना होगा. अगर फ़्लैग चालू नहीं है, तो तरीके अब भी उपलब्ध रहेंगे, लेकिन कोई कार्रवाई नहीं की जा सकेगी.

Protected Audience API के सभी रेफ़रंस

एपीआई रेफ़रंस गाइड उपलब्ध हैं:

Protected Audience API के बारे में जानकारी देने वाला टूल , सुविधाओं के इस्तेमाल और पाबंदियों के बारे में भी जानकारी देता है.

आगे क्या करना है?

हम आपके साथ मिलकर ऐसा एपीआई बनाना चाहते हैं जो सभी के काम आ सके.

एपीआई पर चर्चा करें

दूसरे प्राइवसी सैंडबॉक्स एपीआई की तरह, इस एपीआई को भी दस्तावेज़ के तौर पर दिखाया जाता है और सार्वजनिक तौर पर इस पर चर्चा की जाती है.

एपीआई के साथ प्रयोग करें

Protected Audience API के बारे में बातचीत में, एक्सपेरिमेंट किया जा सकता है और इसमें हिस्सा लिया जा सकता है.