Google Chat API को कॉन्फ़िगर करना

आपके बनाए गए हर Google Chat ऐप्लिकेशन के लिए, अपना Google Cloud प्रोजेक्ट होना ज़रूरी है. साथ ही, उस प्रोजेक्ट में Chat API चालू और कॉन्फ़िगर होना चाहिए.

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

एपीआई कॉल बनाने, अपडेट करने, और मिटाने के लिए या इंटरैक्टिव Chat ऐप्लिकेशन को डिप्लॉय और टेस्ट करने के लिए, आपको Chat API को भी कॉन्फ़िगर करना होगा. इंटरैक्टिव Chat ऐप्लिकेशन, Google Workspace ऐड-ऑन के तौर पर बनाया जाता है. इससे Chat की सुविधाएं बढ़ जाती हैं. Chat API की कॉन्फ़िगरेशन सेटिंग में, Chat ऐप्लिकेशन के बारे में पूरी जानकारी दी जाती है. जैसे, डिसप्ले नेम, अवतार, डिप्लॉयमेंट एंडपॉइंट, और इंटरैक्टिव सुविधाएं.

ज़रूरी शर्तें

• Business या Enterprise Google Workspace खाता, जिसमें Google Chat का ऐक्सेस हो.
• Google Cloud प्रोजेक्ट बनाएं.
• ऐसी स्क्रीन को कॉन्फ़िगर करें जहां OAuth के लिए सहमति दी जाती है.
• Google Chat API को चालू करें.

अपने चैट ऐप्लिकेशन के लिए डिसप्ले नेम, अवतार, और ब्यौरा चुनना

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

किसी Chat ऐप्लिकेशन को कॉन्फ़िगर करने से पहले, यह जानकारी तैयार करें:

फ़ील्ड	ब्यौरा	फ़ॉर्मैट
ऐप्लिकेशन का नाम	Chat ऐप्लिकेशन का डिसप्ले नेम.	ज़्यादा से ज़्यादा 25 अक्षर और अंक
अवतार का यूआरएल	वह इमेज जो आपके चैट ऐप्लिकेशन के अवतार के तौर पर दिखती है.	स्क्वेयर ग्राफ़िक्स इमेज (PNG या JPEG) पर ले जाने वाला एचटीटीपीएस यूआरएल. हमारा सुझाव है कि इमेज का साइज़ 256 x 256 पिक्सल या इससे ज़्यादा हो.
ब्यौरा	चैट ऐप्लिकेशन के मकसद के बारे में कम शब्दों में जानकारी.	ज़्यादा से ज़्यादा 40 अक्षर और अंक

Chat ऐप्लिकेशन का नाम, अवतार, और ब्यौरा, Chat के यूज़र इंटरफ़ेस (यूआई) में उपयोगकर्ताओं को दिखता है. Chat API के कुछ राइट अनुरोधों के लिए, Chat इस जानकारी का इस्तेमाल करता है. इससे Chat में, Chat ऐप्लिकेशन की कार्रवाइयों को एट्रिब्यूट किया जाता है.

उदाहरण के लिए, अगर spaces.create() तरीके को कॉल किया जाता है, तो Chat, स्पेस बनाने वाले व्यक्ति की जानकारी में Chat ऐप्लिकेशन का नाम शामिल करता है. जैसा कि इस इमेज में दिखाया गया है:

पहली इमेज. एट्रिब्यूशन मैसेज, जिसे Chat तब दिखाता है, जब किसी उपयोगकर्ता की ओर से स्पेस बनाने के लिए, spaces.create() तरीके का इस्तेमाल किया जाता है.

चैट ऐप्लिकेशन से इंटरैक्ट करने के लिए, उपयोगकर्ता इस जानकारी को इन तरीकों से भी देखते या इस्तेमाल करते हैं:

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

Google Cloud Console में अपना चैट ऐप्लिकेशन कॉन्फ़िगर करना

Chat ऐप्लिकेशन की जानकारी मिलने के बाद, अपना Cloud प्रोजेक्ट खोलें और Chat API को कॉन्फ़िगर करें:

