このページでは、Google Chat を拡張する Google Workspace アドオンを作成する方法の概要について説明します。
Chat を拡張する Google Workspace アドオンを使用すると、ユーザーは次のいずれかを行うことができます。
- Chat メッセージのリンクをプレビューし、会話を離れることなく操作できます。
- Google Workspace アプリケーション全体でタスクを自動化または実行する。
- 外部ツールやサービスに関するアラートや通知を受け取る。
Chat での Google Workspace アドオンの仕組み
Chat では、アドオンは Google Chat アプリとしてユーザーに表示されます。Chat アプリは、ユーザーとやり取りするために次のことができます。
- テキスト、カード、インタラクティブな UI 要素を含むメッセージを送信する。
- スラッシュ コマンドに応答する。
- ダイアログを開いて、ユーザーがフォームデータの入力などの複数のステップからなるプロセスを完了できるようにします。
- メッセージ内のリンクをプレビューします。会話から直接操作できるように、有用な情報を含んだカードを添付します。
使ってみる
Chat で動作する Google Workspace アドオンの作成を開始するには、次のドキュメントをご覧ください。
- クイックスタートで、Google Apps Script または HTTP サービスを使用して基本的な Chat アプリを作成します。
- Chat API を使用して Chat アプリとそのインタラクティブ機能を構成します。
- アドオンのトリガー、アクション、イベント オブジェクトを使用して Chat インターフェースを作成する方法について学びます。
制限事項と既知の問題
次の Chat とアドオンの機能はご利用いただけません。
- Dialogflow と Pub/Sub です。Apps Script または HTTP サービスを使用して、Chat を拡張するアドオンを構築する必要があります。
- Apps Script のカード サービス。チャット アクションを使用してカードを作成する場合は、代わりに JSON オブジェクトを返します。例については、ダイアログを開いて応答するとリンクをプレビューするをご覧ください。
- カスタム認証カード。Chat からサービスを認証して承認を付与するには、Chat アプリが基本的な認可カードを返す必要があります。
- Chat サイドバーのアドオンのホームページ。アドオンのホームページ トリガーを構成した場合、ホームページは、アドオンが拡張する他の Google Workspace アプリケーションのサイドバーにのみ表示されます。
- Chat アプリのホームページ。Chat アプリのダイレクト メッセージの [ホーム] タブに表示されます。
既存の Google Workspace アドオンを更新する場合は、Chat アプリの次の構成要件を考慮してください。
- Google Workspace Marketplace のインストール設定で、個人と Google Workspace 管理者の両方がアドオンをインストールできるようにする必要があります。
- アドオンのマニフェスト(
addons.common
)の一般的な構成設定は、Chat では無視されます。Chat で動作するようにアドオンを構成するには、Chat API を有効にして構成する必要があります。手順については、Google Chat アプリを構成するをご覧ください。 - HTTP サービスを使用してビルドする場合は、Google Workspace Add-ons API を有効にする必要があります。REST リソース
deployment
とproject
は、他の Google Workspace アプリケーションのアドオンのデプロイにのみ適用されます。 - Chat でアドオンをデプロイしてテストするには、Chat API の [公開設定] を使用する必要があります。Google Workspace Marketplace SDK で構成した公開設定やテスト設定は無視されます。Chat にアドオンのテスト版をデプロイするには、Chat API ドキュメントの Google Chat アプリのインタラクティブ機能をテストするをご覧ください。
- アドオンが Google Workspace Marketplace に公開されている場合、Google Chat API の構成設定の変更の下書きを保存することはできません。Chat API の構成設定を更新すると、更新された Chat アプリを既存のすべてのユーザーがすぐに利用できるようになります。マーケットプレイスのリスティングを更新するには、変更を送信する前に下書きを作成します。