Google Chat ऐप्लिकेशन के निर्देशों का जवाब देना

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

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

यह तय करने के लिए कि आपको कमांड बनानी चाहिए या नहीं और उपयोगकर्ता इंटरैक्शन को डिज़ाइन करने का तरीका जानने के लिए, उपयोगकर्ता के सभी सफ़र तय करें लेख पढ़ें.

Chat ऐप्लिकेशन में इस्तेमाल की जाने वाली कमांड के टाइप

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

  1. स्लैश कमांड: उपयोगकर्ता, मेन्यू से कोई स्लैश कमांड चुन सकते हैं. इसके अलावा, वे स्लैश (/) और फिर पहले से तय किया गया टेक्स्ट टाइप कर सकते हैं. जैसे, /about. आम तौर पर, चैट ऐप्लिकेशन को स्लैश कमांड के लिए आर्ग्युमेंट टेक्स्ट की ज़रूरत होती है.

    अगर आपके Chat ऐप्लिकेशन को उपयोगकर्ता से अतिरिक्त इनपुट की ज़रूरत है, तो स्लैश कमांड बनाएं. उदाहरण के लिए, /search नाम की स्लैश कमांड बनाई जा सकती है. यह कमांड तब काम करती है, जब उपयोगकर्ता कोई वाक्यांश डालकर खोज करता है. जैसे, /search receipts.

  2. क्विक कमांड: उपयोगकर्ता, चैट मैसेज के जवाब देने वाले बॉक्स में मौजूद मेन्यू खोलकर कमांड का इस्तेमाल करते हैं. किसी निर्देश का इस्तेमाल करने के लिए, वे जोड़ें पर क्लिक करते हैं. इसके बाद, वे मेन्यू से कोई निर्देश चुनते हैं.

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

  3. मैसेज से जुड़ी कार्रवाइयां: लोग, मैसेज से जुड़ी कार्रवाइयों का इस्तेमाल करते हैं. इसके लिए, वे किसी मैसेज पर कर्सर घुमाते हैं और तीन बिंदु वाले मेन्यू पर क्लिक करते हैं. किसी निर्देश का इस्तेमाल करने के लिए, वे तीन बिंदु वाला मेन्यू खोलते हैं और मेन्यू से कोई निर्देश चुनते हैं.

    अगर आपका Chat ऐप्लिकेशन, मैसेज के कॉन्टेक्स्ट के आधार पर कार्रवाइयां कर सकता है, तो मैसेज पर कार्रवाई बनाएं.

यहां दी गई इमेज में दिखाया गया है कि लोग स्लैश और क्विक कमांड के साथ-साथ मैसेज से जुड़ी कार्रवाइयों का मेन्यू कैसे ढूंढते हैं:

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

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

HTTP

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

Apps Script

Google Chat ऐप्लिकेशन, जो उपयोगकर्ता के इंटरैक्शन को स्वीकार करता है और उनका जवाब देता है. इसे बनाने के लिए, Apps Script क्विकस्टार्ट पूरा करें.

कमांड सेट अप करना

इस सेक्शन में, कमांड सेट अप करने के लिए यह तरीका बताया गया है:

  1. कमांड के लिए नाम और ब्यौरा बनाएं.
  2. Google Cloud Console में कमांड को कॉन्फ़िगर करें.
  3. ज़रूरी नहीं: स्टार्टर प्रॉम्प्ट के लिए मैप कमांड.

कमांड का नाम और ब्यौरा दें

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

स्लैश कमांड का नाम और जानकारी
स्लैश कमांड का नाम और ब्यौरा.

अपनी कमांड के लिए नाम और जानकारी चुनते समय, इन सुझावों को ध्यान में रखें:

