Nachricht aktualisieren

In diesem Leitfaden wird beschrieben, wie Sie die Methode update() für die Message-Ressource der Google Chat API verwenden, um eine Text- oder Kartennachricht in einem Gruppenbereich zu aktualisieren. Aktualisieren Sie eine Nachricht, um Nachrichtenattribute wie den Inhalt oder den Inhalt einer Karte zu ändern. Sie können auch eine Textnachricht oder eine Karte an eine SMS anhängen.

In der Chat API wird eine Chatnachricht durch das Message-Ressource Chat-Nutzer können zwar nur Nachrichten senden, die Text enthalten, Chat-Apps können viele andere Messaging-Funktionen nutzen, darunter Anzeige statischer oder interaktiver Benutzeroberflächen, das Erfassen von Informationen und Nachrichten privat zu übermitteln. Weitere Informationen zur Nachrichtenfunktion die für die Chat API zur Verfügung stehen, finden Sie in der Nachrichten in Google Chat

Vorbereitung

Node.js

• Ein Google Workspace-Konto für Unternehmen oder Organisationen mit Zugriff auf Google Chat.

• Richten Sie Ihre Umgebung ein:
  • Google Cloud-Projekt erstellen
  • Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
  • Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
  • Installieren Sie die Google Cloud-Clientbibliothek für Node.js.
  • Erstellen Sie Anmeldedaten für den Zugriff, je nachdem, wie Sie sich in Ihrer Google Chat API-Anfrage authentifizieren möchten:
    • Wenn Sie sich als Chat-Nutzer authentifizieren möchten, erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen client_secrets.json in Ihrem lokalen Verzeichnis.
    • Wenn Sie sich als Chat-App authentifizieren möchten, erstellen Sie Anmeldedaten für das Dienstkonto und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen credentials.json.
• Wählen Sie den Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als Chat-App authentifizieren möchten.

Python

• Unternehmen Google Workspace-Konto mit Zugriff auf Google Chat:

• Richten Sie Ihre Umgebung ein:
  • Google Cloud-Projekt erstellen
  • Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
  • Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
  • Installieren Sie die Python Cloud-Clientbibliothek
  • Anmeldedaten für den Zugriff basierend auf der Authentifizierung in der Google Chat API erstellen Anfrage:
    • So authentifizieren Sie sich als Chat-Nutzer: OAuth-Client-ID erstellen Anmeldedaten und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen client_secrets.json in Ihr lokales Verzeichnis.
    • So authentifizieren Sie sich als Chat-App: Dienstkonto erstellen Anmeldedaten und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen credentials.json
• Wählen Sie den Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als Chat-App authentifizieren möchten.

Java

• Ein Google Workspace-Konto für Unternehmen oder Organisationen mit Zugriff auf Google Chat.

• Richten Sie Ihre Umgebung ein:
  • Google Cloud-Projekt erstellen
  • Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
  • Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, und eine Beschreibung der Chat App.
  • Installieren Sie die Java Cloud-Clientbibliothek
  • Anmeldedaten für den Zugriff basierend auf der Authentifizierung in der Google Chat API erstellen Anfrage:
    • Wenn Sie sich als Chat-Nutzer authentifizieren möchten, erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen client_secrets.json in Ihrem lokalen Verzeichnis.
    • So authentifizieren Sie sich als Chat-App: Dienstkonto erstellen Anmeldedaten und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen credentials.json
• Wählen Sie den Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als Chat-App authentifizieren möchten.

Apps Script

• Ein Google Workspace-Konto für Unternehmen oder Organisationen mit Zugriff auf Google Chat.

• Richten Sie Ihre Umgebung ein:
  • Google Cloud-Projekt erstellen
  • Konfigurieren Sie den OAuth-Zustimmungsbildschirm.
  • Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
  • Erstellen Sie ein eigenständiges Apps Script-Projekt und aktivieren Sie den erweiterten Chatdienst.
  • In diesem Leitfaden müssen Sie entweder Nutzer oder die App-Authentifizierung. Erstellen Sie Anmeldedaten für ein Dienstkonto, um sich als Chat-App zu authentifizieren. Eine Anleitung dazu finden Sie unter Authentifizierung und Autorisierung als Google Chat App
• Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als Chat-App.

In den Codebeispielen auf dieser Seite wird die gRPC API-Schnittstelle mit dem Google Cloud-Client verwendet Bibliotheken. Alternativ können Sie die REST API-Schnittstelle verwenden. Weitere Informationen zu gRPC und REST-Oberflächen, siehe Übersicht über die Google Chat API