1. Google Cloud Console में, Chat API पेज पर जाएं और कॉन्फ़िगरेशन पेज पर क्लिक करें:

   Chat API के कॉन्फ़िगरेशन पेज पर जाना

2. ऐप्लिकेशन की जानकारी में जाकर, ऐप्लिकेशन का नाम, अवतार का यूआरएल, और ब्यौरा फ़ील्ड भरें.

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

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

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

   इंटरैक्टिव Chat ऐप्लिकेशन बनाने के लिए, इंटरैक्टिव सुविधाएं चालू करें को चालू करें और ये काम करें:

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

   2. कनेक्शन सेटिंग में जाकर, वह आर्किटेक्चर चुनें जिसका इस्तेमाल करके आपको Chat से इवेंट ऑब्जेक्ट पाने हैं:

      • एचटीटीपी सेवा का इस्तेमाल करने के लिए, एचटीटीपी एंडपॉइंट यूआरएल चुनें और यूआरएल डालें.
      • Google Apps Script प्रोजेक्ट का इस्तेमाल करने के लिए, Apps Script चुनें और प्रोजेक्ट के लिए डिप्लॉयमेंट आईडी दें.
      • Dialogflow एजेंट का इस्तेमाल करने के लिए, Dialogflow को चुनें. इसके बाद, Dialogflow CX या Dialogflow ES को चुनें और एजेंट के संसाधन का नाम डालें.
      • Pub/Sub का इस्तेमाल करने के लिए, Cloud Pub/Sub को चुनें और विषय का नाम डालें.
      चेतावनी: अगर Apps Script डिप्लॉयमेंट आईडी पहले से मौजूद है, तो इसका मतलब है कि क्लाउड प्रोजेक्ट, Google Workspace के किसी मौजूदा ऐड-ऑन से कनेक्ट है. अगर Chat API में डिप्लॉयमेंट आईडी को अपडेट किया जाता है, तो आपके ऐड-ऑन के लिए डिप्लॉयमेंट आईडी अपडेट हो जाता है. इससे Google Workspace Marketplace में आपकी लिस्टिंग पर असर पड़ सकता है. ऐड-ऑन के कॉन्फ़िगरेशन की समीक्षा करने के लिए, Google Workspace Marketplace SDK टूल में अपना ऐप्लिकेशन कॉन्फ़िगर करना लेख पढ़ें.

   3. ज़रूरी नहीं: इवेंट ऑब्जेक्ट को खास एंडपॉइंट या फ़ंक्शन पर रूट करने के लिए, कनेक्शन सेटिंग > ट्रिगर पर जाएं. इसके बाद, यहां दिए गए Chat ट्रिगर के लिए, कॉलबैक एंडपॉइंट या फ़ंक्शन दें या उन्हें अपडेट करें:

      ध्यान दें: Apps Script के लिए, अगर ट्रिगर अपडेट नहीं किए जाते हैं, तो आपको इस सेक्शन में मौजूद डिफ़ॉल्ट कॉलबैक फ़ंक्शन लागू करने होंगे. जैसे, onMessage, onAddedToSpace, onRemovedFromSpace, onAppCommand, और onAppHome.
      • ऐप्लिकेशन का होम पेज (अगर ऐप्लिकेशन के होम पेज पर जाने की सुविधा चालू है): कोई उपयोगकर्ता, Chat ऐप्लिकेशन के साथ सीधी बातचीत में होम टैब खोलता है.
      • स्पेस में जोड़ा गया: कोई उपयोगकर्ता, Chat ऐप्लिकेशन को किसी ग्रुप बातचीत या स्पेस में जोड़ता है या 1:1 मैसेज के लिए Chat ऐप्लिकेशन इंस्टॉल करता है.
      • मैसेज: कोई उपयोगकर्ता, चैट ऐप्लिकेशन को मैसेज भेजता है. उदाहरण के लिए, कोई उपयोगकर्ता चैट ऐप्लिकेशन को डायरेक्ट मैसेज भेजता है या कई लोगों वाले स्पेस में चैट ऐप्लिकेशन को @टैग करता है.
      • स्पेस से हटाया गया: कोई उपयोगकर्ता, किसी स्पेस से Chat ऐप्लिकेशन को अनइंस्टॉल करता है या हटाता है.
      • ऐप्लिकेशन कमांड: कोई उपयोगकर्ता, Chat ऐप्लिकेशन से क्विक कमांड, स्लैश कमांड या मैसेज ऐक्शन को ट्रिगर करता है.

   4. ज़रूरी नहीं: इंटरैक्टिव बनाने वाली अन्य सुविधाएं जोड़ें. जैसे, स्टार्टर प्रॉम्प्ट, कमांड (क्विक कमांड, स्लैश कमांड, और मैसेज पर की जाने वाली कार्रवाइयां) या लिंक की झलक.

   5. किसको दिखे सेक्शन में जाकर, अपना ईमेल पता डालें, ताकि Google Workspace Marketplace पर पब्लिश करने से पहले, चैट ऐप्लिकेशन को इंस्टॉल और टेस्ट किया जा सके. आपके पास अपने Google Workspace संगठन से, ज़्यादा से ज़्यादा पांच लोगों या एक या उससे ज़्यादा Google ग्रुप को चुनने का विकल्प होता है.

