इस पेज का अनुवाद Cloud Translation API से किया गया है.
Switch to English

Google साइन-इन जावास्क्रिप्ट क्लाइंट संदर्भ

यह संदर्भ जावास्क्रिप्ट क्लाइंट विधियों और विशेषताओं का वर्णन करता है जिनका उपयोग आप अपने वेब एप्लिकेशन में Google साइन-इन को लागू करने के लिए करेंगे।

यदि आप लाइब्रेरी का उपयोग करके किसी भी समस्या का सामना करते हैं, तो कृपया इसे हमारे GitHub रिपॉजिटरी को रिपोर्ट करें।

प्रामाणिक सेटअप

gapi ऑब्जेक्ट बनाने के लिए Google API प्लेटफ़ॉर्म लाइब्रेरी लोड करें:

<script src="https://apis.google.com/js/platform.js?onload=init" async defer></script>

प्लेटफ़ॉर्म लायब्रेरी लोड करने के बाद , auth2 लायब्रेरी लोड करें:

function init() {
  gapi.load('auth2', function() {
    /* Ready. Make a call to gapi.auth2.init or some other API */
  });
}

gapi.auth2.init ( params )

GoogleAuth ऑब्जेक्ट को प्रारंभ करता है। आप इस विधि को कॉल करने से पहले gapi.auth2.GoogleAuth के तरीकों को कॉल करें।

जब आप GoogleAuth ऑब्जेक्ट को इनिशियलाइज़ करते हैं, तो आप ऑब्जेक्ट को अपने OAuth 2.0 क्लाइंट आईडी और किसी भी अतिरिक्त विकल्प के साथ कॉन्फ़िगर करते हैं जिसे आप निर्दिष्ट करना चाहते हैं। फिर, यदि उपयोगकर्ता पहले ही साइन इन कर चुका है, तो GoogleAuth ऑब्जेक्ट उपयोगकर्ता के साइन-इन राज्य को पिछले सत्र से पुनर्स्थापित करता है।

बहस
params क्लाइंट कॉन्फ़िगरेशन डेटा के मुख्य-मूल्य जोड़े वाली एक वस्तु। विभिन्न गुणों को कॉन्फ़िगर करने के लिए gapi.auth2.ClientConfig देखें। उदाहरण के लिए:
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com'
}
रिटर्न
gapi.auth2.GoogleAuth The gapi.auth2.GoogleAuth ऑब्जेक्ट। एक वादा प्राप्त करने के लिए तत्कालीन () विधि का उपयोग करें, जब यह gapi.auth2.GoogleAuth हल हो जाता है।

GoogleAuth.then ( onInit , onError )

जब GoogleAuth ऑब्जेक्ट को पूरी तरह से आरंभ किया जाता है, तो onInit फ़ंक्शन को कॉल करता है। यदि प्रारंभ करते समय कोई त्रुटि होती है (यह पुराने असमर्थित ब्राउज़रों में हो सकती है), इसके बजाय onError फ़ंक्शन को कॉल किया जाएगा।

बहस
onInit फ़ंक्शन को GoogleAuth ऑब्जेक्ट के साथ कॉल किया जाता है जब यह पूरी तरह से प्रारंभ हो जाता है।
onError GoogleAuth प्रारंभ करने में विफल होने पर फ़ंक्शन को एक error संपत्ति वाले ऑब्जेक्ट के साथ कहा जाता है।
रिटर्न
वादा एक Promise जो तब पूरा होता है जब onInit फ़ंक्शन पूरा हो जाता है, या एक आरंभीकरण त्रुटि होने पर अस्वीकार कर दिया जाता है। यह onInit फ़ंक्शन से लौटाए गए मान के साथ हल करता है, यदि कोई हो।

त्रुटि कोड

idpiframe_initialization_failed
एक असमर्थित वातावरण के कारण, उदाहरण के लिए, Google से एक आवश्यक iframe को आरंभ करने में विफल। एक details संपत्ति की गई त्रुटि पर अधिक जानकारी देगी।

gapi.auth2.ClientConfig

इंटरफ़ेस जो विभिन्न कॉन्फ़िगरेशन मापदंडों का प्रतिनिधित्व करता है के लिए gapi.auth2.init विधि।

