このページでは、HTTP Chat アプリを作成する方法について説明します。このアーキテクチャを実装する方法はいくつかあります。Google Cloud では、Cloud Functions、Cloud Run、App Engine を使用できます。このクイックスタートでは、Chat アプリがユーザーのメッセージに応答するために使用する Cloud Functions の関数を作成してデプロイします。
このアーキテクチャでは、次の図に示すように、HTTP を使用して Google Cloud またはオンプレミス サーバーと統合するように Chat を構成します。
上の図では、HTTP Chat アプリを操作するユーザーに次の情報のフローがあります。
- ユーザーが、Chat のダイレクト メッセージまたは Chat スペースで、Chat アプリにメッセージを送信します。
- HTTP リクエストは、Chat アプリのロジックを含むクラウドまたはオンプレミス システムのウェブサーバーに送信されます。
- Chat アプリのロジックは、必要に応じて Google Workspace サービス(カレンダー、スプレッドシートなど)、他の Google サービス(マップ、YouTube、Vertex AI など)、その他のウェブサービス(プロジェクト管理システムやチケット発行ツールなど)と統合できます。
- ウェブサーバーが HTTP レスポンスを Chat の Chat アプリサービスに返します。
- レスポンスがユーザーに送信されます。
- 必要に応じて、Chat アプリは Chat API を呼び出して、非同期でメッセージの投稿などのオペレーションを実行できます。
このアーキテクチャでは、システムにすでに存在する既存のライブラリとコンポーネントを柔軟に使用できます。これらの Chat アプリはさまざまなプログラミング言語を使用して設計できるためです。
目標
- 環境を設定する。
- Cloud Functions の関数を作成してデプロイする。
- アプリを Chat に公開します。
- アプリをテストします。
前提条件
- Google Chat と Google Cloud Functions へのアクセス権を持つ Google Workspace アカウント。
- Google Cloud プロジェクト。
- Cloud プロジェクトの課金が有効になっていることを確認します。プロジェクトの課金ステータスを確認する方法をご覧ください。
環境を設定する
Google API を使用する前に、Google Cloud プロジェクトで有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。Google Cloud コンソールで、Google Chat API、Cloud Build API、Cloud Functions API、Cloud Pub/Sub API、Cloud Logging API、Artifact Registry API、Cloud Run API を有効にします。
Cloud 関数を作成してデプロイする
送信者の表示名とアバター画像を含む Chat カードを生成する Cloud Functions の関数を作成してデプロイします。Chat アプリがメッセージを受信すると、関数が実行され、カードが返されます。
Chat 用アプリ用の関数を作成してデプロイする手順は次のとおりです。
Node.js
Google Cloud コンソールで、[Cloud Functions] ページに移動します。
Chat アプリのプロジェクトが選択されていることを確認します。
[
関数を作成] をクリックします。[関数の作成] ページで、関数を設定します。
- [環境] で [第 2 世代] を選択します。
- [関数名] に「
QuickStartChatApp
」と入力します。 - [リージョン] でリージョンを選択します。
- [認証] で [認証が必要] を選択します。
- [次へ] をクリックします。
[ランタイム] で、最新バージョンの Node.js を選択します。
[ソースコード] で [インライン エディタ] を選択します。
[エントリ ポイント] でデフォルトのテキストを削除し、「
helloChat
」と入力します。index.js
の内容を次のコードに置き換えます。[Deploy] をクリックします。
Python
Google Cloud コンソールで、[Cloud Functions] ページに移動します。
Chat アプリのプロジェクトが選択されていることを確認します。
[
関数を作成] をクリックします。[関数の作成] ページで、関数を設定します。
- [環境] で [第 2 世代] を選択します。
- [関数名] に「
QuickStartChatApp
」と入力します。 - [リージョン] でリージョンを選択します。
- [認証] で [認証が必要] を選択します。
- [次へ] をクリックします。
[ランタイム] で、最新バージョンの Python を選択します。
[ソースコード] で [インライン エディタ] を選択します。
[エントリ ポイント] でデフォルトのテキストを削除し、「
hello_chat
」と入力します。main.py
の内容を次のコードに置き換えます。[Deploy] をクリックします。
Java
Google Cloud コンソールで、[Cloud Functions] ページに移動します。
Chat アプリのプロジェクトが選択されていることを確認します。
[
関数を作成] をクリックします。[関数の作成] ページで、関数を設定します。
- [環境] で [第 2 世代] を選択します。
- [関数名] に「
QuickStartChatApp
」と入力します。 - [リージョン] でリージョンを選択します。
- [認証] で [認証が必要] を選択します。
- [次へ] をクリックします。
[ランタイム] で、Java の最新バージョンを選択します。
[ソースコード] で [インライン エディタ] を選択します。
[エントリ ポイント] でデフォルトのテキストを削除し、「
HelloChat
」と入力します。src/main/java/com/example/Example.java
からsrc/main/java/HelloChat.java
に名前を変更しました。HelloChat.java
の内容を次のコードに置き換えます。pom.xml
の内容を次のコードに置き換えます。[Deploy] をクリックします。
Cloud Functions の詳細ページが開き、関数に 2 つの進行状況インジケーターが表示されます。1 つはビルド用で、もう 1 つはサービス用です。両方の進行状況インジケーターが表示されなくなり、チェックマークに変わると、関数がデプロイされて準備が整います。
関数の呼び出しを Google Chat に許可する
Google Chat が関数を呼び出すことを承認するには、Cloud Run 起動元ロールを持つ Google Chat サービス アカウントを追加します。
Google Cloud コンソールで、[Cloud Run] ページに移動します。
Cloud Run サービスリストで、受信側関数の横にあるチェックボックスをオンにします。(関数自体はクリックしないでください)。
[権限] をクリックします。[権限] パネルが開きます。
[プリンシパルを追加] をクリックします。
[新しいプリンシパル] に「
chat@system.gserviceaccount.com
」と入力します。[ロールを選択] で、[Cloud Run] > [Cloud Run 起動元] を選択します。
[保存] をクリックします。
アプリを Google Chat に公開する
Cloud Functions の関数をデプロイしたら、次の手順で Google Chat アプリに変換します。
Google Cloud コンソールで、メニュー アイコン > [Cloud Functions] をクリックします。
Cloud Functions を有効にしたプロジェクトが選択されていることを確認します。
関数のリストで、[QuickStartChatApp] をクリックします。
[トリガー] タブをクリックします。
[HTTPS] の下の URL をコピーします。
「Google Chat API」を検索して、[Google Chat API]、[管理] の順にクリックします。
[Configuration] をクリックし、Google Chat アプリを設定します。
- [アプリ名] に「
Quickstart App
」と入力します。 - [アバターの URL] に「
https://developers.google.com/chat/images/quickstart-app-avatar.png
」と入力します。 - [説明] に「
Quickstart app
」と入力します。 - [機能] で、[1:1 のメッセージを受信する] と [スペースとグループの会話に参加する] を選択します。
- [接続設定] で [アプリの URL] を選択し、Cloud Functions の関数トリガーの URL をボックスに貼り付けます。
- [Authentication Audience] で、[App URL] を選択します。
- [公開設定] で、[ドメイン内の特定のユーザーとグループにこの Google Chat アプリの利用を許可する] を選択し、メールアドレスを入力します。
- [ログ] で、[エラーを Logging にロギング] を選択します。
- [アプリ名] に「
[保存] をクリックします。
Chat 用アプリで、Chat でメッセージを受信して応答する準備が整いました。
Chat 用アプリをテストする
Chat アプリをテストするには、Chat アプリでダイレクト メッセージ スペースを開き、メッセージを送信します。
自分自身を Trusted Tester として追加したときに指定した Google Workspace アカウントを使用して Google Chat を開きます。
- [ チャットを新規作成] をクリックします。
- [1 人以上のユーザーを追加] フィールドに、Chat アプリの名前を入力します。
結果から Chat 用アプリを選択します。ダイレクト メッセージが開きます。
- アプリとの新しいダイレクト メッセージで、「
Hello
」と入力してenter
キーを押します。
Chat アプリのレスポンスには、次の図に示すように、送信者の名前とアバター画像を表示するカード メッセージが含まれます。
Trusted Tester を追加する方法と、インタラクティブ機能のテストについて詳しくは、Google Chat アプリのインタラクティブ機能をテストするをご覧ください。
トラブルシューティング
Google Chat アプリまたはカードがエラーを返すと、Chat インターフェースに「エラーが発生しました」というメッセージが表示されます。または「リクエストを処理できません」が表示されます。Chat UI にエラー メッセージが表示されなくても、Chat アプリやカードが予期しない結果(カード メッセージが表示されないなど)を生成することがあります。
Chat UI にエラー メッセージが表示されない場合がありますが、Chat 用アプリのエラーロギングが有効になっている場合は、説明的なエラー メッセージとログデータを使用してエラーを修正できます。エラーの表示、デバッグ、修正については、Google Chat のエラーのトラブルシューティングと修正をご覧ください。
クリーンアップ
このチュートリアルで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、Cloud プロジェクトを削除することをおすすめします。
- Google Cloud コンソールで、[リソースの管理] ページに移動します。メニュー アイコン > [IAM と管理] > [リソースの管理] をクリックします。
- プロジェクト リストで、削除するプロジェクトを選択し、[削除] をクリックします。
- ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。
関連トピック
Chat 用アプリに機能を追加するには、以下をご覧ください。