Google Identity Services पर माइग्रेट करें

खास जानकारी

Google API को कॉल करने के लिए, हर उपयोगकर्ता के लिए ऐक्सेस टोकन पाने के लिए, Google कई JavaScript लाइब्रेरी उपलब्ध कराता है:

इस गाइड में, इन लाइब्रेरी से Google Identity Services लाइब्रेरी पर माइग्रेट करने के निर्देश दिए गए हैं.

इस गाइड को फ़ॉलो करने से आपको ये फ़ायदे मिलेंगे:

  • अब काम न करने वाली प्लैटफ़ॉर्म लाइब्रेरी को पहचान करने वाली सेवा लाइब्रेरी से बदलें, और
  • अगर एपीआई क्लाइंट लाइब्रेरी का इस्तेमाल किया जा रहा है, तो बंद किए जा चुके gapi.auth2 मॉड्यूल, उसके तरीकों, और ऑब्जेक्ट को हटा दें. साथ ही, उनकी जगह पर पहचान करने वाली सेवा के मिलते-जुलते मॉड्यूल, तरीके, और ऑब्जेक्ट इस्तेमाल करें.

Identity Services JavaScript लाइब्रेरी में हुए बदलावों के बारे में जानने के लिए, खास जानकारी और उपयोगकर्ता की अनुमति देने की प्रोसेस कैसे काम करती है लेख पढ़ें. इससे आपको मुख्य शब्दों और सिद्धांतों को समझने में मदद मिलेगी.

अगर आपको उपयोगकर्ता के साइन-अप और साइन-इन के लिए पुष्टि करने की सुविधा चाहिए, तो 'Google साइन-इन' से माइग्रेट करना पेज देखें.

अनुमति देने के फ़्लो की पहचान करना

उपयोगकर्ता को अनुमति देने के दो तरीके हैं: इंप्लिसिट और ऑथराइज़ेशन कोड.

अपने वेब ऐप्लिकेशन की समीक्षा करें, ताकि यह पता चल सके कि किस तरह के ऑथराइज़ेशन फ़्लो का इस्तेमाल किया जा रहा है.

आपका वेब ऐप्लिकेशन इंप्लिसिट फ़्लो का इस्तेमाल कर रहा है, इसके संकेत:

  • आपका वेब ऐप्लिकेशन पूरी तरह से ब्राउज़र पर आधारित है और इसमें कोई बैकएंड प्लैटफ़ॉर्म नहीं है.
  • Google API को कॉल करने के लिए, उपयोगकर्ता का मौजूद होना ज़रूरी है. आपका ऐप्लिकेशन सिर्फ़ ऐक्सेस टोकन का इस्तेमाल करता है और उसे रीफ़्रेश टोकन की ज़रूरत नहीं होती.
  • आपका वेब ऐप्लिकेशन apis.google.com/js/api.js लोड होता है.
  • आपका इंटिग्रेशन, क्लाइंट-साइड वेब ऐप्लिकेशन के लिए OAuth 2.0 पर आधारित है.
  • आपका ऐप्लिकेशन, JavaScript के लिए Google API क्लाइंट लाइब्रेरी में मौजूद gapi.client या gapi.auth2 मॉड्यूल का इस्तेमाल करता है.

इन बातों से पता चलता है कि आपका वेब ऐप्लिकेशन, ऑथराइज़ेशन कोड फ़्लो का इस्तेमाल कर रहा है:

  • आपका लागू किया गया तरीका इस पर आधारित है:

  • आपका ऐप्लिकेशन, उपयोगकर्ता के ब्राउज़र और आपके बैकएंड प्लैटफ़ॉर्म, दोनों पर काम करता है.

  • आपका बैकएंड प्लैटफ़ॉर्म, ऑथराइज़ेशन कोड एंडपॉइंट को होस्ट करता हो.

  • आपका बैकएंड प्लैटफ़ॉर्म, उपयोगकर्ताओं की ओर से Google API को कॉल करता है. इसके लिए, उपयोगकर्ताओं को मौजूद रहने की ज़रूरत नहीं होती. इसे ऑफ़लाइन मोड भी कहा जाता है.

  • रिफ़्रेश टोकन को आपका बैकएंड प्लैटफ़ॉर्म मैनेज और सेव करता है.

कुछ मामलों में, आपका कोड बेस दोनों फ़्लो के साथ काम कर सकता है.

अनुमति देने का कोई तरीका चुनें

माइग्रेशन शुरू करने से पहले, आपको यह तय करना होगा कि आपके मौजूदा फ़्लो को जारी रखना है या कोई दूसरा फ़्लो अपनाना है.

दोनों फ़्लो के बीच के मुख्य अंतर और फ़ायदों को समझने के लिए, अनुमति देने का फ़्लो चुनना लेख पढ़ें.

ज़्यादातर मामलों में, ऑथराइज़ेशन कोड फ़्लो का इस्तेमाल करने का सुझाव दिया जाता है. इससे उपयोगकर्ता को सबसे ज़्यादा सुरक्षा मिलती है. इस फ़्लो को लागू करने से, आपके प्लैटफ़ॉर्म पर ऑफ़लाइन काम करने वाली नई सुविधाएं भी जोड़ी जा सकती हैं. जैसे, उपयोगकर्ताओं को उनके कैलेंडर, फ़ोटो, और सदस्यताओं में हुए अहम बदलावों की सूचना देने के लिए अपडेट फ़ेच करना.

सिलेक्टर का इस्तेमाल करके, अनुमति देने का कोई फ़्लो चुनें.

इंप्लिसिट फ़्लो

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

इंप्लिसिट फ़्लो के उदाहरण में, Identity Services पर माइग्रेट करने से पहले और बाद के वेब ऐप्लिकेशन दिखाए गए हैं.

ऑथराइज़ेशन कोड फ़्लो

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

ऑथराइज़ेशन कोड फ़्लो के उदाहरण में, पहचान करने वाली सेवा पर माइग्रेट करने से पहले और बाद के वेब ऐप्लिकेशन दिखाए गए हैं.

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

ब्राउज़र में इस्तेमाल किए जाने वाले वेब ऐप्लिकेशन में होने वाले बदलाव

इस सेक्शन में, उन बदलावों के बारे में बताया गया है जो आपको Google Identity Services की JavaScript लाइब्रेरी पर माइग्रेट करते समय, अपने इन-ब्राउज़र वेब ऐप्लिकेशन में करने होंगे.

जिस कोड पर असर पड़ा है उसकी पहचान करना और उसकी जांच करना

डीबग कुकी की मदद से, उन कोड का पता लगाया जा सकता है जिन पर असर पड़ा है. साथ ही, कुकी के बंद होने के बाद के व्यवहार की जांच की जा सकती है.

बड़े या जटिल ऐप्लिकेशन में, gapi.auth2 मॉड्यूल के बंद होने से प्रभावित होने वाले सभी कोड ढूंढना मुश्किल हो सकता है. जल्द ही बंद होने वाली सुविधा के मौजूदा इस्तेमाल को कंसोल में लॉग करने के लिए, G_AUTH2_MIGRATION कुकी की वैल्यू को informational पर सेट करें. इसके अलावा, सेशन स्टोरेज में भी लॉग करने के लिए, कोलन के बाद कोई की-वैल्यू जोड़ें. साइन-इन करने और क्रेडेंशियल मिलने के बाद, इकट्ठा किए गए लॉग की समीक्षा करें या उन्हें बाद में विश्लेषण के लिए बैकएंड पर भेजें. उदाहरण के लिए, informational:showauth2use, showauth2use नाम के सेशन स्टोरेज की में ऑरिजिन और यूआरएल को सेव करता है.

gapi.auth2 मॉड्यूल लोड न होने पर ऐप्लिकेशन के काम करने के तरीके की पुष्टि करने के लिए, G_AUTH2_MIGRATION कुकी की वैल्यू को enforced पर सेट करें. इससे, नीति उल्लंघन ठीक करने के तरीके लागू होने की तारीख से पहले, बंद होने के बाद के व्यवहार की जांच की जा सकती है.

G_AUTH2_MIGRATION कुकी की ये वैल्यू हो सकती हैं:

  • enforced gapi.auth2 मॉड्यूल लोड न करें.
  • informational JS कंसोल में, बंद हो चुकी सुविधा के इस्तेमाल को लॉग करें. वैकल्पिक कुंजी का नाम सेट होने पर, सेशन स्टोरेज में भी लॉग करें: informational:key-name.

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

