वेबसाइटों के लिए, Google की 3P (तीसरे पक्ष की) अनुमति वाली JavaScript लाइब्रेरी - एपीआई का रेफ़रंस

इस रेफ़रंस में, Google 3P ऑथराइज़ेशन JavaScript लाइब्रेरी एपीआई के बारे में जानकारी दी गई है. इसका इस्तेमाल, Google से ऑथराइज़ेशन कोड लोड करने या Google से टोकन ऐक्सेस करने के लिए किया जा सकता है.

तरीका: google.accounts.oauth2.initCodeClient

initCodeClient तरीका, पैरामीटर में मौजूद कॉन्फ़िगरेशन के साथ, एक कोड क्लाइंट शुरू करता है और उसे दिखाता है.

google.accounts.oauth2.initCodeClient(config: CodeClientConfig)

डेटा टाइप: CodeClientConfig

नीचे दी गई टेबल में CodeClientConfig डेटा टाइप की प्रॉपर्टी दी गई हैं.

प्रॉपर्टी
client_id ज़रूरी है. आपके ऐप्लिकेशन का क्लाइंट आईडी. यह वैल्यू, एपीआई कंसोल में देखी जा सकती है.
scope ज़रूरी है. दायरों की ऐसी सूची जिनके बीच में स्पेस होता है, ताकि उन संसाधनों की पहचान की जा सके जिन्हें आपका ऐप्लिकेशन, उपयोगकर्ता की ओर से ऐक्सेस कर सकता है. ये वैल्यू उस स्क्रीन के बारे में बताती हैं जो Google को उपयोगकर्ता को दिखाने के लिए सहमति की स्क्रीन पर दिखता है.
include_granted_scopes यह ज़रूरी नहीं है. डिफ़ॉल्ट रूप से, यह true पर सेट होती है. ऐप्लिकेशन को संदर्भ में अतिरिक्त दायरों का ऐक्सेस मांगने के लिए इंक्रीमेंटल अनुमति का इस्तेमाल करने की सुविधा देता है. अगर इस पैरामीटर की वैल्यू को false पर सेट किया जाता है और अनुमति देने के अनुरोध को स्वीकार कर लिया जाता है, तो नया ऐक्सेस टोकन सिर्फ़ उन स्कोप को कवर करेगा जिनके लिए scope ने इस CodeClientConfig में अनुरोध किया था.
redirect_uri रीडायरेक्ट UX के लिए ज़रूरी है. यह तय करता है कि उपयोगकर्ता के ऑथराइज़ेशन फ़्लो को पूरा करने के बाद, एपीआई सर्वर उपयोगकर्ता को कहां रीडायरेक्ट करता है. यह वैल्यू, OAuth 2.0 क्लाइंट के लिए अनुमति वाले किसी एक ऐसे रीडायरेक्ट यूआरआई से पूरी तरह मेल खानी चाहिए जिसे आपने एपीआई कंसोल में कॉन्फ़िगर किया है. साथ ही, यह हमारे रीडायरेक्ट यूआरआई की पुष्टि करने के नियमों के मुताबिक होना चाहिए. पॉप-अप UX प्रॉपर्टी को अनदेखा कर देगा.
callback पॉप-अप UX के लिए आवश्यक है. वह JavaScript फ़ंक्शन जो दिए गए कोड रिस्पॉन्स को मैनेज करता है. रीडायरेक्ट UX प्रॉपर्टी को अनदेखा कर देगा.
state ज़रूरी नहीं. रीडायरेक्ट UX के लिए सुझाया गया. यह ऐसी किसी भी स्ट्रिंग की वैल्यू के बारे में बताती है जिसका इस्तेमाल आपका ऐप्लिकेशन, अनुमति देने के अनुरोध और अनुमति देने वाले सर्वर के रिस्पॉन्स के बीच स्थिति बनाए रखने के लिए करता है.
enable_granular_consent यह ज़रूरी नहीं है. डिफ़ॉल्ट रूप से, यह true पर सेट होती है. अगर नीति को false पर सेट किया जाता है, तो 2019 से पहले बनाए गए OAuth क्लाइंट आईडी के लिए, Google खाते की ज़्यादा विस्तृत अनुमतियां बंद हो जाएंगी. अगर enable_granular_consent और enable_serial_consent, दोनों सेट हैं, तो सिर्फ़ enable_granular_consent वैल्यू लागू होगी और enable_serial_consent वैल्यू को अनदेखा कर दिया जाएगा.

