'Google से साइन इन करें' JavaScript API का रेफ़रंस

इस रेफ़रंस पेज पर, Sign-In JavaScript API के बारे में बताया गया है. अपने वेब पेजों पर One Tap प्रॉम्प्ट या 'Google से साइन इन करें' बटन दिखाने के लिए, इस एपीआई का इस्तेमाल किया जा सकता है.

तरीका: google.accounts.id.initialize

google.accounts.id.initialize तरीका, कॉन्फ़िगरेशन ऑब्जेक्ट के आधार पर, 'Google से साइन इन करें' क्लाइंट को शुरू करता है. इस तरीके का कोड उदाहरण देखें:

google.accounts.id.initialize(IdConfiguration)

यहां दिए गए कोड के उदाहरण में, onload फ़ंक्शन के साथ google.accounts.id.initialize तरीका लागू किया गया है:

<script>
  window.onload = function () {
    google.accounts.id.initialize({
      client_id: 'YOUR_GOOGLE_CLIENT_ID',
      callback: handleCredentialResponse
    });
    google.accounts.id.prompt();
  };
</script>

google.accounts.id.initialize तरीका, 'Google से साइन इन करें' क्लाइंट का एक इंस्टेंस बनाता है. इसका इस्तेमाल, एक ही वेब पेज के सभी मॉड्यूल में किया जा सकता है.

• आपको google.accounts.id.initialize तरीके को सिर्फ़ एक बार कॉल करना होगा. भले ही, एक ही वेब पेज पर एक से ज़्यादा मॉड्यूल (जैसे, One Tap, मनमुताबिक बटन, रद्द करना वगैरह) का इस्तेमाल किया जा रहा हो.
• अगर google.accounts.id.initialize तरीके को कई बार कॉल किया जाता है, तो सिर्फ़ आखिरी कॉल में किए गए कॉन्फ़िगरेशन को याद रखा जाता है और उनका इस्तेमाल किया जाता है.

जब भी google.accounts.id.initialize तरीके को कॉल किया जाता है, तो कॉन्फ़िगरेशन रीसेट हो जाते हैं. साथ ही, उसी वेब पेज पर मौजूद सभी बाद के तरीके, नए कॉन्फ़िगरेशन का तुरंत इस्तेमाल करते हैं.

डेटा टाइप: IdConfiguration

नीचे दी गई टेबल में, IdConfiguration डेटा टाइप के फ़ील्ड और उनके ब्यौरे दिए गए हैं:

फ़ील्ड
client_id	आपके ऐप्लिकेशन का क्लाइंट आईडी
auto_select	अपने-आप चुनने की सुविधा चालू होती है.
callback	आईडी टोकन को मैनेज करने वाला JavaScript फ़ंक्शन. Google One Tap और 'Google से साइन इन करें' बटन popup यूज़र एक्सपीरियंस (यूएक्स) मोड, इस एट्रिब्यूट का इस्तेमाल करता है.
login_uri	आपके लॉगिन एंडपॉइंट का यूआरएल. 'Google से साइन इन करें' बटन redirect यूज़र एक्सपीरियंस (UX) मोड इस एट्रिब्यूट का इस्तेमाल करता है.
native_callback	JavaScript फ़ंक्शन, जो पासवर्ड क्रेडेंशियल को मैनेज करता है.
cancel_on_tap_outside	अगर उपयोगकर्ता प्रॉम्प्ट के बाहर क्लिक करता है, तो प्रॉम्प्ट रद्द हो जाता है.
prompt_parent_id	One Tap प्रॉम्प्ट कंटेनर एलिमेंट का डीओएम आईडी
nonce	आईडी टोकन के लिए रैंडम स्ट्रिंग
context	One Tap प्रॉम्प्ट में मौजूद टाइटल और शब्द
state_cookie_domain	अगर आपको पैरंट डोमेन और उसके सबडोमेन में One Tap को कॉल करना है, तो पैरंट डोमेन को इस फ़ील्ड में पास करें, ताकि एक ही शेयर की गई कुकी का इस्तेमाल किया जा सके.
ux_mode	'Google से साइन इन करें' बटन का यूज़र एक्सपीरियंस (UX) फ़्लो
allowed_parent_origin	वे ऑरिजिन जिन्हें इंटरमीडियरी iframe को एम्बेड करने की अनुमति है. अगर यह फ़ील्ड मौजूद है, तो One Tap इंटरमीडियरी iframe मोड में चलता है.
intermediate_iframe_close_callback	जब उपयोगकर्ता मैन्युअल तरीके से One Tap को बंद करते हैं, तो यह इंटरमीडिएट iframe के डिफ़ॉल्ट व्यवहार को बदल देता है.
itp_support	ITP ब्राउज़र पर, One Tap के बेहतर यूज़र एक्सपीरियंस की सुविधा चालू करता है.
login_hint	उपयोगकर्ता को हिंट देकर, खाता चुनने की प्रोसेस को छोड़ें.
hd	डोमेन के हिसाब से खाता चुनने की सुविधा सीमित करें.
use_fedcm_for_prompt	ब्राउज़र को उपयोगकर्ता के साइन इन प्रॉम्प्ट को कंट्रोल करने की अनुमति दें. साथ ही, अपनी वेबसाइट और Google के बीच साइन इन फ़्लो को मध्यस्थता करने की अनुमति दें.
enable_redirect_uri_validation	बटन रीडायरेक्ट फ़्लो को चालू करें, जो रीडायरेक्ट यूआरआई की पुष्टि करने के नियमों का पालन करता हो.

client_id

यह फ़ील्ड आपके ऐप्लिकेशन का क्लाइंट आईडी होता है. यह Google Cloud Console में मिलता है और बनाया जाता है. ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	हां	client_id: "CLIENT_ID.apps.googleusercontent.com"

auto_select

इस फ़ील्ड से यह तय होता है कि अगर आपके ऐप्लिकेशन को पहले ही किसी Google सेशन से अनुमति मिली है, तो उपयोगकर्ता के इंटरैक्शन के बिना आईडी टोकन अपने-आप वापस आएगा या नहीं. डिफ़ॉल्ट वैल्यू false है. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
बूलियन	वैकल्पिक	auto_select: true