किसी निर्देश को नाम देने के लिए:

  • छोटे, जानकारी देने वाले, और कार्रवाई करने के लिए इस्तेमाल किए जाने वाले शब्दों या वाक्यांशों का इस्तेमाल करें, ताकि उपयोगकर्ता को निर्देश साफ़ तौर पर समझ आएं. उदाहरण के लिए, Create a reminder के बजाय Remind me का इस्तेमाल करें.
  • अपनी कमांड के लिए, कोई यूनीक या सामान्य नाम इस्तेमाल करें. अगर आपकी कमांड में किसी सामान्य इंटरैक्शन या सुविधा के बारे में बताया गया है, तो ऐसा नाम इस्तेमाल करें जिसे उपयोगकर्ता पहचानते हों और जिसकी उन्हें उम्मीद हो. जैसे, Settings या Feedback. इसके अलावा, कमांड के लिए यूनीक नाम इस्तेमाल करने की कोशिश करें. ऐसा इसलिए, क्योंकि अगर आपकी कमांड का नाम अन्य Chat ऐप्लिकेशन के लिए भी एक जैसा है, तो उपयोगकर्ता को आपकी कमांड ढूंढने और उसका इस्तेमाल करने के लिए, मिलती-जुलती कमांड को फ़िल्टर करना होगा.

किसी निर्देश के बारे में बताने के लिए:

  • ब्यौरे को छोटा और आसान रखें, ताकि लोगों को पता चल सके कि कमांड का इस्तेमाल करने पर उन्हें क्या मिलेगा.
  • उपयोगकर्ताओं को बताएं कि कमांड के लिए, फ़ॉर्मैटिंग से जुड़ी कोई ज़रूरी शर्त है या नहीं. उदाहरण के लिए, अगर आपको ऐसा स्लैश कमांड बनाना है जिसके लिए आर्ग्युमेंट टेक्स्ट की ज़रूरत होती है, तो ब्यौरे को Remind me to do [something] at [time] जैसा कुछ सेट करें.
  • उपयोगकर्ताओं को बताएं कि Chat ऐप्लिकेशन, स्पेस में मौजूद सभी लोगों को जवाब देता है या सिर्फ़ उस उपयोगकर्ता को जवाब देता है जिसने कमांड दी है. उदाहरण के लिए, About क्विक कमांड के लिए, इसे Learn about this app (Only visible to you) के तौर पर बताया जा सकता है.

Google Cloud Console में कमांड को कॉन्फ़िगर करना

स्लैश कमांड, क्विक कमांड या मैसेज पर कार्रवाई बनाने के लिए, आपको Google Chat API के लिए Chat ऐप्लिकेशन के कॉन्फ़िगरेशन में कमांड या कार्रवाई के बारे में जानकारी देनी होगी.

Google Chat API में किसी कमांड को कॉन्फ़िगर करने के लिए, यह तरीका अपनाएं:

  1. Google Cloud Console में, मेन्यू &gt एपीआई और सेवाएं &gt चालू किए गए एपीआई और सेवाएं &gt Google Chat API पर क्लिक करें

    Google Chat API पेज पर जाएं

  2. कॉन्फ़िगरेशन पर क्लिक करें.

  3. कनेक्शन की सेटिंग में जाकर, ट्रिगर पर जाएं और अपने एंडपॉइंट की जानकारी दें. आपको इस ट्रिगर का इस्तेमाल, यहां दिए गए सेक्शन में करना होगा, ताकि निर्देश का जवाब दिया जा सके.

    1. एचटीटीपी एंडपॉइंट यूआरएल: यहां एक सामान्य एचटीटीपी एंडपॉइंट यूआरएल दिया जा सकता है. इसके अलावा, अलग-अलग ट्रिगर के लिए अलग-अलग एचटीटीपी एंडपॉइंट का इस्तेमाल करने के लिए, ऐप्लिकेशन कमांड फ़ील्ड में सीधे तौर पर एंडपॉइंट डालें.
    2. Apps Script: Apps Script का डिप्लॉयमेंट आईडी डालें. डिफ़ॉल्ट रूप से, onAppCommand फ़ंक्शन चालू होगा. किसी दूसरे Apps Script फ़ंक्शन का इस्तेमाल करने के लिए, ऐप्लिकेशन कमांड फ़ील्ड में कस्टम फ़ंक्शन का नाम डालें.

  4. निर्देश में जाकर, कोई निर्देश जोड़ें पर क्लिक करें.

  5. कमांड के बारे में यह जानकारी डालें:

    1. कमांड आईडी: यह 1 से 1,000 के बीच की एक संख्या होती है. इसका इस्तेमाल, Chat ऐप्लिकेशन कमांड की पहचान करने और जवाब देने के लिए करता है.
    2. ब्यौरा: वह टेक्स्ट जिसमें कमांड को इस्तेमाल करने और फ़ॉर्मैट करने का तरीका बताया गया हो. ब्यौरे में ज़्यादा से ज़्यादा 50 वर्ण हो सकते हैं.
    3. निर्देश का टाइप: क्विक कमांड, स्लैश कमांड या मैसेज ऐक्शन में से कोई एक चुनें.
    4. कमांड के लिए कोई नाम डालें:
      • क्विक कमांड का नाम: यह वह नाम होता है जो उपयोगकर्ताओं को मेन्यू में दिखता है. वे इस नाम को चुनकर कमांड को चालू करते हैं. इसमें ज़्यादा से ज़्यादा 50 वर्ण हो सकते हैं और इसमें खास वर्ण शामिल किए जा सकते हैं. उदाहरण के लिए, Remind me.
      • स्लैश कमांड का नाम: यह वह टेक्स्ट होता है जिसे उपयोगकर्ता, मैसेज में कमांड को चालू करने के लिए टाइप करते हैं. इसकी शुरुआत स्लैश से होनी चाहिए. इसमें सिर्फ़ टेक्स्ट होना चाहिए. साथ ही, इसमें ज़्यादा से ज़्यादा 50 वर्ण हो सकते हैं. उदाहरण के लिए, /remindMe.
      • मैसेज पर कार्रवाई का नाम: यह वह डिसप्ले नेम होता है जिसे लोग, मैसेज पर कार्रवाई को शुरू करने के लिए मेन्यू से चुनते हैं. इसमें ज़्यादा से ज़्यादा 50 वर्ण हो सकते हैं और खास वर्ण शामिल किए जा सकते हैं. उदाहरण के लिए, Remind me.

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

  7. ज़रूरी नहीं: अगर आपको Chat ऐप्लिकेशन से, कमांड का जवाब डायलॉग के तौर पर चाहिए, तो डायलॉग खोलें चेकबॉक्स को चुनें.

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