नए OAuth क्लाइंट आईडी पर कोई असर नहीं पड़ता. इसकी वजह यह है कि उनके लिए ज़्यादा अनुमतियां हमेशा चालू रहती हैं.
enable_serial_consent अब सेवा में नहीं है, आपको इसके बजाय enable_granular_consent का इस्तेमाल करना चाहिए. इसका असर enable_granular_consent की तरह ही होता है. enable_serial_consent का इस्तेमाल करने वाले मौजूदा ऐप्लिकेशन आगे भी ऐसा कर सकते हैं. हालांकि, हमारी सलाह है कि अपने ऐप्लिकेशन के अगले अपडेट में, enable_granular_consent का इस्तेमाल करने के लिए अपना कोड अपडेट करें.
login_hint ज़रूरी नहीं. अगर आपके ऐप्लिकेशन को पता है कि किस उपयोगकर्ता को अनुरोध की अनुमति देनी चाहिए, तो वह इस प्रॉपर्टी का इस्तेमाल करके, Google को लॉगिन संकेत दे सकता है. सफल होने पर, खाता नहीं चुना जाता है. टारगेट किए गए उपयोगकर्ता के लिए ईमेल पता या आईडी टोकन सब फ़ील्ड की वैल्यू. ज़्यादा जानकारी के लिए, OpenID Connect दस्तावेज़ में login_hint फ़ील्ड देखें.
hd ज़रूरी नहीं. अगर आपके ऐप्लिकेशन के पास उस Workspace डोमेन के बारे में जानकारी है जिसका उपयोगकर्ता है, तो Google को संकेत देने के लिए इसका इस्तेमाल करें. सफल होने पर, उपयोगकर्ता खाते दिए गए डोमेन के लिए सीमित हो जाते हैं या पहले से चुने गए खाते हो जाते हैं. ज़्यादा जानकारी के लिए, OpenID Connect दस्तावेज़ में hd फ़ील्ड देखें.
ux_mode ज़रूरी नहीं. ऑथराइज़ेशन फ़्लो में इस्तेमाल करने के लिए UX मोड. डिफ़ॉल्ट रूप से, इससे सहमति का फ़्लो एक पॉप-अप में खुलेगा. मान्य वैल्यू popup और redirect हैं.
select_account ज़रूरी नहीं, डिफ़ॉल्ट रूप से यह 'false' पर सेट होता है. बूलियन मान, ताकि उपयोगकर्ता को खाता चुनने का संकेत दिया जा सके.
error_callback ज़रूरी नहीं. पॉप-अप विंडो जैसी कुछ ऐसी गड़बड़ियों को मैनेज करने वाला JavaScript फ़ंक्शन, जो OAuth वाली गड़बड़ियों को हैंडल करती है. यह फ़ंक्शन, ऐप्लिकेशन खुलने से पहले बंद हो जाता है या OAuth रिस्पॉन्स देने से पहले बंद कर दिया जाता है.

इनपुट पैरामीटर का `type` फ़ील्ड, इसकी पूरी वजह बताता है.
  • popup_failed_to_open पॉप-अप विंडो नहीं खुल सकी.
  • popup_closed OAuth रिस्पॉन्स मिलने से पहले पॉप-अप विंडो बंद हो जाती है.
  • अन्य गड़बड़ियों के लिए अज्ञात प्लेसहोल्डर.

डेटा टाइप: CodeClient

क्लास में सिर्फ़ एक सार्वजनिक तरीके का requestCode है, जिससे OAuth 2.0 कोड UX फ़्लो शुरू होता है.

interface CodeClient {
  requestCode(): void;
}

डेटा टाइप: CodeResponse

CodeResponse JavaScript ऑब्जेक्ट को पॉप-अप UX में, आपके callback तरीके को पास कर दिया जाएगा. रीडायरेक्ट UX में, CodeResponse को यूआरएल पैरामीटर के तौर पर पास किया जाएगा.

नीचे दी गई टेबल में CodeResponse डेटा टाइप की प्रॉपर्टी दी गई हैं.