कॉलबैक

यह फ़ील्ड, JavaScript फ़ंक्शन है. यह One Tap प्रॉम्प्ट या पॉप-अप विंडो से मिले आईडी टोकन को हैंडल करता है. अगर Google One Tap या 'Google से साइन इन करें' बटन popup के यूज़र इंटरफ़ेस (यूएक्स) मोड का इस्तेमाल किया जाता है, तो यह एट्रिब्यूट ज़रूरी है. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
फ़ंक्शन	One Tap और popup यूज़र एक्सपीरियंस (यूएक्स) मोड के लिए ज़रूरी है	callback: handleResponse

login_uri

यह एट्रिब्यूट, आपके लॉगिन एंडपॉइंट का यूआरआई होता है.

यह वैल्यू, OAuth 2.0 क्लाइंट के लिए अनुमति वाले किसी एक रीडायरेक्ट यूआरआई से पूरी तरह मेल खानी चाहिए. इस क्लाइंट को आपने Google Cloud Console में कॉन्फ़िगर किया है. साथ ही, यह वैल्यू रीडायरेक्ट यूआरआई की पुष्टि करने के हमारे नियमों के मुताबिक होनी चाहिए.

अगर मौजूदा पेज आपका लॉगिन पेज है, तो इस एट्रिब्यूट को छोड़ा जा सकता है. ऐसे में, क्रेडेंशियल डिफ़ॉल्ट रूप से इस पेज पर पोस्ट हो जाते हैं.

जब कोई उपयोगकर्ता 'Google से साइन इन करें' बटन पर क्लिक करता है और रीडायरेक्ट यूज़र इंटरफ़ेस (यूआई) मोड का इस्तेमाल किया जाता है, तो आईडी टोकन क्रेडेंशियल का रिस्पॉन्स आपके लॉगिन एंडपॉइंट पर पोस्ट किया जाता है.

ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	वैकल्पिक	उदाहरण
URL	डिफ़ॉल्ट रूप से, यह मौजूदा पेज के यूआरआई या आपकी बताई गई वैल्यू पर सेट होता है. इसका इस्तेमाल सिर्फ़ तब किया जाता है, जब ux_mode: "redirect" सेट हो.	login_uri: "https://www.example.com/login"

आपके लॉगिन एंडपॉइंट को ऐसे पोस्ट अनुरोधों को मैनेज करना चाहिए जिनमें बॉडी में आईडी टोकन वैल्यू के साथ credential कुंजी हो.

आपके लॉगिन एंडपॉइंट के लिए अनुरोध का एक उदाहरण यहां दिया गया है:

POST /login HTTP/1.1
Host: www.example.com
Content-Type: application/x-www-form-urlencoded

credential=ID_TOKEN

पर जवाब अपने-आप सबमिट करना है, तो एचटीएमएल एपीआई आज़माएं.

native_callback

यह फ़ील्ड, JavaScript फ़ंक्शन का नाम होता है. यह फ़ंक्शन, ब्राउज़र के नेटिव क्रेडेंशियल मैनेजर से मिले पासवर्ड क्रेडेंशियल को मैनेज करता है. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
फ़ंक्शन	वैकल्पिक	native_callback: handleResponse

cancel_on_tap_outside

इस फ़ील्ड से यह तय होता है कि अगर कोई उपयोगकर्ता प्रॉम्प्ट के बाहर क्लिक करता है, तो एक-टैप अनुरोध रद्द किया जाए या नहीं. डिफ़ॉल्ट वैल्यू true है. वैल्यू को false पर सेट करके, इसे बंद किया जा सकता है. ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
बूलियन	वैकल्पिक	cancel_on_tap_outside: false

prompt_parent_id

यह एट्रिब्यूट, कंटेनर एलिमेंट का डीओएम आईडी सेट करता है. अगर यह सेट नहीं है, तो विंडो के सबसे ऊपर दाएं कोने में, एक टैप वाला प्रॉम्प्ट दिखेगा. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	prompt_parent_id: 'parent_id'

नॉन्स

यह फ़ील्ड एक रैंडम स्ट्रिंग है. इसका इस्तेमाल आईडी टोकन, रीप्ले अटैक को रोकने के लिए करता है. ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	nonce: "biaqbm70g23"

नॉन्स की लंबाई, आपके एनवायरमेंट में काम करने वाले ज़्यादा से ज़्यादा JWT साइज़ और अलग-अलग ब्राउज़र और सर्वर एचटीटीपी साइज़ की सीमाओं तक सीमित होती है.

कॉन्टेक्स्ट

यह फ़ील्ड, 'एक टैप' प्रॉम्प्ट में टाइटल और मैसेज का टेक्स्ट बदलता है. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	context: "use"

यहां दी गई टेबल में, उपलब्ध सभी कॉन्टेक्स्ट और उनके ब्यौरे दिए गए हैं:

संदर्भ
signin	"Google से साइन इन करें"
signup	"Google से साइन अप करें"
use	"Google के साथ इस्तेमाल करें"

state_cookie_domain

अगर आपको पैरंट डोमेन और उसके सबडोमेन में One Tap दिखाना है, तो पैरंट डोमेन को इस फ़ील्ड में पास करें, ताकि एक ही शेयर की गई स्थिति वाली कुकी का इस्तेमाल किया जा सके. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	state_cookie_domain: "example.com"

ux_mode

'Google से साइन इन करें' बटन का इस्तेमाल करने वाले यूज़र एक्सपीरियंस (UX) फ़्लो को सेट करने के लिए, इस फ़ील्ड का इस्तेमाल करें. डिफ़ॉल्ट वैल्यू popup है. इस एट्रिब्यूट का, OneTap यूज़र एक्सपीरियंस पर कोई असर नहीं पड़ता. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	ux_mode: "redirect"

यहां दी गई टेबल में, यूज़र एक्सपीरियंस (यूएक्स) के उपलब्ध मोड और उनके ब्यौरे दिए गए हैं.