यह कमांड अब Chat ऐप्लिकेशन के लिए कॉन्फ़िगर हो गई है.

स्टार्टर प्रॉम्प्ट के लिए मैप कमांड

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

किसी निर्देश को स्टार्टर प्रॉम्प्ट से मैप करने के लिए:

  1. पक्का करें कि आपकी कमांड के लिए, कस्टम आर्ग्युमेंट की ज़रूरत न हो. सिर्फ़ कोई आर्ग्युमेंट नहीं या बुनियादी आर्ग्युमेंट वाली कमांड को स्टार्टर प्रॉम्प्ट के तौर पर इस्तेमाल किया जा सकता है.
  2. Google Cloud Console में, Chat API के कॉन्फ़िगरेशन पेज पर जाएं.
  3. इंटरैक्टिव सुविधाएं > सवाल-जवाब के लिए प्रॉम्प्ट में जाकर, प्रॉम्प्ट जोड़ें पर क्लिक करें.
  4. दिखाने के क्रम के लिए, रैंक (1-3) सेट करें.
  5. टाइप चुनें में जाकर, कमांड प्रॉम्प्ट चुनें. इसके बाद, ड्रॉप-डाउन से अपनी कमांड चुनें.
  6. हो गया पर क्लिक करें. इसके बाद, सेव करें पर क्लिक करें.

किसी निर्देश का जवाब देना

जब उपयोगकर्ता किसी कमांड का इस्तेमाल करते हैं, तो आपके Chat ऐप्लिकेशन को इवेंट ऑब्जेक्ट मिलता है. इवेंट पेलोड (event.chat.appCommandPayload) में एक appCommandPayload ऑब्जेक्ट होता है. इसमें शुरू की गई कमांड के बारे में जानकारी होती है. जैसे, कमांड आईडी और कमांड टाइप. इससे आपको सही जवाब देने में मदद मिलती है. इवेंट ऑब्जेक्ट को उस एचटीटीपी एंडपॉइंट या Apps Script फ़ंक्शन पर भेजा जाता है जिसे आपने ऐप्लिकेशन कमांड ट्रिगर को कॉन्फ़िगर करते समय तय किया था.

