このページでは、Google Chat アプリを使用して Chat 用アプリを作成する Pub/Sub。このタイプの Google Chat アプリのアーキテクチャを 組織にファイアウォールがあると、Chat がアクセスできない メッセージを送信できない場合や、 Chat アプリは Google Workspace Events API。ただし、これらのチャットアプリは非同期メッセージのみを送受信できるため、このアーキテクチャには次の制限があります。
- メッセージでダイアログを使用できません。代わりに、カード メッセージを使用してください。
- 同期レスポンスで個々のカードを更新することはできません。代わりに、
メッセージ全体を削除するには、
patch
メソッドを呼び出します。
次の図は、VM のアーキテクチャを Pub/Sub で構築された Chat アプリ:
上の図では、Pub/Sub を操作するユーザーが Chat アプリには、次のような情報の流れがあります。
ユーザーが Chat で Chat アプリにメッセージを送信します(ダイレクト メッセージまたは Chat スペース)。または、Chat アプリで有効なサブスクリプションがある Chat スペースでイベントが発生します。
Chat はメッセージを Pub/Sub トピックに送信します。
アプリケーション サーバー(Chat アプリ ロジックを含むクラウドまたはオンプレミス システム)は、ファイアウォールを介してメッセージを受信するために Pub/Sub トピックをサブスクライブします。
必要に応じて、Chat アプリは Chat API を使用して、メッセージを非同期で投稿したり、 必要があります。
前提条件
Java
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
- 課金を有効にした Google Cloud プロジェクト。既存のプロジェクトで課金が有効になっていることを確認するには、 プロジェクトの課金ステータスを確認できます。プロジェクトを作成して課金管理を設定するには、Google Cloud プロジェクトを作成するをご覧ください。
- Java 11 以降
- Maven パッケージ管理ツール
Python
- 企業または大企業 以下へのアクセス権を持つ Google Workspace アカウント Google Chat。
- 課金を有効にした Google Cloud プロジェクト。既存のプロジェクトで課金が有効になっていることを確認するには、 プロジェクトの課金ステータスを確認できます。プロジェクトを作成して課金を設定するには、以下をご覧ください。 Google Cloud プロジェクトを作成します。
- Python 3.6 以降
- pip パッケージ管理ツール
Node.js
- 企業または大企業 以下へのアクセス権を持つ Google Workspace アカウント Google Chat。
- 課金を有効にした Google Cloud プロジェクト。既存のプロジェクトで課金が有効になっていることを確認するには、 プロジェクトの課金ステータスを確認できます。プロジェクトを作成して課金管理を設定するには、Google Cloud プロジェクトを作成するをご覧ください。
- Node.js 14 以降
- npm パッケージ管理ツール
-
初期化された Node.js プロジェクト。新しいプロジェクトを初期化するには、プロジェクトを作成し、
新しいフォルダに移動してから、コマンドライン インターフェースで次のコマンドを実行します。
npm init
環境を設定する
Google API を使用する前に、Google Cloud プロジェクトで有効にする必要があります。 1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。Google Cloud コンソールで、Google Chat API と Pub/Sub API を有効にします。
Pub/Sub を設定する
Pub/Sub トピックを作成する Google Chat でメッセージを送信できます。Chat アプリごとに 1 つのトピックを使用することをおすすめします。
次のサービス アカウントに Pub/Sub パブリッシャーのロールを割り当てることで、トピックにチャットの公開権限を付与します。
chat-api-push@system.gserviceaccount.com
サービス アカウントを作成する Chat 用アプリでの Pub/Sub による承認と 秘密鍵ファイルを作業ディレクトリに保存します。
トピックのpull サブスクリプションを作成します。
サブスクリプションに Pub/Sub サブスクライバー ロールを割り当てます。 先ほど作成したサービス アカウント。
スクリプトを作成する
Java
CLI で、サービス アカウントの認証情報を指定します。
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
CLI で、Google Cloud プロジェクト ID を指定します。
export PROJECT_ID=PROJECT_ID
CLI で、作成する Pub/Sub サブスクリプションのサブスクリプション ID を 次の操作を行います。
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
作業ディレクトリに
pom.xml
という名前のファイルを作成します。pom.xml
ファイルに次のコードを貼り付けます。作業ディレクトリにディレクトリ構造
src/main/java
を作成します。src/main/java
ディレクトリに、Main.java
という名前のファイルを作成します。Main.java
に次のコードを貼り付けます。
Python
CLI で、サービス アカウントの認証情報を指定します。
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
CLI で、Google Cloud プロジェクト ID を指定します。
export PROJECT_ID=PROJECT_ID
CLI で、作成する Pub/Sub サブスクリプションのサブスクリプション ID を 次の操作を行います。
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
作業ディレクトリに
requirements.txt
という名前のファイルを作成します。requirements.txt
ファイルに次のコードを貼り付けます。作業ディレクトリに
app.py
という名前のファイルを作成します。app.py
に次のコードを貼り付けます。
Node.js
CLI で、サービス アカウントの認証情報を指定します。
export GOOGLE_APPLICATION_CREDENTIALS=SERVICE_ACCOUNT_FILE_PATH
CLI で、Google Cloud プロジェクト ID を指定します。
export PROJECT_ID=PROJECT_ID
CLI で、前に作成した Pub/Sub サブスクリプションのサブスクリプション ID を指定します。
export SUBSCRIPTION_ID=SUBSCRIPTION_ID
作業ディレクトリに、
package.json
という名前のファイルを作成します。package.json
ファイルに次のコードを貼り付けます。作業ディレクトリに、
index.js
という名前のファイルを作成します。index.js
に次のコードを貼り付けます。
アプリを Chat に公開する
Google Cloud コンソールで、メニュー > [API とサービス] > [有効な API とサービス] > [Google Chat API] > [構成] に移動します。
Pub/Sub 用に Chat アプリを構成します。
- [アプリ名] に「
Quickstart App
」と入力します。 - [アバターの URL] に「
https://developers.google.com/chat/images/quickstart-app-avatar.png
」と入力します。 - [説明] に「
Quickstart app
」と入力します。 - [機能] で、[1:1 のメッセージを受信する] と [スペースとグループの会話に参加する] を選択します。
- [接続設定] で [Cloud Pub/Sub] を選択し、 先ほど作成した Pub/Sub トピックの名前。
- [公開設定] で [ドメイン内の特定のユーザーおよびグループにこの Google Chat アプリの利用を許可する] を選択し、メールアドレスを入力します。
- [ログ] で [エラーを Logging にロギング] を選択します。
- [アプリ名] に「
[保存] をクリックします。
Chat でメッセージを受信して返信する準備が整いました。
スクリプトを実行する
CLI で作業ディレクトリに切り替えて、スクリプトを実行します。
Java
mvn compile exec:java -Dexec.mainClass=Main
Python
python -m venv env
source env/bin/activate
pip install -r requirements.txt -U
python app.py
Node.js
npm install
npm start
コードを実行すると、アプリケーションは Pub/Sub トピックにパブリッシュされたメッセージをリッスンし始めます。
Chat 用アプリをテストする
Chat 用アプリをテストするには、スペースを開いてダイレクト メッセージ スペースを開き、 メッセージを送信します。
Google Workspace アカウントを持つユーザーを ご自身で Trusted Tester として追加した際に提供される通知もあわせてご確認ください。
- [ 新しいチャット] をクリックします。
- [1 人以上のユーザーを追加] フィールドに、招待する Chat アプリ。
検索結果から Chat アプリを選択します。ダイレクト メッセージが開きます。
- アプリとの新しいダイレクト メッセージで、「
Hello
」と入力して押します。enter
。
Trusted Tester を追加し、インタラクティブ機能のテストについて詳しくは、以下をご覧ください。 インタラクティブ機能のテスト Google Chat アプリ。
トラブルシューティング
Google Chat アプリまたは card がエラーを返した場合、 Chat のインターフェースに「エラーが発生しました」というメッセージが表示されている。 または「リクエストを処理できません」が表示されます。Chat UI にエラー メッセージが表示されない場合でも、Chat アプリまたはカードで予期しない結果が生成されることがあります(カード メッセージが表示されないなど)。
チャット UI にエラー メッセージが表示されない場合でも、チャットアプリのエラー ロギングがオンになっている場合は、エラーの修正に役立つ説明的なエラー メッセージとログデータが利用できます。表示のヘルプについては、 エラーの修正について詳しくは、このモジュールの Google Chat のエラーのトラブルシューティングと修正
クリーンアップ
サービス アカウントに対する Google Cloud アカウントへの課金を回避するために、 リソースがある場合は、その Terraform Registry に できます。
-
Google Cloud コンソールで、[リソースの管理] ページに移動します。[
メニュー > IAM と管理者
> [リソースの管理] をクリックします。
<ph type="x-smartling-placeholder"></ph> Resource Manager に移動
- プロジェクト リストで、削除するプロジェクトを選択し、[ を削除します。
- ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックして削除します。 できます。
関連トピック
Chat 用アプリに機能を追加するには、 次のとおりです。