このページでは、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()
メソッド