Cymbal Labs Chat ऐप्लिकेशन के लिए निजी मैसेज. मैसेज में बताया गया है कि Chat ऐप्लिकेशन को Cymbal Labs ने बनाया है. इसमें दस्तावेज़ का लिंक और सहायता टीम से संपर्क करने का लिंक भी दिया गया है.
Chat ऐप्लिकेशन, स्लैश कमांड /help का जवाब निजी तौर पर देता है. इसमें बताया जाता है कि सहायता कैसे पाएं.

स्लैश कमांड या क्विक कमांड का जवाब देना

यहां दिए गए कोड में, एक ऐसे Chat ऐप्लिकेशन का उदाहरण दिखाया गया है जो टेक्स्ट मैसेज के ज़रिए, /about स्लैश कमांड का जवाब देता है. स्लैश कमांड या फटाफट निर्देशों का जवाब देने के लिए, Chat ऐप्लिकेशन, ऐप्लिकेशन कमांड ट्रिगर से इवेंट ऑब्जेक्ट (event.chat.appCommandPayload) को हैंडल करता है. जब किसी इवेंट ऑब्जेक्ट के पेलोड में मेल खाने वाला कमांड आईडी होता है, तो Chat ऐप्लिकेशन, createMessageAction (hostAppDataAction.chatDataAction.createMessageAction) ऑब्जेक्ट के साथ DataActions कार्रवाई दिखाता है:

Node.js

node/chat/avatar-app/index.js
// The ID of the slash command "/about".
// You must use the same ID in the Google Chat API configuration.
const ABOUT_COMMAND_ID = 1;

/**
 * Handle requests from Google Workspace add on
 *
 * @param {Object} req Request sent by Google Chat
 * @param {Object} res Response to be sent back to Google Chat
 */
http('avatarApp', (req, res) => {
  const chatEvent = req.body.chat;
  let message;
  if (chatEvent.appCommandPayload) {
    message = handleAppCommand(chatEvent);
  } else {
    message = handleMessage(chatEvent);
  }
  res.send({ hostAppDataAction: { chatDataAction: { createMessageAction: {
    message: message
  }}}});
});

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 * @return the response message object.
 */
function handleAppCommand(event) {
  switch (event.appCommandPayload.appCommandMetadata.appCommandId) {
    case ABOUT_COMMAND_ID:
      return {
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Python

python/chat/avatar-app/main.py
# The ID of the slash command "/about".
# You must use the same ID in the Google Chat API configuration.
ABOUT_COMMAND_ID = 1

@functions_framework.http
def avatar_app(req: flask.Request) -> Mapping[str, Any]:
  """Handle requests from Google Workspace add on

  Args:
    flask.Request req: the request sent by Google Chat

  Returns:
    Mapping[str, Any]: the response to be sent back to Google Chat
  """
  chat_event = req.get_json(silent=True)["chat"]
  if chat_event and "appCommandPayload" in chat_event:
    message = handle_app_command(chat_event)
  else:
    message = handle_message(chat_event)
  return { "hostAppDataAction": { "chatDataAction": { "createMessageAction": {
      "message": message
  }}}}

def handle_app_command(event: Mapping[str, Any]) -> Mapping[str, Any]:
  """Responds to an APP_COMMAND event in Google Chat.

  Args:
    Mapping[str, Any] event: the event object from Google Chat

  Returns:
    Mapping[str, Any]: the response message object.
  """
  if event["appCommandPayload"]["appCommandMetadata"]["appCommandId"] == ABOUT_COMMAND_ID:
    return {
      "text": "The Avatar app replies to Google Chat messages.",
    }
  return {}

Java

java/chat/avatar-app/src/main/java/com/google/chat/avatar/App.java
// The ID of the slash command "/about".
// You must use the same ID in the Google Chat API configuration.
private static final int ABOUT_COMMAND_ID = 1;

private static final Gson gson = new Gson();

/**
 * Handle requests from Google Workspace add on
 * 
 * @param request the request sent by Google Chat
 * @param response the response to be sent back to Google Chat
 */
@Override
public void service(HttpRequest request, HttpResponse response) throws Exception {
  JsonObject event = gson.fromJson(request.getReader(), JsonObject.class);
  JsonObject chatEvent = event.getAsJsonObject("chat");
  Message message;
  if (chatEvent.has("appCommandPayload")) {
    message = handleAppCommand(chatEvent);
  } else {
    message = handleMessage(chatEvent);
  }
  JsonObject createMessageAction = new JsonObject();
  createMessageAction.add("message", gson.fromJson(gson.toJson(message), JsonObject.class));
  JsonObject chatDataAction = new JsonObject();
  chatDataAction.add("createMessageAction", createMessageAction);
  JsonObject hostAppDataAction = new JsonObject();
  hostAppDataAction.add("chatDataAction", chatDataAction);
  JsonObject dataActions = new JsonObject();
  dataActions.add("hostAppDataAction", hostAppDataAction);
  response.getWriter().write(gson.toJson(dataActions));
}

/**
 * Handles an APP_COMMAND event in Google Chat.
 *
 * @param event the event object from Google Chat
 * @return the response message object.
 */
private Message handleAppCommand(JsonObject event) throws Exception {
  switch (event.getAsJsonObject("appCommandPayload")
    .getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt()) {
    case ABOUT_COMMAND_ID:
      return new Message()
        .setText("The Avatar app replies to Google Chat messages.");
    default:
      return null;
  }
}

Apps Script

apps-script/chat/avatar-app/Code.gs
// The ID of the slash command "/about".
// You must use the same ID in the Google Chat API configuration.
const ABOUT_COMMAND_ID = 1;

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onAppCommand(event) {
  // Executes the app command logic based on ID.
  switch (event.chat.appCommandPayload.appCommandMetadata.appCommandId) {
    case ABOUT_COMMAND_ID:
      return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
        text: 'The Avatar app replies to Google Chat messages.'
      }}}}};
  }
}

