このガイドでは、Google Chat API の Membership
リソースの delete()
メソッドを使用して、スペースからメンバーを削除する(メンバーシップを削除する)方法について説明します。スペースの管理者がスペース内の唯一の管理者である場合、その管理者は削除できません。別のユーザーをスペースとして割り当てる
これらのメンバーシップを削除する前に、
Google Workspace 管理者は、ユーザーを削除したり、 Google グループ、Chat アプリ、チャット アプリを Google Workspace の組織。
Membership
リソースは、人間のユーザーまたは Google Chat アプリがスペースに招待されているか、スペースに参加しているか、スペースに含まれていないかを表します。
前提条件
Node.js
- 企業または大企業 以下へのアクセス権を持つ Google Workspace アカウント Google Chat。
- 環境を設定します。
<ph type="x-smartling-placeholder">
- </ph>
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する
- Google Chat API を有効にして構成し、Chat アプリの名前、アイコン、説明を指定します。
- Node.js の Cloud クライアント ライブラリをインストールします。
- Google Chat API での認証方法に基づいてアクセス認証情報を作成する
request:
<ph type="x-smartling-placeholder">
- </ph>
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
client_secrets.json
という名前の JSON ファイルとしてローカル ディレクトリに保存します。 - Chat 用アプリとして認証するには、
サービス アカウントの作成
認証情報を JSON ファイルとして保存し、
credentials.json
。
- Chat ユーザーとして認証するには、OAuth クライアント ID 認証情報を作成し、認証情報を
- ユーザーとして認証するか、Chat アプリとして認証するかに応じて、認可スコープを選択します。
- Google Chat のスペース。Google Chat API を使用して作成する方法については、以下をご覧ください。 スペースを作成します。Chat で作成するには、 詳しくは、 ヘルプセンターの記事をご覧ください。
<ph type="x-smartling-placeholder">
スペースからユーザーとしてメンバーを削除する
スペースからユーザー、Google グループ、Chat 用アプリを削除するには、 スペースで user authentication の場合: 次のコードを追加します。
chat.memberships
認可スコープを指定します。承認ユーザーには、ユーザーまたは Google グループを削除する権限が必要です スペースから削除することもできます。Chat 用アプリを削除するには、chat.memberships.app
承認スコープ(アプリが削除できるのはその権限のみ 独自のメンバーシップ。ベスト プラクティスとして、 制限付きスコープで アプリを引き続き機能させることができますDeleteMembership()
メソッドを呼び出します。- 削除するメンバーシップの
name
を渡します。メンバーシップがスペース内の唯一のスペース管理者に属している場合は、このメンバーシップを削除する前に、別のユーザーをスペース管理者として割り当てます。
ユーザー認証でメンバーシップを削除する方法は次のとおりです。
Node.js
このサンプルを実行するには、次のように置き換えます。
SPACE_NAME
: スペースの IDname
。 ID は、ListSpaces()
メソッドを呼び出すか、スペースの URL から取得できます。MEMBER_NAME
: メンバーのname
の ID。ID を取得するには、ListMemberships()
メソッドを呼び出します。
成功すると、レスポンスの本文ではメンバーシップと
'state': 'NOT_A_MEMBER'
は、メンバーがスペースからなくなったことを示します。
{ "name": "spaces/SPACE_NAME/members/MEMBER_NAME", "state": "NOT_A_MEMBER" }
Chat アプリとしてスペースからメンバーを削除する
アプリの認証にはワンタイム認証が必要です 管理者の承認が必要です。
アプリ認証を使用してスペースからユーザー、Google グループ、Chat アプリを削除するには、リクエストで次の情報を渡します。
chat.app.memberships
認可スコープを指定します。スペースの管理者のメンバーシップの削除は、Chat アプリによって作成されたスペースでのみサポートされています。membership
リソースでdelete
メソッドを呼び出します。- 削除するメンバーシップの
name
を渡します。メンバーシップが スペースの管理者のみにするには、スペースの管理者を このメンバーシップを削除しています。
API キーを作成する
デベロッパー プレビュー版 API メソッドを呼び出すには、API 検出ドキュメントの非公開のデベロッパー プレビュー版を使用する必要があります。リクエストを認証するには、API キーを渡す必要があります。
API キーを作成するには、アプリの Google Cloud プロジェクトを開き、次の手順を行います。
- Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。
- [認証情報を作成] > をクリックします。 API キー。
- 新しい API キーが表示されます。
- コピーアイコン をクリックします。 を使用して、アプリのコードで使用する API キーをコピーできます。API キーは、プロジェクトの認証情報の [API キー] セクションでも確認できます。
- [キーを制限] をクリックして、詳細設定を更新し、API キーの使用を制限します。詳細については、API キーの制限を適用するをご覧ください。
Chat API を呼び出すスクリプトを作成する
アプリ認証でメンバーシップを削除する手順は次のとおりです。
Python
- 作業ディレクトリに、
chat_membership_delete_app.py
という名前のファイルを作成します。 chat_membership_delete_app.py
に次のコードを含めます。from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships"] def main(): ''' Authenticates with Chat API using app authentication, then deletes the specified membership. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().members().delete( # The membership to delete. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBER with a membership name. # Obtain the membership name from the memberships resource of # Chat API. To delete a Chat app's membership, replace MEMBER # with app; an alias for the app calling the API. name='spaces/SPACE/members/MEMBER' ).execute() # Print Chat API's response in your command line interface. # When deleting a membership, the response body is empty. print(result) if __name__ == '__main__': main()
コードで、次のように置き換えます。
API_KEY
: ビルド用に作成した API キー サービス エンドポイントとして機能します。SPACE
: スペース名。Chat API のspaces.list
メソッドまたはスペースの URL から取得できます。MEMBER
: メンバーシップ名。取得して取得できます。spaces.members.list
メソッドから 使用します。アプリのメンバーシップを削除するには、MEMBER
をapp
に置き換えます。
作業ディレクトリでサンプルをビルドして実行します。
python3 chat_membership_delete_app.py
成功すると、レスポンスの本文ではメンバーシップと
'state': 'NOT_A_MEMBER'
は、メンバーがスペースからなくなったことを示します。
{ "name": "spaces/SPACE/members/MEMBER", "state": "NOT_A_MEMBER" }
制限事項と考慮事項
- アプリの認証では、 Chat アプリでユーザーを削除することはできますが、Google グループを削除することはできません。
Google Workspace 管理者としてスペースからユーザーまたは Google グループを削除する
Google Workspace 管理者は、DeleteMembership()
メソッドを呼び出して、Google Workspace 組織内の任意のスペースからユーザー、Google グループ、Chat アプリを削除できます。
Google Workspace 管理者としてこのメソッドを呼び出す手順は次のとおりです。
- ユーザー認証を使用してメソッドを呼び出し、管理者権限を使用してメソッドの呼び出しをサポートする認可スコープを指定します。
- リクエストで、クエリ パラメータ
useAdminAccess
をtrue
に指定します。
詳細と例については、Google Workspace 管理者として Google Chat スペースを管理するをご覧ください。
関連トピック
- ユーザーまたは Chat アプリのメンバーシップに関する詳細情報を取得する。
- スペースのメンバーを一覧表示する
- Google Chat スペースでユーザーのメンバーシップを更新する。
- ユーザーや Chat アプリをスペースに招待または追加する。