このページでは、Google Apps Script を使用して Google Chat アプリを構築する方法について説明します。Chat アプリを使用すると、直接メッセージを送信し、メッセージをエコーして応答できます。
次の図は、アーキテクチャとメッセージング パターンを示しています。
上の図では、Apps Script Chat アプリを操作するユーザーの情報フローは次のようになります。
- ユーザーが、ダイレクト メッセージまたは Chat スペースで Chat アプリにメッセージを送信します。
- Apps Script で実装され、Google Cloud に存在する Chat アプリのロジックがメッセージを受信して処理します。
- 必要に応じて、Chat 用アプリのロジックを Google Workspace サービス（カレンダー、スプレッドシートなど）や他の Google サービス（Google マップ、YouTube など）と統合できます。
- Chat 用アプリのロジックは、Chat の Chat 用アプリサービスにレスポンスを返します。
- 回答がユーザーに返されます。
目標
- 環境をセットアップする。
- スクリプトを設定します。
- Chat 用アプリを構成します。
- Chat アプリをテストする。
前提条件
- Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。
- Google Cloud プロジェクト 作成するには、Google Cloud プロジェクトを作成するをご覧ください。
環境の設定
Google Cloud コンソールでクラウド プロジェクトを開く
まだ開いていない場合は、このサンプルで使用するクラウド プロジェクトを開きます。
- Google Cloud コンソールで、[プロジェクトを選択] ページに移動します。
- 使用する Google Cloud プロジェクトを選択します。または、[プロジェクトを作成] をクリックし、画面上の手順に沿って操作します。Google Cloud プロジェクトを作成する場合は、プロジェクトの課金を有効にする必要があります。
Chat API を有効にする
Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。Google Cloud コンソールで、Google Chat API を有効にします。
OAuth 同意画面を構成する
OAuth 2.0 を使用するすべてのアプリで、同意画面の構成が必要です。アプリの OAuth 同意画面を構成することで、ユーザーとアプリの審査担当者に表示される内容を定義し、後でアプリを公開できるようにアプリを登録します。
- Google API Console で、メニュー > [Google Auth プラットフォーム] > [ブランディング] に移動します。
- Google Auth Platform をすでに構成している場合は、[ブランディング]、[対象]、[データアクセス] で次の OAuth 同意画面の設定を構成できます。「Google Auth Platform はまだ構成されていません」というメッセージが表示された場合は、[使ってみる] をクリックします。
- [アプリ情報] の [アプリ名] に、アプリの名前を入力します。
- [ユーザー サポートメール] で、ユーザーが同意について問い合わせる際に使用するサポートのメールアドレスを選択します。
- [続行] をクリックします。
- [対象] で [内部] を選択します。
- [続行] をクリックします。
- [連絡先情報] で、プロジェクトに対する変更の通知を受け取るメールアドレスを入力します。
- [続行] をクリックします。
- [完了] で、Google API サービスのユーザーデータに関するポリシーを確認し、同意する場合は [Google API サービス: ユーザーデータに関するポリシーに同意します] を選択します。
- [続行] をクリックします。
- [作成] をクリックします。
- 現時点では、スコープの追加をスキップできます。 今後、Google Workspace 組織外で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更する必要があります。次に、アプリに必要な認可スコープを追加します。詳細については、OAuth 同意画面を構成するガイドをご覧ください。
スクリプトを設定する
スクリプトを設定するには、Apps Script の Getting Started ページから Chat アプリ テンプレートを使用します。
Apps Script プロジェクトを作成する
Apps Script のスタートガイド ページから、[Google Workspace アドオンのスターター] に移動し、[Chat アプリ] テンプレートをクリックします。
開いた新しい Apps Script プロジェクトで、プロジェクトに名前を付けます。
[無題のプロジェクト] をクリックします。
[プロジェクトのタイトル] に「
Quickstart app」と入力します。[名前を変更] をクリックします。
今後、特定の Google API を使用する場合や、アプリを公開する場合は、クラウド プロジェクトを Apps Script プロジェクトに関連付ける必要があります。このガイドでは、その必要はありません。詳細については、Google Cloud プロジェクト ガイドをご覧ください。
テスト デプロイを作成する
この Apps Script プロジェクトのデプロイ ID が必要です。これは次のステップで使用します。
ヘッド デプロイ ID を取得するには、次の操作を行います。
- Chat 用アプリの Apps Script プロジェクトで、[デプロイ] > [デプロイをテスト] をクリックします。
- 後のステップで使用するためにヘッドデプロイ ID をコピーし、[完了] をクリックします。
Chat 用アプリを構成する
Google Chat アプリを構成する手順は次のとおりです。
- API Console で
Google Chat APIを検索し、[Google Chat API] をクリックします。 - [管理] をクリックします。
[構成] をクリックして、Chat 用アプリを設定します。
- [アプリ名] フィールドに「
Quickstart app」と入力します。 - [アバターの URL] フィールドに「
https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png」と入力します。 - [説明] フィールドに「
Quickstart app」と入力します。 - [機能] で、[スペースとグループの会話に参加する] を選択します。
- [接続設定] で [Apps Script プロジェクト] を選択します。
- [デプロイ ID] フィールドに、先ほどコピーしたヘッド デプロイ ID を貼り付けます。
- [公開設定] で、[ドメイン内の特定のユーザーとグループ] を選択し、メールアドレスを入力します。
- [アプリ名] フィールドに「
[保存] をクリックします。
Chat 用アプリがメッセージに応答する準備が整いました。
Chat アプリをテストする
Chat 用アプリをテストするには、Chat 用アプリとのダイレクト メッセージ スペースを開き、メッセージを送信します。
信頼できるテスターとして自分を追加したときに指定した 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 アカウントで課金されないようにするには、クラウド プロジェクトを削除することをおすすめします。
- Google API Console で、[リソースの管理] ページに移動します。メニュー アイコン > [IAM と管理] > [リソースの管理] をクリックします。
- プロジェクト リストで、削除するプロジェクトを選択し、[削除] をクリックします。
- ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。
次のステップ
- インタラクティブなカードを作成する - カード メッセージは、定義済みのレイアウト、ボタンなどのインタラクティブな UI 要素、画像などのリッチメディアをサポートしています。カード メッセージを使用して、詳細情報の提示、ユーザーからの情報の収集、次のステップへの誘導を行います。
- コマンドに応答する - コマンドを使用すると、ユーザーは Chat 用アプリの主な機能を見つけて使用できます。
- ダイアログを起動する - ダイアログは、アプリがユーザーとのやり取りのために開くことができる、ウィンドウ表示のカードベースのインターフェースです。複数のカードを順番に並べることができるため、ユーザーはフォームデータの入力など、複数のステップからなるプロセスを完了できます。
- Codelab: より高度な Chat 用アプリを構築する準備はできていますか？Gemini 対応の Google Chat アプリを作成するの Codelab で作成したフィードバック Chat アプリをご覧ください。
アドオンではない Chat 用アプリ: Google Apps Script を使用して Google Chat 用アプリを作成する
Apps Script で Google Workspace アドオンではない Chat アプリを構築するには、次の手順に沿ってテンプレートからスクリプトを作成し、アドオンではない Chat アプリを構成します。
テンプレートからスクリプトを作成する
- Chat アプリ テンプレートを開く
[無題のプロジェクト] をクリックし、「
Quickstart app」と入力して [名前を変更] をクリックします。今後、特定の Google API を使用する場合や、アプリを公開する場合は、Cloud プロジェクトを Apps Script プロジェクトに関連付ける必要があります。このガイドでは、その必要はありません。詳細については、Google Cloud プロジェクト ガイドをご覧ください。
Chat 用アプリの Apps Script プロジェクトで、[デプロイ] > [デプロイをテスト] をクリックします。
次のステップで使用するヘッドデプロイ ID をコピーして、[完了] をクリックします。
アドオンではない Chat 用アプリを構成する
API Console から、アドオンではない Chat 用アプリを構成します。
- API Console で
Google Chat APIを検索し、[Google Chat API] をクリックします。 - [管理] をクリックします。
[構成] をクリックして、アドオンではない Chat 用アプリを設定します。
- [この Chat アプリを Google Workspace アドオンとして構築する] をオフにします。確認を求めるダイアログが表示されます。ダイアログで [無効にする] をクリックします。
- [アプリ名] フィールドに「
Quickstart app」と入力します。 - [アバターの URL] フィールドに「
https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png」と入力します。 - [説明] フィールドに「
Quickstart app」と入力します。 - [機能] で、[スペースとグループの会話に参加する] を選択します。
- [接続設定] で [Apps Script] を選択します。
- [デプロイ ID] フィールドに、先ほどコピーしたヘッド デプロイ ID を貼り付けます。
- [公開設定] で、[ドメイン内の特定のユーザーとグループ] を選択し、メールアドレスを入力します。
[保存] をクリックします。