मापदंडों
client_id string आवश्यक है। ऐप का क्लाइंट आईडी, Google डेवलपर्स कंसोल में पाया और बनाया गया है।
cookie_policy string वह डोमेन जिसके लिए साइन-इन कुकीज़ बनाना है। या तो एक URI, single_host_origin , या none । अनिर्दिष्ट होने पर single_host_origin को single_host_origin
scope string अंतरिक्ष-सीमांकित स्ट्रिंग के रूप में अनुरोध करने के लिए स्कोप। वैकल्पिक यदि fetch_basic_profile गलत पर सेट नहीं है।
fetch_basic_profile boolean जब वे साइन इन करते हैं, तो उपयोगकर्ताओं की मूल प्रोफ़ाइल जानकारी प्राप्त करें। अनुरोधित स्कोप में 'प्रोफ़ाइल', 'ईमेल' और 'ओपनिड' जोड़ता है। अगर अनिर्दिष्ट है तो सही।
hosted_domain string जी सूट डोमेन जिसके लिए उपयोगकर्ताओं को साइन इन करना होगा। यह क्लाइंट द्वारा संशोधन के लिए अतिसंवेदनशील है, इसलिए लौटे उपयोगकर्ता की होस्ट की गई डोमेन संपत्ति को सत्यापित करना सुनिश्चित करें। क्लाइंट पर GoogleUser.getHostedDomain () और डोमेन को सत्यापित करने के लिए सर्वर पर ID टोकन में hd दावा का उपयोग करें।
ux_mode string साइन-इन प्रवाह के लिए उपयोग करने के लिए UX मोड। डिफ़ॉल्ट रूप से, यह एक पॉपअप में सहमति प्रवाह खोल देगा। मान्य मूल्य popup और redirect
redirect_uri string यदि ux_mode='redirect' का उपयोग किया ux_mode='redirect' , तो यह पैरामीटर आपको डिफ़ॉल्ट redirect_uri को ओवरराइड करने की अनुमति देता है जिसका उपयोग सहमति प्रवाह के अंत में किया जाएगा। डिफ़ॉल्ट redirect_uri वर्तमान URL क्वेरी पैरामीटर और हैश टुकड़ा से छीन लिया गया है।

प्रमाणीकरण

GoogleAuth एक सिंगलटन वर्ग है जो उपयोगकर्ता को Google खाते से साइन इन करने की अनुमति देता है, उपयोगकर्ता की वर्तमान साइन-इन स्थिति प्राप्त करता है, उपयोगकर्ता की Google प्रोफ़ाइल से विशिष्ट डेटा प्राप्त करता है, अतिरिक्त स्कोप का अनुरोध करता है, और चालू खाते से साइन आउट करता है।

gapi.auth2.getAuthInstance ()

GoogleAuth ऑब्जेक्ट लौटाता है। इस पद्धति को कॉल करने से पहले आपको GoogleAuth ऑब्जेक्ट को gapi.auth2.init() साथ प्रारंभ करना होगा।

रिटर्न
gapi.auth2.GoogleAuth The gapi.auth2.GoogleAuth ऑब्जेक्ट। इस ऑब्जेक्ट का उपयोग gapi.auth2.GoogleAuth के तरीकों को कॉल करने के लिए करें।

GoogleAuth.isSignedIn.get ()

वर्तमान उपयोगकर्ता वर्तमान में साइन इन है या नहीं।

रिटर्न
बूलियन true है, तो उपयोगकर्ता के प्रवेश किए, या है false यदि उपयोगकर्ता साइन आउट रहता है या GoogleAuth वस्तु आरंभ नहीं किया है।

GoogleAuth.isSignedIn.listen (श्रोता)

वर्तमान उपयोगकर्ता के साइन-इन स्थिति में परिवर्तन के लिए सुनो।

बहस
listener एक फ़ंक्शन जो बूलियन मान लेता है। जब उपयोगकर्ता साइन इन करता है और उपयोगकर्ता साइन आउट करता है तो false listen() इस फ़ंक्शन को true मानता है।

GoogleAuth.signIn ()

उपयोगकर्ता के लिए निर्दिष्ट किए गए विकल्पों के साथ gapi.auth2.init()

