Slash-Befehle in einer Google Chat-App beantworten

Auf dieser Seite wird erläutert, wie Sie Slash-Befehle für Ihr Google Chat App.

Ein Slash-Befehl ist eine gängige Methode, mit der Nutzer ein Objekt aufrufen und mit ihm interagieren. Chat-App. Außerdem helfen Slash-Befehle, die wichtigsten Funktionen einer Chat-App nutzen.

Um einen Slash-Befehl zu verwenden, geben Nutzer einen Schrägstrich (/) und dann einen kurzen Textbefehl ein. wie /about, um Informationen zur Chat App zu erhalten. Nutzer können verfügbare Slash-Befehle finden, indem sie Google Chat, das ein Fenster mit den verfügbaren Befehlen für den Chat-App:

</ph>

um zu entscheiden, ob Sie Slash-Befehle einrichten sollten Nutzungsinteraktionen gestalten, siehe Definieren Sie alle Kaufprozesse.

Slash-Befehle mit privaten Antworten

Wenn ein Nutzer eine Nachricht sendet, die einen Slash-Befehl enthält, wird die Nachricht für den Nutzer und die Chat App sichtbar. Wenn Sie haben die Chat-App so konfiguriert, dass sie zu Gruppenbereichen hinzugefügt wird mit mehreren Personen arbeiten, können Sie auf den Slash-Befehl um die Interaktion zwischen dem Nutzer und dem Chat-App.

Um mehr über eine Chat-App zu erfahren, in einem Bereich entdecken können, können Nutzer Befehle wie /about oder /help verwenden. Damit nicht alle anderen Personen im Gruppenbereich benachrichtigt werden, Die Chat-App kann privat mit Informationen zu folgenden Themen antworten: wie Sie die Chat App verwenden und Support anfordern.

Vorbereitung

Slash-Befehl einrichten

In diesem Abschnitt wird erläutert, wie Sie mit den folgenden Schritten einen Schrägstrich einrichten. Befehl:

1. Geben Sie einen Namen für den Slash-Befehl ein.
2. Konfigurieren Sie den Slash-Befehl in der Google Chat API.

Slash-Befehl benennen

Der Name eines Slash-Befehls ist das, was Nutzer in eine Chatnachricht eingeben zum Aufrufen der Chat-App. Eine kurze Beschreibung erscheint unter dem Namen, um die Nutzer zur Verwendung des Befehls aufzufordern:

</ph>

Berücksichtigen Sie bei der Auswahl eines Namens und einer Beschreibung für Ihren Slash-Befehl Empfehlungen:

• So benennen Sie den Slash-Befehl:

  • Verwenden Sie kurze, aussagekräftige und umsetzbare Wörter oder Wortgruppen, um Befehle einfach und verständlich. Anstatt beispielsweise zu sagen, /createAReminder, /remindMe verwenden.
  • Wenn Ihr Befehl mehr als ein Wort enthält, helfen Sie Nutzern, den Befehl zu lesen indem Sie für das erste Wort nur Kleinbuchstaben verwenden und dann das erste großschreiben. Buchstaben zusätzlicher Wörter. So wird beispielsweise anstelle von /updatecontact /updateContact verwenden.
  • Überlegen Sie, ob Sie einen eindeutigen oder einen allgemeinen Namen für Ihren Befehl verwenden möchten. Wenn eine typische Interaktion oder Funktion beschreibt, können Sie allgemeinen Namen, den Nutzer erkennen und erwarten, z. B. /settingsoder /feedback. Verwenden Sie andernfalls eindeutige Befehlsnamen. derselbe Befehlsname für andere Chat-Apps ist, muss der Nutzer Filtere ähnliche Befehle, um deine zu finden und zu verwenden.

• So beschreiben Sie den Slash-Befehl:

  • Die Beschreibung sollte kurz und klar sein, damit Nutzer wissen, was sie erwartet wenn der Befehl aufgerufen wird.
  • Teilen Sie den Nutzern mit, ob es Formatierungsanforderungen für den Befehl gibt. Wenn Sie beispielsweise einen /remindMe-Befehl erstellen, für den ein Argument erforderlich ist, Text eingeben, legen Sie die Beschreibung auf etwa Remind me to do [something] at [time] fest.
  • Lassen Sie Nutzer wissen, ob die Chat-App auf oder privat für den Nutzer, der den Befehl aufruft. Für den Slash-Befehl /about könnten Sie ihn beispielsweise so beschreiben: Learn about this app (Only visible to you). Um privat auf eine Slash-Befehl verwenden, finden Sie im Abschnitt Mit einer privaten Nachricht antworten.

Slash-Befehl in der Google Chat API konfigurieren

Um einen Slash-Befehl zu erstellen, müssen Sie Informationen über den Befehl in Konfiguration Ihrer Chat-App für die Google Chat API konfigurieren.

So konfigurieren Sie einen Slash-Befehl in der Google Chat API: Schritte:

1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü menu &gt; APIs und Dienste &gt; Aktivierte APIs und Dienste &gt; Google Chat API

   Zur Seite „Google Chat API“

2. Klicken Sie auf Konfiguration.

3. Klicken Sie unter Slash-Befehle auf Slash-Befehl hinzufügen.