इस कोड सैंपल का इस्तेमाल करने के लिए, ABOUT_COMMAND_ID की जगह उस कमांड आईडी का इस्तेमाल करें जिसे आपने Chat API में कमांड कॉन्फ़िगर करते समय तय किया था.

मैसेज से जुड़ी किसी कार्रवाई का जवाब देना

यहां दिए गए कोड में, Chat ऐप्लिकेशन का एक उदाहरण दिखाया गया है. यह ऐप्लिकेशन, मुझे याद दिलाएं मैसेज पर कार्रवाई का जवाब, टेक्स्ट मैसेज के ज़रिए देता है. मैसेज पर की जाने वाली कार्रवाइयों का जवाब देने के लिए, Chat ऐप्लिकेशन ऐप्लिकेशन कमांड ट्रिगर से इवेंट ऑब्जेक्ट हैंडल करता है. जब किसी इवेंट ऑब्जेक्ट के पेलोड में मैसेज ऐक्शन कमांड आईडी शामिल होता है, तब Chat ऐप्लिकेशन, createMessageAction ऑब्जेक्ट के साथ ऐक्शन DataActions दिखाता है:

Node.js

/**
 * Responds to an APP_COMMAND interaction event from Google Chat.
 *
 * @param {Object} event The interaction event from Google Chat.
 * @param {Object} res The HTTP response object.
 * @return {Object} The JSON response message with a confirmation.
 */
function onAppCommand(event, res) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} =
    event.chat.appCommandPayload.appCommandMetadata;

  if (appCommandType === 'MESSAGE_ACTION' &&
      appCommandId === REMIND_ME_COMMAND_ID) {

    // Message actions can access the context of the message they were
    // invoked on, such as the text or sender of that message.
    const messageText = event.chat.appCommandPayload.message.text;

    // Return a response that includes details from the original message.
    return res.json({
      "hostAppDataAction": {
        "chatDataAction": {
          "createMessageAction": {
            "message": {
              "text": `Setting a reminder for message: "${messageText}"`
            }
          }
        }
      }
    });
  }
}

Python

def on_app_command(event):
    """Responds to an APP_COMMAND interaction event from Google Chat.

    Args:
        event (dict): The interaction event from Google Chat.

    Returns:
        dict: The JSON response message with a confirmation.
    """
    # Collect the command ID and type from the event metadata.
    payload = event.get('chat', {}).get('appCommandPayload', {})
    metadata = payload.get('appCommandMetadata', {})
    if metadata.get('appCommandType') == 'MESSAGE_ACTION' and \
       metadata.get('appCommandId') == REMIND_ME_COMMAND_ID:

        # Message actions can access the context of the message they were
        # invoked on, such as the text or sender of that message.
        message_text = payload.get('message', {}).get('text')

        # Return a response that includes details from the original message.
        return {
            "hostAppDataAction": {
                "chatDataAction": {
                    "createMessageAction": {
                        "message": {
                            "text": f'Setting a reminder for message: "{message_text}"'
                        }
                    }
                }
            }
        }

