メッセージの添付ファイルに関するメタデータを取得する

このガイドでは、Google Chat API の Attachment リソースで get() メソッドを使用して、メッセージの添付ファイルに関するメタデータを取得する方法について説明します。レスポンスは Attachment リソースのインスタンスです。

ユーザーがアプリにメッセージを送信すると、Google Chat は MESSAGE インタラクション イベントをディスパッチします。アプリが受信したインタラクション イベントには、リクエスト本文が含まれます。これは、添付ファイルを含むインタラクション イベントを表す JSON ペイロードです。添付ファイルのデータは、添付ファイルがアップロードされたコンテンツ（ローカル ファイル）か、ドライブに保存されているファイルかによって異なります。Media リソースは、画像、動画、ドキュメントなど、Google Chat にアップロードされたファイルを表します。Attachment リソースは、メッセージに添付されたメディア（ファイル）のインスタンスを表します。Attachment リソースには、添付ファイルが保存されている場所など、添付ファイルに関するメタデータが含まれます。

前提条件

Node.js

メッセージの添付ファイルを取得する

Google Chat のメッセージ添付ファイルに関するメタデータを非同期で取得するには、リクエストで次の情報を渡します。

  • chat.bot 認証スコープを指定します。
  • GetAttachment() メソッドを呼び出し、メッセージの添付ファイルの name を渡します。

メッセージの添付ファイルに関するメタデータを取得する方法は次のとおりです。

Node.js

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

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

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

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

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

await main();

このサンプルを実行するには、spaces/SPACE_NAME/messages/ MESSAGE_NAME/attachments/ATTACHMENT_NAME をメッセージ添付ファイルの名前に置き換えます。

Chat API は、指定されたメッセージの添付ファイルに関するメタデータの詳細を示す Attachment のインスタンスを返します。