Google Workspace ऐड-ऑन को तीसरे पक्ष की सेवा से कनेक्ट करना

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

अगर आपका Google Workspace ऐड-ऑन किसी ऐसी तीसरे पक्ष की सेवा या एपीआई से कनेक्ट होता है जिसे अनुमति देना ज़रूरी है, तो ऐड-ऑन उपयोगकर्ताओं को साइन इन करने और ऐक्सेस की अनुमति देने के लिए कह सकता है.

इस पेज पर बताया गया है कि ऑथराइज़ेशन फ़्लो (जैसे, OAuth) का इस्तेमाल करके उपयोगकर्ताओं की पहचान की पुष्टि कैसे करें. इस फ़्लो में ये चरण शामिल हैं:

  1. पता लगाएं कि अनुमति कब चाहिए.
  2. वह कार्ड इंटरफ़ेस दिखाएं जो उपयोगकर्ताओं को सेवा में साइन इन करने का निर्देश देता हो.
  3. ऐड-ऑन को रीफ़्रेश करें, ताकि उपयोगकर्ता सेवा या सुरक्षित संसाधन को ऐक्सेस कर सकें.

अगर आपके ऐड-ऑन के लिए सिर्फ़ उपयोगकर्ता की पहचान ज़रूरी है, तो आप सीधे उपयोगकर्ताओं के Google Workspace आईडी या ईमेल पते का इस्तेमाल करके, उनकी पुष्टि कर सकते हैं. अगर आपको पुष्टि करने के लिए ईमेल पते का इस्तेमाल करना है, तो JSON की पुष्टि करने के अनुरोध देखें. अगर आपने अपना ऐड-ऑन Google Apps Script का इस्तेमाल करके बनाया है, तो Apps Script दस्तावेज़ पर जाकर, अपने ऐड-ऑन को तीसरे पक्ष की सेवा से कनेक्ट करने के बारे में जानें.

पता लगाएं कि अनुमति देना ज़रूरी है

ऐड-ऑन का इस्तेमाल करते समय, हो सकता है कि उपयोगकर्ताओं को सुरक्षित संसाधन को ऐक्सेस करने की अनुमति न मिले. इसकी कई वजहें हो सकती हैं, जैसे:

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

आपके ऐड-ऑन को इन मामलों का पता लगाना चाहिए, ताकि उपयोगकर्ता साइन इन करके आपकी सेवा को ऐक्सेस कर सकें.

लोगों को आपकी सेवा में साइन इन करने का अनुरोध करना

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

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

साइन इन कार्ड बनाना और लौटाना

आपकी सेवा के साइन-इन कार्ड के लिए, आप Google के बुनियादी अनुमति कार्ड का इस्तेमाल कर सकते हैं या अपने संगठन के लोगो जैसी अतिरिक्त जानकारी दिखाने के लिए कार्ड को पसंद के मुताबिक बना सकते हैं. अगर ऐड-ऑन को सार्वजनिक तौर पर पब्लिश किया जा रहा है, तो आपको कस्टम कार्ड का इस्तेमाल करना होगा.

अनुमति देने वाला बुनियादी कार्ड

नीचे दी गई इमेज में, अनुमति देने वाले Google के बुनियादी कार्ड का उदाहरण दिखाया गया है:

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

अनुमति देने वाले बुनियादी कार्ड का इस्तेमाल करने के लिए, यह JSON रिस्पॉन्स दें:

{
  "basic_authorization_prompt": {
    "authorization_url": "AUTHORIZATION_REDIRECT",
    "resource": "RESOURCE_DISPLAY_NAME"
  }
}

इन्हें बदलें:

  • AUTHORIZATION_REDIRECT: उस वेब ऐप्लिकेशन का यूआरएल जो अनुमति को मैनेज करता है.
  • RESOURCE_DISPLAY_NAME: सुरक्षित संसाधन या सेवा का डिसप्ले नेम. यह नाम उपयोगकर्ता को अनुमति देने के प्रॉम्प्ट पर दिखता है. उदाहरण के लिए, अगर आपका RESOURCE_DISPLAY_NAME Example Account है, तो प्रॉम्प्ट कहता है, "यह ऐड-ऑन ज़्यादा जानकारी दिखाना चाहता है, लेकिन इसे आपका उदाहरण खाता ऐक्सेस करने की अनुमति चाहिए."