लाइब्रेरी और मॉड्यूल

gapi.auth2 मॉड्यूल, साइन-इन करने के लिए उपयोगकर्ता की पुष्टि करने और अनुमति देने के लिए इंप्लिसिट फ़्लो को मैनेज करता है. इस मॉड्यूल को अब इस्तेमाल नहीं किया जा सकता. इसलिए, इसे और इसके ऑब्जेक्ट और तरीकों को Google Identity Services लाइब्रेरी से बदलें.

Identity Services लाइब्रेरी को अपने वेब ऐप्लिकेशन में जोड़ें. इसके लिए, इसे अपने दस्तावेज़ में शामिल करें:

<script src="https://accounts.google.com/gsi/client" async defer></script>

gapi.load('auth2', function) का इस्तेमाल करके, auth2 मॉड्यूल को लोड करने के सभी इंस्टेंस हटाएं.

Google Identity Services लाइब्रेरी, gapi.auth2 मॉड्यूल की जगह इस्तेमाल की जाती है. JavaScript के लिए Google API क्लाइंट लाइब्रेरी से gapi.client मॉड्यूल का इस्तेमाल जारी रखा जा सकता है. साथ ही, खोज से जुड़े दस्तावेज़ से कॉल किए जा सकने वाले JS तरीके अपने-आप बनाने, कई एपीआई कॉल को बैच करने, और सीओआरएस मैनेजमेंट की सुविधा का फ़ायदा लिया जा सकता है.

कुकी

उपयोगकर्ता की अनुमति के लिए, कुकी इस्तेमाल करने की ज़रूरत नहीं होती.

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

क्रेडेंशियल

Google Identity Services, उपयोगकर्ता की पुष्टि और अनुमति को दो अलग-अलग कार्रवाइयों में बांटती है. साथ ही, उपयोगकर्ता के क्रेडेंशियल अलग-अलग होते हैं: उपयोगकर्ता की पहचान करने के लिए इस्तेमाल किया जाने वाला आईडी टोकन, अनुमति के लिए इस्तेमाल किए जाने वाले ऐक्सेस टोकन से अलग होता है.

इन बदलावों को देखने के लिए, क्रेडेंशियल के उदाहरण देखें.

इंप्लिसिट फ़्लो

उपयोगकर्ता की प्रोफ़ाइल को मैनेज करने की सुविधा को अनुमति देने वाले फ़्लो से हटाकर, उपयोगकर्ता की पुष्टि करने और अनुमति देने की प्रोसेस को अलग-अलग करें.

Google साइन-इन की सुविधा वाले JavaScript क्लाइंट के इन रेफ़रंस को हटाएं:

तरीके

  • GoogleUser.getBasicProfile()
  • GoogleUser.getId()

ऑथराइज़ेशन कोड फ़्लो

पहचान करने वाली सेवाएं, ब्राउज़र में मौजूद क्रेडेंशियल को आईडी टोकन और ऐक्सेस टोकन में अलग-अलग करती हैं. यह बदलाव, उन क्रेडेंशियल पर लागू नहीं होता जो आपके बैकएंड प्लैटफ़ॉर्म से Google OAuth 2.0 एंडपॉइंट पर सीधे कॉल करके या आपके प्लैटफ़ॉर्म पर सुरक्षित सर्वर पर चल रही लाइब्रेरी के ज़रिए हासिल किए गए हैं. जैसे, Google APIs Node.js Client.

सेशन की स्थिति

पहले, 'Google साइन इन' की मदद से, उपयोगकर्ता के साइन-इन स्टेटस को मैनेज किया जाता था. इसके लिए, इनका इस्तेमाल किया जाता था:

अपने वेब ऐप्लिकेशन में साइन-इन की स्थिति और उपयोगकर्ता सेशन को मैनेज करने की ज़िम्मेदारी आपकी है.

Google साइन-इन की सुविधा वाले JavaScript क्लाइंट के इन रेफ़रंस को हटाएं:

ऑब्जेक्ट:

  • gapi.auth2.SignInOptions

तरीके:

  • GoogleAuth.attachClickHandler()
  • GoogleAuth.isSignedIn()
  • GoogleAuth.isSignedIn.get()
  • GoogleAuth.isSignedIn.listen()
  • GoogleAuth.signIn()
  • GoogleAuth.signOut()
  • GoogleAuth.currentUser.get()
  • GoogleAuth.currentUser.listen()
  • GoogleUser.isSignedIn()

क्लाइंट कॉन्फ़िगरेशन

इंप्लिसिट या ऑथराइज़ेशन कोड फ़्लो के लिए, टोकन क्लाइंट को शुरू करने के लिए अपने वेब ऐप्लिकेशन को अपडेट करें.

Google साइन-इन की सुविधा वाले JavaScript क्लाइंट के इन रेफ़रंस को हटाएं:

ऑब्जेक्ट:

  • gapi.auth2.ClientConfig
  • gapi.auth2.OfflineAccessOptions

तरीके:

  • gapi.auth2.getAuthInstance()

  • GoogleUser.grant()

इंप्लिसिट फ़्लो

TokenClientConfig ऑब्जेक्ट और initTokenClient() कॉल जोड़ें, ताकि अपने वेब ऐप्लिकेशन को कॉन्फ़िगर किया जा सके. इसके लिए, टोकन क्लाइंट को शुरू करें में दिए गए उदाहरण को फ़ॉलो करें.

Google साइन-इन के JavaScript क्लाइंट के रेफ़रंस को Google Identity Services से बदलें:

ऑब्जेक्ट:

  • TokenClientConfig के साथ gapi.auth2.AuthorizeConfig

तरीके:

  • google.accounts.oauth2.initTokenClient() के साथ gapi.auth2.init()

पैरामीटर:

  • TokenClientConfig.login_hint के साथ gapi.auth2.AuthorizeConfig.login_hint.
  • TokenClientConfig.hd के साथ gapi.auth2.GoogleUser.getHostedDomain().

ऑथराइज़ेशन कोड फ़्लो

कोड क्लाइंट को शुरू करें में दिए गए उदाहरण के मुताबिक, अपने वेब ऐप्लिकेशन को कॉन्फ़िगर करने के लिए, CodeClientConfig ऑब्जेक्ट और initCodeClient() कॉल जोड़ें.

इंप्लिसिट फ़्लो से ऑथराइज़ेशन कोड फ़्लो पर स्विच करते समय:

Google साइन-इन के JavaScript क्लाइंट के रेफ़रंस हटाएं

ऑब्जेक्ट:

  • gapi.auth2.AuthorizeConfig

तरीके:

  • gapi.auth2.init()

पैरामीटर:

  • gapi.auth2.AuthorizeConfig.login_hint
  • gapi.auth2.GoogleUser.getHostedDomain()

टोकन का अनुरोध

उपयोगकर्ता के जेस्चर, जैसे कि बटन पर क्लिक करने से एक अनुरोध जनरेट होता है. इसके बाद, इंप्लिसिट फ़्लो की मदद से, ऐक्सेस टोकन सीधे उपयोगकर्ता के ब्राउज़र पर भेज दिया जाता है. इसके अलावा, हर उपयोगकर्ता के लिए अनुमति कोड को ऐक्सेस टोकन और रीफ़्रेश टोकन से बदलने के बाद, आपके बैकएंड प्लैटफ़ॉर्म पर भेज दिया जाता है.

इंप्लिसिट फ़्लो

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

Google साइन-इन के JavaScript क्लाइंट के रेफ़रंस को Google Identity Services से बदलें:

तरीके:

  • TokenClient.requestAccessToken() के साथ gapi.auth2.authorize()
  • TokenClient.requestAccessToken() के साथ GoogleUser.reloadAuthResponse()

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

अपने कोड बेस को अपडेट करें, ताकि:

  • requestAccessToken() की मदद से, OAuth 2.0 टोकन फ़्लो को ट्रिगर करें.
  • requestAccessToken और OverridableTokenClientConfig का इस्तेमाल करके, इंक्रीमेंटल ऑथराइज़ेशन की सुविधा चालू करें. इससे कई स्कोप के लिए किए गए एक अनुरोध को कई छोटे अनुरोधों में बांटा जा सकता है.
  • मौजूदा टोकन की समयसीमा खत्म होने या उसे रद्द किए जाने पर, नए टोकन का अनुरोध करें.

