Google Chat ऐप्लिकेशन के तौर पर, स्लैश कमांड का जवाब देना

इस पेज में बताया गया है कि Google Chat ऐप्लिकेशन.

स्लैश कमांड, Chat ऐप्लिकेशन को इस्तेमाल करने का एक सामान्य तरीका है. इसकी मदद से, उपयोगकर्ता Chat ऐप्लिकेशन को खोल सकते हैं और उससे इंटरैक्ट कर सकते हैं. साथ ही, स्लैश कमांड की मदद से, उपयोगकर्ता Chat ऐप्लिकेशन की मुख्य सुविधाओं को खोज सकते हैं और उनका इस्तेमाल कर सकते हैं.

स्लैश कमांड का इस्तेमाल करने के लिए, उपयोगकर्ता स्लैश (/) टाइप करते हैं. इसके बाद, Chat ऐप्लिकेशन के बारे में जानकारी पाने के लिए, वे /about जैसे छोटे टेक्स्ट कमांड टाइप करते हैं. उपयोगकर्ता, Google Chat में स्लैश टाइप करके, उपलब्ध स्लैश कमांड देख सकते हैं. इससे एक विंडो खुलती है, जिसमें Chat ऐप्लिकेशन के लिए उपलब्ध कमांड की सूची दिखती है:

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

निजी जवाबों के साथ स्लैश कमांड

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

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

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

स्लैश कमांड सेट अप करना

इस सेक्शन में, स्लैश सेट अप करने के लिए इन चरणों को पूरा करने का तरीका बताया गया है आदेश:

1. अपने स्लैश कमांड को एक नाम दें.
2. Google Chat API में स्लैश कमांड कॉन्फ़िगर करें.

अपने स्लैश कमांड को नाम दें

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

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

• स्लैश कमांड को नाम देने के लिए:

  • छोटे, जानकारी देने वाले, और कार्रवाई करने लायक शब्दों या वाक्यांशों का इस्तेमाल करके उपयोगकर्ता के लिए साफ़ और आसान निर्देश होते हैं. उदाहरण के लिए, /createAReminder के बजाय /remindMe का इस्तेमाल करें.
  • अगर आपके निर्देश में एक से ज़्यादा शब्द हैं, तो उपयोगकर्ताओं को निर्देश पढ़ने में मदद करें पहले शब्द के लिए सभी लोअरकेस का इस्तेमाल करें और फिर पहले अतिरिक्त शब्दों वाला पत्र. उदाहरण के लिए, /updatecontact के बजाय, /updateContact का इस्तेमाल करें.
  • विचार करें कि अपने आदेश के लिए किसी अद्वितीय या सामान्य नाम का उपयोग करें. अगर आपके निर्देश में किसी सामान्य इंटरैक्शन या सुविधा के बारे में बताया गया है, तो किसी ऐसे सामान्य नाम का इस्तेमाल किया जा सकता है जिसे उपयोगकर्ता पहचानते हों और जिसकी उम्मीद करते हों. जैसे, /settings या /feedback. आप चाहें, तो यूनीक कमांड नाम इस्तेमाल करें. ऐसा इसलिए, क्योंकि अगर आपके निर्देश का नाम अन्य चैट ऐप्लिकेशन के लिए एक ही है, तो उपयोगकर्ता को मिलते-जुलते निर्देशों को फ़िल्टर करके, अपने निर्देश खोजें और उनका इस्तेमाल करें.

• अपने स्लैश कमांड के बारे में बताने के लिए:

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

Google Chat API में स्लैश कमांड कॉन्फ़िगर करना

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

Google Chat API में स्लैश कमांड को कॉन्फ़िगर करने के लिए, इन चरणों को पूरा करें कदम:

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

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

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

3. स्लैश कमांड में जाकर, स्लैश कमांड जोड़ें पर क्लिक करें.

4. कमांड के लिए कोई नाम, कमांड आईडी, और जानकारी डालें:

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

5. ज़रूरी नहीं: अगर आपको Chat ऐप्लिकेशन से जवाब पाना है, तो डायलॉग के साथ निर्देश देने के बाद, कोई डायलॉग बॉक्स खोलें.

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

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

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

जब लोग ऐसा Chat मैसेज बनाते हैं जिसमें स्लैश कमांड शामिल होता है, आपके Chat ऐप्लिकेशन को MESSAGE इंटरैक्शन इवेंट मिलेगा. इवेंट पेलोड में slashCommand शामिल है और slashCommandMetadata ऑब्जेक्ट हैं. इन ऑब्जेक्ट में, मैसेज में इस्तेमाल किए गए निर्देश की जानकारी होती है (कमांड आईडी के साथ) ताकि आप सही जवाब दे सकें.

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

// 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 res.send({
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      });
  }
}

// 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.'
      };
  }
}

# Checks for the presence of a slash command in the message.
if "slashCommand" in request_json["message"]:
  # Executes the slash command logic based on its ID.
  # Slash command IDs are set in the Google Chat API configuration.
  if request_json["message"]["slashCommand"]["commandId"] == ABOUT_COMMAND_ID:
    return {
      "privateMessageViewer": request_json["user"],
      "text": 'The Avatar app replies to Google Chat messages.'
    }

// Checks for the presence of a slash command in the message.
if (body.getAsJsonObject("message").has("slashCommand")) {
  // Executes the slash command logic based on its ID.
  // Slash command IDs are set in the Google Chat API configuration.
  JsonObject slashCommand = body.getAsJsonObject("message").getAsJsonObject("slashCommand");
  switch (slashCommand.get("commandId").getAsString()) {
    case ABOUT_COMMAND_ID:
    JsonObject aboutMessage = new JsonObject();
    aboutMessage.addProperty("text", "The Avatar app replies to Google Chat messages.");
    aboutMessage.add("privateMessageViewer", body.getAsJsonObject("user"));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
  }
}

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

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

• स्लैश कमांड का इस्तेमाल करने वाले Chat ऐप्लिकेशन के सैंपल देखना
• मैसेज भेजें
• निजी मैसेज भेजना
• इंटरैक्टिव डायलॉग खोलें