このガイドでは、Google Chat API の Message
リソースで delete()
メソッドを使用して、テキスト メッセージまたはカード メッセージを削除する方法について説明します。
Chat API では、Chat メッセージは Message
リソースで表されます。Chat ユーザーはテキストを含むメッセージのみを送信できますが、Chat アプリでは、静的またはインタラクティブなユーザー インターフェースの表示、ユーザーからの情報の収集、メッセージの非公開送信など、他の多くのメッセージ機能も使用できます。Chat API で利用可能なメッセージ機能の詳細については、Google Chat メッセージの概要をご覧ください。
アプリ認証を使用すると、このメソッドを使用して、Chat アプリが送信したメッセージを削除できます。ユーザー認証では、このメソッドを使用して、認証済みユーザーが送信したメッセージを削除できます。ユーザーがスペースの管理者である場合は、他のスペース メンバーが送信したメッセージを削除することもできます。詳細については、スペースの管理者の役割についてをご覧ください。
前提条件
Node.js
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Node.js の Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証する方法に基づいて、アクセス認証情報を作成します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、サービス アカウントの認証情報を作成し、認証情報を
credentials.json
という名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
Python
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Python の Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証する方法に基づいて、アクセス認証情報を作成します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、サービス アカウントの認証情報を作成し、認証情報を
credentials.json
という名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
Java
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Java Cloud クライアント ライブラリをインストールします。
- Google Chat API リクエストで認証する方法に基づいて、アクセス認証情報を作成します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat アプリとして認証するには、サービス アカウントの認証情報を作成し、認証情報を
credentials.json
という名前の JSON ファイルとして保存します。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
Apps Script
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- スタンドアロンの Apps Script プロジェクトを作成し、Advanced Chat Service を有効にします。
- このガイドでは、ユーザー認証またはアプリ認証のいずれかを使用する必要があります。Chat アプリとして認証するには、サービス アカウントの認証情報を作成します。手順については、Google Chat アプリとして認証と認可を行うをご覧ください。
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、 認可スコープを選択します。
ユーザー認証を使用してメールを削除する
ユーザー認証でメッセージを削除するには、リクエストで次のように渡します。
chat.messages
認可スコープを指定します。DeleteMessage()
メソッドを呼び出します。name
は、削除するメッセージのリソース名に設定します。
次の例では、ユーザー認証でメッセージを削除します。
Node.js
Python
Java
Apps Script
このサンプルを実行するには、次のように置き換えます。
SPACE_NAME
: スペースのname
の ID。ID は、ListSpaces()
メソッドを呼び出すか、スペースの URL から取得できます。MESSAGE_NAME
: メッセージのname
の ID。ID は、Chat API を使用してメッセージを非同期で作成した後に返されたレスポンス本文から取得できます。また、作成時にメッセージに割り当てられたカスタム名を使用して取得することもできます。
成功すると、レスポンスの本文は空になります。これは、メッセージが削除されたことを示します。
アプリ認証を使用してメッセージを削除する
アプリ認証でメッセージを削除するには、リクエストで次の情報を渡します。
chat.bot
認可スコープを指定します。DeleteMessage()
メソッドを呼び出します。name
は、削除するメッセージのリソース名に設定します。
次の例では、アプリ認証でメッセージを削除します。
Node.js
Python
Java
Apps Script
このサンプルを実行するには、次のように置き換えます。
SPACE_NAME
: スペースのname
の ID。ID は、ListSpaces()
メソッドを呼び出すか、スペースの URL から取得できます。MESSAGE_NAME
: メッセージのname
の ID。ID は、Chat API を使用してメッセージを非同期で作成した後に返されたレスポンス本文から取得できます。また、作成時にメッセージに割り当てられたカスタム名を使用して取得することもできます。
成功すると、レスポンスの本文は空になります。これは、メッセージが削除されたことを示します。