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

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

Google Chat में, ऐड-ऑन उपयोगकर्ताओं को Google Chat ऐप्लिकेशन के तौर पर दिखते हैं. ज़्यादा जानने के लिए, Google Chat का ऐक्सेस देने की सुविधा के बारे में खास जानकारी देखें.

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

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

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

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

ट्रिगर

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

इवेंट ऑब्जेक्ट
commonEventObject object (CommonEventObject)
यह एक ऐसा ऑब्जेक्ट है जिसमें सभी इवेंट ऑब्जेक्ट के लिए एक जैसी जानकारी होती है. इससे कोई फ़र्क़ नहीं पड़ता कि होस्ट ऐप्लिकेशन क्या है.
chat object (Chat)
Chat के इंटरैक्शन के बारे में पूरी जानकारी देने वाला ऑब्जेक्ट.

चैट करें

चैट करें
chat.user object (User)
Chat का वह उपयोगकर्ता जिसने Chat ऐप्लिकेशन से इंटरैक्ट किया.
chat.space object (Space)
वह Chat स्पेस जहां उपयोगकर्ता ने Chat ऐप्लिकेशन का इस्तेमाल किया.
chat.eventTime

string (Timestamp format)

इंटरैक्शन होने का समय.

यूनियन फ़ील्ड payload.

payload इनमें से कोई एक हो सकता है:
chat.messagePayload

object (MessagePayload)

वह पेलोड जो Chat ऐप्लिकेशन को मैसेज ट्रिगर से मिलता है.
chat.addedToSpacePayload

object (AddedToSpacePayload)

वह पेलोड जो Chat ऐप्लिकेशन को स्पेस में जोड़ा गया ट्रिगर से मिलता है.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

स्पेस से हटाया गया ट्रिगर से, Chat ऐप्लिकेशन को मिलने वाला पेलोड.
chat.buttonClickedPayload

object (ButtonClickedPayload)

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

object (WidgetUpdatedPayload)

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

CommonEventObject.parameters['autocomplete_widget_query'] ऑब्जेक्ट में वह स्ट्रिंग वैल्यू होती है जिसे उपयोगकर्ता मेन्यू में टाइप करता है.

chat.appCommandPayload

object (AppCommandPayload)

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

पेलोड

इंटरैक्शन के टाइप के आधार पर, इवेंट में एक या एक से ज़्यादा Chat API संसाधनों वाला पेलोड होता है.

मैसेज पेलोड
MessagePayload
chat.messagePayload.message object (Message)
इवेंट को ट्रिगर करने वाला Chat मैसेज.
chat.messagePayload.space object (Space)
Chat का वह स्पेस जिसमें उपयोगकर्ता ने वह मैसेज भेजा था जिसकी वजह से Chat ऐप्लिकेशन खुला.

स्पेस पेलोड में जोड़ा गया
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Chat का वह स्पेस जिसमें उपयोगकर्ता ने Chat ऐप्लिकेशन को जोड़ा या इंस्टॉल किया है.

जब एडमिन, चैट ऐप्लिकेशन इंस्टॉल करते हैं, तो space.adminInstalled फ़ील्ड को true पर सेट कर दिया जाता है.

chat.addedToSpacePayload.interactionAdd boolean
क्या कोई उपयोगकर्ता मैसेज का इस्तेमाल करके, Chat ऐप्लिकेशन को किसी स्पेस में जोड़ता है. उदाहरण के लिए, Chat ऐप्लिकेशन को @टैग करना या स्लैश कमांड का इस्तेमाल करना. अगर true, Chat एक और इवेंट ऑब्जेक्ट भेजता है, जिसमें एक messagePayload होता है. इसमें मैसेज की जानकारी होती है.

स्पेस पेलोड से हटाया गया
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
वह Chat स्पेस जिससे उपयोगकर्ता ने Chat ऐप्लिकेशन को हटाया या अनइंस्टॉल किया.

जब एडमिन, Chat ऐप्लिकेशन अनइंस्टॉल करते हैं, तो space.adminInstalled फ़ील्ड को false पर सेट कर दिया जाता है.