प्रॉपर्टी
code टोकन रिस्पॉन्स का ऑथराइज़ेशन कोड.
scope स्कोप की ऐसी सूची जिसे खाली जगह के हिसाब से व्यवस्थित किया गया हो और जिसे उपयोगकर्ता ने मंज़ूरी दी हो.
state वह स्ट्रिंग वैल्यू जिसका इस्तेमाल आपका ऐप्लिकेशन, अनुमति देने के अनुरोध और उसके जवाब के बीच स्थिति बनाए रखने के लिए करता है.
error सिर्फ़ एक ASCII गड़बड़ी कोड.
error_description अतिरिक्त जानकारी देने वाला ASCII टेक्स्ट जिसे लोग आसानी से पढ़ सकें. इसका इस्तेमाल, गड़बड़ी को समझने में क्लाइंट डेवलपर की मदद करने के लिए किया जाता है.
error_uri यूआरआई, गड़बड़ी के बारे में जानकारी वाले ऐसे वेब पेज की पहचान करता है जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है. इसका इस्तेमाल, क्लाइंट डेवलपर को गड़बड़ी के बारे में ज़्यादा जानकारी देने के लिए किया जाता है.

तरीका: google.accounts.oauth2.initTokenClient

initTokenClient तरीका, पैरामीटर में कॉन्फ़िगरेशन के साथ टोकन क्लाइंट को शुरू करता है और दिखाता है.

google.accounts.oauth2.initTokenClient(config: TokenClientConfig)

डेटा टाइप: TokenClientConfig

नीचे दी गई टेबल में TokenClientConfig डेटा टाइप की प्रॉपर्टी दी गई हैं.

प्रॉपर्टी
client_id ज़रूरी है. आपके ऐप्लिकेशन का क्लाइंट आईडी. यह वैल्यू, एपीआई कंसोल में देखी जा सकती है.
callback ज़रूरी है. लौटाए गए टोकन के रिस्पॉन्स को मैनेज करने वाला JavaScript फ़ंक्शन.
scope ज़रूरी है. दायरों की ऐसी सूची जिनके बीच में स्पेस होता है, ताकि उन संसाधनों की पहचान की जा सके जिन्हें आपका ऐप्लिकेशन, उपयोगकर्ता की ओर से ऐक्सेस कर सकता है. ये वैल्यू उस स्क्रीन के बारे में बताती हैं जो Google को उपयोगकर्ता को दिखाने के लिए सहमति की स्क्रीन पर दिखता है.
include_granted_scopes यह ज़रूरी नहीं है. डिफ़ॉल्ट रूप से, यह true पर सेट होती है. ऐप्लिकेशन को संदर्भ में अतिरिक्त दायरों का ऐक्सेस मांगने के लिए इंक्रीमेंटल अनुमति का इस्तेमाल करने की सुविधा देता है. अगर इस पैरामीटर की वैल्यू को false पर सेट किया जाता है और अनुमति देने के अनुरोध को स्वीकार कर लिया जाता है, तो नया ऐक्सेस टोकन सिर्फ़ उन स्कोप को कवर करेगा जिनके लिए scope ने इस TokenClientConfig में अनुरोध किया था.
prompt ज़रूरी नहीं, डिफ़ॉल्ट रूप से 'select_account' सेट होता है. लोगों को दिखाए जाने के लिए, प्रॉम्प्ट की ऐसी सूची जिसमें स्पेस को अलग-अलग रंगों में दिखाया जाता है और जिसमें केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होते हैं. आपको ये वैल्यू दिख सकती हैं:
  • खाली स्ट्रिंग उपयोगकर्ता को सिर्फ़ तब सूचना दी जाएगी, जब आपका ऐप्लिकेशन ऐक्सेस का अनुरोध करेगा. इसे अन्य वैल्यू के साथ तय नहीं किया जा सकता.
  • 'none' पुष्टि करने या सहमति वाली स्क्रीन न दिखाएं. इसे अन्य वैल्यू के साथ नहीं बताया जाना चाहिए.
  • 'consent' उपयोगकर्ता को सहमति के लिए संकेत दें.
  • 'select_account' उपयोगकर्ता से कोई खाता चुनने का अनुरोध करें.
enable_granular_consent यह ज़रूरी नहीं है. डिफ़ॉल्ट रूप से, यह true पर सेट होती है. अगर नीति को false पर सेट किया जाता है, तो 2019 से पहले बनाए गए OAuth क्लाइंट आईडी के लिए, Google खाते की ज़्यादा विस्तृत अनुमतियां बंद हो जाएंगी. अगर enable_granular_consent और enable_serial_consent, दोनों सेट हैं, तो सिर्फ़ enable_granular_consent वैल्यू लागू होगी और enable_serial_consent वैल्यू को अनदेखा कर दिया जाएगा.