रिटर्न
वादा एक Promise जो GoogleUser उदाहरण के साथ पूरा होता है जब उपयोगकर्ता सफलतापूर्वक अनुरोधित स्कोप को प्रमाणित करता है और अनुदान देता है, या एक error वाली वस्तु के साथ अस्वीकार कर दिया जाता है यदि कोई त्रुटि हुई (त्रुटि कोड के लिए नीचे देखें)।

त्रुटि कोड

GoogleAuth.signIn( options ) देखें।

GoogleAuth.signIn ( options )

निर्दिष्ट विकल्पों का उपयोग करके उपयोगकर्ता में संकेत।

बहस
options या तो:
  • एक gapi.auth2.SignInOptions ऑब्जेक्ट जिसमें साइन-इन मापदंडों के प्रमुख-मूल्य जोड़े हैं। उदाहरण के लिए:
    {
      scope: 'profile email'
    }
  • gapi.auth2.SigninOptionsBuilder का एक उदाहरण। उदाहरण के लिए:
    options = new gapi.auth2.SigninOptionsBuilder();
    options.setAppPackageName('com.example.app');
    options.setFetchBasicProfile(True);
    options.setPrompt('select_account');
    options.setScope('profile').setScope('email');
रिटर्न
वादा एक Promise जो GoogleUser उदाहरण के साथ पूरा होता है जब उपयोगकर्ता सफलतापूर्वक अनुरोधित स्कोप को प्रमाणित करता है और अनुदान देता है, या एक error वाली वस्तु के साथ अस्वीकार कर दिया है यदि कोई त्रुटि हुई (त्रुटि कोड के लिए नीचे देखें)।

त्रुटि कोड

popup_closed_by_user
प्रवाह में साइन खत्म करने से पहले उपयोगकर्ता ने पॉपअप को बंद कर दिया।
access_denied
उपयोगकर्ता ने आवश्यक स्कोप की अनुमति से इनकार कर दिया।
immediate_failed
सहमति प्रवाह को संकेत दिए बिना किसी भी उपयोगकर्ता को स्वचालित रूप से नहीं चुना जा सकता है। त्रुटि उठाया का उपयोग करते समय signIn के साथ prompt: 'none' विकल्प। इस विकल्प का उपयोग करने की आवश्यकता नहीं होनी चाहिए, क्योंकि पिछले सत्र के दौरान यदि पहले साइन किया गया था, तो gapi.auth2.init स्वचालित रूप से उपयोगकर्ता में हस्ताक्षर करेगा।

gapi.auth2.ignInOptions

GoogleAuth.signIn( options ) विधि के लिए विभिन्न कॉन्फ़िगरेशन मापदंडों का प्रतिनिधित्व करने वाला इंटरफ़ेस।

मापदंडों
prompt string सहमति प्रवाह के लिए एक विशिष्ट मोड को मजबूर करता है। वैकल्पिक।
संभावित मूल्य हैं:
  • consent
    प्राधिकरण सर्वर एप्लिकेशन को जानकारी वापस करने से पहले उपयोगकर्ता को सहमति के लिए संकेत देता है।
  • select_account
    प्राधिकरण सर्वर उपयोगकर्ता को Google खाता चुनने के लिए प्रेरित करता है। यह एक ऐसे उपयोगकर्ता को अनुमति देता है जिसके पास कई खातों के बीच चयन करने के लिए कई सत्र हैं जिनके लिए उनके पास वर्तमान सत्र हो सकते हैं।
  • none ( अनुशंसित नहीं )
    प्राधिकरण सर्वर कोई प्रमाणीकरण या उपयोगकर्ता सहमति स्क्रीन प्रदर्शित नहीं करेगा; यदि उपयोगकर्ता पहले से प्रमाणित नहीं है और पहले से अनुरोध किए गए स्कोप के लिए सहमति नहीं दी है तो यह एक त्रुटि लौटाएगा।
    जैसा कि अगर पहले साइन इन किया गया है, तो साइन इन करने में gapi.auth2.init स्वचालित रूप से gapi.auth2.init में साइन इन कर देगा। साइन इन signIn({prompt: 'none'}) आमतौर पर विफल हो जाएगा।
