メッセージを削除する

このガイドでは、 delete() メソッド（テキストやカードを削除する Google Chat API の Message リソースのメソッド） 表示されます。

Chat API では、Chat メッセージは Message リソースで表されます。Chat ユーザーはテキストを含むメッセージしか送信できませんが、 Chat アプリでは、他にもさまざまなメッセージ機能を使用できます。 静的またはインタラクティブなユーザー インターフェースを表示し、 ユーザー、 プライベートでのメッセージの配信などですGoogle Chat 向けの 機能の詳細については、 Google Chat メッセージの概要

アプリ認証では、このメソッドを使用して、Chat アプリが送信したメッセージを削除できます。あり ユーザー認証を使用している場合、 このメソッドを使用すると、認証済みユーザーが送信したメッセージを削除できます。ユーザーがスペースの管理者である場合は、他のスペース メンバーが送信したメッセージを削除することもできます。詳細については、スペースの管理者の役割についてをご覧ください。

前提条件

Node.js

Python

Java

Apps Script

<ph type="x-smartling-placeholder">

ユーザー認証を使用したメールを削除する

ユーザー認証が適用されたメールを削除するには: リクエストに以下を渡します。

  • chat.messages 認可スコープを指定します。
  • DeleteMessage() メソッドを呼び出します。
  • name は、削除するメッセージのリソース名に設定します。

次の例では、ユーザー認証でメッセージを削除します。

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);
}

このサンプルを実行するには、次のように置き換えます。

  • SPACE_NAME: スペースの name の ID。ID を取得するには、このメソッドを呼び出して、 ListSpaces() スペースの URL から取得できます。
  • MESSAGE_NAME: メッセージの ID name。 ID は、Chat API を使用してメッセージを非同期で作成した後に返されたレスポンス本文から取得できます。また、作成時にメッセージに割り当てられたカスタム名を使用して取得することもできます。

成功すると、レスポンスの本文は空になります。これは、メッセージが削除されたことを示します。

アプリの認証を使用したメッセージの削除

メッセージを削除するには、 アプリ認証を使う場合は、 追加します。

  • chat.bot 認可スコープを指定します。
  • DeleteMessage() メソッドを呼び出します。
  • name は、削除するメッセージのリソース名に設定します。

次の例では、メッセージに アプリの認証:

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);
}

このサンプルを実行するには、次のように置き換えます。

  • SPACE_NAME: スペースの ID name。 ID を取得するには、このメソッドを呼び出して、 ListSpaces() スペースの URL から取得できます。
  • MESSAGE_NAME: メッセージの name の ID。ID は、Chat API を使用してメッセージを非同期で作成した後に返されたレスポンス本文から取得できます。また、作成時にメッセージに割り当てられたカスタム名を使用して取得することもできます。

成功すると、レスポンスの本文は空になります。これは、メッセージが削除されたことを示します。