直接メッセージを送受信でき、メッセージのエコーを応答する Google Chat アプリを作成します。
目標
- 環境を設定する。
- スクリプトをセットアップします。
- アプリケーションを公開する。
- スクリプトを実行します。
Prerequisites
- Chat にアクセスできる Google Workspace アカウント。
- 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 コンソールで、メニュー > [API とサービス] > [OAuth 同意画面] に移動します。
- アプリのユーザータイプを選択して、[作成] をクリックします。
- アプリの登録フォームに入力し、[Save and Continue] をクリックします。
現時点では、スコープの追加をスキップして、[Save and Continue] をクリックします。今後、Google Workspace 組織外部で使用するアプリを作成する場合は、アプリに必要な承認スコープを追加して検証する必要があります。
- ユーザータイプとして [外部] を選択した場合は、テストユーザーを追加します。
- [テストユーザー] で [ユーザーを追加] をクリックします。
- メールアドレスとその他の承認済みのテストユーザーを入力し、[保存して次へ] をクリックします。
- アプリの登録の概要を確認します。変更するには、[編集] をクリックします。アプリ登録に問題がない場合は、[Back to Dashboard] をクリックします。
スクリプトを設定する
スクリプトを設定するには、テンプレートを使用し、Apps Script で Cloud プロジェクトを設定します。
テンプレートからスクリプトを作成する
- Apps Script のスタートガイドに移動します。
- [Chat App] テンプレートをクリックします。このテンプレートを表示するには、下方向へのスクロールが必要になる場合があります。
- [無題のプロジェクト] をクリックして「
Quickstart app
」と入力し、[名前を変更] をクリックします。
Cloud プロジェクト番号をコピーする
- Google Cloud コンソールで Cloud プロジェクトに移動します。
- [設定とユーティリティ] > [プロジェクト設定] をクリックします。
- プロジェクト番号をコピーします。
Apps Script プロジェクトの Cloud プロジェクトを設定する
- Chat アプリの Apps Script プロジェクトで、プロジェクト設定アイコン
をクリックします。
- [Google Cloud Platform(GCP)Project] で [Change project] をクリックします。
- [GCP プロジェクト番号] に Google Cloud プロジェクト番号を貼り付けます。
- [プロジェクトを設定] をクリックします。
これで、次の手順で説明されているように、試してみた実際のアプリコードを作成し、要件を満たすようにカスタマイズできます。
Apps Script テンプレートを開くときは、正しい Google アカウントにログインしていることを確認してください。現在のアカウントが、気づかないうちにデフォルトのアカウントに切り替えられる場合もあります。
テストデプロイを作成する
次のステップで使用するために、この Apps Script プロジェクトのデプロイ ID が必要です。
ヘッドデプロイ ID を取得する手順は次のとおりです。
- Chat アプリの Apps Script プロジェクトで、[デプロイ] > [デプロイをテスト] をクリックします。
- 後のステップで使用するヘッドデプロイ ID をコピーし、[完了] をクリックします。
Chat 用アプリの公開
Google Cloud コンソールから Chat アプリを公開します。
- Google Cloud コンソールで
Google Chat API
を検索し、[Google Chat API] をクリックします。 - [管理] をクリックします。
[設定] をクリックし、Chat アプリを設定します。
- [アプリ名] に「
Quickstart app
」と入力します。 - [アバターの URL] フィールドに「
https://developers.google.com/chat/images/quickstart-app-avatar.png
」と入力します。 - [説明] フィールドに「
Quickstart app
」と入力します。 - [機能] で [1 対 1 のメッセージを受け取る] と [スペースとグループの会話に参加する] を選択します。
- [接続設定] で [Apps Script プロジェクト] を選択し、このフィールドにデプロイ ID を貼り付けます。
- [権限] で [ドメイン内の特定のユーザーとグループ] を選択してメールアドレスを入力します。
- [アプリ名] に「
[保存] をクリックしてページを更新します。
構成ページの [App status] で、ステータスを [Live - available to users] に設定します。
[保存] をクリックします。
Chat アプリからメッセージに返信できるようになりました。
スクリプトを実行する
- Chat を開きます。
- [Start a chat] > [Find apps] をクリックして、アプリに新しいダイレクト メッセージを送信します。
- [アプリの検索] ページで
Quickstart App
を検索します。 - [クイックスタート アプリ] の横にある [チャット] をクリックします。
- そのアプリの新しいダイレクト メッセージに、「
Hello
」と入力してenter
を押します。
メッセージを追加していただきありがとうございます。
次のステップ
- インタラクティブ カードの作成 - カード メッセージは、定義されたレイアウト、ボタンなどのインタラクティブな UI 要素、画像などのリッチメディアに対応しています。カード メッセージを使用して詳細情報を表示し、ユーザーから情報を収集して、次のステップに進むことができます。
- スラッシュ コマンドのサポート - スラッシュ コマンドを使用すると、スラッシュ(
/
)で始まるコマンド(例:/help
)を入力することで、アプリに実行できる特定のコマンドを登録してアドバタイズできます。 - 起動ダイアログ - ダイアログはウィンドウベースのカードベースのインターフェースです。アプリはこのインターフェースでユーザーとやり取りできます。複数のカードを順番に並べることができます。これにより、ユーザーはフォームの記入など、複数の手順を踏むことができます。