Private Nachrichten an Google Chat-Nutzer senden

Auf dieser Seite wird erläutert, wie du als Google Chat App.

Eine private Nachricht ist eine Chat-App-Nachricht, die nur für einen bestimmten Chat-Nutzer sichtbar. Du kannst private Nachrichten verwenden in Gruppenbereichen mit mehreren Personen, sodass diese privat mit ihnen interagieren können, Chat-Apps. Beispiel: Ihre Die Chat-App kann private Nachrichten senden, um Folgendes zu tun: Folgendes:

  • Sie antworten auf einen Slash-Befehl. Beispiel: Ein Nutzer ruft den Schrägstrich /about in Ihrer Chat-App auf. in einem Gruppenbereich verwenden, kann Ihre Chat-App mit einer eine private Nachricht, in der erklärt wird, und wie sie verwendet werden.
  • Benachrichtigen oder senden Sie Informationen, die nur für einen Nutzer relevant sind. Für z. B. um einen Nutzer darüber zu informieren, dass ihm eine Aufgabe zugewiesen wurde, oder um die Aufgabe abzuschließen.
  • Sende eine Fehlermeldung. Beispiel: Wenn ein Nutzer den erforderlichen Argumenttext auslässt einen Slash-Befehl an die Chat-App, private Nachricht, um den Fehler zu erklären und dem Nutzer bei der Formatierung des Befehls zu helfen.
  • Senden einer privaten Willkommensnachricht an einen Nutzer, wenn er einem Gruppenbereich hinzugefügt wird, der werden die Richtlinien und die Verwendung der Chat App erläutert.

Wenn eine Chat-App eine private Nachricht sendet, wird die Nachricht zeigt ein Label an, das den Nutzer darüber informiert, dass die Nachricht nur für ihn sichtbar ist:

Private Nachricht für die
  Chat-App von Cymbal Labs. Die Meldung besagt, dass das
  Die Chat-App wurde von Cymbal Labs erstellt und teilt einen Link
  und einen Link zur Kontaktaufnahme mit dem Supportteam.
Abbildung 1: Wenn eine Chat-App eine eine private Nachricht sendet, wird dem Nutzer eine Nachricht mit einem Label mit dem Text Only visible to you.

Vorbereitung

Node.js

  • Eine Google Chat App mit aktivierten interaktiven Funktionen. So erstellen Sie ein Chat-App mit einem HTTP-Dienst verwenden können, führen Sie diese Kurzanleitung aus.
  • Um privat auf einen Slash-Befehl zu antworten, ist ein Slash-Befehl, der für in der Chat-App. Informationen zum Erstellen finden Sie unter Auf Slash-Befehle reagieren:

  • Zum Senden einer privaten Nachricht mit der messages.create() müssen Sie die App-Authentifizierung verwenden.

Python

  • Eine Google Chat App mit aktivierten interaktiven Funktionen. So erstellen Sie ein Chat-App mit einem HTTP-Dienst verwenden können, führen Sie diese Kurzanleitung aus.
  • Um privat auf einen Slash-Befehl zu antworten, ist ein Slash-Befehl, der für in der Chat-App. Informationen zum Erstellen finden Sie unter Auf Slash-Befehle reagieren:

  • Zum Senden einer privaten Nachricht mit der messages.create() müssen Sie die App-Authentifizierung verwenden.

Apps Script

  • Eine Google Chat App mit aktivierten interaktiven Funktionen. So erstellen Sie ein interaktive Chat-App in Apps Script verwenden möchten, führen Sie diese Kurzanleitung aus.
  • Um privat auf einen Slash-Befehl zu antworten, ist ein Slash-Befehl, der für in der Chat-App. Informationen zum Erstellen finden Sie unter Auf Slash-Befehle reagieren:

  • Zum Senden einer privaten Nachricht mit der messages.create() müssen Sie die App-Authentifizierung verwenden.

Private Nachrichten senden

Wenn Sie eine Nachricht privat als Chat-App senden möchten, geben Sie Folgendes an: die privateMessageViewer in der Nachricht, wenn Sie sie erstellen. Sie erstellen private Nachrichten wie Sie verfassen eine Nachricht: entweder durch eine Antwort auf eine Nutzerinteraktion oder durch den asynchronen Aufruf der API Methode create() für den Message. Eine Anleitung zum Senden von Text- oder Kartennachrichten findest du unter Nachricht senden

Das folgende Beispiel zeigt die JSON-Datei für eine private SMS, in der Folgendes angegeben wird: Hello private world!:

{
    "text": "Hello private world!",
    "privateMessageViewer": "USER"
}

In diesem Beispiel steht USER für den Chat-Nutzer. wer die Nachricht sehen kann, im Format Ressource User. Wenn Sie auf eine können Sie das User-Objekt aus dem Interaktionsereignis angeben. Ein Beispiel finden Sie im folgenden Abschnitt Reagieren Sie privat auf einen Slash-Befehl.

Andernfalls können Sie zur Angabe des Betrachters einer privaten Nachricht den Feld name von User Ressource:

{
    "text": "Hello private world!",
    "privateMessageViewer": {
      "name": "users/USER_ID"
    }
}

In diesem Beispiel geben Sie im Feld name die User des Betrachters an. Ressourcenname in Google Chat. USER_ID ersetzen mit einer eindeutigen ID für den Nutzer, z. B. 12345678987654321 oder hao@cymbalgroup.com

Weitere Informationen zum Angeben von Nutzern finden Sie unter Google Chat-Nutzer identifizieren und angeben

Privat auf einen Slash-Befehl antworten

Der folgende Code zeigt ein Beispiel für eine Chat-App. als Antwort auf einen Slash-Befehl mit einer privaten Nachricht.

Die Chat-App verarbeitet eine MESSAGE Interaktionsereignis und antwortet auf den /help-Slash-Befehl mit einer privaten Textnachricht, erklärt die Verwendung:

Node.js

/**
* 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 '1':  // /help
        return res.json({
          privateMessageViewer: event.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>.'
        });
    }
  }

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

Apps Script

/**
* 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 1: // Responds to /help
        return {
          "privateMessageViewer": event.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>."
        };
    }
  }
  else {
    return { "text": "Try a slash command.", "privateMessageViewer": event.user };
  }
}

Python

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 == '1':  # /help
      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'),
      'text': 'Try a slash command.',
  }

Beschränkungen

Zum Senden einer privaten Nachricht darf die Nachricht weder den Parameter Folgendes:

  • Anhänge:
  • Aktionen für Zubehör.
  • Teilweise private Nachrichten Beispiel: eine Chat-App Kann keine Nachricht mit Text und eine Karte senden, die nur für Personen sichtbar ist nur einen Nutzer, aber die Karte ist für alle im Gruppenbereich sichtbar.
  • Nutzerauthentifizierung: Nur Chat-Apps können private Nachrichten senden. Ihr Die Chat-App kann sich nicht als Nutzer authentifizieren, um ein privat.

Private Nachrichten aktualisieren oder löschen

Wenn Sie Google Chat-Nachrichten aktualisieren oder löschen möchten, müssen Sie die Chat API Sie können den Betrachter der privaten Nachricht nicht ändern oder dass die Nachricht öffentlich ist. Wenn Sie also private Nachrichten aktualisieren, Das Feld privateMessageViewer im API-Aufruf (nur für die Ausgabe)

Informationen zum Aktualisieren einer privaten Nachricht findest du unter Nachricht aktualisieren Informationen zum Löschen einer privaten Nachricht findest du unter Nachricht löschen