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

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

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

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

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

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

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

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

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

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

Node.js

Google Chat ऐप्लिकेशन, जिसमें इंटरैक्टिव सुविधाएं चालू हैं. एचटीटीपी सेवा का इस्तेमाल करके, इंटरैक्टिव चैट ऐप्लिकेशन बनाने के लिए, यह क्विकस्टार्ट पूरा करें.

Apps Script

Google Chat ऐप्लिकेशन, जिसमें इंटरैक्टिव सुविधाएं चालू हों. Apps Script में इंटरैक्टिव चैट ऐप्लिकेशन बनाने के लिए, इस क्विकस्टार्ट की प्रोसेस को पूरा करें.

Python

Google Chat ऐप्लिकेशन, जिसमें इंटरैक्टिव सुविधाएं चालू हों. एचटीटीपी सेवा का इस्तेमाल करके इंटरैक्टिव चैट ऐप्लिकेशन बनाने के लिए, इस क्विकस्टार्ट की प्रोसेस को पूरा करें.

Java

Google 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 Console में, मेन्यू > एपीआई और सेवाएं > चालू किए गए एपीआई और सेवाएं > Google Chat API पर क्लिक करें

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

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

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

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

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

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

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

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

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

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

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

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

Node.js

node/avatar-app/index.js
// 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.'
      });
  }
}

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
# 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.'
    }

Java

java/avatar-app/src/main/java/App.java
// 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:
      Message aboutMessage = new Message();
      aboutMessage.setText("The Avatar app replies to Google Chat messages.");
      aboutMessage.setPrivateMessageViewer(new User()
        .setName(body.getAsJsonObject("user").get("name").getAsString()));
      response.getWriter().write(gson.toJson(aboutMessage));
      return;
  }
}

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