नए OAuth क्लाइंट आईडी पर कोई असर नहीं पड़ता. इसकी वजह यह है कि उनके लिए ज़्यादा अनुमतियां हमेशा चालू रहती हैं.
enable_serial_consent अब सेवा में नहीं है, आपको इसके बजाय enable_granular_consent का इस्तेमाल करना चाहिए. इसका असर enable_granular_consent की तरह ही होता है. enable_serial_consent का इस्तेमाल करने वाले मौजूदा ऐप्लिकेशन आगे भी ऐसा कर सकते हैं. हालांकि, हमारी सलाह है कि अपने ऐप्लिकेशन के अगले अपडेट में, enable_granular_consent का इस्तेमाल करने के लिए अपना कोड अपडेट करें.
login_hint ज़रूरी नहीं. अगर आपके ऐप्लिकेशन को पता है कि किस उपयोगकर्ता को अनुरोध की अनुमति देनी चाहिए, तो वह इस प्रॉपर्टी का इस्तेमाल करके, Google को लॉगिन संकेत दे सकता है. सफल होने पर, खाता नहीं चुना जाता है. टारगेट किए गए उपयोगकर्ता के लिए ईमेल पता या आईडी टोकन सब फ़ील्ड की वैल्यू. ज़्यादा जानकारी के लिए, OpenID Connect दस्तावेज़ में login_hint फ़ील्ड देखें.
hd ज़रूरी नहीं. अगर आपके ऐप्लिकेशन के पास उस Workspace डोमेन के बारे में जानकारी है जिसका उपयोगकर्ता है, तो Google को संकेत देने के लिए इसका इस्तेमाल करें. सफल होने पर, उपयोगकर्ता खाते दिए गए डोमेन के लिए सीमित हो जाते हैं या पहले से चुने गए खाते हो जाते हैं. ज़्यादा जानकारी के लिए, OpenID Connect दस्तावेज़ में hd फ़ील्ड देखें.
state ज़रूरी नहीं. इसे इस्तेमाल करने का सुझाव नहीं दिया जाता है. यह ऐसी किसी भी स्ट्रिंग की वैल्यू के बारे में बताती है जिसका इस्तेमाल आपका ऐप्लिकेशन, अनुमति देने के अनुरोध और अनुमति देने वाले सर्वर के रिस्पॉन्स के बीच स्थिति बनाए रखने के लिए करता है.
error_callback ज़रूरी नहीं. पॉप-अप विंडो जैसी कुछ ऐसी गड़बड़ियों को मैनेज करने वाला JavaScript फ़ंक्शन, जो OAuth वाली गड़बड़ियों को हैंडल करती है. यह फ़ंक्शन, ऐप्लिकेशन खुलने से पहले बंद हो जाता है या OAuth रिस्पॉन्स देने से पहले बंद कर दिया जाता है.

इनपुट पैरामीटर का `type` फ़ील्ड, इसकी पूरी वजह बताता है.
  • popup_failed_to_open पॉप-अप विंडो नहीं खुल सकी.
  • popup_closed OAuth रिस्पॉन्स मिलने से पहले पॉप-अप विंडो बंद हो जाती है.
  • अन्य गड़बड़ियों के लिए अज्ञात प्लेसहोल्डर.

डेटा टाइप: TokenClient

क्लास में सिर्फ़ एक सार्वजनिक तरीका requestAccessToken मौजूद है, जो OAuth 2.0 टोकन UX फ़्लो को शुरू करता है.

interface TokenClient {
  requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}
तर्क
overrideConfig OverridableTokenClientConfig ज़रूरी नहीं. इस तरीके में बदले जाने वाले कॉन्फ़िगरेशन.

डेटा टाइप: OverridableTokenClientConfig

नीचे दी गई टेबल में OverridableTokenClientConfig डेटा टाइप की प्रॉपर्टी दी गई हैं.

