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 की दो रिपोर्ट उपलब्ध हैं:

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

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

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

सेलर: reportResult()

नीलामी के नतीजे की जानकारी देने के लिए, सेलर के JavaScript में decisionLogicUrl में दिया गया reportResult() फ़ंक्शन शामिल किया जा सकता है. decisionLogicUrl में 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>
  }

इस फ़ंक्शन से मिली वैल्यू का इस्तेमाल, नीलामी जीतने वाले बिडर के sellerSignals फ़ंक्शन के 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 में कुछ समय के लिए दो तरीके उपलब्ध हैं:

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

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

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

chrome://settings/adPrivacy में जाकर, विज्ञापन देखने वाले की निजता बनाए रखने से जुड़े सभी एपीआई चालू करने पर, ये तरीके Chrome में डिफ़ॉल्ट रूप से उपलब्ध होते हैं. अगर Protected Audience API को चालू करने के लिए, Chrome को कमांड लाइन फ़्लैग के साथ चलाया जा रहा है, तो आपको 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.

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

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

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

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

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

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