scope string रिक्त स्थान-सीमांकित स्ट्रिंग के रूप में अनुरोध करने के लिए स्कोप, gapi.auth2.init में परिभाषित किए गए स्कोप के ऊपर। वैकल्पिक यदि fetch_basic_profile गलत पर सेट नहीं है।
ux_mode string साइन-इन प्रवाह के लिए उपयोग करने के लिए UX मोड। डिफ़ॉल्ट रूप से, यह एक पॉपअप में सहमति प्रवाह खोल देगा। मान्य मूल्य popup और redirect
redirect_uri string यदि ux_mode='redirect' का उपयोग किया ux_mode='redirect' , तो यह पैरामीटर आपको डिफ़ॉल्ट redirect_uri को ओवरराइड करने की अनुमति देता है जिसका उपयोग सहमति प्रवाह के अंत में किया जाएगा। डिफ़ॉल्ट redirect_uri वर्तमान URL क्वेरी पैरामीटर और हैश टुकड़ा से छीन लिया गया है।

GoogleAuth.signOut ()

आवेदन से चालू खाते का पता लगाता है।

रिटर्न
वादा एक Promise जो उपयोगकर्ता द्वारा साइन आउट किए जाने पर पूरा हुआ है।

GoogleAuth.disconnect ()

उपयोगकर्ता द्वारा दिए गए सभी स्कोप को फिर से प्रकाशित करता है।

GoogleAuth.grantOfflineAccess ( options )

निर्दिष्ट स्कोप ऑफ़लाइन उपयोग करने के लिए उपयोगकर्ता से अनुमति प्राप्त करें।

बहस
options एक gapi.auth2.OfflineAccessOptions ऑब्जेक्ट जिसमें पैरामीटर के मुख्य-मूल्य जोड़े हैं। उदाहरण के लिए:
{
  scope: 'profile email'
}
रिटर्न
वादा एक Promise जो उपयोगकर्ता द्वारा अनुरोध किए गए स्कोप को पूरा करने पर पूरा होता है, एक वस्तु जो कि Promise के पूर्ति हैंडलर को प्राधिकरण कोड देता है। उदाहरण के लिए:
auth2.grantOfflineAccess().then(function(resp) {
  var auth_code = resp.code;
});

त्रुटि कोड

popup_closed_by_user
उपयोगकर्ता ने सहमति प्रवाह समाप्त करने से पहले पॉपअप को बंद कर दिया।
access_denied
उपयोगकर्ता ने आवश्यक स्कोप की अनुमति से इनकार कर दिया।
immediate_failed
सहमति प्रवाह को संकेत दिए बिना किसी भी उपयोगकर्ता को स्वचालित रूप से नहीं चुना जा सकता है। त्रुटि उठाया का उपयोग करते समय signIn के साथ prompt: 'none' विकल्प। इस विकल्प का उपयोग करने की आवश्यकता नहीं होनी चाहिए, क्योंकि पिछले सत्र के दौरान यदि पहले साइन किया गया था, तो gapi.auth2.init स्वचालित रूप से उपयोगकर्ता में हस्ताक्षर करेगा।

gapi.auth2.OfflineAccessOptions

GoogleAuth.grantOfflineAccess( options ) विधि के लिए विभिन्न कॉन्फ़िगरेशन मापदंडों का प्रतिनिधित्व करने वाला इंटरफ़ेस।

मापदंडों
prompt string सहमति प्रवाह के लिए एक विशिष्ट मोड को मजबूर करता है। वैकल्पिक।
संभावित मूल्य हैं:
  • consent
    प्राधिकरण सर्वर एप्लिकेशन को जानकारी वापस करने से पहले उपयोगकर्ता को सहमति के लिए संकेत देता है।
  • select_account
    प्राधिकरण सर्वर उपयोगकर्ता को Google खाता चुनने के लिए प्रेरित करता है। यह उन उपयोगकर्ताओं को अनुमति देता है जिनके पास कई खातों के बीच चयन करने के लिए कई खाते हैं जिनके लिए उनके पास वर्तमान सत्र हो सकते हैं।
scope string रिक्त स्थान-सीमांकित स्ट्रिंग के रूप में अनुरोध करने के लिए स्कोप, gapi.auth2.init में परिभाषित किए गए स्कोप के ऊपर। वैकल्पिक यदि fetch_basic_profile गलत पर सेट नहीं है।

