Auf Befehle der Google Chat App reagieren

Auf dieser Seite wird erläutert, wie Sie als Google Chat-App Befehle einrichten und darauf reagieren.

Mit Befehlen können Nutzer wichtige Funktionen einer Chat-App entdecken und verwenden. Nur Chat-Apps können den Inhalt eines Befehls sehen. Wenn ein Nutzer beispielsweise eine Nachricht mit einem Slash-Befehl sendet, ist die Nachricht nur für den Nutzer und die Chat-App sichtbar.

Informationen dazu, ob Sie Befehle erstellen sollten, und wie Sie Nutzerinteraktionen gestalten können, finden Sie unter Alle Nutzer aktionen definieren.

Arten von Chat-App-Befehlen

Sie können Chat-App-Befehle als Slash-Befehle, Schnellbefehle oder Nachrichtenaktionen erstellen. So verwenden Nutzer die einzelnen Befehlstypen:

  1. Slash-Befehle: Nutzer können einen Slash-Befehl im Menü auswählen oder einen Schrägstrich (/) und dann einen vordefinierten Text eingeben, z. B. /about. Für Slash-Befehle ist in Chat-Apps in der Regel ein Argumenttext erforderlich.

    Erstellen Sie einen Slash-Befehl, wenn Ihre Chat-App zusätzliche Eingaben vom Nutzer benötigt. Sie können beispielsweise einen Slash-Befehl namens /search erstellen, der ausgeführt wird, nachdem der Nutzer einen Suchbegriff eingegeben hat, z. B. /search receipts.

  2. Schnellbefehle:Nutzer können Befehle verwenden, indem sie das Menü im Antwortbereich einer Chat-Nachricht öffnen. Dazu klicken sie auf Hinzufügen und wählen einen Befehl aus dem Menü aus.

    Erstellen Sie einen Schnellbefehl, wenn Ihre Chat-App sofort auf den Nutzer reagieren kann, ohne auf zusätzliche Eingaben zu warten. Sie können beispielsweise einen Schnellbefehl namens Zufälliges Bild erstellen, der sofort mit einem Bild antwortet.

  3. Nachrichtenaktionen: Nutzer können Nachrichtenaktionen verwenden, indem sie mit dem Mauszeiger auf eine Nachricht fahren und auf das Dreipunkt-Menü klicken. Dazu öffnen sie das Dreipunkt-Menü und wählen einen Befehl aus dem Menü aus.

    Erstellen Sie eine nachrichtenbasierte Aktion, wenn Ihre Chat-App Aktionen basierend auf dem Kontext einer Nachricht ausführen kann.

Die folgenden Bilder zeigen, wie Nutzer das Menü für Slash- und Schnellbefehle sowie Nachrichtenaktionen finden:

Ein Nutzer entdeckt ein Menü mit Slash-Befehlen und Schnellbefehlen.
Nutzer finden ein Menü mit Slash- und Schnellbefehlen.
Ein Nutzer entdeckt ein Kontextmenü für Nachrichten, das eine nachrichtenbasierte Aktion enthält.
Nutzer finden ein Kontextmenü für Nachrichten mit der nachrichtenbasierten Aktion „Erinnerung festlegen“.

Vorbereitung

HTTP

Ein Google Workspace-Add‑on, das Google Chat erweitert. Führen Sie die HTTP Schnellstartanleitung aus, um ein solches Add‑on zu erstellen.

Apps Script

Ein Google Workspace-Add‑on, das Google Chat erweitert. Führen Sie die Apps Script-Schnellstartanleitung aus, um ein solches Add‑on zu erstellen.

Befehl einrichten

In diesem Abschnitt wird erläutert, wie Sie die folgenden Schritte ausführen, um einen Befehl einzurichten:

  1. Erstellen Sie einen Namen und eine Beschreibung für den Befehl.
  2. Konfigurieren Sie den Befehl in der Google Cloud Console.

Befehl benennen und beschreiben

Der Name eines Befehls ist das, was Nutzer eingeben oder auswählen, um die Chat-App aufzurufen. Unter dem Namen wird auch eine kurze Beschreibung angezeigt, um Nutzer weiter darüber zu informieren, wie sie den Befehl verwenden können:

Name und Beschreibung des Slash-Befehls
Name und Beschreibung für einen Slash-Befehl.

Beachten Sie die folgenden Empfehlungen, wenn Sie einen Namen und eine Beschreibung für Ihren Befehl auswählen:

Befehl benennen:

  • Verwenden Sie kurze, beschreibende und handlungsauffordernde Wörter oder Sätze, damit die Befehle für den Nutzer klar sind. Verwenden Sie beispielsweise anstelle des Namens Create a reminder die Option Remind me.
  • Verwenden Sie einen eindeutigen oder häufig verwendeten Namen für Ihren Befehl. Wenn Ihr Befehl eine typische Interaktion oder Funktion beschreibt, können Sie einen häufig verwendeten Namen verwenden, den Nutzer kennen und erwarten, z. B. Settings oder Feedback. Andernfalls sollten Sie eindeutige Befehls namen verwenden. Wenn Ihr Befehlsname für andere Chat-Apps gleich ist, muss der Nutzer ähnliche Befehle filtern, um Ihren zu finden und zu verwenden.

Befehl beschreiben:

  • Halten Sie die Beschreibung kurz und klar, damit Nutzer wissen, was sie erwartet, wenn sie den Befehl verwenden.
  • Informieren Sie Nutzer über Formatierungsanforderungen für den Befehl. Wenn Sie beispielsweise einen Slash-Befehl erstellen, für den ein Argumenttext erforderlich ist, legen Sie die Beschreibung auf etwas wie Remind me to do [something] at [time] fest.
  • Informieren Sie Nutzer darüber, ob die Chat-App allen im Bereich antwortet oder privat dem Nutzer, der den Befehl aufruft. Für den Schnellbefehl About, könnten Sie ihn beispielsweise als Learn about this app (Only visible to you) beschreiben.

Befehl in der Google Cloud Console konfigurieren

Wenn Sie einen Slash-Befehl, einen Schnellbefehl oder eine nachrichtenbasierte Aktion erstellen möchten, geben Sie Informationen zum Befehl oder zur Aktion in der Konfiguration Ihrer Chat-App für die Google Chat API an.

So konfigurieren Sie einen Befehl in der Google Chat API:

  1. Klicken Sie in der Google Cloud Console auf das Menü > APIs & Dienste > Aktivierte APIs & Dienste > Google Chat API

    Zur Seite der Google Chat API

  2. Klicken Sie auf Konfiguration.

  3. Gehen Sie unter Verbindungseinstellungen zu Trigger und geben Sie die Endpunktdetails an. Sie müssen diesen Trigger im folgenden Abschnitt verwenden, um auf den Befehl zu antworten.

    1. HTTP-Endpunkt-URL: Hier können Sie eine gemeinsame HTTP-Endpunkt-URL angeben. Alternativ können Sie verschiedene HTTP-Endpunkte für verschiedene Trigger verwenden, indem Sie den Endpunkt direkt im Feld App-Befehl angeben.
    2. Apps Script: Geben Sie die Bereitstellungs-ID von Apps Script ein. Standardmäßig wird die Funktion onAppCommand aufgerufen. Wenn Sie eine andere Apps Script-Funktion verwenden möchten, geben Sie den Namen der benutzerdefinierten Funktion im Feld App-Befehl an.

  4. Klicken Sie unter Befehle auf Befehl hinzufügen.

  5. Geben Sie die folgenden Informationen zum Befehl ein:

    1. Befehls-ID:Eine Zahl zwischen 1 und 1000, mit der Ihre Chat-App den Befehl erkennt und eine Antwort zurückgibt.
    2. Beschreibung:Der Text, der beschreibt, wie der Befehl verwendet und formatiert wird. Beschreibungen können bis zu 50 Zeichen lang sein.
    3. Befehlstyp:Wählen Sie entweder Schnellbefehl, Slash-Befehl oder nachrichtenbasierte Aktion aus.
    4. Geben Sie einen Namen für den Befehl an:
      • Name des Schnellbefehls:Der Anzeigename, den Nutzer im Menü auswählen, um den Befehl aufzurufen. Kann bis zu 50 Zeichen lang sein und Sonderzeichen enthalten. Beispiel: Remind me.
      • Name des Slash-Befehls:Der Text, den Nutzer eingeben, um den Befehl in einer Nachricht aufzurufen. Muss mit einem Schrägstrich beginnen, darf nur Text enthalten und kann bis zu 50 Zeichen lang sein. Beispiel: /remindMe.
      • Name der nachrichtenbasierten Aktion:Der Anzeigename, den Nutzer im Menü auswählen, um die nachrichtenbasierte Aktion aufzurufen. Kann bis zu 50 Zeichen lang sein und Sonderzeichen enthalten. Beispiel: Remind me.

  6. Optional: Ladenachricht: Eine Toast-Benachrichtigung, die dem Nutzer angezeigt wird, während die nachrichtenbasierte Aktion ausgeführt wird. Nur für Nachrichtenaktionen verfügbar, bei denen keine Dialogfelder geöffnet werden.

  7. Optional: Wenn Ihre Chat-App mit einem Dialogfeld auf den Befehl antworten soll, aktivieren Sie das Kontrollkästchen Dialogfeld öffnen.

  8. Klicken Sie auf Speichern.

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

Auf einen Befehl antworten

Wenn Nutzer einen Befehl verwenden, empfängt Ihre Chat-App ein Ereignisobjekt. Die Ereignisnutzlast enthält ein appCommandPayload Objekt mit Details zum aufgerufenen Befehl (einschließlich der Befehls ID und des Befehlstyps), damit Sie eine entsprechende Antwort zurückgeben können. Das Ereignisobjekt wird an den HTTP-Endpunkt oder die Apps Script Funktion gesendet, die Sie beim Konfigurieren des Triggers App-Befehl angegeben haben.

Private Nachricht für die Chat-App von Cymbal Labs. In der Nachricht wird darauf hingewiesen, dass die Chat-App von Cymbal Labs erstellt wurde. Außerdem enthält sie einen Link zur Dokumentation und einen Link zum Kontaktieren des Supportteams.
Eine Chat-App antwortet privat auf den Slash-Befehl /help und erklärt, wie Nutzer Support erhalten.

Der folgende Code zeigt ein Beispiel für eine Chat-App, die mit einer Textnachricht auf den Slash-Befehl /about antwortet. Um auf Slash-Befehle zu antworten, verarbeitet die Chat-App Ereignisobjekte von einem App-Befehl -Trigger. Wenn die Nutzlast eines Ereignisobjekts eine Slash Befehls-ID enthält, gibt die Chat-App die Aktion DataActions mit einem createMessageAction Objekt zurück:

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

Ersetzen Sie in diesem Codebeispiel ABOUT_COMMAND_ID durch die Befehls-ID, die Sie beim Konfigurieren des Befehls in der Chat API angegeben haben.

Auf eine nachrichtenbasierte Aktion antworten

Der folgende Code zeigt ein Beispiel für eine Chat-App, die mit einer Textnachricht auf die nachrichtenbasierte Aktion Erinnerung festlegen antwortet. Um auf Nachrichtenaktionen zu antworten, verarbeitet die Chat-App Ereignisobjekte von einem App-Befehl -Trigger. Wenn die Nutzlast eines Ereignisobjekts eine Befehls-ID für eine nachrichtenbasierte Aktion enthält, gibt die Chat-App die Aktion DataActions mit einem createMessageAction Objekt zurück:

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();
  }
}

Ersetzen Sie in diesem Codebeispiel REMIND_ME_COMMAND_ID durch die Befehls-ID, die Sie beim Konfigurieren des Befehls in der Chat API angegeben haben.

Befehl testen

Informationen zum Testen des Befehls und des Codes finden Sie unter Interaktive Funktionen für Google Chat-Apps testen.

Informationen zum Testen und Verwenden des Befehls in der Chat-UI finden Sie in der Google Chat-Hilfe unter Apps in Google Chat verwenden.