5. ज़रूरी नहीं: Google Cloud Logging का इस्तेमाल करने के लिए, लॉग में जाकर, लॉगिंग में गड़बड़ियों को लॉग करें चेकबॉक्स को चुनें. ज़्यादा जानकारी के लिए, Chat ऐप्लिकेशन के लिए गड़बड़ी के लॉग के बारे में क्वेरी करना लेख पढ़ें.

6. सेव करें पर क्लिक करें.

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

Google Workspace के मौजूदा ऐड-ऑन के लिए ध्यान देने वाली बातें

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

• Marketplace से ऐड-ऑन को इंस्टॉल करने की सुविधा, उपयोगकर्ताओं और Google Workspace एडमिन, दोनों के लिए उपलब्ध होनी चाहिए. Google Workspace Marketplace SDK में, इंस्टॉलेशन की ये सेटिंग कॉन्फ़िगर की जाती हैं.
• चैट ऐप्लिकेशन, उस नाम और लोगो का इस्तेमाल नहीं करते जिसे आपने मेनिफ़ेस्ट के addons.common ऑब्जेक्ट में, Google Workspace के अन्य ऐप्लिकेशन के लिए कॉन्फ़िगर किया है.
• Google Workspace Marketplace पर पब्लिश किए गए ऐड-ऑन के लिए, Google Chat API की कॉन्फ़िगरेशन सेटिंग में किए गए किसी भी बदलाव का ड्राफ़्ट सेव नहीं किया जा सकता. Chat API की कॉन्फ़िगरेशन सेटिंग को अपडेट और सेव करने के बाद, अपडेट किया गया Chat ऐप्लिकेशन सभी मौजूदा उपयोगकर्ताओं के लिए तुरंत उपलब्ध हो जाता है. Marketplace पर अपनी लिस्टिंग को अपडेट करने के लिए, कोई भी बदलाव सबमिट करने से पहले, एक ड्राफ़्ट बनाएं.
• अगर आपने Apps Script का इस्तेमाल करके ऐड-ऑन बनाया है, तो:
  • आपको उसी Apps Script डिप्लॉयमेंट आईडी का इस्तेमाल करना होगा जिसका इस्तेमाल आपने ऐड-ऑन के बाकी कॉन्फ़िगरेशन के लिए किया है.
  • Chat में टेस्ट डिप्लॉयमेंट इंस्टॉल करने के लिए, Apps Script एडिटर का इस्तेमाल नहीं किया जा सकता. इसके बजाय, आपको उन्हें सीधे Chat के यूज़र इंटरफ़ेस (यूआई) से इंस्टॉल करना होगा.