यूज़र एक्सपीरियंस (यूएक्स) मोड
popup	पॉप-अप विंडो में साइन-इन यूज़र एक्सपीरियंस (यूएक्स) फ़्लो को पूरा करता है.
redirect	पूरे पेज को रीडायरेक्ट करके, साइन इन यूज़र एक्सपीरियंस फ़्लो को पूरा करता है.

allowed_parent_origin

वे ऑरिजिन जिन्हें इंटरमीडियरी iframe को एम्बेड करने की अनुमति है. अगर यह फ़ील्ड मौजूद है, तो One Tap, इंटरमीडिएट iframe मोड में चलता है. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग या स्ट्रिंग ऐरे	वैकल्पिक	allowed_parent_origin: "https://example.com"

यहां दी गई टेबल में, इस्तेमाल की जा सकने वाली वैल्यू टाइप और उनके ब्यौरे दिए गए हैं.

वैल्यू टाइप
string	एक डोमेन का यूआरआई.	"https://example.com"
string array	डोमेन यूआरआई का कलेक्शन.	["https://news.example.com", "https://local.example.com"]

वाइल्डकार्ड प्रीफ़िक्स भी काम करते हैं. उदाहरण के लिए, "https://*.example.com" सभी लेवल पर example.com और उसके सबडोमेन से मैच करता है.जैसे, news.example.com, login.news.example.com. वाइल्डकार्ड का इस्तेमाल करते समय इन बातों का ध्यान रखें:

• पैटर्न स्ट्रिंग में सिर्फ़ वाइल्डकार्ड और टॉप लेवल डोमेन शामिल नहीं हो सकते. उदाहरण के लिए, https://.com और https://.co.uk अमान्य हैं. जैसा कि ऊपर बताया गया है, "https://.example.com" example.com और उसके सबडोमेन से मेल खाता है. दो अलग-अलग डोमेन दिखाने के लिए, ऐरे का इस्तेमाल भी किया जा सकता है. उदाहरण के लिए, ["https://example1.com", "https://.example2.com"], example1.com, example2.com, और example2.com के सबडोमेन वाले डोमेन से मैच करता है
• वाइल्डकार्ड डोमेन, सुरक्षित https:// स्कीम से शुरू होने चाहिए. इसलिए, "*.example.com" को अमान्य माना जाता है.

अगर allowed_parent_origin फ़ील्ड की वैल्यू अमान्य है, तो इंटरमीडिएट iframe मोड का One Tap शुरू नहीं हो पाएगा और रुक जाएगा.

intermediate_iframe_close_callback

जब उपयोगकर्ता One Tap के यूज़र इंटरफ़ेस (यूआई) में 'X' बटन पर टैप करके, One Tap को मैन्युअल तरीके से बंद करते हैं, तो यह इंटरमीडिएट iframe के डिफ़ॉल्ट व्यवहार को बदल देता है. डिफ़ॉल्ट रूप से, इंटरमीडियरी iframe को तुरंत DOM से हटा दिया जाता है.

intermediate_iframe_close_callback फ़ील्ड सिर्फ़ इंटरमीडिएट इंटरफ़्रेम मोड में लागू होता है. साथ ही, इसका असर सिर्फ़ One Tap iframe के बजाय, इंटरमीडिएट iframe पर पड़ता है. कॉलबैक शुरू होने से पहले, One Tap का यूज़र इंटरफ़ेस हटा दिया जाता है.

टाइप	ज़रूरी है	उदाहरण
फ़ंक्शन	वैकल्पिक	intermediate_iframe_close_callback: logBeforeClose

itp_support

इस फ़ील्ड से यह तय होता है कि इंटेलिजेंट ट्रैकिंग प्रिवेंशन (आईटीपी) की सुविधा वाले ब्राउज़र पर, एक टैप वाले अपग्रेड किए गए यूज़र इंटरफ़ेस (यूएक्स) को चालू किया जाना चाहिए या नहीं. डिफ़ॉल्ट वैल्यू false है. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
बूलियन	वैकल्पिक	itp_support: true

login_hint

अगर आपके ऐप्लिकेशन को पहले से पता है कि किस उपयोगकर्ता को साइन इन करना है, तो वह Google को लॉगिन करने का संकेत दे सकता है. खाता चुनने की प्रोसेस पूरी होने पर, खाता चुनने का विकल्प स्किप कर दिया जाता है. स्वीकार की जाने वाली वैल्यू: ईमेल पता या आईडी टोकन sub फ़ील्ड की वैल्यू.

ज़्यादा जानकारी के लिए, OpenID Connect के दस्तावेज़ में login_hint फ़ील्ड देखें.

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग, ईमेल पता या आईडी टोकन sub फ़ील्ड की वैल्यू.	वैकल्पिक	login_hint: 'elisa.beckett@gmail.com'

hd

जब किसी उपयोगकर्ता के पास एक से ज़्यादा खाते हों और उसे सिर्फ़ अपने Workspace खाते से साइन-इन करना हो, तो Google को डोमेन नेम का हिंट देने के लिए इसका इस्तेमाल करें. खाता चुनने के दौरान दिखाए गए उपयोगकर्ता खाते, दिए गए डोमेन तक सीमित होते हैं. वाइल्डकार्ड वैल्यू: *, उपयोगकर्ता को सिर्फ़ Workspace खाते दिखाता है. साथ ही, खाता चुनने के दौरान, उपभोक्ता खातों (user@gmail.com) को बाहर रखता है.

ज़्यादा जानकारी के लिए, OpenID Connect के दस्तावेज़ में hd फ़ील्ड देखें.

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग. कोई पूरी तरह क्वालिफ़ाइड डोमेन नेम या *.	वैकल्पिक	hd: '*'

use_fedcm_for_prompt

ब्राउज़र को उपयोगकर्ता के साइन इन प्रॉम्प्ट को कंट्रोल करने की अनुमति दें. साथ ही, अपनी वेबसाइट और Google के बीच साइन इन फ़्लो को मध्यस्थता दें. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होती है. ज़्यादा जानकारी के लिए, FedCM पर माइग्रेट करना पेज देखें.

