このページでは、Google Workspace 管理者が Google Chat API を使用して組織全体で Google Chat スペースを管理する方法の概要について説明します。
Google Workspace 管理者は、Google 管理コンソールのスペース管理ツールを使用するか、Google Chat API を呼び出して Chat スペースを管理できます。管理者は Chat API を使用して、スペースを大規模に管理し、一般的なタスクや反復タスクを自動化する Google Chat アプリを作成できます。
管理者が Chat API でできること
管理者は、割り当てられた管理者ロールに基づいて管理タスクを実行できます。
Google Workspace 管理者は、Chat API を使用して次のようなさまざまな管理タスクを実行できます。
- 指定した条件に基づいてスペースを検索する
- スペースのメンバーを一覧表示する
- スペースにメンバーを追加したり、スペースからメンバーを削除したりする
- メンバーとスペースの詳細を取得する
- スペースを更新または削除する
- ユーザーのメンバーシップを更新する
Google Workspace 管理者として認証と認可を行う方法
管理タスクに Chat API を使用する場合、管理者は管理者権限を呼び出すか、アプリケーションのサービス アカウントの権限のドメイン全体の委任を構成することで、リクエストを認証して承認できます。
次の表に、管理者が Chat API の使用時に認証できる方法を示します。
ユーザー認証 | API メソッドを呼び出すユーザー | Chat でユーザーに表示される内容 |
---|---|---|
管理者権限 | useAdminAccess=true を持つ管理者 |
「組織の管理者が [アクション] を実行しました。」 たとえば、「組織の管理者が Kiran B をスペース管理者に変更しました」などです。 管理者ユーザーの名前、ユーザー ID、Chat アプリの名前は識別されません。 |
ドメイン全体の委任 | ユーザーに代わってサービス アカウント |
「[ユーザー] が [アプリ名] で [アクション] を実行しました。」 たとえば、「Sasha T がスペースの名前を「リリース プロジェクトのディスカッション」に変更しました」などです。 サービスによって権限を借用されたユーザーが、アクションを実行したユーザーとして識別されます。 |
組織で Chat API を使用する
このセクションの例では、管理者が管理者権限を使用して組織のスペースとメンバーを管理する際に Chat API を使用する方法を示します。
次の Chat API メソッドは、useAdminAccess=true
で管理者権限を有効にします。
spaces.delete()
spaces.get()
spaces.patch()
spaces.search()
spaces.members.create()
spaces.members.delete()
spaces.members.get()
spaces.members.list()
spaces.members.patch()
ユーザーのスペース メンバーシップを管理する
次のシナリオは、Google Workspace 管理者が Chat API を使用して組織内のユーザーのスペース メンバーシップを管理する方法です。
スペースにユーザーを追加する
管理者は spaces.members.create()
を使用して、組織内の任意のスペースにユーザーを追加できます。
spaces.search()
と組み合わせて使用すると、管理者は検索クエリによって決定された一連のスペースにユーザーを追加できます。これは、新入社員を組織にオンボーディングする際に役立ちます。管理者は、ルーティン プロセスを自動化できます。
ユーザーを見つけてスペースから削除する
管理者は spaces.members.get()
を使用して、ユーザー(組織内または組織外)が組織内のいずれかのスペースのメンバーであるかどうかを判断できます。
spaces.search()
と組み合わせて使用すると、管理者はユーザーがメンバーであるすべてのスペースを見つけ、spaces.members.delete()
を使用してスペースからユーザーを削除できます。これは、社員が組織内でチームを移動する場合や、組織を離れる社員をオフボーディングする場合に役立ちます。管理者は、日常的なプロセスを自動化できます。
ユーザーをスペース管理者に昇格する
管理者は spaces.members.patch()
を使用して、スペースのメンバーを ROLE_MEMBER
から ROLE_MANAGER
に昇格できます。管理者は spaces.members.patch()
を使用して、メンバーを ROLE_MANAGER
から ROLE_MEMBER
に移動することもできます。
spaces.search()
と組み合わせて使用すると、管理者はマネージャーがいないスペースを見つけて、spaces.members.patch()
で既存のメンバーを ROLE_MANAGER
に昇格させることができます。
スペースの外部メンバーを検索する
管理者は spaces.members.list()
を使用して、スペースのメンバーのリストを取得し、組織の People API または Directory API からユーザー プロファイルを取得し、外部ドメインまたは組織のメンバーである結果をフィルタできます。詳しくは、チャットでユーザーを識別する方法をご覧ください。
スペースの監査と管理
次のシナリオは、Google Workspace 管理者が Chat API を使用して組織内のスペースを監査および管理する方法を示しています。
使用されていないスペースを見つけて削除する
使用していない Chat スペースは、貴重なストレージ容量を占有し、ユーザー インターフェースを煩雑にします。管理者は spaces.search()
を使用して非アクティブなスペースを見つけ、spaces.delete()
を使用して削除できます。詳細なガイダンスとコードサンプルについては、使用されていない Chat スペースを検索して削除するをご覧ください。
組織内のスペースを監査する
管理者は spaces.search()
を使用して、組織内のすべてのスペースのリストを取得できます。このリストには、各スペースの設定とメタデータ(作成日、最終アクティビティ日、メンバー数、履歴設定のステータス、外部ゲストの招待機能など)に関する詳細情報が含まれます。
検索条件に基づいてスペースのリストをエクスポートする
管理者は spaces.search()
を使用して、query
で指定された条件を満たすスペースのリストを取得し、結果を CSV ファイルにエクスポートして分析できます。
検索条件に基づいてスペースのメンバーを検索する
管理者は spaces.members.list()
を使用して、組織内の任意のスペースのメンバーのリストを取得し、特定の条件で結果を分析できます。
スペースの管理者を確認する
管理者は spaces.members.list()
を使用して、MembershipState=ROLE_MANAGER
にフィルタされたスペースのメンバーのリストを取得できます。
組織内のすべてのスペースのすべてのスペース管理者を検索するには、spaces.search()
を使用して一覧表示します。次に、リスト内の各スペースに対して spaces.members.list
を使用してマネージャーを取得します。
関連トピック
- 管理者権限を使用して認証と認可を行う
- Google Workspace 管理者として Google Chat API を使用して Google Chat スペースを検索、管理する
spaces.search()
メソッド