एक से ज़्यादा स्कोप के साथ काम करने के लिए, आपको अपने कोड बेस में स्ट्रक्चर से जुड़े बदलाव करने पड़ सकते हैं. इससे, सभी स्कोप के लिए एक साथ ऐक्सेस का अनुरोध करने के बजाय, ज़रूरत के हिसाब से स्कोप के लिए ऐक्सेस का अनुरोध किया जा सकता है. इसे इंक्रीमेंटल ऑथराइज़ेशन कहा जाता है. हर अनुरोध में कम से कम स्कोप होने चाहिए. आम तौर पर, एक ही स्कोप होना चाहिए. इंक्रीमेंटल ऑथराइज़ेशन के लिए, अपने ऐप्लिकेशन को अपडेट करने के तरीके के बारे में ज़्यादा जानने के लिए, उपयोगकर्ता की सहमति को मैनेज करने का तरीका देखें.

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

ऑथराइज़ेशन कोड फ़्लो

कोई लिंक या बटन जोड़ें, ताकि Google से अनुमति कोड का अनुरोध करने के लिए, requestCode() को कॉल किया जा सके. उदाहरण के लिए, OAuth 2.0 कोड फ़्लो ट्रिगर करना देखें.

समयसीमा खत्म हो चुके या रद्द किए गए ऐक्सेस टोकन का जवाब देने के तरीके के बारे में ज़्यादा जानने के लिए, टोकन मैनेज करने वाला सेक्शन देखें.

टोकन मैनेज करना

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

जब किसी ऐसे ऐक्सेस टोकन का इस्तेमाल किया जाता है जिसकी समयसीमा खत्म हो गई है या जिसे रद्द कर दिया गया है, तो Google API, 401 Unauthorized का एचटीटीपी स्टेटस कोड और invalid_token गड़बड़ी का मैसेज दिखाता है. उदाहरण के लिए, अमान्य टोकन रिस्पॉन्स देखें.

ऐसे टोकन जिनकी समयसीमा खत्म हो गई है

ऐक्सेस टोकन कम समय के लिए होते हैं और अक्सर कुछ मिनटों के लिए ही मान्य होते हैं.

टोकन रद्द करना

Google खाते का मालिक, पहले दी गई सहमति को किसी भी समय वापस ले सकता है. ऐसा करने से, मौजूदा ऐक्सेस टोकन और रीफ़्रेश टोकन अमान्य हो जाते हैं. ऐक्सेस वापस लेने की प्रोसेस, revoke() का इस्तेमाल करके आपके प्लैटफ़ॉर्म से या Google खाते से शुरू की जा सकती है.

Google साइन-इन के JavaScript क्लाइंट के रेफ़रंस को Google Identity Services से बदलें:

तरीके:

  • google.accounts.oauth2.revoke() के साथ getAuthInstance().disconnect()
  • google.accounts.oauth2.revoke() के साथ GoogleUser.disconnect()

जब कोई उपयोगकर्ता आपके प्लैटफ़ॉर्म पर अपना खाता मिटाता है या आपके ऐप्लिकेशन के साथ डेटा शेयर करने की सहमति वापस लेना चाहता है, तो revoke को कॉल करें.

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

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

उपयोगकर्ता का साइन-इन

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

  • इससे उपयोगकर्ता को बार-बार साइन-इन करने की ज़रूरत नहीं पड़ती. ऐक्सेस टोकन का अनुरोध करने पर, Google खाते में साइन-इन करने की प्रोसेस शुरू हो जाती है. हालांकि, ऐसा तब होता है, जब कोई चालू सेशन पहले से मौजूद न हो.
  • CodeClientConfig या TokenClientConfig ऑब्जेक्ट में login_hint पैरामीटर की वैल्यू के तौर पर, JWT आईडी टोकन क्रेडेंशियल email फ़ील्ड का सीधे तौर पर इस्तेमाल करना. यह सुविधा खास तौर पर तब मददगार होती है, जब आपके प्लैटफ़ॉर्म पर उपयोगकर्ता खाते को मैनेज करने वाला सिस्टम न हो.
  • अपने प्लैटफ़ॉर्म पर पहले से मौजूद किसी स्थानीय उपयोगकर्ता खाते से जुड़े Google खाते को ढूंढना और उसे लिंक करना. इससे आपके प्लैटफ़ॉर्म पर डुप्लीकेट खातों की संख्या कम करने में मदद मिलती है.
  • जब कोई नया, लोकल खाता बनाया जाता है, तो साइन-अप डायलॉग और फ़्लो को उपयोगकर्ता की पुष्टि करने वाले डायलॉग और फ़्लो से साफ़ तौर पर अलग किया जा सकता है. इससे ज़रूरी चरणों की संख्या कम हो जाती है और वेबसाइट छोड़ने की दर में सुधार होता है.

साइन-इन करने के बाद और ऐक्सेस टोकन जारी होने से पहले, उपयोगकर्ताओं को आपके ऐप्लिकेशन के लिए, अनुरोध किए गए स्कोप की सहमति देनी होगी.

सहमति मिलने के बाद, ऐक्सेस टोकन के साथ-साथ उन स्कोप की सूची भी मिलती है जिन्हें उपयोगकर्ता ने स्वीकार या अस्वीकार किया है.

अलग-अलग अनुमतियों की मदद से, उपयोगकर्ता अलग-अलग स्कोप को स्वीकार या अस्वीकार कर सकते हैं. एक से ज़्यादा स्कोप के ऐक्सेस का अनुरोध करने पर, हर स्कोप को अन्य स्कोप से अलग, मंज़ूरी दी जाती है या अस्वीकार किया जाता है. उपयोगकर्ता की पसंद के आधार पर, आपका ऐप्लिकेशन चुनिंदा तौर पर उन सुविधाओं और फ़ंक्शन को चालू करता है जो किसी खास स्कोप पर निर्भर करते हैं.

इंप्लिसिट फ़्लो

Google साइन-इन के JavaScript क्लाइंट के रेफ़रंस को Google Identity Services से बदलें:

ऑब्जेक्ट:

  • TokenClient.TokenResponse के साथ gapi.auth2.AuthorizeResponse
  • TokenClient.TokenResponse के साथ gapi.auth2.AuthResponse

तरीके:

  • google.accounts.oauth2.hasGrantedAllScopes() के साथ GoogleUser.hasGrantedScopes()
  • google.accounts.oauth2.hasGrantedAllScopes() के साथ GoogleUser.getGrantedScopes()

Google साइन-इन के JavaScript क्लाइंट के रेफ़रंस हटाएं:

तरीके:

  • GoogleUser.getAuthResponse()

बारीकी से दी जाने वाली अनुमतियों के इस उदाहरण का पालन करके, अपने वेब ऐप्लिकेशन को hasGrantedAllScopes() और hasGrantedAnyScope() के साथ अपडेट करें.

ऑथराइज़ेशन कोड फ़्लो

ऑथराइज़ेशन कोड को मैनेज करने से जुड़े निर्देशों का पालन करके, अपने बैकएंड प्लैटफ़ॉर्म पर ऑथराइज़ेशन कोड एंडपॉइंट को अपडेट करें या जोड़ें.

अनुरोध की पुष्टि करने, ऐक्सेस टोकन पाने, और टोकन रीफ़्रेश करने के लिए, अपने प्लैटफ़ॉर्म को अपडेट करें. इसके लिए, कोड मॉडल का इस्तेमाल करें गाइड में बताया गया तरीका अपनाएं.

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

इंप्लिसिट फ़्लो के उदाहरण

पुराना तरीका

GAPI क्लाइंट लाइब्रेरी

JavaScript के लिए Google API क्लाइंट लाइब्रेरी का उदाहरण. यह ब्राउज़र में चल रही है और उपयोगकर्ता की सहमति के लिए पॉप-अप डायलॉग का इस्तेमाल कर रही है.

gapi.auth2 मॉड्यूल अपने-आप लोड हो जाता है और gapi.client.init() इसका इस्तेमाल करता है. इसलिए, यह छिपा हुआ है.