टाइप	ज़रूरी है	उदाहरण
बूलियन	वैकल्पिक	use_fedcm_for_prompt: true

enable_redirect_uri_validation

रीडायरेक्ट यूआरआई की पुष्टि करने के नियमों का पालन करने वाला बटन रीडायरेक्ट फ़्लो चालू करें.

टाइप	ज़रूरी है	उदाहरण
बूलियन	वैकल्पिक	enable_redirect_uri_validation: true

तरीका: google.accounts.id.prompt

google.accounts.id.prompt तरीका, initialize() तरीका इस्तेमाल करने के बाद, One Tap प्रॉम्प्ट या ब्राउज़र के नेटिव क्रेडेंशियल मैनेजर को दिखाता है. इस तरीके का कोड उदाहरण यहां देखें:

 google.accounts.id.prompt(/**
 @type{(function(!PromptMomentNotification):void)=} */ momentListener)

आम तौर पर, prompt() तरीके को पेज लोड होने पर कॉल किया जाता है. Google की ओर से सेशन की स्थिति और उपयोगकर्ता सेटिंग की वजह से, हो सकता है कि One Tap प्रॉम्प्ट का यूज़र इंटरफ़ेस (यूआई) न दिखे. अलग-अलग पलों के लिए यूज़र इंटरफ़ेस (यूआई) के स्टेटस की सूचना पाने के लिए, यूआई के स्टेटस की सूचनाएं पाने के लिए कोई फ़ंक्शन पास करें.

सूचनाएं इन स्थितियों में भेजी जाती हैं:

• डिसप्ले मोमेंट: यह prompt() तरीके को कॉल करने के बाद होता है. सूचना में एक बूलियन वैल्यू होती है, जिससे यह पता चलता है कि यूज़र इंटरफ़ेस दिख रहा है या नहीं.

• छोटा हुआ पल: ऐसा तब होता है, जब One Tap प्रॉम्प्ट अपने-आप रद्द हो जाता है, मैन्युअल तरीके से रद्द कर दिया जाता है या Google क्रेडेंशियल जारी नहीं कर पाता. जैसे, चुने गए सेशन से Google से साइन आउट हो गया हो.

  ऐसे मामलों में, हमारा सुझाव है कि आप पहचान की पुष्टि करने वाली किसी दूसरी सेवा का इस्तेमाल करें.

• खारिज किया गया पल: ऐसा तब होता है, जब Google किसी क्रेडेंशियल को ऐक्सेस कर लेता है या उपयोगकर्ता क्रेडेंशियल ऐक्सेस करने के फ़्लो को रोकना चाहता है. उदाहरण के लिए, जब उपयोगकर्ता आपके लॉगिन डायलॉग में अपना उपयोगकर्ता नाम और पासवर्ड डालना शुरू करता है, तो google.accounts.id.cancel() तरीके का इस्तेमाल करके, One Tap प्रॉम्प्ट को बंद किया जा सकता है और खारिज किए गए पल को ट्रिगर किया जा सकता है.

यहां दिए गए कोड के उदाहरण में, स्किप किए गए हिस्से को लागू किया गया है:

<script>
  window.onload = function () {
    google.accounts.id.initialize(...);
    google.accounts.id.prompt((notification) => {
      if (notification.isNotDisplayed() || notification.isSkippedMoment()) {
        // continue with another identity provider.
      }
    });
  };
</script>

डेटा टाइप: PromptMomentNotification

यहां दी गई टेबल में, PromptMomentNotification डेटा टाइप के तरीकों और ब्यौरे की सूची दी गई है:

तरीका
isDisplayMoment()	क्या यह सूचना किसी डिसप्ले मोमेंट के लिए है? ध्यान दें: जब FedCM चालू होता है, तो यह सूचना नहीं भेजी जाती. ज़्यादा जानकारी के लिए, FedCM पर माइग्रेट करना पेज देखें.
isDisplayed()	क्या यह सूचना किसी डिसप्ले मोमेंट के लिए है और यूज़र इंटरफ़ेस (यूआई) दिखाया गया है? ध्यान दें: जब FedCM चालू होता है, तो यह सूचना नहीं भेजी जाती. ज़्यादा जानकारी के लिए, FedCM पर माइग्रेट करना पेज देखें.
isNotDisplayed()	क्या यह सूचना किसी डिसप्ले मोमेंट के लिए है और यूज़र इंटरफ़ेस (यूआई) नहीं दिख रहा है? ध्यान दें: जब FedCM चालू होता है, तो यह सूचना नहीं भेजी जाती. ज़्यादा जानकारी के लिए, FedCM पर माइग्रेट करना पेज देखें.
getNotDisplayedReason()	यूज़र इंटरफ़ेस (यूआई) न दिखने की पूरी वजह. इस एट्रिब्यूट की ये वैल्यू हो सकती हैं: browser_not_supported invalid_client missing_client_id opt_out_or_no_session secure_http_required suppressed_by_user unregistered_origin unknown_reason ध्यान दें: अगर FedCM की सुविधा चालू है, तो यह तरीका काम नहीं करता. ज़्यादा जानकारी के लिए, FedCM पर माइग्रेट करना पेज देखें.
isSkippedMoment()	क्या यह सूचना, स्किप किए गए पल के लिए है?
getSkippedReason()	स्किप किए गए हिस्से की पूरी वजह. इस एट्रिब्यूट की ये वैल्यू हो सकती हैं: auto_cancel user_cancel tap_outside issuing_failed ध्यान दें: अगर FedCM की सुविधा चालू है, तो यह तरीका काम नहीं करता. ज़्यादा जानकारी के लिए, FedCM पर माइग्रेट करना पेज देखें.
isDismissedMoment()	क्या यह सूचना, खारिज किए गए किसी पल के लिए है?
getDismissedReason()	खारिज किए जाने की पूरी वजह. ये वैल्यू हो सकती हैं credential_returned cancel_called flow_restarted
getMomentType()	पल के टाइप के लिए स्ट्रिंग दिखाता है. ये वैल्यू हो सकती हैं हैं: display skipped dismissed