अनुमति देने की प्रक्रिया पूरी करने के बाद, उपयोगकर्ता को सुरक्षित संसाधन ऐक्सेस करने के लिए, ऐड-ऑन को रीफ़्रेश करने के लिए कहा जाता है.

पसंद के मुताबिक अनुमति देने वाला कार्ड

अनुमति देने के अनुरोध में बदलाव करने के लिए, अपनी सेवा के साइन इन अनुभव के लिए पसंद के मुताबिक कार्ड बनाया जा सकता है.

अगर आपका ऐड-ऑन सार्वजनिक तौर पर पब्लिश किया जा रहा है, तो आपको कस्टम ऑथराइज़ेशन कार्ड का इस्तेमाल करना होगा. Google Workspace Marketplace पर पब्लिश करने की ज़रूरी शर्तों के बारे में ज़्यादा जानने के लिए, ऐप्लिकेशन की समीक्षा के बारे में जानकारी लेख पढ़ें.

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

Cymbal Labs के लिए कस्टम ऑथराइज़ेशन कार्ड, जिसमें कंपनी का लोगो, ब्यौरा, और साइन इन करने का बटन शामिल होता है.

पसंद के मुताबिक बनाए गए इस कार्ड के उदाहरण का इस्तेमाल करने के लिए, नीचे दिया गया JSON रिस्पॉन्स दिखाएं:

{
  "custom_authorization_prompt": {
    "action": {
      "navigations": [
        {
          "pushCard": {
            "sections": [
              {
                "widgets": [
                  {
                    "image": {
                      "imageUrl": "LOGO_URL",
                      "altText": "LOGO_ALT_TEXT"
                    }
                  },
                  {
                    "divider": {}
                  },
                  {
                    "textParagraph": {
                      "text": "DESCRIPTION"
                    }
                  },
                  {
                    "buttonList": {
                      "buttons": [
                        {
                          "text": "Sign in",
                          "onClick": {
                            "openLink": {
                              "url": "AUTHORIZATION_REDIRECT",
                              "onClose": "RELOAD",
                              "openAs": "OVERLAY"
                            }
                          },
                          "color": {
                            "red": 0,
                            "green": 0,
                            "blue": 1,
                            "alpha": 1,
                          }
                        }
                      ]
                    }
                  },
                  {
                    "textParagraph": {
                      "text": "TEXT_SIGN_UP"
                    }
                  }
                ]
              }
            ]
          }
        }
      ]
    }
  }
}

इन्हें बदलें:

  • LOGO_URL: लोगो या इमेज के लिए यूआरएल. एक सार्वजनिक यूआरएल होना चाहिए.
  • LOGO_ALT_TEXT: लोगो या इमेज के लिए वैकल्पिक टेक्स्ट, जैसे कि Cymbal Labs Logo.
  • DESCRIPTION: उपयोगकर्ताओं के साइन इन करने के लिए एक कॉल-टू-ऐक्शन, जैसे कि Sign in to get started.
  • 'साइन-इन करें' बटन को अपडेट करने के लिए:
    • AUTHORIZATION_REDIRECT: उस वेब ऐप्लिकेशन का यूआरएल जो अनुमति को मैनेज करता है.
    • ज़रूरी नहीं: बटन का रंग बदलने के लिए, color फ़ील्ड के आरजीबीए फ़्लोट वैल्यू को अपडेट करें.
  • TEXT_SIGN_UP: यह टेक्स्ट, उपयोगकर्ताओं को खाता नहीं होने पर खाता बनाने के लिए कहता है. उदाहरण के लिए, New to Cymbal Labs? <a href=\"https://www.example.com/signup\">Sign up</a> here.