4. Geben Sie einen Namen, eine Befehls-ID und eine Beschreibung für den Befehl ein:

   1. Name:Der Anzeigename für den Befehl und die Nutzereingabe zum Aufrufen Ihrer Anwendung. Muss mit einem Schrägstrich beginnen, darf nur Text enthalten und darf darf maximal 50 Zeichen lang sein.
   2. Beschreibung:Der Text zur Beschreibung der Verwendung und Formatierung. den Befehl. Beschreibungen dürfen maximal 50 Zeichen lang sein.
   3. Befehls-ID:Eine Zahl zwischen 1 und 1.000, die in Ihrem Die Chat-App verwendet, um den Slash-Befehl zu erkennen und eine Antwort zurückgeben.

5. Optional: Wenn Sie möchten, dass Ihre Chat-App auf über ein Dialogfeld den Befehl Kästchen Dialogfeld öffnen

6. Klicken Sie auf Speichern.

Der Slash-Befehl ist jetzt für die Chat-App konfiguriert.

Auf einen Slash-Befehl antworten

Wenn Nutzer eine Chatnachricht erstellen, die einen Slash-Befehl enthält, Ihre Chat-App empfängt ein MESSAGE-Interaktionsereignis. Die Ereignisnutzlast enthält das Objekt slashCommand. und slashCommandMetadata Objekte. Diese Objekte enthalten Details zu dem in der Nachricht verwendeten Befehl einschließlich der Befehls-ID, damit Sie eine entsprechende Antwort zurückgeben können.

</ph>

Der folgende Code zeigt ein Beispiel für eine Chat-App. die auf den Slash-Befehl /help antwortet, indem er Folgendes verarbeitet: MESSAGE Interaktionsereignisse und die Erkennung Gibt an, ob die Nachricht die entsprechende Befehls-ID enthält. Wenn die Nachricht Folgendes enthält: der Befehls-ID gibt die Chat-App eine private Nachricht zurück. wie Sie Hilfe erhalten:

/**
* Responds to a MESSAGE event in Google Chat.
*
* @param {!Object} req Request sent from Google Chat app
* @param {!Object} res Response to send back
*
* @return {!Object} respond to slash command
*/
exports.onMessage = function onMessage(req, res) {
  if (req.method === 'GET' || !req.body.message) {
    return res.send('Hello! This function is meant to be used in Google Chat app.');
  }

  const event = req.body;

  // Checks for the presence of event.message.slashCommand.
  // If the slash command is "/help", responds with a private text message.
  if (event.message.slashCommand) {
    switch (event.message.slashCommand.commandId) {
      case 'ID': // The ID for your slash command
        return res.json({
          privateMessageViewer: event.user, // Optional. Responds privately to the slash command.
          text: 'This Chat app was created by Cymbal Labs. To get help with this app, <https://cymbalgroup.com/docs|see our documentation> or <https://cymbalgroup.com/support|contact our support team>.'
        });
    }
  }

  // If the Chat app doesn't detect a slash command, it responds
  // with a private text message
  return res.json({
    privateMessageViewer: event.user,
    text: 'Try a slash command.'
  });
};

/**
* Responds to a MESSAGE event in Google Chat.
*
* @param {Object} event the event object from Google Chat
*/
function onMessage(event) {
  if (event.message.slashCommand) {
    switch (event.message.slashCommand.commandId) {
      case ID: // The ID for your slash command
        return {
          "privateMessageViewer": event.user, // Optional. Responds privately to the slash command.
          "text": "This Chat app was created by Cymbal Labs. To get help with this app, <https://cymbalgroup.com/docs|see our documentation> or <https://cymbalgroup.com/support|contact our support team>."
        };
    }
  }
  else {
    return { "text": "Try a slash command.", "privateMessageViewer": event.user };
  }
}

from typing import Any, Mapping

import flask
import functions_framework

@functions_framework.http
def main(req: flask.Request) -> Mapping[str, Any]:
  """Responds to a MESSAGE event in Google Chat.

  Args:
      req (flask.Request): the event object from Chat API.

  Returns:
      Mapping[str, Any]: open a Dialog in response to a card's button click.
  """
  if req.method == 'GET':
    return 'Hello! This function must be called from Google Chat.'

  request = req.get_json(silent=True)

  # Checks for the presence of event.message.slashCommand.
  # If the slash command is "/help", responds with a private text message.
  if request.get('message', {}).get('slashCommand'):
    command_id = request.get('message', {}).get('slashCommand').get('commandId')
    if command_id == 'ID': # The ID for your slash command
      return {
          'privateMessageViewer': request.get('user'),
          'text': (
              'This Chat app was created by Cymbal Labs. To get help with this'
              ' app, <https://cymbalgroup.com/docs|see our documentation> or'
              ' <https://cymbalgroup.com/support|contact our support team>.'
          ),
      }

  return {
      'privateMessageViewer': request.get('user'), # Optional. Responds privately to the slash command.
      'text': 'Try a slash command.',
  }

Ersetzen Sie ID durch die Befehls-ID, die Sie angegeben, wenn Sie den Slash-Befehl in der Chat API konfiguriert haben. Informationen zum Testen dieses Codes finden Sie unter Interaktive Funktionen für Google Chat-Apps testen

Weitere Informationen

• Beispiele für Chat-Apps mit Slash-Befehlen
• Nachricht senden
• Private Nachrichten senden
• Interaktive Dialogfelder öffnen