डेटा टाइप: CredentialResponse

जब आपका callback फ़ंक्शन शुरू किया जाता है, तो पैरामीटर के तौर पर एक CredentialResponse ऑब्जेक्ट पास किया जाता है. नीचे दी गई टेबल में, क्रेडेंशियल रिस्पॉन्स ऑब्जेक्ट में मौजूद फ़ील्ड की सूची दी गई है:

फ़ील्ड
credential	यह फ़ील्ड, आईडी टोकन दिखाता है.
select_by	इस फ़ील्ड से यह तय होता है कि क्रेडेंशियल कैसे चुना जाए.
state	यह फ़ील्ड सिर्फ़ तब तय किया जाता है, जब उपयोगकर्ता साइन इन करने के लिए, 'Google से साइन इन करें' बटन पर क्लिक करता है और बटन का state एट्रिब्यूट तय किया जाता है.

क्रेडेंशियल

यह फ़ील्ड, base64-एन्कोड किए गए JSON वेब टोकन (JWT) की स्ट्रिंग के तौर पर आईडी टोकन है.

डिकोड करने पर, JWT कुछ ऐसा दिखता है:

header
{
  "alg": "RS256",
  "kid": "f05415b13acb9590f70df862765c655f5a7a019e", // JWT signature
  "typ": "JWT"
}
payload
{
  "iss": "https://accounts.google.com", // The JWT's issuer
  "nbf":  161803398874,
  "aud": "314159265-pi.apps.googleusercontent.com", // Your server's client ID
  "sub": "3141592653589793238", // The unique ID of the user's Google Account
  "hd": "gmail.com", // If present, the host domain of the user's GSuite email address
  "email": "elisa.g.beckett@gmail.com", // The user's email address
  "email_verified": true, // true, if Google has verified the email address
  "azp": "314159265-pi.apps.googleusercontent.com",
  "name": "Elisa Beckett",
                            // If present, a URL to user's profile picture
  "picture": "https://lh3.googleusercontent.com/a-/e2718281828459045235360uler",
  "given_name": "Elisa",
  "family_name": "Beckett",
  "iat": 1596474000, // Unix timestamp of the assertion's creation time
  "exp": 1596477600, // Unix timestamp of the assertion's expiration time
  "jti": "abc161803398874def"
}

sub फ़ील्ड, Google खाते के लिए दुनिया भर में यूनीक आइडेंटिफ़ायर होता है. उपयोगकर्ता के आइडेंटिफ़ायर के तौर पर, sub फ़ील्ड का सिर्फ़ इस्तेमाल करें. ऐसा इसलिए, क्योंकि यह सभी Google खातों में यूनीक होता है और इसका दोबारा इस्तेमाल नहीं किया जाता. ईमेल पते को आइडेंटिफ़ायर के तौर पर इस्तेमाल न करें, क्योंकि किसी Google खाते में अलग-अलग समय पर कई ईमेल पते हो सकते हैं.

email, email_verified, और hd फ़ील्ड का इस्तेमाल करके, यह पता लगाया जा सकता है कि Google किसी ईमेल पते को होस्ट करता है या नहीं और उस पर अधिकार रखता है या नहीं. जिन मामलों में Google के पास आधिकारिक अधिकार होता है, उनमें उपयोगकर्ता के खाते के मालिक होने की पुष्टि की जाती है.

ऐसे मामले जिनमें Google आधिकारिक है:

• email में @gmail.com सफ़िक्स है, तो यह Gmail खाता है.
• email_verified सही है और hd सेट है, तो यह Google Workspace खाता है.

उपयोगकर्ता, Gmail या Google Workspace का इस्तेमाल किए बिना भी Google खातों के लिए रजिस्टर कर सकते हैं. जब email में @gmail.com सफ़िक्स नहीं होता और hd मौजूद नहीं होता, तो Google के पास पुष्टि करने का अधिकार नहीं होता. साथ ही, उपयोगकर्ता की पुष्टि करने के लिए, पासवर्ड या चैलेंज के अन्य तरीकों का सुझाव दिया जाता है. email_verfied भी सही हो सकता है, क्योंकि Google खाता बनाते समय Google ने उपयोगकर्ता की पुष्टि की थी. हालांकि, हो सकता है कि तीसरे पक्ष के ईमेल खाते का मालिकाना हक तब से बदल गया हो.

exp फ़ील्ड में, टोकन की समयसीमा खत्म होने का समय दिखता है. इसकी मदद से, आपके सर्वर साइड पर टोकन की पुष्टि की जा सकती है. 'Google से साइन इन करें' सुविधा से मिले आईडी टोकन के लिए, यह अवधि एक घंटे की होती है. समयसीमा खत्म होने से पहले, आपको टोकन की पुष्टि करनी होगी. सेशन मैनेजमेंट के लिए exp का इस्तेमाल न करें. आईडी टोकन की समयसीमा खत्म होने का मतलब यह नहीं है कि उपयोगकर्ता ने साइन आउट कर दिया है. आपके उपयोगकर्ताओं के सेशन को मैनेज करने की ज़िम्मेदारी आपके ऐप्लिकेशन की है.

select_by

नीचे दी गई टेबल में, select_by फ़ील्ड की संभावित वैल्यू दी गई हैं. वैल्यू सेट करने के लिए, सेशन और सहमति की स्थिति के साथ इस्तेमाल किए गए बटन के टाइप का इस्तेमाल किया जाता है,

• उपयोगकर्ता ने One Tap या 'Google से साइन इन करें' बटन दबाया हो या फिर टच किए बिना अपने-आप साइन इन होने की सुविधा का इस्तेमाल किया हो.

• कोई मौजूदा सेशन मिला या उपयोगकर्ता ने नया सेशन शुरू करने के लिए, किसी Google खाते को चुना और उसमें साइन इन किया.

• आपके ऐप्लिकेशन के साथ आईडी टोकन के क्रेडेंशियल शेयर करने से पहले, उपयोगकर्ता या तो

  • क्रेडेंशियल शेयर करने की सहमति देने के लिए, 'पुष्टि करें' बटन दबाया हो या
  • ने पहले ही सहमति दी हो और Google खाता चुनने के लिए, 'खाता चुनें' का इस्तेमाल किया हो.