GoogleAuth.attachClickHandler ( container , options , onsuccess , onfailure )

निर्दिष्ट कंटेनर के क्लिक हैंडलर में साइन-इन प्रवाह को देता है।

बहस
container क्लिक हैंडलर संलग्न करने के लिए div तत्व, का आईडी, या, का संदर्भ।
options एक वस्तु जिसमें मापदंडों के मुख्य-मूल्य जोड़े होते हैं। GoogleAuth.signIn () देखें।
onsuccess साइन-इन पूर्ण होने के बाद कॉल करने का कार्य।
onfailure साइन-इन विफल होने पर कॉल करने का कार्य।

उपयोगकर्ताओं

GoogleUser ऑब्जेक्ट एक उपयोगकर्ता खाते का प्रतिनिधित्व करता है। GoogleUser ऑब्जेक्ट आमतौर पर GoogleAuth.currentUser.get () पर कॉल करके प्राप्त किए जाते हैं।

GoogleAuth.currentUser.get ()

GoogleUser ऑब्जेक्ट लौटाता है जो वर्तमान उपयोगकर्ता का प्रतिनिधित्व करता है। ध्यान दें कि एक नए आरंभिक GoogleAuth उदाहरण में, वर्तमान उपयोगकर्ता सेट नहीं किया गया है। एक प्रारंभिक GoogleAuth उदाहरण प्राप्त करने के लिए currentUser.listen() विधि या GoogleAuth.then() का उपयोग करें।

रिटर्न
GoogleUser वर्तमान उपयोगकर्ता

GoogleAuth.currentUser.listen ( listener )

CurrentUser में बदलावों के लिए सुनो।

बहस
listener एक फ़ंक्शन जो GoogleUser पैरामीटर लेता है। listen इस फ़ंक्शन को currentUser परिवर्तन को संशोधित करने वाले हर बदलाव पर GoogleUser उदाहरण currentUser

GoogleUser.getId ()

उपयोगकर्ता की विशिष्ट आईडी स्ट्रिंग प्राप्त करें।

रिटर्न
तार उपयोगकर्ता की अद्वितीय आईडी

GoogleUser.isSignedIn ()

यदि उपयोगकर्ता साइन इन है, तो सही है।

रिटर्न
बूलियन यदि उपयोगकर्ता साइन इन है तो सही है

GoogleUser.getHostedDomain ()

यदि उपयोगकर्ता जी सूट खाते के साथ साइन इन करता है तो उपयोगकर्ता का G सुइट डोमेन प्राप्त करें।

रिटर्न
तार उपयोगकर्ता का जी सूट डोमेन

GoogleUser.getGrantedScopes ()

स्कोप प्राप्त करें जो उपयोगकर्ता ने अंतरिक्ष-सीमांकित स्ट्रिंग के रूप में दिए हैं।

रिटर्न
तार उपयोगकर्ता द्वारा दिए गए स्कोप

GoogleUser.getBasicProfile ()

उपयोगकर्ता की मूल प्रोफ़ाइल जानकारी प्राप्त करें।

रिटर्न
gapi.auth2.BasicProfile आप निम्नलिखित विधियों के साथ gapi.auth2.BasicProfile के गुणों को पुनः प्राप्त कर सकते हैं:
  • BasicProfile.getId ()
  • BasicProfile.getName ()
  • BasicProfile.getGivenName ()
  • BasicProfile.getFamilyName ()
  • BasicProfile.getImageUrl ()
  • BasicProfile.getEmail ()

GoogleUser.getAuthResponse (शामिल करेंऑथराइज़ेशनडाटा)

उपयोगकर्ता के सामान्य सत्र से प्रतिक्रिया ऑब्जेक्ट प्राप्त करें।

बहस
includeAuthorizationData वैकल्पिक: एक बूलियन जो निर्दिष्ट करता है कि क्या हमेशा एक्सेस टोकन और स्कोप वापस करना है। डिफ़ॉल्ट रूप से, पहुंच टोकन और अनुरोधित स्कोप तब नहीं लौटाए जाते हैं जब fetch_basic_profile सत्य (डिफ़ॉल्ट मान) है और अतिरिक्त स्कोप का अनुरोध नहीं किया जाता है।
रिटर्न
gapi.auth2.AuthResponse A gapi.auth2.AuthResponse वस्तु।