<!DOCTYPE html>
  <html>
    <head>
      <script src="https://apis.google.com/js/api.js"></script>
      <script>
        function start() {
          gapi.client.init({
            'apiKey': 'YOUR_API_KEY',
            'clientId': 'YOUR_CLIENT_ID',
            'scope': 'https://www.googleapis.com/auth/cloud-translation',
            'discoveryDocs': ['https://www.googleapis.com/discovery/v1/apis/translate/v2/rest'],
          }).then(function() {
            // Execute an API request which is returned as a Promise.
            // The method name language.translations.list comes from the API discovery.
            return gapi.client.language.translations.list({
              q: 'hello world',
              source: 'en',
              target: 'de',
            });
          }).then(function(response) {
            console.log(response.result.data.translations[0].translatedText);
          }, function(reason) {
            console.log('Error: ' + reason.result.error.message);
          });
        };

        // Load the JavaScript client library and invoke start afterwards.
        gapi.load('client', start);
      </script>
    </head>
    <body>
      <div id="results"></div>
    </body>
  </html>

JS क्लाइंट लाइब्रेरी

क्लाइंट-साइड वेब ऐप्लिकेशन के लिए OAuth 2.0, जो उपयोगकर्ता की सहमति के लिए पॉप-अप डायलॉग का इस्तेमाल करके ब्राउज़र में चलता है.

gapi.auth2 मॉड्यूल को मैन्युअल तरीके से लोड किया जाता है.

<!DOCTYPE html>
<html><head></head><body>
<script>
  var GoogleAuth;
  var SCOPE = 'https://www.googleapis.com/auth/drive.metadata.readonly';
  function handleClientLoad() {
    // Load the API's client and auth2 modules.
    // Call the initClient function after the modules load.
    gapi.load('client:auth2', initClient);
  }

  function initClient() {
    // In practice, your app can retrieve one or more discovery documents.
    var discoveryUrl = 'https://www.googleapis.com/discovery/v1/apis/drive/v3/rest';

    // Initialize the gapi.client object, which app uses to make API requests.
    // Get API key and client ID from Google Cloud console.
    // 'scope' field specifies space-delimited list of access scopes.
    gapi.client.init({
        'apiKey': 'YOUR_API_KEY',
        'clientId': 'YOUR_CLIENT_ID',
        'discoveryDocs': [discoveryUrl],
        'scope': SCOPE
    }).then(function () {
      GoogleAuth = gapi.auth2.getAuthInstance();

      // Listen for sign-in state changes.
      GoogleAuth.isSignedIn.listen(updateSigninStatus);

      // Handle initial sign-in state. (Determine if user is already signed in.)
      var user = GoogleAuth.currentUser.get();
      setSigninStatus();

      // Call handleAuthClick function when user clicks on
      //      "Sign In/Authorize" button.
      $('#sign-in-or-out-button').click(function() {
        handleAuthClick();
      });
      $('#revoke-access-button').click(function() {
        revokeAccess();
      });
    });
  }

  function handleAuthClick() {
    if (GoogleAuth.isSignedIn.get()) {
      // User is authorized and has clicked "Sign out" button.
      GoogleAuth.signOut();
    } else {
      // User is not signed in. Start Google auth flow.
      GoogleAuth.signIn();
    }
  }

  function revokeAccess() {
    GoogleAuth.disconnect();
  }

  function setSigninStatus() {
    var user = GoogleAuth.currentUser.get();
    var isAuthorized = user.hasGrantedScopes(SCOPE);
    if (isAuthorized) {
      $('#sign-in-or-out-button').html('Sign out');
      $('#revoke-access-button').css('display', 'inline-block');
      $('#auth-status').html('You are currently signed in and have granted ' +
          'access to this app.');
    } else {
      $('#sign-in-or-out-button').html('Sign In/Authorize');
      $('#revoke-access-button').css('display', 'none');
      $('#auth-status').html('You have not authorized this app or you are ' +
          'signed out.');
    }
  }

  function updateSigninStatus() {
    setSigninStatus();
  }
</script>

<button id="sign-in-or-out-button"
        style="margin-left: 25px">Sign In/Authorize</button>
<button id="revoke-access-button"
        style="display: none; margin-left: 25px">Revoke access</button>

<div id="auth-status" style="display: inline; padding-left: 25px"></div><hr>

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
<script async defer src="https://apis.google.com/js/api.js"
        onload="this.onload=function(){};handleClientLoad()"
        onreadystatechange="if (this.readyState === 'complete') this.onload()">
</script>
</body></html>

OAuth 2.0 एंडपॉइंट

ब्राउज़र में चलने वाले क्लाइंट-साइड वेब ऐप्लिकेशन के लिए OAuth 2.0, उपयोगकर्ता की सहमति के लिए Google के अनुमति देने वाले सर्वर पर रीडायरेक्ट करता है.

इस उदाहरण में, उपयोगकर्ता के ब्राउज़र से Google के OAuth 2.0 एंडपॉइंट पर किए गए डायरेक्ट कॉल दिखाए गए हैं. इसमें gapi.auth2 मॉड्यूल या JavaScript लाइब्रेरी का इस्तेमाल नहीं किया गया है.

<!DOCTYPE html>
<html><head></head><body>
<script>
  var YOUR_CLIENT_ID = 'REPLACE_THIS_VALUE';
  var YOUR_REDIRECT_URI = 'REPLACE_THIS_VALUE';
  var fragmentString = location.hash.substring(1);

  // Parse query string to see if page request is coming from the Google authorization server.
  var params = {};
  var regex = /([^&=]+)=([^&]*)/g, m;
  while (m = regex.exec(fragmentString)) {
    params[decodeURIComponent(m[1])] = decodeURIComponent(m[2]);
  }
  if (Object.keys(params).length > 0) {
    localStorage.setItem('oauth2-test-params', JSON.stringify(params) );
    if (params['state'] && params['state'] == 'try_sample_request') {
      trySampleRequest();
    }
  }

  // If there's an access token, try an API request.
  // Otherwise, start OAuth 2.0 flow.
  function trySampleRequest() {
    var params = JSON.parse(localStorage.getItem('oauth2-test-params'));
    if (params && params['access_token']) {
      var xhr = new XMLHttpRequest();
      xhr.open('GET',
          'https://www.googleapis.com/drive/v3/about?fields=user&' +
          'access_token=' + params['access_token']);
      xhr.onreadystatechange = function (e) {
        if (xhr.readyState === 4 && xhr.status === 200) {
          console.log(xhr.response);
        } else if (xhr.readyState === 4 && xhr.status === 401) {
          // Token invalid, so prompt for user permission.
          oauth2SignIn();
        }
      };
      xhr.send(null);
    } else {
      oauth2SignIn();
    }
  }

  /*
   * Create form to request access token from the Google authorization server.
   */
function oauth2SignIn() {
  // Google's OAuth 2.0 endpoint for requesting an access token
  var oauth2Endpoint = 'https://accounts.google.com/o/oauth2/v2/auth';

    // Create element to open OAuth 2.0 endpoint in new window.
    var form = document.createElement('form');
    form.setAttribute('method', 'GET'); // Send as a GET request.
    form.setAttribute('action', oauth2Endpoint);

    // Parameters to pass to OAuth 2.0 endpoint.
    var params = {'client_id': YOUR_CLIENT_ID,
                  'redirect_uri': YOUR_REDIRECT_URI,
                  'scope': 'https://www.googleapis.com/auth/drive.metadata.readonly',
                  'state': 'try_sample_request',
                  'include_granted_scopes': 'true',
                  'response_type': 'token'};

    // Add form parameters as hidden input values.
    for (var p in params) {
      var input = document.createElement('input');
      input.setAttribute('type', 'hidden');
      input.setAttribute('name', p);
      input.setAttribute('value', params[p]);
      form.appendChild(input);
    }

    // Add form to page and submit it to open the OAuth 2.0 endpoint.
    document.body.appendChild(form);
    form.submit();
  }
</script>

<button onclick="trySampleRequest();">Try sample request</button>
</body></html>

नया तरीका

सिर्फ़ जीआईएस

इस उदाहरण में, सिर्फ़ Google Identity Services की JavaScript लाइब्रेरी को दिखाया गया है. इसमें टोकन मॉडल का इस्तेमाल किया गया है और उपयोगकर्ता की सहमति के लिए पॉप-अप डायलॉग का इस्तेमाल किया गया है. यह क्लाइंट को कॉन्फ़िगर करने, ऐक्सेस टोकन का अनुरोध करने और उसे पाने, और Google API को कॉल करने के लिए ज़रूरी कम से कम चरणों को दिखाने के लिए दिया गया है.

