Google Chat API を構成する

作成する Google Chat アプリごとに、Chat API が有効になっていて構成されている独自の Google Cloud プロジェクトが必要です。このページでは、Chat API を構成する方法について説明します。

前提条件

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

Chat API を呼び出すには、次の情報を指定して Google Chat アプリを設定する必要があります。

フィールド 説明 形式
アプリ名 Chat アプリの表示名。 半角 25 文字（全角 13 文字）まで
アバターの 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 アプリの詳細を取得したら、Cloud プロジェクトを開いて Chat API を構成します。

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

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

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

  3. [インタラクティブ機能] で、[インタラクティブ機能を有効にする] の切り替えボタンをクリックしてオフにすると、Chat アプリのインタラクティブ機能が無効になります。この設定は後で行うことができます。インタラクティブな機能の構成と構築については、ユーザー操作の受信と応答をご覧ください。

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

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

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

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

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

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