इस फ़ील्ड की वैल्यू इनमें से किसी एक टाइप पर सेट होती है,

मान	ब्यौरा
auto	किसी ऐसे उपयोगकर्ता का अपने-आप साइन इन होना जिसका मौजूदा सेशन है और जिसने पहले क्रेडेंशियल शेयर करने की सहमति दी है. यह सिर्फ़ उन ब्राउज़र पर लागू होता है जिन पर FedCM काम नहीं करता.
user	किसी मौजूदा सेशन में मौजूद उपयोगकर्ता ने पहले ही सहमति दी हो और वह क्रेडेंशियल शेयर करने के लिए, One Tap 'इसी तौर पर जारी रखें' बटन दबाया हो. यह सिर्फ़ उन ब्राउज़र पर लागू होता है जिन पर FedCM काम नहीं करता.
fedcm	उपयोगकर्ता ने FedCM का इस्तेमाल करके क्रेडेंशियल शेयर करने के लिए, One Tap 'इसी तौर पर जारी रखें' बटन दबाया. यह सिर्फ़ उन ब्राउज़र पर लागू होता है जिन पर FedCM काम करता है.
fedcm_auto	किसी मौजूदा सेशन वाले उपयोगकर्ता का अपने-आप साइन इन होना. ऐसा तब होता है, जब उसने पहले ही FedCM One Tap का इस्तेमाल करके क्रेडेंशियल शेयर करने की सहमति दी हो. यह सिर्फ़ उन ब्राउज़र पर लागू होता है जिन पर FedCM काम करता है.
user_1tap	किसी मौजूदा सेशन वाले उपयोगकर्ता ने सहमति देने और क्रेडेंशियल शेयर करने के लिए, One Tap 'इसी तौर पर जारी रखें' बटन दबाया. यह सिर्फ़ Chrome के 75 और उसके बाद के वर्शन पर लागू होता है.
user_2tap	किसी मौजूदा सेशन के बिना, उपयोगकर्ता ने खाता चुनने के लिए, One Tap 'इसी खाते से जारी रखें' बटन दबाया. इसके बाद, सहमति देने और क्रेडेंशियल शेयर करने के लिए, पॉप-अप विंडो में पुष्टि करें बटन दबाया. यह उन ब्राउज़र पर लागू होता है जो Chromium पर आधारित नहीं हैं.
itp	ऐसा उपयोगकर्ता जिसके पास मौजूदा सेशन है और जिसने पहले सहमति दी थी और ITP ब्राउज़र पर, एक टैप की सुविधा का इस्तेमाल किया था.
itp_confirm	किसी मौजूदा सेशन वाले उपयोगकर्ता ने ITP ब्राउज़र पर, एक टैप की सुविधा का इस्तेमाल किया. साथ ही, सहमति देने और क्रेडेंशियल शेयर करने के लिए, 'पुष्टि करें' बटन दबाया.
itp_add_session	कोई ऐसा उपयोगकर्ता जिसके पास कोई मौजूदा सेशन नहीं है और जिसने पहले सहमति दी है, वह Google खाता चुनने और क्रेडेंशियल शेयर करने के लिए, ITP ब्राउज़र पर One Tap दबाता है.
itp_confirm_add_session	किसी मौजूदा सेशन के बिना, उपयोगकर्ता ने सबसे पहले ITP ब्राउज़र पर, एक टैप की सुविधा का इस्तेमाल करके Google खाता चुना. इसके बाद, सहमति देने और क्रेडेंशियल शेयर करने के लिए, पुष्टि करें बटन दबाया.
btn	किसी मौजूदा सेशन में मौजूद उपयोगकर्ता ने पहले सहमति दी हो और उसने क्रेडेंशियल शेयर करने के लिए, 'कोई खाता चुनें' से कोई Google खाता चुना हो. इसके बाद, उसने 'Google से साइन इन करें' बटन दबाया हो.
btn_confirm	किसी मौजूदा सेशन वाले उपयोगकर्ता ने सहमति देने और क्रेडेंशियल शेयर करने के लिए, Google से साइन इन करें बटन और पुष्टि करें बटन दबाया.
btn_add_session	किसी ऐसे उपयोगकर्ता ने 'Google से साइन इन करें' बटन दबाया जिसने पहले सहमति दी थी, लेकिन जिसका कोई मौजूदा सेशन नहीं था. ऐसा करने पर, उसने Google खाता चुना और क्रेडेंशियल शेयर किए.
btn_confirm_add_session	किसी मौजूदा सेशन के बिना, उपयोगकर्ता ने Google खाता चुनने के लिए, सबसे पहले 'Google से साइन इन करें' बटन पर दबाया. इसके बाद, सहमति देने और क्रेडेंशियल शेयर करने के लिए, 'पुष्टि करें' बटन पर दबाया.

राज्य

यह फ़ील्ड सिर्फ़ तब तय किया जाता है, जब उपयोगकर्ता साइन इन करने के लिए, 'Google से साइन इन करें' बटन पर क्लिक करता है और क्लिक किए गए बटन का state एट्रिब्यूट तय किया जाता है. इस फ़ील्ड की वैल्यू, बटन के state एट्रिब्यूट में बताई गई वैल्यू होती है.

एक ही पेज पर, 'Google से साइन इन करें' के कई बटन रेंडर किए जा सकते हैं. इसलिए, हर बटन को एक यूनीक स्ट्रिंग असाइन की जा सकती है. इसलिए, इस state फ़ील्ड का इस्तेमाल करके यह पता लगाया जा सकता है कि उपयोगकर्ता ने साइन इन करने के लिए किस बटन पर क्लिक किया.

तरीका: google.accounts.id.renderButton

google.accounts.id.renderButton तरीका, आपके वेब पेजों में 'Google से साइन इन करें' बटन दिखाता है.

इस तरीके का कोड उदाहरण यहां देखें:

google.accounts.id.renderButton(
      /** @type{!HTMLElement} */ parent,
      /** @type{!GsiButtonConfiguration} */ options
    )

