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 Karten-Nachricht in einem Gruppenbereich zu aktualisieren. Sie können eine Nachricht aktualisieren, um Nachrichtenattribute wie den Text oder den Inhalt einer Karte zu ändern. Sie können einer Kartenmitteilung auch eine Textnachricht voranstellen oder eine Karte an eine Textnachricht anhängen.

In der Chat API wird eine Chat-Nachricht durch die Ressource Message dargestellt. Während Chat-Nutzer nur Nachrichten mit Text senden können, können Chat-Apps viele andere Messaging-Funktionen nutzen, darunter das Anzeigen statischer oder interaktiver Benutzeroberflächen, das Erfassen von Informationen von Nutzern und das private Senden von Nachrichten. Weitere Informationen zu den Messaging-Funktionen, die für die Chat API verfügbar sind, finden Sie unter Google Chat-Nachrichten – Übersicht.

Vorbereitung

Node.js

Python

Java

Apps Script

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, übergeben Sie Folgendes in Ihrem Antrag:

  • Geben Sie den chat.messages-Autorisierungsbereich an.
  • Rufen Sie die Methode UpdateMessage() auf.
  • Übergeben Sie message als Instanz von Message mit Folgendem:
    • Das Feld name ist auf die zu aktualisierende Nachricht festgelegt und enthält eine Bereichs-ID und eine Nachrichten-ID.
    • Das Feld text ist mit dem neuen Text festgelegt.
  • Übergeben Sie updateMask mit dem Wert text.

Wenn die aktualisierte Nachricht eine Kartenbenachrichtigung ist, wird der Text vor den Karten eingefügt, die weiterhin angezeigt werden.

So aktualisieren Sie eine Nachricht oder fügen einer Kartenmitteilung mit Nutzerauthentifizierung eine SMS voran:

Node.js

chat/client-libraries/cloud/update-message-user-cred.js
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
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
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
/**  * 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); }

Um dieses Beispiel auszuführen, ersetzen Sie Folgendes:

  • SPACE_NAME: Die ID aus dem name des Bereichs. Sie können die ID abrufen, indem Sie die Methode ListSpaces() aufrufen oder die URL des Bereichs verwenden.
  • MESSAGE_NAME: die ID aus dem name der Nachricht. Sie können die ID aus dem Antworttext abrufen, der nach dem asynchronen Erstellen einer Nachricht mit der Chat API oder mit dem benutzerdefinierten Namen zurückgegeben wird, der der Nachricht beim Erstellen zugewiesen wurde.

Die Chat API gibt eine Instanz von Message zurück, in der die aktualisierte Nachricht beschrieben wird.

Nachricht als Chat-App aktualisieren

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

Wenn Sie eine Nachricht mit App-Authentifizierung aktualisieren möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie den chat.bot-Autorisierungsbereich an.
  • Rufen Sie die Methode UpdateMessage() auf.
  • Übergeben Sie message als Instanz von Message mit Folgendem:
    • Das Feld name ist auf die zu aktualisierende Nachricht festgelegt und enthält eine Bereichs-ID und eine Nachrichten-ID.
    • Das Feld text wird mit dem neuen Text festgelegt, wenn es aktualisiert werden muss.
    • Das Feld cardsV2, das mit den neuen Karten festgelegt wird, wenn sie aktualisiert werden müssen.
  • Übergeben Sie updateMask mit der Liste der zu aktualisierenden Felder, z. B. text und cardsV2.

Wenn die aktualisierte Nachricht eine Kartenbenachrichtigung ist und der Text aktualisiert wird, wird der aktualisierte Text vor die Karten gestellt, die weiterhin angezeigt werden. Wenn die aktualisierte Nachricht eine SMS ist und die Karten aktualisiert werden, werden die aktualisierten Karten an den Text angehängt, der weiterhin angezeigt wird.

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

Node.js

chat/client-libraries/cloud/update-message-app-cred.js
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
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
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
/**  * 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); }

Um dieses Beispiel auszuführen, ersetzen Sie Folgendes:

  • SPACE_NAME: Die ID aus dem name des Bereichs. Sie können die ID abrufen, indem Sie die Methode ListSpaces() aufrufen oder die URL des Bereichs verwenden.
  • MESSAGE_NAME: die ID aus dem name der Nachricht. Sie können die ID aus dem Antworttext abrufen, der nach dem asynchronen Erstellen einer Nachricht mit der Chat API oder mit dem benutzerdefinierten Namen zurückgegeben wird, der der Nachricht beim Erstellen zugewiesen wurde.

Die Chat API gibt eine Instanz von Message zurück, in der die aktualisierte Nachricht beschrieben wird.