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. 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.
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:
Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü > APIs und Dienste > Aktivierte APIs und Dienste > Google Chat API.
Klicken Sie auf Konfiguration.
Gehen Sie unter Erweiterte Einstellungen zu Trigger und prüfen Sie, ob das Feld App-Befehl einen Trigger enthält, z. B. einen HTTP-Endpunkt oder eine Apps Script-Funktion. Sie müssen diesen Trigger im folgenden Abschnitt verwenden, um auf den Schnellbefehl zu reagieren.
Klicken Sie unter Befehle auf Befehl hinzufügen.
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.
Optional: Wenn Ihre Chat-App auf den Befehl mit einem Dialogfeld reagieren soll, setzen Sie ein Häkchen in das Kästchen Dialogfeld öffnen.
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 Ereignisobjekt mit Informationen zum Schnellbefehl.
Das Ereignisobjekt enthält eine AppCommand-Nutzlast mit Details zum aufgerufenen Befehl (einschließlich der Befehls-ID), damit du eine entsprechende Antwort zurückgeben kannst.
Wenn Sie auf einen Schnellbefehl reagieren möchten, müssen Sie den Trigger App-Befehl implementieren, damit Ihre Chat-App alle Ereignisobjekte verarbeiten kann, die App-Befehlsmetadaten enthalten.
Der folgende Code zeigt ein Beispiel für eine Chat-App, die auf den Befehl Hilfe antwortet. Um auf Schnellbefehle zu reagieren, verarbeitet die Chat-App Ereignisobjekte von einem App-Befehl-Trigger. Wenn die Nutzlast eines Ereignisobjekts eine ID für einen Schnellbefehl enthält, gibt die Chat-App die Aktion DataActions mit einem createMessageAction-Objekt zurück:
Apps Script
// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You must
// use the same ID as set in the Google Chat API configuration.
const HELP_COMMAND_ID = 0;
/**
* Responds to an APP_COMMAND event in Google Chat.
*
* @param {Object} event the event object from Google Chat
*/
function onAppCommand(event) {
// Stores the Google Chat app command metadata as a variable.
const appCommandMetadata = event.chat.appCommandPayload.appCommandMetadata;
if (appCommandMetadata.appCommandType == "QUICK_COMMAND") {
// Executes the quick command logic based on its ID.
// Quick command IDs are set in the Google Chat API configuration.
switch (appCommandMetadata.appCommandId) {
case HELP_COMMAND_ID:
return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
text: 'The Avatar app replies to Google Chat messages.'
}}}}};
}
}
}
Wenn Sie dieses Codebeispiel verwenden möchten, ersetzen Sie HELP_COMMAND_ID durch die Befehls-ID, die Sie beim Konfigurieren des Schnellbefehls in der Chat API angegeben haben.
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.