डेटा टाइप: GsiButtonConfiguration

नीचे दी गई टेबल में, GsiButtonConfiguration डेटा टाइप के फ़ील्ड और उनके ब्यौरे दिए गए हैं:

एट्रिब्यूट
type	बटन का टाइप: आइकॉन या स्टैंडर्ड बटन.
theme	बटन की थीम. उदाहरण के लिए, filled_blue या filled_black.
size	बटन का साइज़. उदाहरण के लिए, छोटा या बड़ा.
text	बटन का टेक्स्ट. उदाहरण के लिए, "Google से साइन इन करें" या "Google से साइन अप करें".
shape	बटन का आकार. उदाहरण के लिए, आयताकार या गोल.
logo_alignment	Google के लोगो का अलाइनमेंट: बाईं ओर या बीच में.
width	बटन की चौड़ाई, पिक्सल में.
locale	अगर यह सेट है, तो बटन की भाषा रेंडर की जाती है.
click_listener	अगर यह सेट है, तो 'Google से साइन इन करें' बटन पर क्लिक करने पर, इस फ़ंक्शन को कॉल किया जाता है.
state	सेट होने पर, यह स्ट्रिंग आईडी टोकन के साथ दिखती है.

एट्रिब्यूट के टाइप

नीचे दिए गए सेक्शन में, हर एट्रिब्यूट के टाइप और उदाहरण के बारे में जानकारी दी गई है.

टाइप

बटन का टाइप. डिफ़ॉल्ट वैल्यू standard है.

ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	हां	type: "icon"

यहां दी गई टेबल में, बटन के उपलब्ध टाइप और उनके बारे में जानकारी दी गई है:

टाइप
standard
icon

थीम

बटन की थीम. डिफ़ॉल्ट वैल्यू outline है. ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	theme: "filled_blue"

यहां दी गई टेबल में, उपलब्ध थीम और उनकी जानकारी दी गई है:

थीम
outline
filled_blue
filled_black

साइज़

बटन का साइज़. डिफ़ॉल्ट वैल्यू large है. ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	size: "small"

यहां दी गई टेबल में, बटन के उपलब्ध साइज़ और उनके बारे में जानकारी दी गई है:

साइज़
large
medium
small

टेक्स्ट

बटन का टेक्स्ट. डिफ़ॉल्ट वैल्यू signin_with है. अलग-अलग text एट्रिब्यूट वाले आइकॉन बटन के टेक्स्ट में कोई विज़ुअल अंतर नहीं होता. हालांकि, स्क्रीन पर टेक्स्ट को पढ़ने की सुविधा के लिए ऐसा नहीं किया जाता.

ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	text: "signup_with"

नीचे दी गई टेबल में, बटन के लिए उपलब्ध सभी टेक्स्ट और उनके ब्यौरे दिए गए हैं:

टेक्स्ट
signin_with
signup_with
continue_with
signin

आकार

बटन का आकार. डिफ़ॉल्ट वैल्यू rectangular है. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	shape: "rectangular"

यहां दी गई टेबल में, बटन के उपलब्ध आकार और उनके बारे में जानकारी दी गई है:

आकार
rectangular
pill
circle
square

logo_alignment

Google के लोगो का अलाइनमेंट. डिफ़ॉल्ट वैल्यू left है. यह एट्रिब्यूट सिर्फ़ standard बटन टाइप पर लागू होता है. ज़्यादा जानकारी के लिए, यहां दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	logo_alignment: "center"

यहां दी गई टेबल में, उपलब्ध अलाइनमेंट और उनके ब्यौरे दिए गए हैं:

logo_alignment
left
center

चौड़ाई

पिक्सल में, बटन की कम से कम चौड़ाई. इमेज की चौड़ाई ज़्यादा से ज़्यादा 400 पिक्सल होनी चाहिए.

ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	width: "400"

locale

ज़रूरी नहीं. तय की गई स्थानीय भाषा का इस्तेमाल करके बटन का टेक्स्ट दिखाएं. ऐसा न करने पर, उपयोगकर्ता के Google खाते या ब्राउज़र की सेटिंग में डिफ़ॉल्ट भाषा का इस्तेमाल किया जाएगा. लाइब्रेरी लोड करते समय, src डायरेक्टिव में hl पैरामीटर और भाषा कोड जोड़ें. उदाहरण के लिए: gsi/client?hl=<iso-639-code>.

अगर यह सेट नहीं है, तो ब्राउज़र की डिफ़ॉल्ट भाषा या Google सेशन के उपयोगकर्ता की प्राथमिकता का इस्तेमाल किया जाता है. इसलिए, अलग-अलग उपयोगकर्ताओं को स्थानीय भाषा में बने बटन के अलग-अलग वर्शन दिख सकते हैं. साथ ही, हो सकता है कि वे अलग-अलग साइज़ में दिखें.

ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	locale: "zh_CN"

click_listener

click_listener एट्रिब्यूट का इस्तेमाल करके, 'Google से साइन इन करें' बटन पर क्लिक करने पर, कॉल किए जाने वाले JavaScript फ़ंक्शन को तय किया जा सकता है.

  google.accounts.id.renderButton(document.getElementById("signinDiv"), {
      theme: 'outline',
      size: 'large',
      click_listener: onClickHandler
    });

  
  function onClickHandler(){
    console.log("Sign in with Google button clicked...")
  }
  

इस उदाहरण में, Google से साइन इन करें बटन पर क्लिक किया गया... मैसेज, Console में तब लॉग किया जाता है, जब 'Google से साइन इन करें' बटन पर क्लिक किया जाता है.

राज्य

ज़रूरी नहीं, क्योंकि एक ही पेज पर 'Google से साइन इन करें' के कई बटन रेंडर किए जा सकते हैं. इसलिए, हर बटन को एक यूनीक स्ट्रिंग असाइन की जा सकती है. आईडी टोकन के साथ वही स्ट्रिंग दिखेगी, ताकि आप यह पता लगा सकें कि उपयोगकर्ता ने साइन इन करने के लिए किस बटन पर क्लिक किया.

