इस रेफ़रंस पेज में, Intermediate iframe Support JavaScript API के बारे में बताया गया है. इसका इस्तेमाल One Tap, बाद के यूज़र एक्सपीरियंस (यूएक्स) में इंटरमीडिएट iframe में बदलाव करने के लिए करता है.
इंटरमीडिएट iframe इस्तेमाल करने का तरीका जानने के लिए, iframe का इस्तेमाल करके 'एक टैप से साइन इन करें' सुविधा को इंटिग्रेट करना गाइड देखें.
इस टेबल में, सभी उपलब्ध तरीकों और उनके काम करने के तरीके के बारे में बताया गया है.
| तरीके | |
|---|---|
verifyParentOrigin |
यह कुकी, पैरंट ऑरिजिन की पुष्टि करती है |
notifyParentClose |
यह पैरंट फ़्रेम को सूचना देता है कि One Tap UX फ़्लो को छोड़ दिया गया है |
notifyParentDone |
यह कुकी, पैरंट फ़्रेम को सूचना देती है कि 'एक टैप करके साइन इन करें' सुविधा का UX फ़्लो पूरा हो गया है |
notifyParentResize |
यह कुकी, पैरंट फ़्रेम को सूचना देती है कि इंटरमीडिएट iframe का साइज़ बदला गया है |
notifyParentTapOutsideMode |
यह कुकी, पैरंट फ़्रेम को सूचना देती है कि जब उपयोगकर्ता इंटरमीडिएट iframe के बाहर क्लिक करता है, तो इंटरमीडिएट iframe को रद्द करना है या नहीं |
Intermediate Iframe Support JavaScript Library लोड करना
इस कोड स्निपेट को उन एचटीएमएल पेजों में शामिल करें जहां आपको इंटरमीडिएट 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" |
verifiedCallback
यह फ़ील्ड, JavaScript का कॉलबैक तरीका है. यह तब ट्रिगर होता है, जब मौजूदा पैरंट ऑरिजिन को इंटरमीडिएट iframe एम्बेड करने की अनुमति होती है.
verificationFailedCallback
यह फ़ील्ड, JavaScript कॉलबैक का एक तरीका है. यह तब ट्रिगर होता है, जब मौजूदा पैरंट ऑरिजिन को इंटरमीडिएट iframe एम्बेड करने की अनुमति नहीं होती.
तरीका: google.accounts.id.intermediate.notifyParentClose
जब 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 को रद्द करना है या नहीं.