• अगर आपने एचटीटीपी सेवा का इस्तेमाल करके ऐड-ऑन बनाया है, तो Google Workspace ऐड-ऑन एपीआई का इस्तेमाल करके बनाए गए मेनिफ़ेस्ट और डिप्लॉयमेंट में, चैट ऐप्लिकेशन के कॉन्फ़िगरेशन की जानकारी शामिल न करें. Google Workspace Marketplace SDK में तय किए गए एचटीटीपी डिप्लॉयमेंट का इस्तेमाल, सिर्फ़ Google Workspace के अन्य ऐप्लिकेशन के लिए किया जाता है.

अन्य लोगों को Chat API को कॉन्फ़िगर करने की अनुमति देना

कुछ उपयोगकर्ताओं को Chat ऐप्लिकेशन के कॉन्फ़िगरेशन पेज का ऐक्सेस दिया जा सकता है. इसके लिए, उन्हें Chat ऐप्लिकेशन के मालिक या Chat ऐप्लिकेशन के दर्शक की Google Cloud Identity Access Management (IAM) भूमिका असाइन करें. इन भूमिकाओं वाले उपयोगकर्ता, एपीआई और सेवाएं डैशबोर्ड का इस्तेमाल करके, चैट ऐप्लिकेशन के कॉन्फ़िगरेशन पेज पर नहीं जा सकते. हालांकि, वे चैट ऐप्लिकेशन के होस्ट क्लाउड प्रोजेक्ट के लिए, Google Cloud Console पर जाकर कॉन्फ़िगरेशन पेज को ऐक्सेस कर सकते हैं. इसके लिए, यह तरीका अपनाएं:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

जहां PROJECT_ID, Chat ऐप्लिकेशन को होस्ट करने वाले Google Cloud प्रोजेक्ट का प्रोजेक्ट आईडी है.

प्रोजेक्ट की भूमिका वाले उपयोगकर्ता भी ऐप्लिकेशन कॉन्फ़िगरेशन पेज को ऐक्सेस कर सकते हैं.

जिन उपयोगकर्ताओं के पास कस्टम भूमिकाएं हैं और उनमें resourcemanager.projects.(get|update) अनुमतियां शामिल हैं वे Chat ऐप्लिकेशन के कॉन्फ़िगरेशन को ऐक्सेस नहीं कर सकते. कस्टम भूमिकाओं के लिए, chat.bots.(get|update) अनुमतियों का इस्तेमाल करें.

मिलते-जुलते विषय

• चैट ऐप्लिकेशन का आर्किटेक्चर चुनना
• उपयोगकर्ता के इंटरैक्शन पाना और उनका जवाब देना
• Google Chat ऐप्लिकेशन के लिए, इंटरैक्टिव सुविधाओं की जांच करना

ऐड-ऑन के तौर पर काम न करने वाले चैट ऐप्लिकेशन: Google Chat API को कॉन्फ़िगर करना

अगर आपके पास कोई ऐसा Chat ऐप्लिकेशन है जो Google Workspace ऐड-ऑन नहीं है, तो आपका कॉन्फ़िगरेशन, हर इवेंट के ट्रिगर के बजाय सभी इंटरैक्शन इवेंट के लिए एक एंडपॉइंट का इस्तेमाल करता है:

1. Google Cloud Console में, Chat API के कॉन्फ़िगरेशन पेज पर जाएं:

   Chat API के कॉन्फ़िगरेशन पेज पर जाएं

2. इंटरैक्टिव सुविधाएं में जाकर, इंटरैक्टिव सुविधाएं चालू करें को चालू करें.

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

4. Functionality में जाकर, ज़रूरत के हिसाब से Support App Home या Join spaces and group conversations को चुनें.

5. कनेक्शन सेटिंग में जाकर, अपने चैट ऐप्लिकेशन के लिए एक एंडपॉइंट तय करें. जैसे, एचटीटीपी एंडपॉइंट यूआरएल, Apps Script डिप्लॉयमेंट आईडी, Cloud Pub/Sub विषय का नाम या Dialogflow.

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

अगर आपको किसी ऐसे Chat ऐप्लिकेशन को Google Workspace ऐड-ऑन में अपग्रेड करना है जो पहले से ऐड-ऑन नहीं है, तो Google Chat ऐप्लिकेशन को Google Workspace ऐड-ऑन में बदलें लेख पढ़ें.