このガイドでは、Google Chat API の Space
リソースで setUp()
メソッドを使用して Google Chat スペースを設定する方法について説明します。スペースを設定すると、スペースが作成され、指定したユーザーが追加されます。
Space
リソースは、ユーザーや Chat アプリがメッセージを送信したり、ファイルを共有したり、コラボレーションしたりできる場所を表します。スペースにはいくつかのタイプがあります。
- ダイレクト メッセージ(DM)は、2 人のユーザー間、またはユーザーと Chat アプリ間の会話です。
- グループ チャットとは、3 人以上のユーザーと Chat 用アプリ。
- 名前付きスペースは、メッセージの送信、ファイルの共有、 考えています
スペースを設定する際は、次の点を考慮してください。
- 呼び出し元(認証済み)ユーザーが自動的にスペースに追加されるので、 リクエストでユーザーのメンバーシップを指定する必要はありません。
- ダイレクト メッセージ(DM)を作成する際に、2 人のユーザーの間に DM が存在する場合、 DM が返されます。それ以外の場合は、DM が作成されます。
- グループ チャットを作成するときに、リクエストで指定されたメンバーシップがいずれもグループ チャットに正常に追加されなかった場合(権限の問題など)、空のグループ チャット(呼び出し元のユーザーのみを含む)が作成されることがあります。
- スレッド形式の返信を使用するスペースを設定したり、Google Workspace 外のユーザーを追加したりすることはできません。
- リクエストで指定された重複するメンバーシップ(呼び出し元のユーザーを含む)は、リクエスト エラーになるのではなく、除外されます。
前提条件
Node.js
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Google Chat API を有効にして構成する。名前、 アプリのアイコン、説明を入力します。
- Node.js Cloud クライアント ライブラリをご覧ください。
- <ph type="x-smartling-placeholder"></ph>
デスクトップ アプリケーション用の OAuth クライアント ID 認証情報を作成するサンプルを実行するには、
で、認証情報を
client_secrets.json
という名前の JSON ファイルとして ディレクトリにあります。
- <ph type="x-smartling-placeholder"></ph> ユーザー認証をサポートする認可スコープを選択します。
Python
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成する。名前、 アプリのアイコン、説明を入力します。
- Python Cloud クライアント ライブラリをご覧ください。
- <ph type="x-smartling-placeholder"></ph>
デスクトップ アプリケーション用の OAuth クライアント ID 認証情報を作成するサンプルを実行するには、
で、認証情報を
client_secrets.json
という名前の JSON ファイルとして ディレクトリにあります。
- <ph type="x-smartling-placeholder"></ph> ユーザー認証をサポートする認可スコープを選択します。
Java
- Google Chat へのアクセス権を持つビジネスまたはエンタープライズ向け Google Workspace アカウント。
- 環境を設定します。
<ph type="x-smartling-placeholder">
- </ph>
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成する。名前、 アプリのアイコン、説明を入力します。
- Java の Cloud クライアント ライブラリをインストールします。
- デスクトップ アプリケーションの OAuth クライアント ID 認証情報を作成します。サンプルを実行するには、
で、認証情報を
client_secrets.json
という名前の JSON ファイルとして ディレクトリにあります。
- ユーザー認証をサポートする認可スコープを選択します。
Apps Script
- 企業または大企業 以下へのアクセス権を持つ Google Workspace アカウント Google Chat。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- スタンドアロンの Apps Script プロジェクトを作成し、Advanced Chat Service を有効にします。
- <ph type="x-smartling-placeholder"></ph> ユーザー認証をサポートする認可スコープを選択します。
スペースを設定する
スペースを設定するには、リクエストで次の内容を渡します。
chat.spaces.create
またはchat.spaces
の認可スコープを指定します。SetUpSpace()
メソッドを呼び出します。space
をSpace
のインスタンスとして渡し、displayName
やspaceType
などの必要なフィールドをすべて指定します。memberships
をMembership
インスタンスの配列として渡します。インスタンスごとに、次の操作を行います。 <ph type="x-smartling-placeholder">- </ph>
- 人間のユーザーをスペースのメンバーとして追加するには、
users/{user}
を指定します({user}
)。person
の{person_id}
のいずれかです。 People API から取得する、またはuser
ディレクトリ API で管理できます。たとえば、People API のユーザーresourceName
がpeople/123456789
の場合、member.name
としてusers/123456789
を含むメンバーシップを追加することで、ユーザーをスペースに追加できます。 - グループをスペースのメンバーとして追加するには、
groups/{group}
を指定します({group}
)。 メンバーシップを作成するグループ ID です。グループの ID kubectl の「get」コマンドや Cloud Identity API。 たとえば、Cloud Identity API がgroups/123456789
という名前のグループを返す場合は、membership.groupMember.name
をgroups/123456789
に設定します。Google グループを 名前付きスペースにのみ追加できます。
- 人間のユーザーをスペースのメンバーとして追加するには、
呼び出し元のユーザーと別の人間ユーザーとの間で DM を作成するには、リクエストで人間ユーザーのメンバーシップを指定します。
呼び出し元のユーザーと通話アプリの間の DM を作成するには、
space.singleUserBotDm
を true
に設定し、メンバーシップは指定しません。この方法は、通話アプリで DM を設定する場合にのみ使用できます。通話アプリをスペースのメンバーとして追加する場合や、2 人の人間ユーザー間の既存の DM に追加する場合は、メンバーシップを作成するをご覧ください。
次の例では、名前付きスペースを作成し、そのスペースに 1 つのメンバーシップを 2 人(認証済みユーザーともう 1 人)のユーザーのためのスペースです。
Node.js
Python
Java
Apps Script
サンプルを実行するには、次のように置き換えます。
DISPLAY_NAME
: 新しいスペースの表示名。USER_NAME
: 追加するユーザーの ID できます。
スペースに移動するには、スペースのリソース ID を使用してスペースの URL を作成します。リソース ID は、Google Chat の回答のスペース name
から取得できます。
できます。たとえば、スペースの name
が spaces/1234567
の場合、https://mail.google.com/chat/u/0/#chat/space/1234567
という URL を使用してスペースに移動できます。
関連トピック
- スペースを作成します。
- スペースの詳細を取得する。
- スペースを一覧表示する。
- スペースを更新する。
- スペースを削除する。
- ダイレクト メッセージ スペースを探す。
- 特定のユーザーがスペースを検索できるようにする