このガイドでは、Google Chat API の Message
リソースの list()
メソッドを使用して、スペース内のメッセージをページネーション付きでフィルタ可能なリストとして表示する方法について説明します。
Chat API では、Chat メッセージは Message
リソースで表されます。Chat ユーザーはテキストを含むメッセージのみを送信できますが、Chat アプリでは、静的またはインタラクティブなユーザー インターフェースの表示、ユーザーからの情報の収集、メッセージの非公開送信など、他の多くのメッセージ機能も使用できます。Google Chat 向けの
機能の詳細については、
Google Chat メッセージの概要
前提条件
Node.js
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Node.js Cloud クライアント ライブラリをご覧ください。
- デスクトップ アプリケーションの OAuth クライアント ID 認証情報を作成します。このガイドのサンプルを実行するには、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。
- <ph type="x-smartling-placeholder"></ph> ユーザー認証をサポートする認可スコープを選択します。
- Google Chat スペース。Google Chat API を使用して作成する方法については、以下をご覧ください。 スペースを作成します。Chat で作成するには、ヘルプセンターのドキュメントをご覧ください。
Python
- 企業または大企業 以下へのアクセス権を持つ Google Workspace アカウント Google Chat。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成する。名前、 アプリのアイコン、説明を入力します。
- Python の Cloud クライアント ライブラリをインストールします。
- <ph type="x-smartling-placeholder"></ph>
デスクトップ アプリケーション用の OAuth クライアント ID 認証情報を作成するサンプルを実行するには、
で、認証情報を
client_secrets.json
という名前の JSON ファイルとして ディレクトリにあります。
- <ph type="x-smartling-placeholder"></ph> ユーザー認証をサポートする認可スコープを選択します。
- Google Chat スペース。Google Chat API を使用して作成する方法については、以下をご覧ください。 スペースを作成します。Chat で作成するには、ヘルプセンターのドキュメントをご覧ください。
Java
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Java の Cloud クライアント ライブラリをインストールします。
- <ph type="x-smartling-placeholder"></ph>
デスクトップ アプリケーション用の OAuth クライアント ID 認証情報を作成するサンプルを実行するには、
で、認証情報を
client_secrets.json
という名前の JSON ファイルとして ディレクトリにあります。
- <ph type="x-smartling-placeholder"></ph> ユーザー認証をサポートする認可スコープを選択します。
- Google Chat のスペース。Google Chat API を使用して作成するには、スペースを作成するをご覧ください。Chat で作成するには、ヘルプセンターのドキュメントをご覧ください。
Apps Script
- 企業または大企業 以下へのアクセス権を持つ Google Workspace アカウント Google Chat。
- 環境を設定します。
<ph type="x-smartling-placeholder">
- </ph>
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成する。名前、 アプリのアイコン、説明を入力します。
- スタンドアロンの Apps Script プロジェクトを作成する [高度なチャット サービス] をオンにします。
- ユーザー認証をサポートする認可スコープを選択します。
- Google Chat のスペース。Google Chat API を使用して作成する方法については、以下をご覧ください。 スペースを作成します。Chat で作成するには、 詳しくは、 ヘルプセンターの記事をご覧ください。
メッセージの一覧表示
ユーザー認証を使用してメッセージを一覧表示するには、リクエストで次のように渡します。
chat.messages.readonly
またはchat.messages
の認可スコープを指定します。ListMessages()
メソッドを呼び出します。
次の例では、Chat スペース内のメッセージが一覧表示されます。
Node.js
Python
Java
Apps Script
このサンプルを実行するには、SPACE_NAME
を
スペースの
name
表示されます。ID は、ListSpaces()
メソッドを呼び出すか、スペースの URL から取得できます。
Chat API は
メッセージのリスト
送信できるようになります。リクエストにメッセージがない場合、Chat API レスポンスは空のオブジェクトを返します。REST/HTTP を使用する場合
レスポンスには空の JSON オブジェクト {}
が含まれます。