Java

/**
 * Responds to an APP_COMMAND interaction event from Google Chat.
 *
 * @param event The interaction event from Google Chat.
 * @param response The HTTP response object.
 */
void onAppCommand(JsonObject event, HttpResponse response) throws Exception {
  // Collect the command ID and type from the event metadata.
  JsonObject payload = event.getAsJsonObject("chat").getAsJsonObject("appCommandPayload");
  JsonObject metadata = payload.getAsJsonObject("appCommandMetadata");
  String appCommandType = metadata.get("appCommandType").getAsString();

  if (appCommandType.equals("MESSAGE_ACTION")) {
    int commandId = metadata.get("appCommandId").getAsInt();
    if (commandId == REMIND_ME_COMMAND_ID) {
      // Message actions can access the context of the message they were
      // invoked on, such as the text or sender of that message.
      String messageText = payload.getAsJsonObject("message").get("text").getAsString();

      // Return a response that includes details from the original message.
      JsonObject responseMessage = new JsonObject();
      responseMessage.addProperty("text", "Setting a reminder for message: " + messageText);

      JsonObject createMessageAction = new JsonObject();
      createMessageAction.add("message", responseMessage);

      JsonObject chatDataAction = new JsonObject();
      chatDataAction.add("createMessageAction", createMessageAction);

      JsonObject hostAppDataAction = new JsonObject();
      hostAppDataAction.add("chatDataAction", chatDataAction);

      JsonObject finalResponse = new JsonObject();
      finalResponse.add("hostAppDataAction", hostAppDataAction);

      response.getWriter().write(finalResponse.toString());
    }
  }
}

Apps Script

/**
 * Responds to an APP_COMMAND interaction event in Google Chat.
 *
 * @param {Object} event The interaction event from Google Chat.
 * @return {Object} The JSON response message with a confirmation.
 */
function onAppCommand(event) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} =
    event.chat.appCommandPayload.appCommandMetadata;

  if (appCommandType === 'MESSAGE_ACTION' &&
      appCommandId === REMIND_ME_COMMAND_ID) {

    // Message actions can access the context of the message they were
    // invoked on, such as the text or sender of that message.
    const messageText = event.chat.appCommandPayload.message.text;

    // Return a response that includes details from the original message.
    return CardService.newChatResponseBuilder()
        .setText("Setting a reminder for message: " + messageText)
        .build();
  }
}

इस कोड सैंपल का इस्तेमाल करने के लिए, REMIND_ME_COMMAND_ID की जगह उस कमांड आईडी को डालें जिसे आपने Chat API में कमांड कॉन्फ़िगर करते समय डाला था.

निर्देश की जांच करना

कमांड और कोड की जांच करने के लिए, Google Chat ऐप्लिकेशन के लिए इंटरैक्टिव सुविधाओं की जांच करना लेख पढ़ें.

Chat के यूज़र इंटरफ़ेस (यूआई) में कमांड को टेस्ट करने और इस्तेमाल करने का तरीका जानने के लिए, Google Chat के सहायता दस्तावेज़ में Google Chat में ऐप्लिकेशन इस्तेमाल करना लेख पढ़ें.

ऐसे चैट ऐप्लिकेशन जिन्हें ऐड-ऑन के तौर पर नहीं जोड़ा गया है: ये निर्देश का जवाब देते हैं

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

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

ऐड-ऑन नहीं है, तो आपको इवेंट पेलोड में अलग-अलग इवेंट टाइप और मेटाडेटा ऑब्जेक्ट हैंडल करने होंगे:

कमांड का टाइप इवेंट किस तरह का है कमांड का मेटाडेटा
स्लैश कमांड MESSAGE message.slashCommand या message.annotation.slashCommand
फ़टाफ़ट निर्देश APP_COMMAND appCommandMetadata
मैसेज पर कार्रवाई APP_COMMAND appCommandMetadata