<!DOCTYPE html>
<html>
  <head>
    <script src="https://accounts.google.com/gsi/client" onload="initClient()" async defer></script>
  </head>
  <body>
    <script>
      var client;
      var access_token;

      function initClient() {
        client = google.accounts.oauth2.initTokenClient({
          client_id: 'YOUR_CLIENT_ID',
          scope: 'https://www.googleapis.com/auth/calendar.readonly \
                  https://www.googleapis.com/auth/contacts.readonly',
          callback: (tokenResponse) => {
            access_token = tokenResponse.access_token;
          },
        });
      }
      function getToken() {
        client.requestAccessToken();
      }
      function revokeToken() {
        google.accounts.oauth2.revoke(access_token, () => {console.log('access token revoked')});
      }
      function loadCalendar() {
        var xhr = new XMLHttpRequest();
        xhr.open('GET', 'https://www.googleapis.com/calendar/v3/calendars/primary/events');
        xhr.setRequestHeader('Authorization', 'Bearer ' + access_token);
        xhr.send();
      }
    </script>
    <h1>Google Identity Services Authorization Token model</h1>
    <button onclick="getToken();">Get access token</button><br><br>
    <button onclick="loadCalendar();">Load Calendar</button><br><br>
    <button onclick="revokeToken();">Revoke token</button>
  </body>
</html>

GAPI async/await

इस उदाहरण में, टोकन मॉडल का इस्तेमाल करके Google Identity Service लाइब्रेरी को जोड़ने, gapi.auth2 मॉड्यूल को हटाने, और JavaScript के लिए Google API क्लाइंट लाइब्रेरी का इस्तेमाल करके एपीआई को कॉल करने का तरीका बताया गया है.

लाइब्रेरी लोड करने के क्रम को लागू करने के लिए, Promises, async, और await का इस्तेमाल किया जाता है. साथ ही, अनुमति से जुड़ी गड़बड़ियों को पकड़ने और फिर से कोशिश करने के लिए भी इनका इस्तेमाल किया जाता है. एपीआई कॉल सिर्फ़ तब किया जाता है, जब मान्य ऐक्सेस टोकन उपलब्ध हो.

जब पेज पहली बार लोड होता है, तब ऐक्सेस टोकन मौजूद न होने पर या ऐक्सेस टोकन की समयसीमा खत्म होने के बाद, उपयोगकर्ताओं को 'कैलेंडर दिखाएं' बटन दबाना होगा.

<!DOCTYPE html>
<html>
<head>
    <title>GAPI and GIS Example</title>
    <script async defer src="https://apis.google.com/js/api.js" onload="gapiLoad()"></script>
    <script async defer src="https://accounts.google.com/gsi/client" onload="gisLoad()"></script>
</head>
<body>
    <h1>GAPI Client with GIS Authorization</h1>
    <button id="authorizeBtn" style="visibility:hidden;">Authorize and Load Events</button>
    <button id="revokeBtn" style="visibility:hidden;">Revoke Access</button>
    <div id="content"></div>

    <script>
        const YOUR_CLIENT_ID = "YOUR_CLIENT_ID";
        const YOUR_API_KEY = 'YOUR_API_KEY';
        const CALENDAR_SCOPE = 'https://www.googleapis.com/auth/calendar.readonly';

        let tokenClient;
        let libsLoaded = 0;

        function gapiLoad() {
            gapi.load('client', initGapiClient);
        }

        async function initGapiClient() {
            try {
                await gapi.client.init({ apiKey: YOUR_API_KEY });
                await gapi.client.load('https://www.googleapis.com/discovery/v1/apis/calendar/v3/rest');
                console.log('GAPI client initialized.');
                checkAllLoaded();
            } catch (err) {
                handleError('GAPI initialization failed:', err);
            }
        }

        function gisLoad() {
            try {
                tokenClient = google.accounts.oauth2.initTokenClient({
                    client_id: YOUR_CLIENT_ID,
                    scope: CALENDAR_SCOPE,
                    callback: '', // Will be set dynamically
                    error_callback: handleGisError,
                });
                console.log('GIS TokenClient initialized.');
                checkAllLoaded();
            } catch (err) {
                handleError('GIS initialization failed:', err);
            }
        }

        function checkAllLoaded() {
            libsLoaded++;
            if (libsLoaded === 2) {
                document.getElementById('authorizeBtn').style.visibility = 'visible';
                document.getElementById('revokeBtn').style.visibility = 'visible';
                document.getElementById('authorizeBtn').onclick = makeApiCall;
                document.getElementById('revokeBtn').onclick = revokeAccess;
                console.log('Ready to authorize.');
            }
        }

        function handleGisError(err) {
            console.error('GIS Error:', err);
            let message = 'An error occurred during authorization.';
            if (err && err.type === 'popup_failed_to_open') {
                message = 'Failed to open popup. Please disable popup blockers.';
            } else if (err && err.type === 'popup_closed') {
                message = 'Authorization popup was closed.';
            }
            document.getElementById('content').textContent = message;
        }

        function handleError(message, error) {
            console.error(message, error);
            document.getElementById('content').textContent = `${message} ${error.message || JSON.stringify(error)}`;
        }

        async function makeApiCall() {
            document.getElementById('content').textContent = 'Processing...';
            try {
                let token = gapi.client.getToken();
                if (!token || !token.access_token) {
                    console.log('No token, fetching one...');
                    await getToken();
                }

                console.log('Calling Calendar API...');
                const response = await gapi.client.calendar.events.list({ 'calendarId': 'primary' });
                displayEvents(response.result);
            } catch (err) {
                console.error('API call failed:', err);
                const errorInfo = err.result && err.result.error;
                if (errorInfo && (errorInfo.code === 401 || (errorInfo.code === 403 && errorInfo.status === "PERMISSION_DENIED"))) {
                    console.log('Auth error on API call, refreshing token...');
                    try {
                        await getToken({ prompt: 'consent' }); // Force refresh
                        const retryResponse = await gapi.client.calendar.events.list({ 'calendarId': 'primary' });
                        displayEvents(retryResponse.result);
                    } catch (refreshErr) {
                        handleError('Failed to refresh token or retry API call:', refreshErr);
                    }
                } else {
                    handleError('Error loading events:', err.result ? err.result.error : err);
                }
            }
        }

        async function getToken(options = { prompt: '' }) {
            return new Promise((resolve, reject) => {
                if (!tokenClient) return reject(new Error("GIS TokenClient not initialized."));
                tokenClient.callback = (tokenResponse) => {
                    if (tokenResponse.error) {
                        reject(new Error(`Token Error: ${tokenResponse.error} - ${tokenResponse.error_description}`));
                    } else {
                        console.log('Token acquired.');
                        resolve(tokenResponse);
                    }
                };
                tokenClient.requestAccessToken(options);
            });
        }

        function displayEvents(result) {
            const events = result.items;
            if (events && events.length > 0) {
                let eventList = '<h3>Upcoming Events:</h3><ul>' + events.map(event =>
                    `<li>${event.summary} (${event.start.dateTime || event.start.date})</li>`
                ).join('') + '</ul>';
                document.getElementById('content').innerHTML = eventList;
            } else {
                document.getElementById('content').textContent = 'No upcoming events found.';
            }
        }

        function revokeAccess() {
            const token = gapi.client.getToken();
            if (token && token.access_token) {
                google.accounts.oauth2.revoke(token.access_token, () => {
                    console.log('Access revoked.');
                    document.getElementById('content').textContent = 'Access has been revoked.';
                    gapi.client.setToken(null);
                });
            } else {
                document.getElementById('content').textContent = 'No token to revoke.';
            }
        }
    </script>
</body>
</html>

GAPI कॉलबैक

इस उदाहरण में, टोकन मॉडल का इस्तेमाल करके Google Identity Service लाइब्रेरी को जोड़ने, gapi.auth2 मॉड्यूल को हटाने, और JavaScript के लिए Google API क्लाइंट लाइब्रेरी का इस्तेमाल करके एपीआई को कॉल करने का तरीका बताया गया है.

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

उपयोगकर्ताओं को पेज लोड होने पर, 'कैलेंडर दिखाएं' बटन दबाना होगा. साथ ही, कैलेंडर की जानकारी रीफ़्रेश करने के लिए, उन्हें फिर से यह बटन दबाना होगा.

