Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

Google Chat API を構成する

作成する Google Chat 用アプリごとに、Chat API が有効になって構成されている独自の Google Cloud プロジェクトが必要です。

スペースの取得やメッセージの一覧表示など、ユーザー認証を使用して読み取り専用の API 呼び出しを行うには、API を有効にして OAuth クライアントを作成するだけで済みます。

作成、更新、削除の API 呼び出しを実行する場合や、インタラクティブな Chat 用アプリ（Chat を拡張する Google Workspace アドオンとして構築）をデプロイしてテストする場合も、Chat API を構成する必要があります。Chat API の構成設定では、表示名、アバター、デプロイエンドポイント、インタラクティブ機能など、Chat 用アプリに関するすべての詳細を指定します。

前提条件

Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。
Google Cloud プロジェクトを作成します。
OAuth 同意画面を構成します。
Google Chat API を有効にします。

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

Chat API を有効にすると、Chat でユーザーに表示される Chat 用アプリの詳細（表示名、アバター、説明など）を構成できます。これらの詳細は Chat にのみ表示されます。Chat 用アプリを Marketplace に公開するには、Chat 用アプリの Marketplace の掲載情報に表示される詳細も指定する必要があります。

Chat 用アプリを構成する前に、次の情報を準備します。

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

Chat アプリの名前、アバター、説明は、Chat UI でユーザーに表示されます。一部の Chat API 書き込みリクエストでは、Chat はこの情報を使用して、Chat アプリが Chat で行うアクションを帰属させます。

たとえば、spaces.create() メソッドを呼び出すと、次の図に示すように、スペースを作成したユーザーの説明に Chat 用アプリの名前が含まれます。

Google Chat アプリがユーザーのスペースを作成します。 — **図 1**. `spaces.create()` メソッドを使用してユーザーに代わってスペースを作成するときに Chat に表示される帰属メッセージ。

Chat 用アプリを操作する際に、ユーザーは次の方法でこの情報を確認または使用することもできます。

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

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

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

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

Chat API の構成ページに移動
[アプリケーション情報] で、[アプリ名]、[アバターの URL]、[説明] の各フィールドに入力します。
[インタラクティブ機能] で、Chat 用アプリがユーザー操作に応答するかどうかを設定します。

注: Chat 用アプリが Chat API のみを呼び出し、ユーザー操作を受信または応答しない場合は、[インタラクティブ機能を有効にする] をオフのままにして、次のステップに進みます。
インタラクティブな Chat 用アプリを構築するには、[インタラクティブ機能を有効にする] をオンにして、次の操作を行います。
1. [機能] で、次の操作を行います。
  - 省略可: [アプリホームをサポート] を選択すると、Chat 用アプリとの 1 対 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] を選択して、トピック名を入力します。
  警告: Apps Script デプロイ ID がすでに設定されている場合、Cloud プロジェクトは既存の Google Workspace アドオンに接続されています。Chat API でデプロイ ID を更新すると、アドオンのデプロイ ID が更新され、Google Workspace Marketplace のリスティングに影響する可能性があります。アドオンの構成を確認するには、Google Workspace Marketplace SDK でアプリを構成するをご覧ください。
3. 省略可: イベントオブジェクトを特定のエンドポイントまたは関数に転送するには、[接続設定] > [トリガー] に移動し、次の Chat トリガーのコールバックエンドポイントまたは関数を指定するか、更新します。
  
  注: Apps Script の場合、トリガーを更新しない場合は、このセクションに入力されたデフォルトのコールバック関数（onMessage、onAddedToSpace、onRemovedFromSpace、onAppCommand、onAppHome など）を実装する必要があります。
  - アプリホーム（[アプリホームをサポート] が有効になっている場合）: ユーザーが Chat 用アプリとの 1 対 1 のダイレクトメッセージで [ホーム] タブを開きます。
  - 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 グループです。
省略可: [ログ] で、[Logging にエラーを記録する] チェックボックスをオンにして、Google Cloud Logging を使用します。詳細については、Chat 用アプリのクエリエラーログをご覧ください。
[保存] をクリックします。

構成を保存すると、Chat API の [公開設定] で指定したユーザーは、Chat 用アプリをインストール、テスト、使用できるようになります。Chat 用アプリのテストとデバッグを開始するには、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 用アプリが既存のすべてのユーザーにすぐに利用可能になります。マーケットプレイスのリスティングを更新するには、変更を送信する前に下書きを作成できます。
Apps Script を使用してアドオンを構築した場合:
- アドオンの他の構成で使用している Apps Script デプロイ ID と同じ ID を使用する必要があります。
- Apps Script エディタを使用して Chat にテストデプロイをインストールすることはできません。代わりに、Chat の UI から直接インストールする必要があります。
HTTP サービスを使用してアドオンをビルドした場合は、Google Workspace アドオン API を使用して作成するマニフェストとデプロイで、Chat 用アプリの構成の詳細を省略します。Google Workspace Marketplace SDK で指定した HTTP デプロイは、他の Google Workspace アプリケーションでのみ使用されます。

他のユーザーに Chat API を構成する権限を付与する

Chat apps Owner または Chat apps Viewer の Google Cloud Identity Access Management（IAM）ロールを付与することで、特定のユーザーに Chat 用アプリの構成ページへのアクセス権を付与できます。これらのロールを持つユーザーは、[API とサービス] ダッシュボードを使用して Chat 用アプリの構成ページに移動することはできませんが、次のように Chat 用アプリのホストクラウドプロジェクトの Google Cloud コンソールに移動して構成ページにアクセスできます。

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

ここで、PROJECT_ID は Chat 用アプリをホストする Google Cloud プロジェクトのプロジェクト ID です。

アドオンではない Chat 用アプリ: Google Chat API を構成する

Google Workspace アドオンではない Chat 用アプリを管理している場合、構成ではイベントごとのトリガーではなく、すべてのインタラクションイベントに単一のエンドポイントを使用します。

Google Cloud コンソールで、Chat API の [構成] ページに移動します。

[Chat API の構成] ページに移動
[インタラクティブ機能] で、[インタラクティブ機能を有効にする] をオンにします。
[この Chat 用アプリを Google Workspace アドオンとしてビルドする] をオフにします。確認を求めるダイアログが開きます。ダイアログで [無効にする] をクリックします。
[機能] で、必要に応じて [アプリのホームをサポートする] または [スペースとグループの会話に参加する] を選択します。
[接続設定] で、Chat 用アプリの単一のエンドポイント（HTTP エンドポイント URL、Apps Script デプロイ ID、Cloud Pub/Sub トピック名、Dialogflow）を指定します。
必要に応じて [コマンド]、[リンクのプレビュー]、[公開設定]、[ログ] を構成し、[保存] をクリックします。

アドオンではない Chat 用アプリを、Google Chat を拡張する Google Workspace アドオンにアップグレードするには、Google Chat 用アプリを Google Workspace アドオンに変換するをご覧ください。