इस रेफ़रंस पेज पर, इंटरमीडिएट iframe के साथ काम करने वाले JavaScript API के बारे में बताया गया है. One Tap, बाद के यूएक्स में इंटरमीडिएट 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 को एम्बेड करने की अनुमति नहीं होती. |
origins
ऐसे ऑरिजिन जिन्हें इंटरमीडिएट 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
google.accounts.id.intermediate.notifyParentClose तरीका, पैरंट फ़्रेम को इंटरमीडिएट iframe बंद करने की सूचना देता है. ऐसा तब होता है, जब One Tap उपयोगकर्ता अनुभव फ़्लो को स्किप कर दिया जाता है. इस तरीके के लिए, यहां दिया गया कोड देखें:
google.accounts.id.intermediate.notifyParentClose()
मेथड: google.accounts.id.intermediate.notifyParentDone
google.accounts.id.intermediate.notifyParentDone तरीका, पैरंट फ़्रेम को इंटरमीडिएट 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 को रद्द करना है या नहीं.