Google Chat アプリを構成する

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

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

前提条件

HTTP

Apps Script

チャットアプリの表示名、アバター、説明を選択する

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

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

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

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

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

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

Chat アプリの詳細を取得したら、Cloud プロジェクトを開いて Chat API を構成します。

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

    [Chat API の構成] ページに移動

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

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

    1. [機能] で、Chat アプリをインストールして使用できるように、チェックボックスを 1 つ以上選択します。

      • 1 対 1 のメッセージを受信する: ユーザーは、ユーザーと Chat アプリ間の専用スペースに Chat アプリをインストールして、そのアプリでメッセージを送信できます。

      • スペースとグループの会話に参加する: 複数のユーザーが参加するスペースに Chat アプリを追加して操作できます。

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

      • HTTP サービスを使用するには、[HTTP エンドポイント URL] を選択し、URL を指定します。
      • Google Apps Script プロジェクトを使用するには、[Apps Script] を選択し、プロジェクトのデプロイ ID を指定します。

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

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

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

    5. [公開設定] でメールアドレスを指定します。これにより、Google Workspace Marketplace に公開する前に、Chat アプリをインストールしてテストできます。Google Workspace 組織内の最大 5 人のユーザーまたは 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 で構成します。
  • チャットアプリは、manifestの addons.common オブジェクトで他の Google Workspace アプリ用に構成した名前とロゴを使用しません。
  • Google Workspace Marketplace に公開されているアドオンの場合、Google Chat API の構成設定の変更の下書きを保存することはできません。Chat API の構成設定を更新して保存すると、更新された Chat アプリをすべての既存のユーザーが利用できるようになります。マーケットプレイスのリスティングを更新するには、変更を送信する前に下書きを作成します。

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

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