क्रॉस-ऑरिजिन iframe के भीतर सहमति: __tcfapiLocator और __gppLocator पैटर्न
समस्या: सहमति टॉप विंडो में रहती है
CMP आपके पेज पर, टॉप-लेवल विंडो में चलता है। आपके विज्ञापन का बड़ा हिस्सा वहाँ नहीं चलता। डिस्प्ले क्रिएटिव, रिच मीडिया, हेडर बिडिंग रेंडरर और कई तृतीय-पक्ष विजेट iframe के भीतर चलते हैं, अक्सर किसी अन्य ऑरिजिन पर। क्रॉस-ऑरिजिन iframe का कोड पैरेंट पेज के किसी फ़ंक्शन को सीधे कॉल नहीं कर सकता, इसलिए वह सीधे __tcfapi या __gpp कॉल करके विज़िटर का चुनाव नहीं पढ़ सकता।
IAB फ़्रेमवर्क इसे एक छोटे, भलीभाँति परिभाषित मैसेजिंग नियम से हल करते हैं। अगर आप ऐसे ऐड प्रोडक्ट, एम्बेड या मापन स्क्रिप्ट बनाते हैं जो फ़्रेम में चलते हैं, या ऐसे ऐड स्टैक डीबग करते हैं, तो यह ठीक-ठीक जानना उपयोगी है कि यह कैसे काम करता है।
Locator फ़्रेम
JavaScript API के साथ-साथ, TCF CMP टॉप-लेवल पेज में __tcfapiLocator नाम का एक खाली, अदृश्य iframe जोड़ता है। GPP CMP यही __gppLocator नाम के फ़्रेम के साथ करता है। इन फ़्रेमों में कोई कंटेंट नहीं होता। इनका एकमात्र काम खोजे जाने योग्य होना है: किसी भी नेस्टेड फ़्रेम की कोई भी स्क्रिप्ट विंडो पदानुक्रम में ऊपर चढ़ सकती है और हर स्तर पर जाँच सकती है कि उस नाम का फ़्रेम मौजूद है या नहीं।
चूँकि फ़्रेम के नाम window.frames के ज़रिए ऑरिजिन के पार दिखाई देते हैं, गहराई से नेस्टेड क्रॉस-ऑरिजिन iframe की स्क्रिप्ट उस पेज की किसी और चीज़ तक पहुँच के बिना उस विंडो को खोज सकती है जो CMP को होस्ट करती है।
फ़्रेम्ड स्क्रिप्ट CMP को कैसे खोजती है
- वर्तमान विंडो से शुरू करें। अगर __tcfapi स्थानीय रूप से मौजूद है, तो उसे सीधे उपयोग करें — स्क्रिप्ट किसी फ़्रेम में नहीं है, या फ़्रेम CMP साझा करता है।
- अन्यथा ऊपर की ओर लूप चलाएँ: जाँचें कि क्या वर्तमान विंडो में __tcfapiLocator नाम का फ़्रेम है; अगर नहीं, तो window.parent पर जाएँ और फिर जाँचें, टॉप विंडो पर रुकते हुए।
- जब locator मिल जाए, तो जिस विंडो में वह है वही CMP की विंडो है। संचार अब postMessage के ज़रिए होता है।
हर एक्सेस को try/catch में लपेटें, क्योंकि कुछ ब्राउज़र या सैंडबॉक्सिंग सेटिंग क्रॉस-ऑरिजिन प्रॉपर्टी एक्सेस पर एरर फेंकती हैं, और जब window.parent वर्तमान विंडो के बराबर हो जाए तो लूप रोक दें।
संदेश का फ़ॉर्मैट
TCF के लिए, फ़्रेम्ड स्क्रिप्ट CMP विंडो को एक संदेश पोस्ट करती है जिसमें __tcfapiCall प्रॉपर्टी वाला एक ऑब्जेक्ट होता है। उसके भीतर चार फ़ील्ड हैं:
- command — उदाहरण के लिए getTCData, ping या addEventListener;
- parameter — कमांड को जो भी आर्ग्युमेंट चाहिए, या null;
- version — API संस्करण, TCF v2 के लिए 2;
- callId — कॉलर द्वारा बनाया गया अनूठा मान।
CMP इन संदेशों को सुनता है, कमांड चलाता है, और __tcfapiReturn प्रॉपर्टी वाला एक ऑब्जेक्ट वापस पोस्ट करता है जिसमें returnValue, success और वही callId होते हैं। कॉलर callId से कुंजीबद्ध लंबित callback का एक मैप रखता है, message इवेंट सुनता है, और हर रिटर्न को सही callback तक पहुँचाता है। GPP यही पैटर्न __gppCall और __gppReturn के साथ अपनाता है।
कई इंटीग्रेशन एक छोटा प्रॉक्सी लिखते हैं: फ़्रेम के भीतर __tcfapi नाम का स्थानीय फ़ंक्शन जो कॉल को संदेशों में बदलता है। टॉप विंडो के लिए लिखा कोड तब फ़्रेम के भीतर बिना बदलाव के काम करता है।
फ़्रेमों के पार इवेंट listener
postMessage के ज़रिए भेजा गया addEventListener कॉल एक बार का अनुरोध नहीं है। CMP हर बार सहमति स्थिति बदलने पर एक रिटर्न संदेश पोस्ट करेगा, सभी में वही callId होगा। इसलिए आपके dispatcher को उस callback को पहले उत्तर के बाद हटाने की जगह रजिस्टर्ड रखना होगा। यह भूलना एक क्लासिक बग है: फ़्रेम्ड स्क्रिप्ट सहमति एक बार पढ़ती है और बाद की वापसी को कभी नहीं जान पाती।
सुरक्षा संबंधी विचार
- संदेश का आकार सत्यापित करें। जिस संदेश में अपेक्षित प्रॉपर्टी न हो उसे अनदेखा करें, और स्ट्रिंग पेलोड को सावधानी से पार्स करें, क्योंकि कुछ इम्प्लीमेंटेशन ऑब्जेक्ट की जगह JSON स्ट्रिंग भेजते हैं।
- आँख मूँदकर भरोसा न करें। कोई भी पेज आपके फ़्रेम को संदेश पोस्ट कर सकता है। रिस्पॉन्स को सम्मान किए जाने वाले सहमति सिग्नल के रूप में लें, प्रमाणित डेटा के रूप में नहीं, और उन्हें कभी विशेषाधिकार वाली क्रियाएँ चालू न करने दें।
- जहाँ संभव हो विशिष्ट टार्गेट ऑरिजिन उपयोग करें। जब CMP का ऑरिजिन ज्ञात हो, तो हर ऑरिजिन की जगह उसी को पोस्ट करें।
जहाँ यह पैटर्न नहीं पहुँचता
कुछ ऐड वातावरण क्रिएटिव को अधिक सख़्ती से अलग रखते हैं। SafeFrame कंटेनर, सही अनुमतियों के बिना सैंडबॉक्स्ड iframe, और अलग दस्तावेज़ों में रेंडर हुए क्रिएटिव फ़्रेम ट्री पर चल नहीं पाते या संदेश नहीं पा सकते। ऐसे मामलों में सहमति सिग्नल को आमतौर पर स्पष्ट रूप से देना पड़ता है, उदाहरण के लिए विज्ञापन अनुरोध पर पैरामीटर के रूप में या ऐड सर्वर द्वारा क्रिएटिव को दिए गए मानों के रूप में, जैसे gdpr और gdpr_consent पैरामीटर जिन्हें कई ऐड टैग सपोर्ट करते हैं।
डीबगिंग चेकलिस्ट
- टॉप विंडो के DevTools में, Elements पैनल में पुष्टि करें कि locator फ़्रेम मौजूद हैं।
- कंसोल संदर्भ को iframe पर बदलें और जाँचें कि वहाँ से locator पहुँच में है या नहीं।
- दोनों विंडो में आने वाले message इवेंट लॉग करें ताकि पुष्टि हो कि कॉल और रिटर्न बह रहे हैं।
- बैनर में सहमति बदलें और सत्यापित करें कि फ़्रेम्ड listener को अपडेट मिलता है।
- CMP के देर से लोड होने के साथ परीक्षण करें, ताकि पक्का हो कि फ़्रेम्ड कोड तुरंत हार मानने की जगह दोबारा कोशिश करता है या प्रतीक्षा करता है।
मुख्य बातें
- क्रॉस-ऑरिजिन फ़्रेम __tcfapiLocator और __gppLocator फ़्रेमों के ज़रिए CMP तक पहुँचते हैं।
- कॉल और रिटर्न __tcfapiCall/__tcfapiReturn या GPP के समकक्षों के साथ postMessage का उपयोग करते हैं, जिन्हें callId से मिलाया जाता है।
- listener callback को रजिस्टर्ड रखें ताकि बाद के सहमति बदलाव पहुँचें।
- हर संदेश को सत्यापित करें और उसे भरोसेमंद इनपुट न मानें।
- जहाँ फ़्रेम पूरी तरह अलग हैं, वहाँ विज्ञापन अनुरोध पर सहमति स्पष्ट रूप से दें।