<!DOCTYPE html>
<html>
<head>
  <script async defer src="https://apis.google.com/js/api.js" onload="gapiLoad()"></script>
  <script async defer src="https://accounts.google.com/gsi/client" onload="gisInit()"></script>
</head>
<body>
  <h1>GAPI with GIS callbacks</h1>
  <button id="showEventsBtn" onclick="showEvents();">Show Calendar</button><br><br>
  <button id="revokeBtn" onclick="revokeToken();">Revoke access token</button>
  <script>
    let tokenClient;
    let gapiInited;
    let gisInited;

    document.getElementById("showEventsBtn").style.visibility="hidden";
    document.getElementById("revokeBtn").style.visibility="hidden";

    function checkBeforeStart() {
       if (gapiInited && gisInited){
          // Start only when both gapi and gis are initialized.
          document.getElementById("showEventsBtn").style.visibility="visible";
          document.getElementById("revokeBtn").style.visibility="visible";
       }
    }

    function gapiInit() {
      gapi.client.init({
        // NOTE: OAuth2 'scope' and 'client_id' parameters have moved to initTokenClient().
      })
      .then(function() {  // Load the Calendar API discovery document.
        gapi.client.load('https://www.googleapis.com/discovery/v1/apis/calendar/v3/rest');
        gapiInited = true;
        checkBeforeStart();
      });
    }

    function gapiLoad() {
        gapi.load('client', gapiInit)
    }

    function gisInit() {
     tokenClient = google.accounts.oauth2.initTokenClient({
                client_id: 'YOUR_CLIENT_ID',
                scope: 'https://www.googleapis.com/auth/calendar.readonly',
                callback: '',  // defined at request time
            });
      gisInited = true;
      checkBeforeStart();
    }

    function showEvents() {

      tokenClient.callback = (resp) => {
        if (resp.error !== undefined) {
          throw(resp);
        }
        // GIS has automatically updated gapi.client with the newly issued access token.
        console.log('gapi.client access token: ' + JSON.stringify(gapi.client.getToken()));

        gapi.client.calendar.events.list({ 'calendarId': 'primary' })
        .then(calendarAPIResponse => console.log(JSON.stringify(calendarAPIResponse)))
        .catch(err => console.log(err));

        document.getElementById("showEventsBtn").innerText = "Refresh Calendar";
      }

      // Conditionally ask users to select the Google Account they'd like to use,
      // and explicitly obtain their consent to fetch their Calendar.
      // NOTE: To request an access token a user gesture is necessary.
      if (gapi.client.getToken() === null) {
        // Prompt the user to select a Google Account and asked for consent to share their data
        // when establishing a new session.
        tokenClient.requestAccessToken({prompt: 'consent'});
      } else {
        // Skip display of account chooser and consent dialog for an existing session.
        tokenClient.requestAccessToken({prompt: ''});
      }
    }

    function revokeToken() {
      let cred = gapi.client.getToken();
      if (cred !== null) {
        google.accounts.oauth2.revoke(cred.access_token, () => {console.log('Revoked: ' + cred.access_token)});
        gapi.client.setToken('');
        document.getElementById("showEventsBtn").innerText = "Show Calendar";
      }
    }
  </script>
</body>
</html>

ऑथराइज़ेशन कोड फ़्लो के उदाहरण

Google Identity Services लाइब्रेरी का पॉप-अप यूएक्स, ऑथराइज़ेशन कोड को सीधे आपके बैकएंड टोकन एंडपॉइंट पर भेजने के लिए, यूआरएल रीडायरेक्ट का इस्तेमाल कर सकता है. इसके अलावा, उपयोगकर्ता के ब्राउज़र में चल रहे JavaScript कॉलबैक हैंडलर का इस्तेमाल किया जा सकता है. यह हैंडलर, आपके प्लैटफ़ॉर्म पर रिस्पॉन्स को प्रॉक्सी करता है. दोनों ही मामलों में, आपका बैकएंड प्लैटफ़ॉर्म, OAuth 2.0 फ़्लो को पूरा करेगा, ताकि मान्य रीफ़्रेश और ऐक्सेस टोकन मिल सके.

पुराना तरीका

सर्वर-साइड वेब ऐप्लिकेशन

बैकएंड प्लैटफ़ॉर्म पर चल रहे सर्वर-साइड ऐप्लिकेशन के लिए Google साइन-इन. इसके लिए, उपयोगकर्ता की सहमति लेने के लिए Google पर रीडायरेक्ट किया जाता है.

<!DOCTYPE html>
<html>
  <head>
    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>
    <script src="https://apis.google.com/js/client:platform.js?onload=start" async defer></script>
    <script>
      function start() {
        gapi.load('auth2', function() {
          auth2 = gapi.auth2.init({
            client_id: 'YOUR_CLIENT_ID',
            api_key: 'YOUR_API_KEY',
            discovery_docs: ['https://www.googleapis.com/discovery/v1/apis/translate/v2/rest'],
            // Scopes to request in addition to 'profile' and 'email'
            scope: 'https://www.googleapis.com/auth/cloud-translation',
          });
        });
      }
      function signInCallback(authResult) {
        if (authResult['code']) {
          console.log("sending AJAX request");
          // Send authorization code obtained from Google to backend platform
          $.ajax({
            type: 'POST',
            url: 'YOUR_AUTHORIZATION_CODE_ENDPOINT_URL',
            // Always include an X-Requested-With header to protect against CSRF attacks.
            headers: {
              'X-Requested-With': 'XMLHttpRequest'
            },
            contentType: 'application/octet-stream; charset=utf-8',
            success: function(result) {
              console.log(result);
            },
            processData: false,
            data: authResult['code']
          });
        } else {
          console.log('error: failed to obtain authorization code')
        }
      }
    </script>
  </head>
  <body>
    <button id="signinButton">Sign In With Google</button>
    <script>
      $('#signinButton').click(function() {
        // Obtain an authorization code from Google
        auth2.grantOfflineAccess().then(signInCallback);
      });
    </script>
  </body>
</html>

रीडायरेक्ट का इस्तेमाल करने वाला एचटीटीपी/REST

उपयोगकर्ता के ब्राउज़र से आपके बैकएंड प्लैटफ़ॉर्म पर ऑथराइज़ेशन कोड भेजने के लिए, वेब सर्वर ऐप्लिकेशन के लिए OAuth 2.0 का इस्तेमाल करना. उपयोगकर्ता की सहमति को मैनेज करने के लिए, उपयोगकर्ता के ब्राउज़र को Google के ऑथराइज़ेशन सर्वर पर रीडायरेक्ट किया जाता है.

/*
 * Create form to request access token from the Google authorization server.
 */
function oauthSignIn() {
  // Google's OAuth 2.0 endpoint for requesting an access token
  var oauth2Endpoint = 'https://accounts.google.com/o/oauth2/v2/auth';
  // Create &lt;form> element to submit parameters to OAuth 2.0 endpoint.
  var form = document.createElement('form');
  form.setAttribute('method', 'GET'); // Send as a GET request.
  form.setAttribute('action', oauth2Endpoint);
  // Parameters to pass to OAuth 2.0 endpoint.
  var params = {'client\_id': 'YOUR_CLIENT_ID',
                'redirect\_uri': 'YOUR_AUTHORIZATION_CODE_ENDPOINT_URL',
                'response\_type': 'token',
                'scope': 'https://www.googleapis.com/auth/drive.metadata.readonly',
                'include\_granted\_scopes': 'true',
                'state': 'pass-through value'};
  // Add form parameters as hidden input values.
  for (var p in params) {
    var input = document.createElement('input');
    input.setAttribute('type', 'hidden');
    input.setAttribute('name', p);
    input.setAttribute('value', params[p]);
    form.appendChild(input);
  }

  // Add form to page and submit it to open the OAuth 2.0 endpoint.
  document.body.appendChild(form);
  form.submit();
}

नया तरीका

जीआईएस पॉप-अप यूएक्स