स्लैश कमांड का जवाब देना

यहां दिए गए कोड में, एक ऐसे Chat ऐप्लिकेशन का उदाहरण दिखाया गया है जो ऐड-ऑन नहीं है. यह स्लैश कमांड /about का जवाब देता है. Chat ऐप्लिकेशन, MESSAGE इंटरैक्शन इवेंट को मैनेज करता है. साथ ही, यह पता लगाता है कि इंटरैक्शन इवेंट में मैचिंग कमांड आईडी शामिल है या नहीं. इसके बाद, यह एक निजी Message ऑब्जेक्ट दिखाता है:

Node.js

node/avatar-app/index.js
/**
 * Handles slash and quick commands.
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleAppCommands(event, res) {
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
    case HELP_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

Apps Script

apps-script/avatar-app/avatar-app.gs
// Checks for the presence of a slash command in the message.
if (event.message.slashCommand) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  switch (event.message.slashCommand.commandId) {
    case ABOUT_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Python

python/avatar-app/main.py
def handle_app_commands(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles slash and quick commands.

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """
    app_command_id = event["appCommandMetadata"]["appCommandId"]

    if app_command_id == ABOUT_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    elif app_command_id == HELP_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    return {}

Java

java/avatar-app/src/main/java/AvatarApp.java
/**
 * Handles slash and quick commands.
 *
 * @param event    The Google Chat event.
 * @param response The HTTP response object.
 */
