Google Chat-Nachrichten senden

Auf dieser Seite wird erläutert, wie Google Chat-Apps Nachrichten senden können, um auf Nutzerinteraktionen zu antworten.

In Google Chat werden Add-ons für Nutzer als Google Chat-Apps angezeigt. Weitere Informationen finden Sie unter Google Chat erweitern – Übersicht.

  • Kontaktformular über Slash-Befehl
    Abbildung 1: Eine Chat-App antwortet auf einen Befehl mit einer Textnachricht und einer Schaltfläche.
  • Kontaktformular in einem Dialogfeld
    Abbildung 2: Eine Chat-App öffnet ein Dialogfeld, in dem Nutzer Informationen eingeben können.
  • Kartennachricht mit Eingabe-Widgets für Formulare.
    Abbildung 5 Eine Chat-App sendet eine Nachricht mit Text und einer interaktiven Karte.

Vorbereitung

Node.js

Ein Google Workspace-Add-on, das Google Chat erweitert. Führen Sie dazu die HTTP-Kurzanleitung aus.

Apps Script

Ein Google Workspace-Add-on, das Google Chat erweitert. Wenn Sie ein solches Script erstellen möchten, folgen Sie der Apps Script-Kurzanleitung.

Mitteilung entwerfen

Chat-Apps können in einer Nachricht Folgendes enthalten:

  • Text, der Hyperlinks, @Erwähnungen und Emojis enthält
  • Eine oder mehrere Karten, die in einer Nachricht angezeigt werden oder in einem neuen Fenster als Dialogfeld geöffnet werden.
  • Ein oder mehrere Zusatz-Widgets, also Schaltflächen, die nach Text oder Karten in einer Nachricht angezeigt werden.

Informationen zum Erstellen von Nachrichten finden Sie in der folgenden Dokumentation zur Google Chat API:

Mit Nach­richt antworten

Chat-Apps können auf die folgenden Trigger oder Interaktionen mit einer Nachricht reagieren:

  • Nachrichten-Trigger, z. B. wenn Nutzer eine Chat-App mit einer @Erwähnung oder einer Direktnachricht taggen.
  • Zu Gruppenbereich hinzugefügt-Trigger, z. B. wenn Nutzer die Chat-App aus dem Google Workspace Marketplace installieren oder einem Gruppenbereich hinzufügen.
  • Schaltflächenklicks auf Karten in Nachrichten oder Dialogen Beispielsweise, wenn Nutzer Informationen eingeben und auf „Senden“ klicken.

Andernfalls können Chat-Apps proaktiv Nachrichten senden, indem sie die Google Chat API aufrufen.

Wenn du mit einer Nachricht antworten möchtest, gib die Aktion DataActions mit einem CreateMessageAction-Objekt zurück:

{ "hostAppDataAction": { "chatDataAction": { "createMessageAction": {
  "message": MESSAGE
}}}

Ersetzen Sie MESSAGE durch eine Message-Ressource aus der Chat API. Weitere Informationen zur Funktionsweise von Aktionen finden Sie unter Chataktionen.

Im folgenden Beispiel erstellt und sendet eine Chat-App eine SMS, wenn sie einem Gruppenbereich hinzugefügt wird. Wenn ein Nutzer Ihre Chat-App einem Gruppenbereich hinzufügt, soll eine SMS gesendet werden. Dazu muss Ihre Chat-App auf den Trigger Zum Gruppenbereich hinzugefügt reagieren und die Aktion DataActions zurückgeben:

Node.js

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} req The request object from Google Workspace Add-on.
 * @param {Object} res The response object from the Chat app. An onboarding message that
 *                     introduces the app and helps people get started with it.
 */
exports.cymbalApp = function cymbalApp(req, res) {
  const chatEvent = req.body.chat;
  // Send an onboarding message when added to a Chat space
  if (chatEvent.addedToSpacePayload) {
    res.json({ hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
      text: 'Hi, Cymbal at your service. I help you manage your calendar' +
            'from Google Chat. Take a look at your schedule today by typing' +
            '`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To learn' +
            'what else I can do, type `/help`.'
    }}}}});
  }
};

Apps Script

/**
 * Sends an onboarding message when the Chat app is added to a space.
 *
 * @param {Object} event The event object from Chat API.
 * @return {Object} Response from the Chat app. An onboarding message that
 *                  introduces the app and helps people get started with it.
 */
function onAddedToSpace(event) {
  return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
    text: 'Hi, Cymbal at your service. I help you manage your calendar' +
          'from Google Chat. Take a look at your schedule today by typing' +
          '`/checkCalendar`, or schedule a meeting with `/scheduleMeeting`. To learn' +
          'what else I can do, type `/help`.'
  }}}}};
}

Das Codebeispiel gibt die folgende Textnachricht zurück:

Beispiel für eine Onboarding-Nachricht

Weitere Beispiele für Antworten per Nachricht finden Sie in den folgenden Anleitungen:

Nachricht aktualisieren

Chat-Apps können auch gesendete Nachrichten aktualisieren. Beispielsweise, um eine Nachricht zu aktualisieren, nachdem ein Nutzer ein Dialogfeld gesendet oder auf eine Schaltfläche in einer Nachricht geklickt hat.

Wenn Sie eine Chat-App-Nachricht aktualisieren möchten, geben Sie die Aktion DataActions mit einem UpdateMessageAction zurück, wie im folgenden Beispiel gezeigt:

{ "hostAppDataAction": { "chatDataAction": { "updateMessageAction": {
  "message": MESSAGE
}}}}

Ersetzen Sie MESSAGE durch eine Message-Ressource aus der Chat API.

Weitere Informationen zur Funktionsweise von Aktionen finden Sie unter Chataktionen.

Chat-Apps können auch eine Nachricht von einem Nutzer aktualisieren, um eine Vorschau eines von ihm gesendeten Links zurückzugeben. Weitere Informationen finden Sie im Hilfeartikel Vorschau von Links in Google Chat-Nachrichten.

Mit der Google Chat API auf Interaktionen antworten oder proaktive Nachrichten senden

Anstatt eine Add-on-Aktion zurückzugeben, müssen Chat-Apps möglicherweise die Google Chat API verwenden, um auf eine Interaktion zu reagieren. Chat-Apps müssen beispielsweise die Google Chat API aufrufen, um Folgendes zu tun:

  • Nachrichten nach einem Zeitplan oder über Änderungen an externen Ressourcen senden. Beispielsweise Benachrichtigungen zu einem neuen Problem oder Fall.
  • Sie antworten mehr als 30 Sekunden nach der Interaktion. Beispielsweise, um nach Abschluss einer langwierigen Aufgabe mit einer Nachricht zu antworten.
  • Eine Nachricht außerhalb des Gruppenbereichs senden, in dem die Interaktion stattgefunden hat.
  • Nachrichten im Namen eines Google Chat-Nutzers senden

Wenn Sie eine Nachricht über die Chat API senden möchten, müssen Sie die Authentifizierung einrichten und die Methode create() für die Ressource Message aufrufen. Eine Anleitung dazu finden Sie unter Mit der Google Chat API eine Nachricht senden.