このページでは、Google Apps Script を使用して Google Chat で動作する Google Workspace アドオンをビルドする方法について説明します。
Chat アプリでは、ダイレクト メッセージを送信すると、メッセージがエコーバックされます。
次の図は、アーキテクチャとメッセージング パターンを示しています。
上の図では、Apps Script Chat 用アプリを操作するユーザーに対して、次のような情報の流れが発生します。
- ユーザーが、ダイレクト メッセージまたは Chat スペースで Chat 用アプリにメッセージを送信します。
- Google Cloud に存在する Apps Script で実装された Chat 用アプリのロジックが、メッセージを受信して処理します。
- 必要に応じて、Chat 用アプリのロジックを Google Workspace サービス（カレンダーやスプレッドシートなど）や、Google サービス（Google マップや YouTube など）と統合できます。
- Chat 用アプリのロジックは、Chat の Chat 用アプリ サービスに応答を返します。
- レスポンスがユーザーに返されます。
目標
- 環境をセットアップする。
- スクリプトを設定します。
- Chat 用アプリの Google Workspace アドオンを構成します。
- Chat 用アプリをテストします。
前提条件
- Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。
- Google Cloud プロジェクト 作成するには、Google Cloud プロジェクトを作成するをご覧ください。
環境の設定
Google Cloud コンソールで Cloud プロジェクトを開く
まだ開いていない場合は、このサンプルで使用する 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 Cloud コンソールで、メニュー > > [ブランディング] に移動します。
- をすでに構成している場合は、[ブランディング]、[ユーザー]、[データアクセス] で次の OAuth 同意画面の設定を構成できます。[ まだ設定されていません] というメッセージが表示された場合は、[使ってみる] をクリックします。
- [アプリ情報] の [アプリ名] に、アプリの名前を入力します。
- [ユーザー サポートメール] で、ユーザーが同意について問い合わせる際に使用するサポートのメールアドレスを選択します。
- [続行] をクリックします。
- [対象] で [内部] を選択します。
- [続行] をクリックします。
- [連絡先情報] で、プロジェクトに対する変更の通知を受け取るメールアドレスを入力します。
- [続行] をクリックします。
- [完了] で、Google API サービスのユーザーデータに関するポリシーを確認し、同意する場合は [Google API サービス: ユーザーデータに関するポリシーに同意します] を選択します。
- [続行] をクリックします。
- [作成] をクリックします。
- 現時点では、スコープの追加はスキップできます。今後、Google Workspace 組織外で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更する必要があります。次に、アプリに必要な認可スコープを追加します。詳細については、OAuth 同意画面を構成するガイドをご覧ください。
スクリプトを設定する
スクリプトを設定するには、Apps Script のスタートガイド ページにある Chat 用アプリ テンプレートを使用し、スクリプトを Cloud プロジェクトに接続します。
Apps Script プロジェクトを作成する
Apps Script の スタートガイド ページで、[アドオンのスターター] に移動し、[Chat 用アプリ] テンプレートをクリックします。
開いた新しい Apps Script プロジェクトで、プロジェクトに名前を付けます。
[無題のプロジェクト] をクリックします。
[プロジェクトのタイトル] に「
Add-on Chat app」と入力します。[名前を変更] をクリックします。
Cloud プロジェクト番号をコピーする
- Google Cloud コンソールで、メニュー アイコン > [IAM と管理] > [設定] に移動します。
- [プロジェクト番号] フィールドで、値をコピーします。
Apps Script プロジェクトの Cloud プロジェクトを設定する
- Chat 用アプリの Apps Script プロジェクトで、[プロジェクトの設定]
をクリックします。 - [Google Cloud Platform（GCP）プロジェクト] で、[プロジェクトを変更] をクリックします。
- [GCP プロジェクト番号] に、Google Cloud プロジェクト番号を貼り付けます。
- [プロジェクトを設定] をクリックします。
これで、動作するアプリコードが完成しました。このコードは、次の手順で試してから、要件に合わせてカスタマイズできます。
Apps Script プロジェクトを開くときに、正しい Google アカウントにログインしていることを確認します。現在のアカウントが、ユーザーが気づかないうちにデフォルトのアカウントに切り替わることがあります。
テスト デプロイを作成する
次のステップで使用できるように、この Apps Script プロジェクトのデプロイ ID が必要です。
ヘッド デプロイ ID を取得するには、次の操作を行います。
- Chat 用アプリの Apps Script プロジェクトで、[デプロイ] > [テストデプロイ] をクリックします。
- ヘッド デプロイ ID をコピーして、後のステップで使用し、[完了] をクリックします。
アドオンを構成する
Apps Script のデプロイを使用して、次の手順でアドオンを作成し、Google Chat 用アプリをデプロイします。
- コンソールで
Google Chat APIを検索し、[Google Chat API] をクリックします。 - [管理] をクリックします。
[構成] をクリックして、Chat 用アプリを設定します。
- [アプリ名] フィールドに「
Add-on Chat app」と入力します。 - [アバターの URL] フィールドに「
https://developers.google.com/workspace/add-ons/images/quickstart-app-avatar.png」と入力します。 - [説明] フィールドに「
Add-on Chat app」と入力します。 - [機能] で、[スペースとグループの会話に参加する] を選択します。
- [接続設定] で [Apps Script プロジェクト] を選択します。
- [Deployment ID] フィールドに、前にコピーした Head デプロイ ID を貼り付けます。
- [公開設定] で、[ドメイン内の特定のユーザーとグループ] を選択し、メールアドレスを入力します。
- [アプリ名] フィールドに「
[保存] をクリックします。
Chat アプリでメッセージに返信できるようになりました。
Chat アプリをテストする
Chat 用アプリをテストするには、Chat 用アプリとのダイレクト メッセージ スペースを開いてメッセージを送信します。
信頼できるテスターとして登録した際に指定した Google Workspace アカウントを使用して、Google Chat を開きます。
- [ 新しいチャット] をクリックします。
- [ユーザーを 1 人以上追加] フィールドに、Chat 用アプリの名前を入力します。
結果から Chat 用アプリを選択します。ダイレクト メッセージが開きます。
そのアプリの新しいダイレクト メッセージに、「
Hello」と入力してenterを押します。Chat 用アプリから、追加していただいたことへの感謝とメッセージの返信が届きます。
信頼できるテスターを追加して、インタラクティブ機能のテストについて詳しくは、Google Chat 用アプリのインタラクティブ機能をテストするをご覧ください。
トラブルシューティング
Google Chat 用アプリまたはカードがエラーを返すと、Chat インターフェースに「エラーが発生しました」というメッセージが表示されます。または「リクエストを処理できません。」と表示されることがあります。Chat UI にエラー メッセージが表示されない場合でも、Chat 用アプリやカードで予期しない結果が生じることがあります。たとえば、カード メッセージが表示されないことがあります。
Chat UI にエラー メッセージが表示されない場合でも、Chat 用アプリのエラー ロギングが有効になっている場合は、エラーの修正に役立つ説明的なエラー メッセージとログデータを利用できます。エラーの表示、デバッグ、修正については、Google Chat のエラーのトラブルシューティングと修正をご覧ください。
クリーンアップ
このチュートリアルで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、Cloud プロジェクトを削除することをおすすめします。
- Google Cloud コンソールで、[リソースの管理] ページに移動します。メニュー アイコン > [IAM と管理] > [リソースの管理] をクリックします。
- プロジェクト リストで、削除するプロジェクトを選択し、[削除] をクリックします。
- ダイアログでプロジェクト ID を入力し、[シャットダウン] をクリックしてプロジェクトを削除します。