Nachricht im Namen eines Nutzers aktualisieren

Bei der Nutzerauthentifizierung kann nur der Text einer Nachricht aktualisiert werden.

Wenn Sie eine Nachricht mit Nutzerauthentifizierung aktualisieren möchten, geben Sie Folgendes in Ihrer Anfrage an:

• Geben Sie den Autorisierungsbereich chat.messages an.
• Rufen Sie die Methode UpdateMessage() auf.
• Übergeben Sie message als Instanz von Message Dabei gilt:
  • Das Feld „name“, das für die zu aktualisierende Nachricht festgelegt ist und die die ID des Gruppenbereichs enthält und eine Nachrichten-ID.
  • Das Feld text ist mit dem neuen Text festgelegt.
• Übergeben Sie updateMask mit dem Wert text.

Wenn es sich bei der aktualisierten Nachricht um eine Kartennachricht handelt, wird der Text vor die Karten eingefügt, die weiterhin angezeigt werden.

So aktualisieren Sie eine Nachricht oder fügen Sie einer Kartennachricht mit Nutzerauthentifizierung eine SMS vor:

Node.js

chat/client-libraries/cloud/update-message-user-cred.js

Auf GitHub ansehen

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.messages'];

// This sample shows how to update a message with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    message: {
      // Replace SPACE_NAME and MESSAGE_NAME here
      name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
      text: 'Updated with user credential!'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['text']
    }
  };

  // Make the request
  const response = await chatClient.updateMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/update_message_user_cred.py

Auf GitHub ansehen

from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.messages"]

# This sample shows how to update a message with user credential
def update_message_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateMessageRequest(
        message = {
            # Replace SPACE_NAME and MESSAGE_NAME here
            "name": "spaces/SPACE_NAME/messages/MESSAGE_NAME",
            "text": "Updated with user credential!"
        },
        # The field paths to update. Separate multiple values with commas or use
        # `*` to update all field paths.
        update_mask = "text"
    )

    # Make the request
    response = client.update_message(request)

    # Handle the response
    print(response)

update_message_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateMessageUserCred.java

Auf GitHub ansehen

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateMessageRequest;
import com.google.chat.v1.Message;
import com.google.protobuf.FieldMask;