प्रॉपर्टी
scope ज़रूरी नहीं. स्कोप की ऐसी सूची जिसे अलग-अलग स्पेस में व्यवस्थित किया जाता है. इससे उन संसाधनों की पहचान होती है जिन्हें आपका ऐप्लिकेशन, उपयोगकर्ता की ओर से ऐक्सेस कर सकता है. ये वैल्यू, उस स्क्रीन के बारे में जानकारी देती हैं जो Google को सहमति देने के लिए दिखाता है.
include_granted_scopes यह ज़रूरी नहीं है. डिफ़ॉल्ट रूप से, यह true पर सेट होती है. ऐप्लिकेशन को संदर्भ में अतिरिक्त दायरों का ऐक्सेस मांगने के लिए इंक्रीमेंटल अनुमति का इस्तेमाल करने की सुविधा देता है. अगर इस पैरामीटर की वैल्यू को false पर सेट किया जाता है और अनुमति देने के अनुरोध को स्वीकार कर लिया जाता है, तो नया ऐक्सेस टोकन सिर्फ़ उन स्कोप को कवर करेगा जिनके लिए scope ने इस OverridableTokenClientConfig में अनुरोध किया था.
prompt ज़रूरी नहीं. लोगों को दिखाने के लिए, प्रॉम्प्ट की ऐसी सूची जिसमें स्पेस को अलग-अलग जगह दी गई हो और जिसमें केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) हों.
enable_granular_consent यह ज़रूरी नहीं है. डिफ़ॉल्ट रूप से, यह true पर सेट होती है. अगर false पर सेट किया जाता है, तो 2019 से पहले बनाए गए OAuth क्लाइंट आईडी के लिए, Google खाते की ज़्यादा जानकारी वाली अनुमतियां बंद हो जाएंगी.अगर enable_granular_consent और enable_serial_consent, दोनों को सेट किया जाता है, तो सिर्फ़ enable_granular_consent वैल्यू लागू होगी और enable_serial_consent वैल्यू को अनदेखा कर दिया जाएगा.

नए OAuth क्लाइंट आईडी पर कोई असर नहीं पड़ता. इसकी वजह यह है कि उनके लिए ज़्यादा अनुमतियां हमेशा चालू रहती हैं.
enable_serial_consent अब सेवा में नहीं है, आपको इसके बजाय enable_granular_consent का इस्तेमाल करना चाहिए. इसका असर enable_granular_consent की तरह ही होता है. enable_serial_consent का इस्तेमाल करने वाले मौजूदा ऐप्लिकेशन आगे भी ऐसा कर सकते हैं. हालांकि, हमारी सलाह है कि अपने ऐप्लिकेशन के अगले अपडेट में, enable_granular_consent का इस्तेमाल करने के लिए अपना कोड अपडेट करें.
login_hint ज़रूरी नहीं. अगर आपके ऐप्लिकेशन को पता है कि किस उपयोगकर्ता को अनुरोध की अनुमति देनी चाहिए, तो वह इस प्रॉपर्टी का इस्तेमाल करके, Google को लॉगिन संकेत दे सकता है. सफल होने पर, खाता नहीं चुना जाता है. टारगेट किए गए उपयोगकर्ता के लिए ईमेल पता या आईडी टोकन सब फ़ील्ड की वैल्यू. ज़्यादा जानकारी के लिए, OpenID Connect दस्तावेज़ में login_hint फ़ील्ड देखें.
state ज़रूरी नहीं. इसे इस्तेमाल करने का सुझाव नहीं दिया जाता है. यह ऐसी किसी भी स्ट्रिंग की वैल्यू के बारे में बताती है जिसका इस्तेमाल आपका ऐप्लिकेशन, अनुमति देने के अनुरोध और अनुमति देने वाले सर्वर के रिस्पॉन्स के बीच स्थिति बनाए रखने के लिए करता है.

डेटा टाइप: TokenResponse

पॉप-अप UX में, आपके कॉलबैक के तरीके में TokenResponse JavaScript ऑब्जेक्ट पास किया जाएगा.

नीचे दी गई टेबल में TokenResponse डेटा टाइप की प्रॉपर्टी दी गई हैं.

प्रॉपर्टी
access_token कामयाब टोकन रिस्पॉन्स का ऐक्सेस टोकन.
expires_in ऐक्सेस टोकन के सेकंड में लाइफ़टाइम.
hd होस्ट किया गया वह डोमेन जिससे साइन इन किया हुआ है.
prompt वह प्रॉम्प्ट वैल्यू जिसका इस्तेमाल TokenClientConfig या OverridableTokenClientConfig में दी गई वैल्यू की संभावित सूची में से किया गया है.
token_type जारी किए गए टोकन का टाइप.
scope स्कोप की ऐसी सूची जिसे खाली जगह के हिसाब से व्यवस्थित किया गया हो और जिसे उपयोगकर्ता ने मंज़ूरी दी हो.
state वह स्ट्रिंग वैल्यू जिसका इस्तेमाल आपका ऐप्लिकेशन, अनुमति देने के अनुरोध और उसके जवाब के बीच स्थिति बनाए रखने के लिए करता है.
error सिर्फ़ एक ASCII गड़बड़ी कोड.
error_description अतिरिक्त जानकारी देने वाला ASCII टेक्स्ट जिसे लोग आसानी से पढ़ सकें. इसका इस्तेमाल, गड़बड़ी को समझने में क्लाइंट डेवलपर की मदद करने के लिए किया जाता है..
error_uri यूआरआई, गड़बड़ी के बारे में जानकारी वाले ऐसे वेब पेज की पहचान करता है जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है. इसका इस्तेमाल, क्लाइंट डेवलपर को गड़बड़ी के बारे में ज़्यादा जानकारी देने के लिए किया जाता है.

