Google Chat アプリを構成する

このページでは、Google Chat アプリを Google Workspace アドオンとして構成してデプロイする方法について説明します。

Chat を拡張する Google Workspace アドオンをデプロイしてテストするには、Google Chat API を使用して Chat アプリを有効にして構成する必要があります。Chat API の構成設定では、使用する Chat アプリに関するすべての詳細（名前、アバター、デプロイ、インタラクティブ機能など）を指定します。

前提条件

Chat アプリの表示名、アバター、説明を選択する

Chat アプリの名前、アバター、説明は、Chat UI に表示されます。ユーザーは、Chat アプリを操作するために、この情報を次の方法で確認または使用します。

  • Chat アプリを @メンションして、スペースに追加したり、 メッセージを送信したりします。
  • Chat アプリを検索して、ダイレクト メッセージを開始します。 [アプリ] メニューでは、ダイレクト メッセージに Chat アプリの名前とアバターが表示されます。
  • 入力バーから、Chat アプリを参照して、名前、アバター、説明を確認できます。

Chat アプリを構成する前に、次の情報を準備する必要があります。

フィールド 説明 形式
アプリ名 Chat アプリの表示名。 最大 25 文字の英数字
アバターの URL Chat アプリのアバターとして表示される画像。 正方形のグラフィック画像（PNG または JPEG）を指す HTTPS URL。 推奨サイズは 256 × 256 ピクセル以上です。
説明 Chat アプリの目的の簡単な説明。 最大 40 文字の英数字

次のセクションでは、この情報を Chat API の構成設定で指定します。

Google Cloud コンソールで Chat アプリを構成する

Google Cloud コンソールで、Chat に表示される Chat アプリの詳細（表示名、アバター、説明など）を構成します。これらの詳細は Chat のみに表示されます。Chat アプリを Marketplace に公開するには、Chat アプリの Marketplace リストに表示される詳細も 指定する必要があります。

Chat アプリの詳細が用意できたら、クラウド プロジェクトを開いて Chat API を構成します。

  1. Google Cloud コンソールで、Chat API ページに移動し、[構成] ページをクリックします。

    Chat API 構成ページに移動

  2. [アプリケーション情報] で、[アプリ名]、[アバターの URL]、 および [説明] フィールドに入力します。

  3. [インタラクティブ機能] で、[インタラクティブ機能を有効にする] をオンにして、次の操作を行います。

    1. [機能] で [スペースとグループの会話に参加する] を選択すると、Chat アプリをインストールして使用できるようになります。

      デフォルトでは、ユーザーはユーザーと Chat アプリ間の専用スペースに Chat アプリをインストールしてメッセージを送信できます。また、複数のユーザーがいるスペースで Chat アプリを追加して操作することもできます。

    2. [**接続設定**] で、Chat からイベント オブジェクトを受信するために使用するアーキテクチャを選択します。

      • HTTP サービスを使用するには、[HTTP エンドポイント URL] を選択して URL を指定します。
      • Google Apps Script プロジェクトを使用するには、 [Apps Script] を選択して、 [デプロイ ID] を指定します。
      • Dialogflow エージェントを使用するには、[Dialogflow] を選択し、[Dialogflow CX] または [Dialogflow ES] を選択して、エージェントのリソース名を指定します。
      • Pub/Sub を使用するには、[Cloud Pub/Sub] を選択してトピック名を入力します。

    3. 省略可: 複数のエンドポイントまたは 関数にイベント オブジェクトを受信するには、[**接続設定**] > [**トリガー**] に移動し、次の Chat トリガーのコールバック関数を指定または 更新します:

      • スペースに追加: ユーザーが Chat アプリを グループ会話またはスペースに追加するか、 1:1 メッセージ用に Chat アプリをインストールします。
      • メッセージ: ユーザーが Chat アプリにメッセージを送信します。たとえば、 Chat アプリにダイレクト メッセージを送信したり、複数のユーザーがいるスペースで Chat アプリを @メンションしたりします。
      • スペースから削除: ユーザーがスペースから Chat アプリをアンインストールまたは削除します。
      • アプリコマンド: ユーザーが Chat アプリからクイック コマンドまたはスラッシュ コマンドを使用します。

    4. 省略可: クイック コマンド、 スラッシュ コマンド、 または リンクのプレビューなど、他のインタラクティブ機能を追加します。

    5. [公開設定] でメールアドレスを指定すると、Google Workspace Marketplace に公開する前に Chat アプリを インストールしてテスト できます。最大 5 人の個人、または Google Workspace 組織の 1 つ以上の Google グループを指定できます。

  4. 省略可: [ログ] で [Logging にエラーを記録する] チェックボックスをオンにして Google Cloud Logging を使用します。詳細については、Chat API のドキュメントの Chat アプリのエラーログをクエリする をご覧ください。

  5. [保存] をクリックします。

構成を保存すると、Chat API の [公開設定]で指定したユーザーは、Chat アプリをインストール、テスト、使用できます。Chat アプリのテストとデバッグを開始するには、Chat API のドキュメントのGoogle Chat アプリのインタラクティブ機能をテストするをご覧ください。

既存の Google Workspace アドオンに関する考慮事項

Chat アプリは、他の Google Workspace アプリケーションを拡張する Google Workspace アドオンとは異なる構成が必要です。 アドオンが他の Google Workspace アプリケーションを拡張する場合は、Chat アプリを構成する際の次の要件を考慮してください。

  • 個人と Google Workspace 管理者の両方が、Marketplace からアドオンをインストールできる必要があります。これらのインストール設定は、Google Workspace Marketplace SDK で構成します。
  • Chat アプリでは、マニフェストの manifest の addons.common オブジェクトで他の Google Workspace アプリケーション用に構成した名前とロゴは使用されません。
  • Google Workspace Marketplace に公開されているアドオンの場合、 Google Chat API 構成設定への変更のドラフトを保存することはできません。 Chat API 構成設定を更新して保存すると、更新された Chat アプリは既存のすべてのユーザーが利用できるようになります。Marketplace リストを更新するには、変更を送信する前に ドラフトを作成します 。

  • Apps Script を使用してアドオンを構築した場合:

  • HTTP サービスを使用してアドオンを構築した場合は、Google Workspace アドオン API を使用して作成したマニフェストとデプロイで、Chat アプリの構成の詳細を省略します。Google Workspace Marketplace SDK で指定した HTTP デプロイは、他の Google Workspace アプリケーションでのみ使用されます。