इस उदाहरण में, सिर्फ़ Google Identity Services की JavaScript लाइब्रेरी को दिखाया गया है. इसमें ऑथराइज़ेशन कोड मॉडल का इस्तेमाल करके, उपयोगकर्ता की सहमति के लिए पॉप-अप डायलॉग और Google से ऑथराइज़ेशन कोड पाने के लिए कॉलबैक हैंडलर का इस्तेमाल किया गया है. यह क्लाइंट को कॉन्फ़िगर करने, सहमति लेने, और आपके बैकएंड प्लैटफ़ॉर्म पर ऑथराइज़ेशन कोड भेजने के लिए ज़रूरी कम से कम चरणों को दिखाने के लिए दिया गया है.

<!DOCTYPE html>
<html>
  <head>
    <script src="https://accounts.google.com/gsi/client" onload="initClient()" async defer></script>
  </head>
  <body>
    <script>
      var client;
      function initClient() {
        client = google.accounts.oauth2.initCodeClient({
          client_id: 'YOUR_CLIENT_ID',
          scope: 'https://www.googleapis.com/auth/calendar.readonly',
          ux_mode: 'popup',
          callback: (response) => {
            var code_receiver_uri = 'YOUR_AUTHORIZATION_CODE_ENDPOINT_URI',
            // Send auth code to your backend platform
            const xhr = new XMLHttpRequest();
            xhr.open('POST', code_receiver_uri, true);
            xhr.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
            xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
            xhr.onload = function() {
              console.log('Signed in as: ' + xhr.responseText);
            };
            xhr.send('code=' + response.code);
            // After receipt, the code is exchanged for an access token and
            // refresh token, and the platform then updates this web app
            // running in user's browser with the requested calendar info.
          },
        });
      }
      function getAuthCode() {
        // Request authorization code and obtain user consent
        client.requestCode();
      }
    </script>
    <button onclick="getAuthCode();">Load Your Calendar</button>
  </body>
</html>

जीआईएस रीडायरेक्ट यूएक्स

ऑथराइज़ेशन कोड मॉडल, पॉप-अप और रीडायरेक्ट यूएक्स मोड के साथ काम करता है. इससे हर उपयोगकर्ता के लिए ऑथराइज़ेशन कोड को आपके प्लैटफ़ॉर्म पर होस्ट किए गए एंडपॉइंट पर भेजा जा सकता है. रीडायरेक्ट यूएक्स मोड यहां दिखाया गया है:

<!DOCTYPE html>
<html>
  <head>
    <script src="https://accounts.google.com/gsi/client" onload="initClient()" async defer></script>
  </head>
  <body>
    <script>
      var client;
      function initClient() {
        client = google.accounts.oauth2.initCodeClient({
          client_id: 'YOUR_CLIENT_ID',
          scope: 'https://www.googleapis.com/auth/calendar.readonly \
                  https://www.googleapis.com/auth/photoslibrary.readonly',
          ux_mode: 'redirect',
          redirect_uri: 'YOUR_AUTHORIZATION_CODE_ENDPOINT_URI'
        });
      }
      // Request an access token
      function getAuthCode() {
        // Request authorization code and obtain user consent
        client.requestCode();
      }
    </script>
    <button onclick="getAuthCode();">Load Your Calendar</button>
  </body>
</html>

JavaScript लाइब्रेरी

Google Identity Services एक JavaScript लाइब्रेरी है. इसका इस्तेमाल, उपयोगकर्ता की पुष्टि करने और अनुमति देने के लिए किया जाता है. यह लाइब्रेरी, कई अलग-अलग लाइब्रेरी और मॉड्यूल में मिलने वाली सुविधाओं और फ़ंक्शन को एक साथ लाती है और उन्हें बदलती है:

Identity Services पर माइग्रेट करते समय ये कार्रवाइयां करें:

मौजूदा JS लाइब्रेरी नई JS लाइब्रेरी नोट
apis.google.com/js/api.js accounts.google.com/gsi/client नई लाइब्रेरी जोड़ें और इंप्लिसिट फ़्लो का पालन करें.
apis.google.com/js/client.js accounts.google.com/gsi/client नई लाइब्रेरी जोड़ें और ऑथराइज़ेशन कोड फ़्लो का पालन करें.

लाइब्रेरी के बारे में खास जानकारी

पुरानी Google साइन-इन JavaScript क्लाइंट लाइब्रेरी और नई Google Identity Services लाइब्रेरी के बीच ऑब्जेक्ट और तरीके की तुलना. साथ ही, माइग्रेशन के दौरान की जाने वाली कार्रवाई और अतिरिक्त जानकारी के साथ नोट.

पुराना नई सुविधा नोट
GoogleAuth ऑब्जेक्ट और उससे जुड़े तरीके:
GoogleAuth.attachClickHandler() हटाएं
GoogleAuth.currentUser.get() हटाएं
GoogleAuth.currentUser.listen() हटाएं
GoogleAuth.disconnect() google.accounts.oauth2.revoke पुराने को नए से बदलें. https://myaccount.google.com/permissions पर जाकर भी ऐक्सेस वापस लिया जा सकता है
GoogleAuth.grantOfflineAccess() हटाने के लिए, ऑथराइज़ेशन कोड फ़्लो का पालन करें.
GoogleAuth.isSignedIn.get() हटाएं
GoogleAuth.isSignedIn.listen() हटाएं
GoogleAuth.signIn() हटाएं
GoogleAuth.signOut() हटाएं
GoogleAuth.then() हटाएं
GoogleUser ऑब्जेक्ट और उससे जुड़े तरीके:
GoogleUser.disconnect() google.accounts.id.revoke पुराने को नए से बदलें. https://myaccount.google.com/permissions पर जाकर भी ऐक्सेस वापस लिया जा सकता है
GoogleUser.getAuthResponse() requestCode() या requestAccessToken() पुराने को नए से बदलें
GoogleUser.getBasicProfile() हटाएं पर टैप करें. इसके बजाय, आईडी टोकन का इस्तेमाल करें. 'Google साइन-इन' से माइग्रेट करना लेख पढ़ें.
GoogleUser.getGrantedScopes() hasGrantedAnyScope() पुराने को नए से बदलें
GoogleUser.getHostedDomain() हटाएं
GoogleUser.getId() हटाएं
GoogleUser.grantOfflineAccess() हटाने के लिए, ऑथराइज़ेशन कोड फ़्लो का पालन करें.
GoogleUser.grant() हटाएं
GoogleUser.hasGrantedScopes() hasGrantedAnyScope() पुराने को नए से बदलें
GoogleUser.isSignedIn() हटाएं
GoogleUser.reloadAuthResponse() requestAccessToken() समयसीमा खत्म हो चुके या रद्द किए गए ऐक्सेस टोकन को बदलने के लिए, पुराने टोकन को हटाएं और नए टोकन को कॉल करें.
gapi.auth2 ऑब्जेक्ट और उससे जुड़े तरीके:
gapi.auth2.AuthorizeConfig ऑब्जेक्ट TokenClientConfig या CodeClientConfig पुराने को नए से बदलें
gapi.auth2.AuthorizeResponse ऑब्जेक्ट हटाएं
gapi.auth2.AuthResponse ऑब्जेक्ट हटाएं
gapi.auth2.authorize() requestCode() या requestAccessToken() पुराने को नए से बदलें
gapi.auth2.ClientConfig() TokenClientConfig या CodeClientConfig पुराने को नए से बदलें
gapi.auth2.getAuthInstance() हटाएं
gapi.auth2.init() initTokenClient() या initCodeClient() पुराने को नए से बदलें
gapi.auth2.OfflineAccessOptions ऑब्जेक्ट हटाएं
gapi.auth2.SignInOptions ऑब्जेक्ट हटाएं
gapi.signin2 ऑब्जेक्ट और उससे जुड़े तरीके:
gapi.signin2.render() हटाएं पर टैप करें. g_id_signin एलिमेंट की एचटीएमएल डीओएम लोडिंग या google.accounts.id.renderButton के लिए जेएस कॉल, उपयोगकर्ता को Google खाते में साइन-इन करने के लिए ट्रिगर करता है.

क्रेडेंशियल का उदाहरण

मौजूदा क्रेडेंशियल

Google साइन-इन प्लैटफ़ॉर्म लाइब्रेरी, JavaScript के लिए Google API क्लाइंट लाइब्रेरी या Google OAuth 2.0 एंडपॉइंट पर किए गए डायरेक्ट कॉल, एक ही जवाब में OAuth 2.0 ऐक्सेस टोकन और OpenID Connect आईडी टोकन, दोनों दिखाते हैं.