// This sample shows how to update message with user credential.
public class UpdateMessageUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.messages";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateMessageRequest.Builder request = UpdateMessageRequest.newBuilder()
        .setMessage(Message.newBuilder()
          // replace SPACE_NAME and MESSAGE_NAME here
          .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME")
          .setText("Updated with user credential!"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("text"));
      Message response = chatServiceClient.updateMessage(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

Auf GitHub ansehen

/**
 * This sample shows how to update a message with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.messages'
 * referenced in the manifest file (appsscript.json).
 */
function updateMessageUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const message = {
    text: 'Updated with user credential!'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'text';

  // Make the request
  const response = Chat.Spaces.Messages.patch(message, name, {
    updateMask: updateMask
  });

  // Handle the response
  console.log(response);
}

Ersetzen Sie zum Ausführen dieses Beispiels Folgendes:

• SPACE_NAME: die ID aus dem name Sie erhalten die ID durch Aufrufen der ListSpaces() oder anhand der URL des Gruppenbereichs erfolgen.
• MESSAGE_NAME: die ID aus dem name der Nachricht. Sie finden die ID im Antworttext, der nach dem Erstellen eines asynchron mit der Chat API oder mit dem benutzerdefinierter Name der Nachricht bei der Erstellung zugewiesen ist.

Die Chat API gibt eine Instanz von Message der die aktualisierte Nachricht enthält.

Nachricht in der Chat App aktualisieren

Mit der App-Authentifizierung können sowohl der Text als auch die Karten einer Nachricht aktualisiert werden.

Um eine Nachricht mit App-Authentifizierung zu aktualisieren, übergeben Sie in Ihrer Anfrage Folgendes:

• Geben Sie den Autorisierungsbereich für chat.bot an.
• Rufen Sie die Methode UpdateMessage() auf.
• Übergeben Sie message als Instanz von Message Dabei gilt:
  • Das Feld „name“, das für die zu aktualisierende Nachricht festgelegt ist und die die ID des Gruppenbereichs enthält und eine Nachrichten-ID.
  • Das Feld text, das mit dem neuen Text festgelegt ist, wenn es aktualisiert werden muss.
  • Das mit den neuen Karten festgelegte Feld cardsV2, wenn diese aktualisiert werden müssen.
• Übergeben Sie updateMask mit der Liste der Felder, um z. B. text zu aktualisieren, und cardsV2

Wenn die aktualisierte Nachricht Kartennachricht und der Text aktualisiert wird, wird der aktualisierte Text den Karten vorangestellt, die weiterhin angezeigt werden. Wenn die aktualisierte Nachricht SMS und Karten aktualisiert werden, hängen die aktualisierten Karten an den Text an (der sich Display).

So aktualisieren Sie den Text und die Karten einer Nachricht mit App-Authentifizierung:

Node.js

chat/client-libraries/cloud/update-message-app-cred.js

Auf GitHub ansehen

import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to update a message with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    message: {
      // Replace SPACE_NAME and MESSAGE_NAME here
      name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME',
      text: 'Text updated with app credential!',
      cardsV2 : [{ card: { header: {
        title: 'Card updated with app credential!',
        imageUrl: 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
      }}}]
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['text', 'cards_v2']
    }
  };

  // Make the request
  const response = await chatClient.updateMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/update_message_app_cred.py

Auf GitHub ansehen

from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to update a message with app credential
def update_message_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.UpdateMessageRequest(
        message = {
            # Replace SPACE_NAME and MESSAGE_NAME here
            "name": "spaces/SPACE_NAME/messages/MESSAGE_NAME",
            "text": "Text updated with app credential!",
            "cards_v2" : [{ "card": { "header": {
                "title": 'Card updated with app credential!',
                "image_url": 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
            }}}]
        },
        # The field paths to update. Separate multiple values with commas or use
        # `*` to update all field paths.
        update_mask = "text,cardsV2"
    )

    # Make the request
    response = client.update_message(request)

    # Handle the response
    print(response)

update_message_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateMessageAppCred.java

Auf GitHub ansehen

import com.google.apps.card.v1.Card;
import com.google.apps.card.v1.Card.CardHeader;
import com.google.chat.v1.CardWithId;
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateMessageRequest;
import com.google.chat.v1.Message;
import com.google.protobuf.FieldMask;

// This sample shows how to update message with app credential.
public class UpdateMessageAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      UpdateMessageRequest.Builder request = UpdateMessageRequest.newBuilder()
        .setMessage(Message.newBuilder()
          // replace SPACE_NAME and MESSAGE_NAME here
          .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME")
          .setText("Text updated with app credential!")
          .addCardsV2(CardWithId.newBuilder().setCard(Card.newBuilder()
            .setHeader(CardHeader.newBuilder()
              .setTitle("Card updated with app credential!")
              .setImageUrl("https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg")))))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addAllPaths(List.of("text", "cards_v2")));
      Message response = chatServiceClient.updateMessage(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

Auf GitHub ansehen

/**
 * This sample shows how to update a message with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function updateMessageAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const message = {
    text: 'Text updated with app credential!',
    cardsV2 : [{ card: { header: {
      title: 'Card updated with app credential!',
      imageUrl: 'https://fonts.gstatic.com/s/i/short-term/release/googlesymbols/info/default/24px.svg'
    }}}]
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'text,cardsV2';

  // Make the request
  const response = Chat.Spaces.Messages.patch(message, name, {
    updateMask: updateMask
  }, getHeaderWithAppCredentials());

  // Handle the response
  console.log(response);
}

Ersetzen Sie zum Ausführen dieses Beispiels Folgendes:

• SPACE_NAME: die ID aus dem name Sie erhalten die ID durch Aufrufen der ListSpaces() oder anhand der URL des Gruppenbereichs erfolgen.
• MESSAGE_NAME: die ID aus dem name der Nachricht. Sie finden die ID im Antworttext, der nach dem Erstellen eines asynchron mit der Chat API oder mit dem benutzerdefinierter Name der Nachricht bei der Erstellung zugewiesen ist.

Die Chat API gibt eine Instanz von Message zurück, die Details zur aktualisierten Nachricht enthält.

Weitere Informationen

• Nachricht formatieren
• Nachricht löschen
• Details zu einer Nachricht abrufen
• Nachrichten in einem Gruppenbereich auflisten
• Nachricht senden: