Als Google Chat-App auf Schnellbefehle reagieren

Auf dieser Seite wird beschrieben, wie Sie Schnellbefehle für die Google Chat App einrichten und darauf reagieren.

Mit einem Schnellbefehl können Nutzer eine Chat-App aufrufen und mit ihr interagieren. Wenn Sie einen Schnellbefehl verwenden möchten, öffnen Sie das Integrationsmenü, indem Sie in einem Chatbereich oder einer Unterhaltung auf „Google Workspace-Tools“  klicken. Wählen Sie dann einen App-Befehl mit einem Namen aus, der nicht mit einem Schrägstrich (/) beginnt. Wenn Sie einen Schnellbefehl auswählen, wird die Chat-App direkt ohne weitere Eingaben des Nutzers aufgerufen, was schnelle Nutzerinteraktionen ermöglicht.

Nutzer können eine Chat-App auch über einen Slash-Befehl aufrufen. Eine Anleitung finden Sie unter Auf Slash-Befehle reagieren. Im Vergleich zu Slash-Befehlen haben Schnellbefehle in der Chat-Benutzeroberfläche einen nutzerfreundlicheren Namen, werden sofort nach der Auswahl aufgerufen und erfordern nicht, dass sich der Nutzer den Namen des Slash-Befehls merken oder eingeben muss.

Integrationsmenü mit Schnellbefehlen
Abbildung 1: Das Integrationsmenü mit Schnellbefehlen für eine Chat-App.

Schnellbefehl in der Google Chat API einrichten

Wenn Sie einen Schnellbefehl erstellen oder vorhandene Slash-Befehle in Schnellbefehle umwandeln möchten, müssen Sie in der Konfiguration Ihrer Chat-App für die Google Chat API Informationen zum Befehl angeben.

So konfigurieren Sie einen Schnellbefehl in der Google Chat API:

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

    Zur Seite „Google Chat API“

  2. Klicken Sie auf Konfiguration.

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

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

    • Befehls-ID:Eine Zahl zwischen 1 und 1.000, mit der Ihre Chat-App den Befehl erkennt und eine Antwort zurückgibt.
    • Name:Der Anzeigename für den Befehl. Namen können bis zu 50 Zeichen lang sein und Sonderzeichen enthalten.
      • Verwenden Sie kurze, beschreibende und umsetzbare Wörter oder Wortgruppen, damit die Befehle für die Nutzer klar sind. Verwenden Sie beispielsweise Kontakt aktualisieren für einen Befehl, mit dem ein Kontaktdatensatz geändert wird.
    • Beschreibung:Text, der die Funktionsweise des Befehls beschreibt. Beschreibungen dürfen maximal 50 Zeichen lang sein und Sonderzeichen enthalten.
      • Die Beschreibung sollte kurz und klar sein, damit Nutzer wissen, was sie beim Aufrufen des Befehls erwartet.
      • Informieren Sie die Nutzer darüber, ob die Chat-App an alle im Gruppenbereich oder privat an den Nutzer antwortet, der den Befehl ausführt. Für den Schnellbefehl Info könnten Sie beispielsweise Informationen zu dieser App (nur für Sie sichtbar) angeben.
    • Befehlstyp:Wählen Sie Schnellbefehl aus.

  5. Optional: Wenn Ihre Chat-App auf den Befehl mit einem Dialogfeld reagieren soll, setzen Sie ein Häkchen in das Kästchen Dialogfeld öffnen.

  6. Klicken Sie auf Speichern.

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

Auf einen Schnellbefehl reagieren

Wenn Nutzer einen Schnellbefehl aufrufen, erhält Ihre Chat-App ein APP_COMMAND-Interaktionsereignis. Die Ereignisnutzlast enthält das appCommandMetadata-Objekt mit Details zum aufgerufenen Befehl (einschließlich Befehls-ID und Befehlstyp), damit du eine entsprechende Antwort zurückgeben kannst.

Der folgende Code zeigt ein Beispiel für eine Chat-App, die auf den Befehl Hilfe antwortet, indem sie APP_COMMAND-Interaktionsereignisse verarbeitet und erkennt, ob die Ereignisnutzlast die übereinstimmende Befehls-ID enthält. Wenn die Ereignisnutzlast die Befehls-ID enthält, gibt die Chat-App eine private Nachricht zurück:

Apps Script 

// Handle the APP_COMMAND event type.
function onAppCommand(event) {
  // Executes the command logic based on its ID.
  // Command IDs are set in the Google Chat API configuration.
  switch (event.appCommandMetadata.appCommandId) {
    case HELP_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

Legen Sie HELP_COMMAND_ID auf die Befehls-ID fest, die Sie beim Konfigurieren des Schnellbefehls in der Chat API angegeben haben. Wie Sie diesen Code testen, erfahren Sie unter Interaktive Funktionen für Google Chat-Apps testen. Wenn Sie einen Schnellbefehl in Google Chat testen möchten, öffnen Sie das Integrationsmenü, indem Sie auf „Google Workspace-Tools“  klicken und dann den gewünschten Schnellbefehl auswählen.

Vorhandene Slash-Befehle in Kurzbefehle umwandeln

Wenn Sie einen vorhandenen Slash-Befehl in einen Schnellbefehl ändern möchten, bearbeiten Sie den Slash-Befehl in der Google Chat API. Ändern Sie dazu den Befehlstyp von Slash-Befehl in Schnellbefehl.

Wenn Nutzer einen Schnellbefehl ausführen, erhält Ihre Chat-App ein APP_COMMAND-Interaktionsereignis anstelle eines MESSAGE-Interaktionsereignisses, das für Slash-Befehle gesendet wird. Aktualisieren Sie Ihre Chat-App, um diesen Interaktionsereignistyp zu verarbeiten. Lesen Sie dazu die Ereignisnutzlast mit dem appCommandMetadata-Objekt mit Details zum aufgerufenen Schnellbefehl. Weitere Informationen finden Sie unter Auf einen Schnellbefehl antworten.