access_token और id_token, दोनों को शामिल करने वाले जवाब का उदाहरण:

  {
    "token_type": "Bearer",
    "access_token": "ya29.A0ARrdaM-SmArZaCIh68qXsZSzyeU-8mxhQERHrP2EXtxpUuZ-3oW8IW7a6D2J6lRnZrRj8S6-ZcIl5XVEqnqxq5fuMeDDH_6MZgQ5dgP7moY-yTiKR5kdPm-LkuPM-mOtUsylWPd1wpRmvw_AGOZ1UUCa6UD5Hg",
    "scope": "https://www.googleapis.com/auth/calendar.readonly",
    "login_hint": "AJDLj6I2d1RH77cgpe__DdEree1zxHjZJr4Q7yOisoumTZUmo5W2ZmVFHyAomUYzLkrluG-hqt4RnNxrPhArd5y6p8kzO0t8xIfMAe6yhztt6v2E-_Bb4Ec3GLFKikHSXNh5bI-gPrsI",
    "expires_in": 3599,
    "id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjkzNDFhYmM0MDkyYjZmYzAzOGU0MDNjOTEwMjJkZDNlNDQ1MzliNTYiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJhY2NvdW50cy5nb29nbGUuY29tIiwiYXpwIjoiNTM4MzQ0NjUzMjU1LTc1OGM1aDVpc2M0NXZnazI3ZDhoOGRlYWJvdnBnNnRvLmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwiYXVkIjoiNTM4MzQ0NjUzMjU1LTc1OGM1aDVpc2M0NXZnazI3ZDhoOGRlYWJvdnBnNnRvLmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwic3ViIjoiMTE3NzI2NDMxNjUxOTQzNjk4NjAwIiwiaGQiOiJnb29nbGUuY29tIiwiZW1haWwiOiJkYWJyaWFuQGdvb2dsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiYXRfaGFzaCI6IkJBSW55TjN2MS1ZejNLQnJUMVo0ckEiLCJuYW1lIjoiQnJpYW4gRGF1Z2hlcnR5IiwicGljdHVyZSI6Imh0dHBzOi8vbGgzLmdvb2dsZXVzZXJjb250ZW50LmNvbS9hLS9BT2gxNEdnenAyTXNGRGZvbVdMX3VDemRYUWNzeVM3ZGtxTE5ybk90S0QzVXNRPXM5Ni1jIiwiZ2l2ZW5fbmFtZSI6IkJyaWFuIiwiZmFtaWx5X25hbWUiOiJEYXVnaGVydHkiLCJsb2NhbGUiOiJlbiIsImlhdCI6MTYzODk5MTYzOCwiZXhwIjoxNjM4OTk1MjM4LCJqdGkiOiI5YmRkZjE1YWFiNzE2ZDhjYmJmNDYwMmM1YWM3YzViN2VhMDQ5OTA5In0.K3EA-3Adw5HA7O8nJVCsX1HmGWxWzYk3P7ViVBb4H4BoT2-HIgxKlx1mi6jSxIUJGEekjw9MC-nL1B9Asgv1vXTMgoGaNna0UoEHYitySI23E5jaMkExkTSLtxI-ih2tJrA2ggfA9Ekj-JFiMc6MuJnwcfBTlsYWRcZOYVw3QpdTZ_VYfhUu-yERAElZCjaAyEXLtVQegRe-ymScra3r9S92TA33ylMb3WDTlfmDpWL0CDdDzby2asXYpl6GQ7SdSj64s49Yw6mdGELZn5WoJqG7Zr2KwIGXJuSxEo-wGbzxNK-mKAiABcFpYP4KHPEUgYyz3n9Vqn2Tfrgp-g65BQ",
    "session_state": {
      "extraQueryParams": {
        "authuser": "0"
      }
    },
    "first_issued_at": 1638991637982,
    "expires_at": 1638995236982,
    "idpId": "google"
  }

Google Identity Services का क्रेडेंशियल

Google Identity Services लाइब्रेरी यह जानकारी दिखाती है:

  • अनुमति देने के लिए इस्तेमाल किया जाने वाला ऐक्सेस टोकन:

    {
  "access_token": "ya29.A0ARrdaM_LWSO-uckLj7IJVNSfnUityT0Xj-UCCrGxFQdxmLiWuAosnAKMVQ2Z0LLqeZdeJii3TgULp6hR_PJxnInBOl8UoUwWoqsrGQ7-swxgy97E8_hnzfhrOWyQBmH6zs0_sUCzwzhEr_FAVqf92sZZHphr0g",
  "token_type": "Bearer",
  "expires_in": 3599,
  "scope": "https://www.googleapis.com/auth/calendar.readonly"
}

  • या पुष्टि करने के लिए इस्तेमाल किया जाने वाला आईडी टोकन:

    {
  "clientId": "538344653255-758c5h5isc45vgk27d8h8deabovpg6to.apps.googleusercontent.com",
  "credential": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImMxODkyZWI0OWQ3ZWY5YWRmOGIyZTE0YzA1Y2EwZDAzMjcxNGEyMzciLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJuYmYiOjE2MzkxNTcyNjQsImF1ZCI6IjUzODM0NDY1MzI1NS03NThjNWg1aXNjNDV2Z2syN2Q4aDhkZWFib3ZwZzZ0by5hcHBzLmdvb2dsZXVzZXJjb250ZW50LmNvbSIsInN1YiI6IjExNzcyNjQzMTY1MTk0MzY5ODYwMCIsIm5vbmNlIjoiZm9vYmFyIiwiaGQiOiJnb29nbGUuY29tIiwiZW1haWwiOiJkYWJyaWFuQGdvb2dsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwiYXpwIjoiNTM4MzQ0NjUzMjU1LTc1OGM1aDVpc2M0NXZnazI3ZDhoOGRlYWJvdnBnNnRvLmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwibmFtZSI6IkJyaWFuIERhdWdoZXJ0eSIsInBpY3R1cmUiOiJodHRwczovL2xoMy5nb29nbGV1c2VyY29udGVudC5jb20vYS0vQU9oMTRHZ3pwMk1zRkRmb21XTF91Q3pkWFFjc3lTN2RrcUxOcm5PdEtEM1VzUT1zOTYtYyIsImdpdmVuX25hbWUiOiJCcmlhbiIsImZhbWlseV9uYW1lIjoiRGF1Z2hlcnR5IiwiaWF0IjoxNjM5MTU3NTY0LCJleHAiOjE2MzkxNjExNjQsImp0aSI6IjRiOTVkYjAyZjU4NDczMmUxZGJkOTY2NWJiMWYzY2VhYzgyMmI0NjUifQ.Cr-AgMsLFeLurnqyGpw0hSomjOCU4S3cU669Hyi4VsbqnAV11zc_z73o6ahe9Nqc26kPVCNRGSqYrDZPfRyTnV6g1PIgc4Zvl-JBuy6O9HhClAK1HhMwh1FpgeYwXqrng1tifmuotuLQnZAiQJM73Gl-J_6s86Buo_1AIx5YAKCucYDUYYdXBIHLxrbALsA5W6pZCqqkMbqpTWteix-G5Q5T8LNsfqIu_uMBUGceqZWFJALhS9ieaDqoxhIqpx_89QAr1YlGu_UO6R6FYl0wDT-nzjyeF5tonSs3FHN0iNIiR3AMOHZu7KUwZaUdHg4eYkU-sQ01QNY_11keHROCRQ",
  "select_by": "user"
}

अमान्य टोकन रिस्पॉन्स

समयसीमा खत्म हो चुके, रद्द किए गए या अमान्य ऐक्सेस टोकन का इस्तेमाल करके एपीआई अनुरोध करने पर, Google से मिलने वाले जवाब का उदाहरण:

एचटीटीपी रिस्पॉन्स हेडर

  www-authenticate: Bearer realm="https://accounts.google.com/", error="invalid_token"

जवाब का मुख्य हिस्सा

  {
    "error": {
      "code": 401,
      "message": "Request had invalid authentication credentials. Expected OAuth 2 access token, login cookie or other valid authentication credential. See https://developers.google.com/identity/sign-in/web/devconsole-project.",
      "errors": [
        {
          "message": "Invalid Credentials",
          "domain": "global",
          "reason": "authError",
          "location": "Authorization",
          "locationType": "header"
        }
      ],
      "status": "UNAUTHENTICATED"
    }
  }