GoogleUser.reloadAuthResponse ()

पहुँच टोकन के एक ताज़ा करता है, और फिर नए AuthResponse के लिए एक वादा देता है।

रिटर्न
Promise एक Promise जो पुनः लोड किए गए gapi.auth2.AuthResponse साथ पूरा हो गया है। gapi.auth2.AuthResponse को फिर से लोड करने के दौरान किसी भी कारण से किया जाता है।

gapi.auth2.AuthResponse

GoogleUser.getAuthResponse( includeAuthorizationData ) या GoogleUser.reloadAuthResponse() विधियों को कॉल करने पर प्रतिक्रिया वापस आ गई।

गुण
access_token string पहुँच टोकन प्रदान की गई।
id_token string आईडी टोकन दिया गया।
scope string एक्सेस टोकन में दिए गए स्कोप।
expires_in number पहुँच टोकन समाप्त होने तक सेकंड की संख्या।
first_issued_at number टाइमस्टैम्प जिस पर उपयोगकर्ता ने अनुरोध किए गए स्कोप को पहले दिया था।
expires_at number टाइमस्टैम्प जिस पर एक्सेस टोकन समाप्त हो जाएगा।

GoogleUser.hasGranedScopes ( scopes )

यदि उपयोगकर्ता ने निर्दिष्ट स्कोप दिए तो यह सही है।

बहस
scopes स्कोप का एक अंतरिक्ष-सीमांकित स्ट्रिंग।
रिटर्न
बूलियन सच है अगर स्कोप प्रदान किए गए थे

GoogleUser.grant ( options )

उपयोगकर्ता को अतिरिक्त स्कोप का अनुरोध करें।

मापदंडों की सूची और त्रुटि कोड के लिए GoogleAuth.signIn() देखें।

GoogleUser.grantOfflineAccess ( options )

निर्दिष्ट स्कोप ऑफ़लाइन उपयोग करने के लिए उपयोगकर्ता से अनुमति प्राप्त करें।

बहस
options एक gapi.auth2.OfflineAccessOptions ऑब्जेक्ट जिसमें पैरामीटर के मुख्य-मूल्य जोड़े हैं। उदाहरण के लिए:
{
  scope: 'profile email'
}

GoogleUser.disconnect ()

उपयोगकर्ता द्वारा एप्लिकेशन के लिए दिए गए सभी स्कोप को पुनः प्राप्त करता है।

यूआई तत्व

gapi.signin2.render ( id , options )

options ऑब्जेक्ट द्वारा निर्दिष्ट सेटिंग्स का उपयोग करके, दिए गए आईडी के साथ तत्व में एक साइन-इन बटन रेंडर options

बहस
id तत्व की आईडी जिसमें साइन-इन बटन को रेंडर करना है।
options बटन को रेंडर करने के लिए उपयोग करने के लिए सेटिंग्स वाली ऑब्जेक्ट। उदाहरण के लिए:
{
  scope: 'email',
  width: 200,
  height: 50,
  longtitle: true,
  theme: 'dark',
  onsuccess: handleSuccess,
  onfailure: handleFailure
}
आप निम्नलिखित विकल्प निर्दिष्ट कर सकते हैं:
मापदंडों
क्षेत्र उपयोगकर्ता द्वारा साइन इन करने पर अनुरोध करने के लिए स्कोप (डिफ़ॉल्ट: profile )।
चौड़ाई पिक्सल में बटन की चौड़ाई (डिफ़ॉल्ट: 120 )।
ऊंचाई पिक्सल में बटन की ऊंचाई (डिफ़ॉल्ट: 36 )।
लंबे समय तक रहनेवाला "साइन इन" (डिफ़ॉल्ट: false ) के बजाय "Google के साथ साइन इन करें" जैसे लंबे लेबल प्रदर्शित करें। जब आप लंबे शीर्षक का उपयोग करते हैं, तो आपको बटन की चौड़ाई को उसके डिफ़ॉल्ट से बढ़ाना चाहिए।
विषय बटन का रंग विषय: या तो light या dark (डिफ़ॉल्ट: light )।
onSuccess कॉलबैक फ़ंक्शन कॉल करने के लिए जब कोई उपयोगकर्ता सफलतापूर्वक साइन इन करता है। इस फ़ंक्शन को एक तर्क लेना होगा: उदाहरण के लिए gapi.auth2.GoogleUser (डिफ़ॉल्ट: कोई नहीं)।
असफलता साइन-इन विफल होने पर कॉलबैक फ़ंक्शन। यह फ़ंक्शन कोई तर्क नहीं लेता है (डिफ़ॉल्ट: कोई नहीं)।

