Löschen einer Nachricht

In diesem Leitfaden wird die Verwendung des delete() Methode für die Ressource Message der Google Chat API, um einen Text oder eine Karte zu löschen .

In der Chat API wird eine Chatnachricht durch die Ressource Message dargestellt. 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 zu den Messaging-Funktionen, die für die Chat API verfügbar sind, finden Sie unter Google Chat-Nachrichten – Übersicht.

Bei der App-Authentifizierung können Sie mit dieser Methode eine Nachricht löschen, die über die Chat-App gesendet wurde. Bei der Nutzerauthentifizierung können Sie mit dieser Methode eine Nachricht löschen, die der authentifizierte Nutzer gesendet hat. Wenn wenn der Nutzer Administrator des Gruppenbereichs ist, haben Sie möglicherweise auch die Möglichkeit, Nachricht, die andere Mitglieder des Gruppenbereichs gesendet haben. Weitere Informationen finden Sie unter Die Rolle als Administrator eines Gruppenbereichs.

Vorbereitung

Node.js

Python

Java

Apps Script

Nachrichten mit Nutzerauthentifizierung löschen

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

  • Geben Sie den Autorisierungsbereich chat.messages an.
  • Rufen Sie die Methode DeleteMessage() auf.
  • Legen Sie für name den Ressourcennamen der zu löschenden Nachricht fest.

Im folgenden Beispiel wird eine Nachricht mit Nutzerauthentifizierung:

Node.js

chat/client-libraries/cloud/delete-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 delete 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 = {
    // Replace SPACE_NAME and MESSAGE_NAME here
    name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME'
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/delete_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 delete a message with user credential
def delete_message_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.DeleteMessageRequest(
        # Replace SPACE_NAME and MESSAGE_NAME here
        name = "spaces/SPACE_NAME/messages/MESSAGE_NAME",
    )

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

    # Handle the response
    print(response)

delete_message_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/DeleteMessageUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.DeleteMessageRequest;
import com.google.chat.v1.SpaceName;

// This sample shows how to delete message with user credential.
public class DeleteMessageUserCred {

  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))) {
      DeleteMessageRequest.Builder request = DeleteMessageRequest.newBuilder()
        // replace SPACE_NAME and MESSAGE_NAME here
        .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME");
      chatServiceClient.deleteMessage(request.build());
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to delete 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 deleteMessageUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';

  // Make the request
  const response = Chat.Spaces.Messages.remove(name);

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

Ersetzen Sie Folgendes, um dieses Beispiel auszuführen:

  • 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.

Wenn der Vorgang erfolgreich war, ist der Antworttext leer, was darauf hinweist, dass die Nachricht gelöscht.

Nachricht mit App-Authentifizierung löschen

So löschen Sie eine Nachricht mit App-Authentifizierung, übergeben Sie den Folgendes in Ihrer Anfrage angeben:

  • Geben Sie den Autorisierungsbereich chat.bot an.
  • Rufen Sie die Methode DeleteMessage() auf.
  • Legen Sie name auf den Ressourcennamen der zu löschenden Nachricht fest.

Im folgenden Beispiel wird eine Nachricht mit App-Authentifizierung:

Node.js

chat/client-libraries/cloud/delete-message-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';

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

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and MESSAGE_NAME here
    name: 'spaces/SPACE_NAME/messages/MESSAGE_NAME'
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/delete_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 delete a message with app credential
def delete_message_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.DeleteMessageRequest(
        # Replace SPACE_NAME and MESSAGE_NAME here
        name = "spaces/SPACE_NAME/messages/MESSAGE_NAME",
    )

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

    # Handle the response
    print(response)

delete_message_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/DeleteMessageAppCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.DeleteMessageRequest;

// This sample shows how to delete message with app credential.
public class DeleteMessageAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      DeleteMessageRequest.Builder request = DeleteMessageRequest.newBuilder()
        // replace SPACE_NAME and MESSAGE_NAME here
        .setName("spaces/SPACE_NAME/messages/MESSAGE_NAME");
      chatServiceClient.deleteMessage(request.build());
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to delete a message with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function deleteMessageAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME and MESSAGE_NAME here
  const name = 'spaces/SPACE_NAME/messages/MESSAGE_NAME';
  const parameters = {};

  // Make the request
  const response = Chat.Spaces.Messages.remove(name, parameters, getHeaderWithAppCredentials());

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

Ersetzen Sie Folgendes, um dieses Beispiel auszuführen:

  • SPACE_NAME: die ID aus der name des Gruppenbereichs. Sie erhalten die ID durch Aufrufen der ListSpaces() oder anhand der URL des Gruppenbereichs erfolgen.
  • MESSAGE_NAME: die ID aus der name Sie können die ID aus dem Antworttext abrufen, der nach dem asynchronen Erstellen einer Nachricht mit der Chat API zurückgegeben wird, oder über den benutzerdefinierten Namen, der der Nachricht beim Erstellen zugewiesen wurde.

Wenn der Vorgang erfolgreich war, ist der Antworttext leer.