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

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

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

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

स्लैश कमांड विंडो
पहली इमेज: यह विंडो तब दिखती है, जब उपयोगकर्ता Google 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 मैसेज में टाइप करते हैं Gmail फिर से शुरू करने के लिए. कम शब्दों में जानकारी भी नाम के नीचे दिखाई देता है, ताकि उपयोगकर्ताओं को कमांड इस्तेमाल करने के तरीके के बारे में ज़्यादा जानकारी दी जा सके:

स्लैश कमांड का नाम और जानकारी
दूसरी इमेज: स्लैश कमांड का नाम और ब्यौरा.

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

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

    • छोटे, जानकारी देने वाले, और कार्रवाई करने लायक शब्दों या वाक्यांशों का इस्तेमाल करके उपयोगकर्ता के लिए साफ़ और आसान निर्देश होते हैं. उदाहरण के लिए, /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. Command ID: 1 से 1000 तक की कोई संख्या जो Chat ऐप्लिकेशन, स्लैश निर्देश को पहचानने के लिए इस्तेमाल करता है और जवाब दें.

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

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

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

स्लैश निर्देश का जवाब दें

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

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

नीचे दिया गया कोड, चैट ऐप्लिकेशन का एक उदाहरण दिखाता है जो मैन्युअल तरीके से /about स्लैश कमांड का जवाब देता है MESSAGE इंटरैक्शन इवेंट और उनका पता लगाना कि क्या मैसेज में मेल खाने वाला कमांड आईडी है. अगर मैसेज में यह शामिल हो कमांड आईडी, 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:
    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 ऐप्लिकेशन के लिए इंटरैक्टिव सुविधाओं की जांच करें.