तरीका: google.accounts.oauth2.hasGrantedAllScopes

यह जांच करता है कि उपयोगकर्ता ने, बताए गए सभी दायरे या दायरे दिए हैं या नहीं.

google.accounts.oauth2.hasGrantedAllScopes(
                                            tokenResponse: TokenResponse,
                                            firstScope: string, ...restScopes: string[]
                                          ): boolean;
तर्क
tokenResponse TokenResponse ज़रूरी है. एक TokenResponse ऑब्जेक्ट.
firstScope स्ट्रिंग ज़रूरी है. वह स्कोप जिसकी जांच करनी है.
restScopes स्ट्रिंग[] ज़रूरी नहीं. जांच करने के लिए, अन्य स्कोप.
रिटर्न
boolean अगर सभी स्कोप दिए गए हैं, तो वैल्यू 'सही' होगी.

तरीका: google.accounts.oauth2.hasGranted परिवार

यह जांच करता है कि उपयोगकर्ता ने कोई खास दायरा या दायरा दिया है या नहीं.

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;
तर्क
tokenResponse TokenResponse ज़रूरी है. एक TokenResponse ऑब्जेक्ट.
firstScope स्ट्रिंग ज़रूरी है. वह स्कोप जिसकी जांच करनी है.
restScopes स्ट्रिंग[] ज़रूरी नहीं. जांच करने के लिए, अन्य स्कोप.
रिटर्न
boolean अगर कोई भी दायरा दिया गया हो, तो वैल्यू 'सही' होगी.

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

revoke तरीका, उपयोगकर्ता के ऐप्लिकेशन को दिए गए सभी दायरे रद्द कर देता है. अनुमति वापस लेने के लिए, मान्य ऐक्सेस टोकन की ज़रूरत होती है.

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;
तर्क
accessToken स्ट्रिंग ज़रूरी है. मान्य ऐक्सेस टोकन.
callback फ़ंक्शन ज़रूरी नहीं. RevocationResponse हैंडलर.

डेटा टाइप: RevocationResponse

आपके कॉलबैक करने के तरीके में RevocationResponse JavaScript ऑब्जेक्ट पास किया जाएगा.

नीचे दी गई टेबल में RevocationResponse डेटा टाइप की प्रॉपर्टी दी गई हैं.

प्रॉपर्टी
successful बूलियन. सफल होने पर true, विफल होने पर false.
error स्ट्रिंग. सफलता के बारे में जानकारी नहीं है. सिर्फ़ एक ASCII गड़बड़ी कोड. इसमें स्टैंडर्ड OAuth 2.0 गड़बड़ी कोड के अलावा, और भी चीज़ें शामिल हो सकती हैं. revoke वाले तरीके में होने वाली सामान्य गड़बड़ियां:
  • invalid_token - revoke तरीके को कॉल करने से पहले, टोकन की समयसीमा खत्म हो चुकी है या उसे निरस्त कर दिया गया है. ज़्यादातर मामलों में, यह देखा जा सकता है कि accessToken से जुड़ा अनुदान रद्द कर दिया गया है.
  • invalid_request - टोकन को रद्द नहीं किया जा सकता. आपको यह पक्का करना चाहिए कि accessToken, Google OAuth 2.0 का मान्य क्रेडेंशियल है.
error_description स्ट्रिंग. सफलता के बारे में जानकारी नहीं है. ऐसा ASCII टेक्स्ट जिसे लोग आसानी से पढ़ सकें, उससे error प्रॉपर्टी के बारे में ज़्यादा जानकारी मिलती है. डेवलपर इसका इस्तेमाल, गड़बड़ी को बेहतर तरीके से समझने के लिए कर सकते हैं. error_description स्ट्रिंग सिर्फ़ अंग्रेज़ी में है. error की सूची में मौजूद आम गड़बड़ियों के लिए, error_description:
  • invalid_token - टोकन की समयसीमा खत्म हो गई है या उसे रद्द कर दिया गया है.
  • invalid_request - टोकन को रद्द नहीं किया जा सकता.