ज़्यादा जानकारी के लिए, नीचे दी गई टेबल देखें:

टाइप	ज़रूरी है	उदाहरण
स्ट्रिंग	वैकल्पिक	data-state: "button 1"

डेटा टाइप: क्रेडेंशियल

जब आपका native_callback फ़ंक्शन शुरू किया जाता है, तो पैरामीटर के तौर पर Credential ऑब्जेक्ट पास किया जाता है. इस टेबल में, ऑब्जेक्ट में मौजूद फ़ील्ड की सूची दी गई है:

फ़ील्ड
id	उपयोगकर्ता की पहचान करता है.
password	पासवर्ड

तरीका: google.accounts.id.disableAutoSelect

जब उपयोगकर्ता आपकी वेबसाइट से साइन आउट करता है, तो आपको कुकी में स्थिति रिकॉर्ड करने के लिए, google.accounts.id.disableAutoSelect को कॉल करना होगा. इससे यूज़र एक्सपीरियंस में रुकावट नहीं आती. इस तरीके का कोड स्निपेट यहां देखें:

google.accounts.id.disableAutoSelect()

यहां दिए गए कोड के उदाहरण में, onSignout() फ़ंक्शन के साथ google.accounts.id.disableAutoSelect तरीका लागू किया गया है:

<script>
  function onSignout() {
    google.accounts.id.disableAutoSelect();
  }
</script>

तरीका: google.accounts.id.storeCredential

यह तरीका, ब्राउज़र के नेटिव क्रेडेंशियल मैनेजर एपीआई के store() तरीके के लिए एक रैपर है. इसलिए, इसका इस्तेमाल सिर्फ़ पासवर्ड क्रेडेंशियल को सेव करने के लिए किया जा सकता है. इस तरीके का कोड उदाहरण यहां देखें:

google.accounts.id.storeCredential(Credential, callback)

यहां दिए गए कोड के उदाहरण में, onSignIn() फ़ंक्शन के साथ google.accounts.id.storeCredential तरीका लागू किया गया है:

<script>
  function onSignIn() {
    let cred = {id: '...', password: '...'};
    google.accounts.id.storeCredential(cred);
  }
</script>

तरीका: google.accounts.id.cancel

अगर आपने भरोसेमंद पक्ष के डीओएम से प्रॉम्प्ट हटा दिया है, तो One Tap फ़्लो को रद्द किया जा सकता है. अगर कोई क्रेडेंशियल पहले से चुना गया है, तो रद्द करने की कार्रवाई को अनदेखा कर दिया जाता है. इस तरीके का कोड उदाहरण देखें:

google.accounts.id.cancel()

यहां दिए गए कोड के उदाहरण में, onNextButtonClicked() फ़ंक्शन के साथ google.accounts.id.cancel() तरीका लागू किया गया है:

<script>
  function onNextButtonClicked() {
    google.accounts.id.cancel();
    showPasswordPage();
  }
</script>

लाइब्रेरी लोड होने पर कॉलबैक: onGoogleLibraryLoad

आपके पास onGoogleLibraryLoad कॉलबैक रजिस्टर करने का विकल्प है. 'Google से साइन इन करें' JavaScript लाइब्रेरी लोड होने के बाद, इसकी सूचना दी जाती है:

window.onGoogleLibraryLoad = () => {
    ...
};

यह कॉलबैक, window.onload कॉलबैक का सिर्फ़ एक शॉर्टकट है. गतिविधि में कोई अंतर नहीं है.

यहां दिए गए कोड के उदाहरण में, onGoogleLibraryLoad कॉलबैक लागू किया गया है:

<script>
  window.onGoogleLibraryLoad = () => {
   google.accounts.id.initialize({
     ...
   });
   google.accounts.id.prompt();
  };
</script>

तरीका: google.accounts.id.revoke

google.accounts.id.revoke तरीका, किसी उपयोगकर्ता के आईडी टोकन को शेयर करने के लिए इस्तेमाल किए गए OAuth अनुदान को रद्द करता है. इस तरीके का कोड स्निपेट देखें: javascript google.accounts.id.revoke(login_hint, callback)

पैरामीटर	टाइप	ब्यौरा
login_hint	स्ट्रिंग	उपयोगकर्ता के Google खाते का ईमेल पता या यूनीक आईडी. आईडी, क्रेडेंशियल पेलोड की sub प्रॉपर्टी है.
callback	फ़ंक्शन	RevocationResponse हैंडलर, जो ज़रूरी नहीं है.

यहां दिए गए कोड सैंपल में, आईडी के साथ revoke तरीके का इस्तेमाल करने का तरीका बताया गया है.

  google.accounts.id.revoke('1618033988749895', done => {
    console.log(done.error);
  });

डेटा टाइप: RevocationResponse

जब आपका callback फ़ंक्शन शुरू किया जाता है, तो पैरामीटर के तौर पर एक RevocationResponse ऑब्जेक्ट पास किया जाता है. नीचे दी गई टेबल में, रद्द करने के अनुरोध के जवाब वाले ऑब्जेक्ट में मौजूद फ़ील्ड की सूची दी गई है:

फ़ील्ड
successful	यह फ़ील्ड, मेथड कॉल की रिटर्न वैल्यू है.
error	इस फ़ील्ड में, गड़बड़ी के बारे में ज़्यादा जानकारी देने वाला मैसेज शामिल किया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है.

हो गया

यह फ़ील्ड एक बूलियन वैल्यू है. अगर रद्द करने के तरीके का कॉल पूरा हो जाता है, तो यह वैल्यू 'सही' पर सेट होती है. अगर कॉल पूरा नहीं होता है, तो यह वैल्यू 'गलत' पर सेट होती है.

गड़बड़ी

यह फ़ील्ड एक स्ट्रिंग वैल्यू है. अगर रद्द करने के तरीके का कॉल पूरा नहीं हो पाता है, तो इसमें गड़बड़ी का ज़्यादा जानकारी वाला मैसेज होता है. अगर कॉल पूरा हो जाता है, तो यह वैल्यू तय नहीं होती.