Google Chat का इंटरफ़ेस बनाएं

इस पेज पर, Google Chat के लिए ऐड-ऑन के यूज़र इंटरफ़ेस (यूआई) बनाने के तरीके के बारे में खास जानकारी दी गई है.

Chat ऐप्लिकेशन के लिए इंटरफ़ेस बनाने के लिए, इन ऐड-ऑन कॉम्पोनेंट का इस्तेमाल किया जाता है:

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

चैट ऐप्लिकेशन, इन इंटरफ़ेस में कार्ड बना सकते हैं और उन्हें दिखा सकते हैं:

  • मैसेज में टेक्स्ट, स्टैटिक या इंटरैक्टिव कार्ड, और बटन शामिल हो सकते हैं.
  • डायलॉग, ऐसे कार्ड होते हैं जो नई विंडो में खुलते हैं. आम तौर पर, ये उपयोगकर्ताओं से जानकारी सबमिट करने के लिए कहते हैं.
  • लिंक की झलक. ये ऐसे कार्ड होते हैं जो किसी बाहरी सेवा के बारे में जानकारी की झलक दिखाते हैं.

ट्रिगर

इस सेक्शन में, उन ट्रिगर के बारे में बताया गया है जिनका इस्तेमाल Google Workspace ऐड-ऑन, Chat में करते हैं.

ट्रिगर, Chat ऐप्लिकेशन को शुरू करने के खास तरीके होते हैं. उपयोगकर्ता, Chat के यूज़र इंटरफ़ेस (यूआई) का इस्तेमाल करके, इन तरीकों से ऐप्लिकेशन शुरू करते हैं. जैसे, @mention या ऐप्लिकेशन के कमांड का इस्तेमाल करना.

इस टेबल में, Chat ट्रिगर, उनकी जानकारी, और Chat ऐप्लिकेशन के जवाब देने के तरीके के बारे में बताया गया है:

ट्रिगर ब्यौरा सामान्य जवाब
स्पेस में जोड़ा गया

कोई उपयोगकर्ता किसी स्पेस में Chat ऐप्लिकेशन जोड़ता है या कोई Google Workspace एडमिन, अपने संगठन के उपयोगकर्ताओं के लिए डायरेक्ट मैसेज वाले स्पेस में Chat ऐप्लिकेशन इंस्टॉल करता है. एडमिन के इंस्टॉल किए गए Chat ऐप्लिकेशन के बारे में जानने के लिए, Google Workspace एडमिन सहायता केंद्र के दस्तावेज़ में अपने डोमेन में, Google Workspace Marketplace पर मौजूद ऐप्लिकेशन इंस्टॉल करना लेख पढ़ें.

Chat ऐप्लिकेशन, शामिल होने का मैसेज भेजता है. इसमें बताया जाता है कि यह क्या करता है और स्पेस में मौजूद लोग इससे कैसे इंटरैक्ट कर सकते हैं.
मैसेज

कोई उपयोगकर्ता, Chat ऐप्लिकेशन में मैसेज के साथ इन तरीकों से इंटरैक्ट करता है:

  • Chat ऐप्लिकेशन के साथ, डायरेक्ट मैसेज (डीएम) स्पेस में मैसेज भेजता है.
  • किसी भी तरह के स्पेस में Chat ऐप्लिकेशन को @mention किया गया हो.
  • ऐसा मैसेज भेजता है जिसमें एक ऐसा लिंक होता है जो लिंक की झलक के लिए यूआरएल पैटर्न से मेल खाता है.
  • यह कार्रवाई, selectionInput विजेट के मल्टीसिलेक्ट मेन्यू में टेक्स्ट टाइप करती है.
Chat ऐप्लिकेशन, मैसेज के कॉन्टेंट के आधार पर जवाब देता है. उदाहरण के लिए, Chat ऐप्लिकेशन, स्लैश कमांड /about का जवाब ऐसे मैसेज से देता है जिसमें Chat ऐप्लिकेशन के ज़रिए किए जा सकने वाले टास्क के बारे में बताया गया हो.
स्पेस से हटा दिया गया

जब कोई उपयोगकर्ता किसी स्पेस से Chat ऐप्लिकेशन को हटा देता है या Google Workspace एडमिन, अपने संगठन के किसी उपयोगकर्ता के लिए Chat ऐप्लिकेशन को अनइंस्टॉल कर देता है.

उपयोगकर्ता, उन Chat ऐप्लिकेशन को नहीं हटा सकते जिन्हें उनके एडमिन ने इंस्टॉल किया था. अगर किसी उपयोगकर्ता ने पहले से ही Chat ऐप्लिकेशन इंस्टॉल किया हुआ है, तो वह इंस्टॉल ही रहेगा. भले ही, Google Workspace एडमिन उसे अनइंस्टॉल करने की कोशिश करे.

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

कोई उपयोगकर्ता Chat ऐप्लिकेशन के कमांड का इस्तेमाल करता है.

Chat ऐप्लिकेशन, कमांड का जवाब देता है. उदाहरण के लिए, मैसेज के साथ जवाब देता है या कोई डायलॉग बॉक्स खोलता है.

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