private void handleAppCommands(JsonObject event, HttpResponse response) throws Exception {
  int appCommandId = event.getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt();

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      Message aboutMessage = new Message();
      aboutMessage.setText("The Avatar app replies to Google Chat messages.");
      aboutMessage.setPrivateMessageViewer(new User()
          .setName(event.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
    case HELP_COMMAND_ID:
      Message helpMessage = new Message();
      helpMessage.setText("The Avatar app replies to Google Chat messages.");
      helpMessage.setPrivateMessageViewer(new User()
          .setName(event.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(helpMessage));
      return;
  }
}

ABOUT_COMMAND_ID की जगह, वह कमांड आईडी डालें जिसे आपने Google Cloud Console में कमांड कॉन्फ़िगर करते समय डाला था.

किसी कमांड का तुरंत जवाब देना

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

Node.js

node/avatar-app/index.js
/**
 * Handles slash and quick commands.
 *
 * @param {Object} event - The Google Chat event.
 * @param {Object} res - The HTTP response object.
 */
function handleAppCommands(event, res) {
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
    case HELP_COMMAND_ID:
      return res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

Apps Script

apps-script/avatar-app/avatar-app.gs
/**
 * Handles the APP_COMMAND event type. This function is triggered when a user
 * interacts with a quick command within the Google Chat app.  It responds
 * based on the command ID.
 *
 * @param {Object} event The event object from Google Chat, containing details
 *     about the app command interaction.  It includes information like the
 *     command ID and the user who triggered it.
 */
function onAppCommand(event) {
  // Executes the quick command logic based on its ID.
  // Command IDs are set in the Google Chat API configuration.
  switch (event.appCommandMetadata.appCommandId) {
    case HELP_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Python

python/avatar-app/main.py
def handle_app_commands(event: Mapping[str, Any]) -> Mapping[str, Any]:
    """Handles slash and quick commands.

    Args:
        Mapping[str, Any] event: The Google Chat event.

    Returns:
        Mapping[str, Any]: the response
    """
    app_command_id = event["appCommandMetadata"]["appCommandId"]

    if app_command_id == ABOUT_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    elif app_command_id == HELP_COMMAND_ID:
        return {
            "privateMessageViewer": event["user"],
            "text": "The Avatar app replies to Google Chat messages.",
        }
    return {}

Java

java/avatar-app/src/main/java/AvatarApp.java
/**
 * Handles slash and quick commands.
 *
 * @param event    The Google Chat event.
 * @param response The HTTP response object.
 */
private void handleAppCommands(JsonObject event, HttpResponse response) throws Exception {
  int appCommandId = event.getAsJsonObject("appCommandMetadata").get("appCommandId").getAsInt();

  switch (appCommandId) {
    case ABOUT_COMMAND_ID:
      Message aboutMessage = new Message();
      aboutMessage.setText("The Avatar app replies to Google Chat messages.");
      aboutMessage.setPrivateMessageViewer(new User()
          .setName(event.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
    case HELP_COMMAND_ID:
      Message helpMessage = new Message();
      helpMessage.setText("The Avatar app replies to Google Chat messages.");
      helpMessage.setPrivateMessageViewer(new User()
          .setName(event.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(helpMessage));
      return;
  }
}

HELP_COMMAND_ID की जगह, वह कमांड आईडी डालें जिसे आपने Google Cloud Console में कमांड कॉन्फ़िगर करते समय डाला था.

मैसेज से जुड़ी किसी कार्रवाई का जवाब देना

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

Node.js 

/**
 * Responds to an APP_COMMAND interaction event from Google Chat.
 *
 * @param {Object} event The interaction event from Google Chat.
 * @param {Object} res The HTTP response object.
 * @return {Object} The JSON response message with a confirmation.
 */
function handleAppCommand(event, res) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  // Use appCommandType to detect message actions.
  if (appCommandType === 'MESSAGE_ACTION' &&
      appCommandId === REMIND_ME_COMMAND_ID) {

    // Message actions can access the context of the message they were
    // invoked on, such as the text or sender of that message.
    const messageText = event.message.text;

    // Return a response that includes details from the original message.
    return res.send({
      text: `Setting a reminder for this message: "${messageText}"`
    });
  }
}

Apps Script 

/**
 * Responds to an APP_COMMAND interaction event in Google Chat.
 *
 * @param {Object} event The interaction event from Google Chat.
 * @return {Object} The JSON response message with a confirmation.
 */
function onAppCommand(event) {
  // Collect the command ID and type from the event metadata.
  const {appCommandId, appCommandType} = event.appCommandMetadata;

  if (appCommandType === 'MESSAGE_ACTION' &&
      appCommandId === REMIND_ME_COMMAND_ID) {

    // Message actions can access the context of the message they were
    // invoked on, such as the text or sender of that message.
    const messageText = event.message.text;

    // Return a response that includes details from the original message.
    return { "text": "Setting a reminder for message: " + messageText };
  }
}

Python 

def handle_app_command(event):
    """Responds to an APP_COMMAND interaction event from Google Chat.

    Args:
        event (dict): The interaction event from Google Chat.

    Returns:
        dict: The JSON response message with a confirmation.
    """
    # Collect the command ID and type from the event metadata.
    metadata = event.get('appCommandMetadata', {})
    if metadata.get('appCommandType') == 'MESSAGE_ACTION' and \
       metadata.get('appCommandId') == REMIND_ME_COMMAND_ID:

        # Message actions can access the context of the message they were
        # invoked on, such as the text or sender of that message.
        message_text = event.get('message', {}).get('text')

        # Return a response that includes details from the original message.
        return {
            "text": f'Setting a reminder for message: "{message_text}"'
        }

Java 

/**
 * Responds to an APP_COMMAND interaction event from Google Chat.
 *
 * @param event The interaction event from Google Chat.
 * @param response The HTTP response object.
 */
void handleAppCommand(JsonObject event, HttpResponse response) throws Exception {
  // Collect the command ID and type from the event metadata.
  JsonObject metadata = event.getAsJsonObject("appCommandMetadata");
  String appCommandType = metadata.get("appCommandType").getAsString();

  if (appCommandType.equals("MESSAGE_ACTION")) {
    int commandId = metadata.get("appCommandId").getAsInt();
    if (commandId == REMIND_ME_COMMAND_ID) {
      // Message actions can access the context of the message they were
      // invoked on, such as the text or sender of that message.
      String messageText = event.getAsJsonObject("message").get("text").getAsString();

      // Return a response that includes details from the original message.
      JsonObject responseMessage = new JsonObject();
      responseMessage.addProperty("text", "Setting a reminder for message: " + messageText);
      response.getWriter().write(responseMessage.toString());
    }
  }
}

REMIND_ME_COMMAND_ID की जगह, वह कमांड आईडी डालें जिसे आपने Google Cloud Console में कमांड कॉन्फ़िगर करते समय डाला था.