Google Chat アプリを構成する

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

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

前提条件

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

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

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

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

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

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

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

Google Cloud コンソールで、表示名、アバター、説明など、Chat でユーザーに表示される Chat 用アプリの詳細を設定します。これらの詳細は Chat にのみ表示されます。Chat 用アプリを Marketplace に公開するには、Chat 用アプリの Marketplace の掲載情報に表示される詳細情報も指定する必要があります。

Chat 用アプリの詳細情報を取得したら、Cloud プロジェクトを開いて 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 を指定します。

    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. 省略可: [ログ] で、[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 用アプリでは、マニフェストの 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 アプリケーションでのみ使用されます。