ट्रिगर का जवाब देने के लिए, यहां दी गई गाइड देखें:

इवेंट ऑब्जेक्ट

जब Chat ट्रिगर चालू होता है या जब Chat उपयोगकर्ता, Chat ऐप्लिकेशन के यूज़र इंटरफ़ेस (जैसे, किसी बटन पर क्लिक करना) से इंटरैक्ट करते हैं, तब Chat ऐप्लिकेशन को इवेंट ऑब्जेक्ट मिलते हैं. इवेंट ऑब्जेक्ट की मदद से, इंटरैक्शन डेटा का इस्तेमाल करके यूज़र इंटरफ़ेस (यूआई) को अपडेट किया जा सकता है या उस पर प्रतिक्रिया दी जा सकती है.

इवेंट ऑब्जेक्ट मैनेज करने के बारे में जानने के लिए, ये गाइड देखें:

Chat और Google Workspace के अन्य ऐप्लिकेशन में ऐड-ऑन इवेंट ऑब्जेक्ट के बारे में जानने के लिए, इवेंट ऑब्जेक्ट देखें.

चैट से जुड़ी कार्रवाइयां

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

ऐड-ऑन की मदद से की जाने वाली कार्रवाई का जवाब देने के लिए, Chat ऐप्लिकेशन को 30 सेकंड के अंदर जवाब देना होगा. साथ ही, जवाब को उसी स्पेस में पोस्ट करना होगा जहां बातचीत हुई थी. इसके अलावा, Chat ऐप्लिकेशन को पुष्टि करने की सुविधा सेट अप करनी होगी. साथ ही, जवाब देने के लिए Google Chat API को कॉल करना होगा.

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

उपयोगकर्ता के इंटरैक्शन का जवाब देने के लिए, चैट ऐप्लिकेशन को इवेंट ऑब्जेक्ट को मैनेज करना होगा. साथ ही, इनमें से कोई एक JSON ऑब्जेक्ट दिखाना होगा:

यहां दी गई टेबल में बताया गया है कि Chat ऐप्लिकेशन, कार्रवाइयों के साथ कैसे जवाब दे सकते हैं. चैट ऐप्लिकेशन, JSON ऑब्जेक्ट दिखा सकते हैं या Apps Script के AddOnResponseService का इस्तेमाल करके जवाब बना सकते हैं.

चैट ऐप्लिकेशन से मिला जवाब JSON फ़ॉर्मैट में, सामान लौटाने के लिए ज़रूरी कार्रवाई वापस लाने के लिए ज़रूरी कार्रवाई (Apps Script)
मैसेज भेजें या अपडेट करें. DataActions DataActionsResponse
डायलॉग खोलें, अपडेट करें या बंद करें. RenderActions ActionResponse
किसी कार्ड या डायलॉग से जानकारी इकट्ठा करने के लिए, उपयोगकर्ताओं के मल्टीसेलेक्ट मेन्यू में टाइप किए गए टेक्स्ट के आधार पर, चुनने के लिए आइटम सुझाएं. RenderActions ActionResponse
लिंक की झलक दिखाने की सुविधा, उन मैसेज में काम करती है जो Chat इस्तेमाल करने वाले लोग किसी स्पेस में भेजते हैं. DataActions DataActionsResponse

Google Chat API का इस्तेमाल करके जवाब देना

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

  • इंटरैक्शन के 30 सेकंड बाद जवाब दें.
  • उस स्पेस के बाहर टास्क पूरे करना जहां इंटरैक्शन हुआ था.
  • Chat में ऐसे टास्क पूरे करना जो ऐड-ऑन की कार्रवाइयों के तौर पर उपलब्ध नहीं हैं. उदाहरण के लिए, उन स्पेस की सूची बनाना जिनमें कोई उपयोगकर्ता या Chat ऐप्लिकेशन सदस्य है या स्पेस में उपयोगकर्ताओं को जोड़ना.
  • Chat के उपयोगकर्ता की ओर से टास्क पूरे करना. इसके लिए, उपयोगकर्ता की पुष्टि करना ज़रूरी है.

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

Node.js

async function onEvent(req, res) {
  // Trigger asynchronous job that will respond using the Google Chat API.
  ...

  // Respond with an empty response to the Google Chat platform.
  return res.send({});
};

Python

def on_event(event) -> dict:
  # Trigger asynchronous job that will respond using the Google Chat API.
  ...

  # Respond with an empty response to the Google Chat platform.
  return {}

Java

public String onEvent(JsonNode event) {
  // Trigger asynchronous job that will respond using the Google Chat API.
  ...

  // Respond with an empty response to the Google Chat platform.
  return "{}";
}

Apps Script

function onEvent(event) {
  // Trigger asynchronous job that will respond using the Google Chat API.
  ...

  // Respond with an empty response to the Google Chat platform.
  return null;
}

Chat API को प्रमाणित करने और कॉल करने के बारे में जानने के लिए, Chat API की खास जानकारी देखें.