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