उन्नत

gapi.auth2.authorize ( params , callback )

एक बार OAuth 2.0 प्राधिकरण करता है। उपयोग किए गए मापदंडों के आधार पर, यह Google साइन-इन प्रवाह के लिए एक पॉपअप खोलेगा या उपयोगकर्ता की बातचीत के बिना, चुपचाप अनुरोधित प्रतिक्रिया को लोड करने का प्रयास करेगा।

कुछ उपयोग के मामले जहां यह विधि उपयोगी है:

  • आपके एप्लिकेशन को केवल एक बार Google API समापन बिंदु का अनुरोध करने की आवश्यकता होती है, उदाहरण के लिए उपयोगकर्ता के पसंदीदा YouTube वीडियो को पहली बार साइन इन करने के लिए लोड करना।
  • आपके आवेदन का अपना सत्र प्रबंधन बुनियादी ढांचा है, और इसे केवल आपके बैकएंड में उपयोगकर्ता की पहचान करने के लिए आईडी टोकन की आवश्यकता है।
  • एक ही पेज के भीतर कई क्लाइंट आईडी का उपयोग किया जाता है।
बहस
params एक ऑब्जेक्ट जिसमें कॉन्फ़िगरेशन डेटा के मुख्य-मूल्य जोड़े हैं। विभिन्न गुणों को कॉन्फ़िगर करने के लिए gapi.auth2.AuthorizeConfig देखें। उदाहरण के लिए:
{
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}
callback अनुरोध पूरा हो जाने के बाद एक gapi.auth2.AuthorizeResponse

उदाहरण

gapi.auth2.authorize({
  client_id: 'CLIENT_ID.apps.googleusercontent.com',
  scope: 'email profile openid',
  response_type: 'id_token permission'
}, function(response) {
  if (response.error) {
    // An error happened!
    return;
  }
  // The user authorized the application for the scopes requested.
  var accessToken = response.access_token;
  var idToken = response.id_token;
  // You can also now use gapi.client to perform authenticated requests.
});

त्रुटि कोड

idpiframe_initialization_failed
एक असमर्थित वातावरण के कारण, उदाहरण के लिए, Google से एक आवश्यक iframe को आरंभ करने में विफल। एक details संपत्ति उठाया त्रुटि पर अधिक जानकारी देगा।
popup_closed_by_user
प्रवाह में साइन खत्म करने से पहले उपयोगकर्ता ने पॉपअप को बंद कर दिया।
access_denied
उपयोगकर्ता ने आवश्यक स्कोप की अनुमति से इनकार कर दिया।
immediate_failed
सहमति प्रवाह को संकेत दिए बिना किसी भी उपयोगकर्ता को स्वचालित रूप से नहीं चुना जा सकता है। prompt: 'none' साथ prompt: 'none' का उपयोग करते समय त्रुटि signIn prompt: 'none' विकल्प।

gapi.auth2.AuthorizeConfig

इंटरफ़ेस जो अंतर कॉन्फ़िगरेशन के लिए विभिन्न कॉन्फ़िगरेशन मापदंडों का प्रतिनिधित्व करता है। gapi.auth2.authorize विधि।

गुण
client_id string आवश्यक है । ऐप का क्लाइंट आईडी, Google डेवलपर्स कंसोल में पाया और बनाया गया है।
scope string आवश्यक है । अंतरिक्ष-सीमांकित स्ट्रिंग के रूप में अनुरोध करने के लिए स्कोप।
response_type string अंतरिक्ष-सीमांकित प्रतिक्रिया प्रकार की एक सूची। 'permission' लिए चूक। संभावित मूल्य हैं:
  • id_token , एक ID टोकन प्राप्त करने के लिए
  • एक्सेस टोकन प्राप्त करने के लिए permission (या token )
  • code , एक प्राधिकरण कोड प्राप्त करने के लिए
