इस रेफ़रंस पेज में इंटरमीडिएट Iframe सपोर्ट JavaScript API के बारे में बताया गया है. इसकी मदद से, आने वाले UX में इंटरमीडिएट iframe में बदलाव किया जा सकता है.
बीच के iframe इस्तेमाल करने का तरीका जानने के लिए, Iframe का इस्तेमाल करके One Tap को इंटिग्रेट करें गाइड देखें.
नीचे दी गई टेबल में, सभी उपलब्ध तरीकों और उनके व्यवहार की सूची दी गई है.
| तरीके | |
|---|---|
verifyParentOrigin |
पैरंट ऑरिजिन की पुष्टि करता है |
notifyParentClose |
इससे पैरंट फ़्रेम को सूचना मिलती है कि One Tap UX फ़्लो छोड़ दिया गया है |
notifyParentDone |
One Tap UX फ़्लो के होने पर, पैरंट फ़्रेम को सूचना देता है |
notifyParentResize |
इंटरमीडिएट iframe का साइज़ बदलने के लिए, पैरंट फ़्रेम को सूचना देता है |
notifyParentTapOutsideMode |
यह सूचना पैरंट फ़्रेम को बताता है कि उपयोगकर्ता के इंटरमीडिएट iframe के बाहर क्लिक करने पर, इंटरमीडिएट iframe को रद्द करना है या नहीं |
इंटरमीडिएट Iframe सपोर्ट JavaScript लाइब्रेरी को लोड करें
नीचे दिए गए कोड स्निपेट को ऐसे किसी भी एचटीएमएल पेज में डालें जहां आपको इंटरमीडिएट iframe लोड करना है:
<script src="https://accounts.google.com/gsi/intermediatesupport"></script>
तरीका: google.accounts.id.intermediate.verifyParentOrigin
google.accounts.id.intermediate.verifyParentOrigin तरीका, पैरंट ऑरिजिन की पुष्टि करता है. तरीके का यह कोड उदाहरण देखें:
google.accounts.id.intermediate.verifyParentOrigin(
origins, verifiedCallback, verificationFailedCallback)
इस उदाहरण में बताया गया है कि पैरंट ऑरिजिन की पुष्टि होने के बाद ही यूज़र इंटरफ़ेस (यूआई) कैसे दिखाया जाए:
<script>
window.onload = () => {
google.accounts.id.intermediate.verifyParentOrigin(
"https://example.com", showUI, showError);
};
</script>
यहां दी गई टेबल में पैरामीटर की सूची दी गई है:
| पैरामीटर | |
|---|---|
origins |
वे ऑरिजिन जिन्हें इंटरमीडिएट iframe को एम्बेड करने की अनुमति है. |
verifiedCallback |
JavaScript कॉलबैक का तरीका तब ट्रिगर होता है, जब मौजूदा पैरंट ऑरिजिन को इंटरमीडिएट iframe को एम्बेड करने की अनुमति होती है. |
verificationFailedCallback |
JavaScript कॉलबैक तरीका तब ट्रिगर होता है, जब मौजूदा पैरंट ऑरिजिन को इंटरमीडिएट iframe को एम्बेड करने की अनुमति नहीं होती. |
ऑरिजिन
वे ऑरिजिन जिन्हें इंटरमीडिएट iframe को एम्बेड करने की अनुमति है. ज़्यादा जानकारी के लिए यह टेबल देखें:
| टाइप | ज़रूरी है | उदाहरण |
|---|---|---|
| स्ट्रिंग, स्ट्रिंग ऐरे या फ़ंक्शन | ज़रूरी नहीं | allowed_parent_origin: "https://example.com" |
यहां दी गई टेबल में, इस्तेमाल की जा सकने वाली वैल्यू टाइप और उनसे जुड़ी जानकारी दी गई है.
| वैल्यू टाइप | ||
|---|---|---|
string |
एक डोमेन यूआरआई. | "https://example.com" |
string array |
डोमेन यूआरआई की कैटगरी. | "https://news.example.com,https://local.example.com" |
पुष्टि किया गया कॉलबैक
यह फ़ील्ड JavaScript कॉलबैक का तरीका है, जो तब ट्रिगर होता है, जब मौजूदा पैरंट ऑरिजिन को इंटरमीडिएट iframe को एम्बेड करने की अनुमति होती है.
पुष्टि करने से जुड़ी गड़बड़ी
यह फ़ील्ड JavaScript कॉलबैक का तरीका है, जो तब ट्रिगर होता है, जब मौजूदा पैरंट ऑरिजिन को इंटरमीडिएट iframe को एम्बेड करने की अनुमति नहीं होती.
तरीका: google.accounts.id.intermediate.notifyParentClosed
जब One Tap UX फ़्लो को स्किप किया जाता है, तो google.accounts.id.intermediate.notifyParentClose तरीका,
इंटरमीडिएट iframe को बंद करने के लिए, पैरंट फ़्रेम को सूचना देता है. तरीके का यह कोड उदाहरण देखें:
google.accounts.id.intermediate.notifyParentClose()
तरीका: google.accounts.id.intermediate.notifyParentDone
google.accounts.id.intermediate.notifyParentClose तरीका, पैरंट फ़्रेम को इंटरमीडिएट iframe को बंद करने और लॉगिन स्टेटस को रीफ़्रेश करने के लिए सूचना देता है. तरीके का
नीचे दिया गया उदाहरण देखें:
google.accounts.id.intermediate.notifyParentDone()
तरीका: google.accounts.id.intermediate.notifyParentResize
google.accounts.id.intermediate.notifyParentResize तरीका, पैरंट फ़्रेम को इंटरमीडिएट iframe का साइज़ बदलने के लिए सूचना देता है. तरीके का यह उदाहरण देखें:
google.accounts.id.intermediate.notifyParentResize(height)
ऊंचाई
पिक्सल में नई ऊंचाई. यह अनिवार्य फ़ील्ड है. मान एक नॉन-नेगेटिव संख्या होनी चाहिए.
अगर ऊंचाई पैरामीटर 0 से ज़्यादा है, तो इंटरमीडिएट iframe को नई ऊंचाई पर सेट कर दिया जाता है. अगर लंबाई वाला पैरामीटर 0 है, तो इंटरमीडिएट iframe नहीं दिखेगा. छिपा हुआ iframe बंद नहीं है. इसे बाद में, साइज़ बदलने के किसी दूसरे तरीके के कॉल से दिखाया जा सकता है.
तरीका: google.accounts.id.intermediate.notifyParentTapOutsideMode
google.accounts.id.intermediate.notifyParentTapOutsideMode का तरीका, पैरंट फ़्रेम को सूचना देता है कि उपयोगकर्ता के इंटरमीडिएट iframe के बाहर क्लिक करने पर, इंटरमीडिएट iframe को रद्द करना है या नहीं. तरीके का यह कोड उदाहरण देखें:
google.accounts.id.intermediate.notifyParentTapOutsideMode(cancel)
अभी नहीं
यह ज़रूरी बूलियन वैल्यू यह बताती है कि जब उपयोगकर्ता, इंटरमीडिएट iframe के बाहर क्लिक करता है, तो इंटरमीडिएट iframe को रद्द करना है या नहीं.