बटन पर क्लिक किए जाने से जुड़ा पेलोड
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Chat का वह मैसेज जिसमें उपयोगकर्ता ने क्लिक किया है.
chat.buttonClickedPayload.space object (Space)
Chat स्पेस, जहां उपयोगकर्ता ने Chat ऐप्लिकेशन के मैसेज में मौजूद बटन पर क्लिक किया.
chat.buttonClickedPayload.isDialogEvent boolean
क्या उपयोगकर्ता ने डायलॉग के साथ इंटरैक्ट करने के लिए बटन पर क्लिक किया.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
अगर isDialogEvent true है, तो डायलॉग में इंटरैक्शन का टाइप.

Enum DialogEventType.

dialogEventType की वैल्यू इनमें से सिर्फ़ एक हो सकती है:
TYPE_UNSPECIFIED डिफ़ॉल्ट मान. नहीं बताया गया है
REQUEST_DIALOG उपयोगकर्ता, डायलॉग बॉक्स के लिए अनुरोध करता है. उदाहरण के लिए, वे स्लैश कमांड का इस्तेमाल करते हैं या मैसेज में मौजूद बटन पर क्लिक करते हैं.
SUBMIT_DIALOG कोई उपयोगकर्ता, डायलॉग में मौजूद किसी इंटरैक्टिव एलिमेंट पर क्लिक करता है. उदाहरण के लिए, कोई उपयोगकर्ता डायलॉग बॉक्स में जानकारी भरता है और जानकारी सबमिट करने के लिए बटन पर क्लिक करता है.

विजेट का अपडेट किया गया पेलोड
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
वह चैट स्पेस जहां इंटरैक्शन हुआ.

ऐप्लिकेशन कमांड पेलोड
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
इस बारे में मेटाडेटा कि उपयोगकर्ता ने किस कमांड का इस्तेमाल किया और उन्होंने कमांड को कैसे ट्रिगर किया.
chat.appCommandPayload.space object (Space)
वह चैट स्पेस जिसमें उपयोगकर्ता ने कमांड का इस्तेमाल किया.
chat.appCommandPayload.thread object (Thread)
अगर इंटरैक्शन किसी थ्रेड में हुआ है, तो वह Chat की वह थ्रेड जहां उपयोगकर्ता ने कमांड का इस्तेमाल किया है.
chat.appCommandPayload.message object (Message)
स्लैश कमांड के साथ उपयोगकर्ता ने जो मैसेज भेजा है.
chat.appCommandPayload.configCompleteRedirectUri string
अगर कमांड के लिए अनुमति या कॉन्फ़िगरेशन की ज़रूरत है, तो उपयोगकर्ता को Google Chat के बाहर प्रोसेस पूरी करने के बाद, रीडायरेक्ट करने के लिए यूआरएल.
chat.appCommandPayload.isDialogEvent boolean
क्या कमांड से कोई डायलॉग खुलता है.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
डायलॉग के साथ इंटरैक्शन का टाइप.

Enum DialogEventType.

dialogEventType की वैल्यू इनमें से सिर्फ़ एक हो सकती है:
TYPE_UNSPECIFIED डिफ़ॉल्ट मान. नहीं बताया गया है
REQUEST_DIALOG उपयोगकर्ता, डायलॉग बॉक्स के लिए अनुरोध करता है. उदाहरण के लिए, वे स्लैश कमांड का इस्तेमाल करते हैं या मैसेज में मौजूद बटन पर क्लिक करते हैं.
SUBMIT_DIALOG कोई उपयोगकर्ता, डायलॉग में मौजूद किसी इंटरैक्टिव एलिमेंट पर क्लिक करता है. उदाहरण के लिए, कोई उपयोगकर्ता डायलॉग बॉक्स में जानकारी भरता है और जानकारी सबमिट करने के लिए बटन पर क्लिक करता है.
ऐप्लिकेशन के निर्देश का मेटाडेटा
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

कमांड आईडी.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
निर्देश का टाइप.

Enum AppCommandType.

AppCommandType की वैल्यू इनमें से सिर्फ़ एक हो सकती है:
APP_COMMAND_TYPE_UNSPECIFIED डिफ़ॉल्ट मान. नहीं बताया गया है
SLASH_COMMAND कोई उपयोगकर्ता, स्लैश / से शुरू होने वाला मैसेज भेजकर कमांड का इस्तेमाल करता है.

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

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

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

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

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

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

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

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

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

Chat API की पुष्टि करने और उसे कॉल करने के बारे में जानने के लिए, Chat API की खास जानकारी देखें.