prompt string सहमति प्रवाह के लिए एक विशिष्ट मोड को मजबूर करता है। संभावित मूल्य हैं:
  • consent
    प्राधिकरण सर्वर एप्लिकेशन को जानकारी वापस करने से पहले उपयोगकर्ता को सहमति के लिए संकेत देता है।
  • select_account
    प्राधिकरण सर्वर उपयोगकर्ता को Google खाता चुनने के लिए प्रेरित करता है। यह एक ऐसे उपयोगकर्ता को अनुमति देता है जिसके पास कई खातों के बीच चयन करने के लिए एक से अधिक खाते हैं जिनके लिए उनके पास वर्तमान सत्र हो सकते हैं।
  • none
    प्राधिकरण सर्वर कोई प्रमाणीकरण या उपयोगकर्ता सहमति स्क्रीन प्रदर्शित नहीं करेगा; यदि उपयोगकर्ता पहले से ही प्रमाणित नहीं है और पहले से अनुरोधित स्कोप के लिए सहमति नहीं दी है तो यह एक त्रुटि लौटाएगा।
    यदि code को प्रतिक्रिया प्रकार के रूप में अनुरोध किया जाता है, तो लौटा हुआ कोड केवल एक access_token लिए access_token , न कि एक refresh_token
cookie_policy string वह डोमेन जिसके लिए साइन-इन कुकीज़ बनाना है। या तो एक URI, single_host_origin , या none । अनिर्दिष्ट होने पर single_host_origin को single_host_origin
hosted_domain string जी सूट डोमेन जिसके लिए उपयोगकर्ताओं को साइन इन करना होगा। यह क्लाइंट द्वारा संशोधन के लिए अतिसंवेदनशील है, इसलिए लौटे उपयोगकर्ता की होस्ट की गई डोमेन संपत्ति को सत्यापित करना सुनिश्चित करें।
login_hint string साइन-इन प्रवाह में पूर्व-चयन के लिए उपयोगकर्ता का ईमेल या उपयोगकर्ता आईडी। यह उपयोगकर्ता द्वारा संशोधन करने के लिए अतिसंवेदनशील है, जब तक कि prompt: "none" न हो prompt: "none" का उपयोग किया जाता है।
include_granted_scopes boolean क्या एक एक्सेस टोकन का अनुरोध करना है जिसमें उपयोगकर्ता द्वारा ऐप को पहले दिए गए सभी स्कोप शामिल हैं, या केवल वर्तमान कॉल में अनुरोध किए गए स्कोप। चूक true

gapi.auth2.AuthorizeResponse

प्रतिक्रिया की कॉलबैक को लौट gapi.auth2.authorize विधि।

गुण
access_token string पहुँच टोकन प्रदान की गई। केवल तभी मौजूद है जब response_type में permission या token निर्दिष्ट किया गया था।
id_token string आईडी टोकन दिया गया। केवल वर्तमान अगर id_token में निर्दिष्ट किया गया था response_type
code string प्राधिकरण कोड प्रदान किया गया। केवल मौजूद है अगर code response_type में निर्दिष्ट किया गया था।
scope string एक्सेस टोकन में दिए गए स्कोप। केवल तभी मौजूद है जब response_type में permission या token निर्दिष्ट किया गया था।
expires_in number पहुँच टोकन समाप्त होने तक सेकंड की संख्या। केवल तभी मौजूद है जब response_type में permission या token निर्दिष्ट किया गया था।
first_issued_at number टाइमस्टैम्प जिस पर उपयोगकर्ता ने अनुरोध किए गए स्कोप को पहले दिया था। केवल तभी मौजूद है जब response_type में permission या token निर्दिष्ट किया गया था।
expires_at number टाइमस्टैम्प जिस पर एक्सेस टोकन समाप्त हो जाएगा। केवल तभी मौजूद है जब response_type में permission या token निर्दिष्ट किया गया था।
error string जब अनुरोध विफल हुआ, तो इसमें त्रुटि कोड शामिल है
error_subtype string जब अनुरोध विफल हो जाता है, तो इसमें त्रुटि जानकारी अतिरिक्त कोड भी हो सकती है।