Google Chat アプリを構成する

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

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

前提条件

HTTP

Apps Script

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

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

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

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

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

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

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

Chat アプリの詳細が表示されたら、Cloud プロジェクトを開き、Chat API を構成します。

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

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

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

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

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

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

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

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

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

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

      • Added to space: ユーザーがグループの会話またはスペースに Chat アプリを追加するか、1 対 1 のメッセージを処理する Chat アプリをインストールする。
      • メッセージ: ユーザーが Chat アプリにメッセージを送信します。たとえば、Chat アプリにダイレクト メッセージを送信したり、複数のユーザーとスペースで Chat アプリに名前リンクを付けたりできます。
      • Removed from space: ユーザーがスペースから Chat アプリをアンインストールまたは削除した。
      • アプリコマンド: ユーザーは、Chat アプリからクイック コマンドまたはスラッシュ コマンドを使用します。

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

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

  4. 省略可: Google Cloud Logging を使用するには、[ログ] で [エラーを 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 アプリでは、マニフェストの addons.common オブジェクトで他の Google Workspace アプリケーション用に構成した名前とロゴは使用されません。
  • Google Workspace Marketplace に公開されているアドオンの場合、Google Chat API の構成設定に加えた変更の下書きを保存することはできません。Chat API の構成設定を更新して保存すると、更新された Chat アプリを既存のすべてのユーザーが使用できるようになります。Marketplace リスティングを更新するには、変更を送信する前にドラフトを作成します。

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

    • 他のアドオン構成で使用するのと同じ Apps Script デプロイ ID を使用する必要があります。
    • Apps Script エディタを使用して Chat にテストデプロイをインストールすることはできません。代わりに、Chat UI から直接インストールする必要があります。

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