スペースからメンバーを削除する

このガイドでは、Google Chat API の Membership リソースの delete() メソッドを使用して、スペースからメンバーを削除する方法（メンバーシップの削除）について説明します。スペースの管理者がスペース内の唯一の管理者である場合、その管理者は削除できません。これらのメンバーシップを削除する前に、スペースの管理者として別のユーザーを割り当てます。

Google Workspace 管理者は、Google Workspace 組織内の任意のスペースからユーザー、Google グループ、Chat アプリを削除できます。

Membership リソースは、人間のユーザーまたは Google Chat アプリがスペースに招待されているか、スペースに参加しているか、スペースに含まれていないかを表します。

前提条件

Node.js

ユーザーとしてスペースからメンバーを削除する

ユーザー認証を使用してスペースからユーザー、Google グループ、Chat アプリを削除するには、リクエストで次の情報を渡します。

  • chat.memberships 認可スコープを指定します。承認ユーザーには、スペースからユーザーまたは Google グループを削除する権限が必要です。Chat アプリを削除するには、chat.memberships.app 認可スコープを指定します（アプリは自分のメンバーシップのみを削除できます。他のアプリのメンバーシップは削除できません）。ベスト プラクティスとして、アプリが機能できる最も制限の厳しいスコープを選択することをおすすめします。
  • DeleteMembership() メソッドを呼び出します。
  • 削除するメンバーシップの name を渡します。メンバーシップがスペース内の唯一のスペース管理者に属している場合は、このメンバーシップを削除する前に、別のユーザーをスペース管理者として割り当てます。

ユーザー認証でメンバーシップを削除する方法は次のとおりです。

Node.js

chat/client-libraries/cloud/delete-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.delete'];

// This sample shows how to delete a space with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    name: 'spaces/SPACE_NAME'
  };

  // Make the request
  const response = await chatClient.deleteSpace(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

このサンプルを実行するには、次のように置き換えます。

  • SPACE_NAME: スペースの name の ID。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 アプリとしてスペースからメンバーを削除する

アプリの認証には、1 回限りの管理者の承認が必要です。

アプリ認証を使用してスペースからユーザー、Google グループ、Chat アプリを削除するには、リクエストで次の情報を渡します。

  • chat.app.memberships 認可スコープを指定します。スペースの管理者のメンバーシップの削除は、Chat アプリによって作成されたスペースでのみサポートされています。
  • membership リソースで delete メソッドを呼び出します。
  • 削除するメンバーシップの name を渡します。メンバーシップがスペース内の唯一のスペース管理者に属している場合は、このメンバーシップを削除する前に、別のユーザーをスペース管理者として割り当てます。

API キーを作成する

デベロッパー プレビュー版 API メソッドを呼び出すには、API 検出ドキュメントの非公開のデベロッパー プレビュー版を使用する必要があります。リクエストを認証するには、API キーを渡す必要があります。

API キーを作成するには、アプリの Google Cloud プロジェクトを開いて次の操作を行います。

  1. Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。

    [認証情報] に移動

  2. [認証情報を作成] > [API キー] をクリックします。
  3. 新しい API キーが表示されます。
    • [コピー] をクリックして、アプリのコードで使用する API キーをコピーします。API キーは、プロジェクトの認証情報の [API キー] セクションでも確認できます。
    • [キーを制限] をクリックして、詳細設定を更新し、API キーの使用を制限します。詳細については、API キーの制限を適用するをご覧ください。

Chat API を呼び出すスクリプトを作成する

アプリ認証でメンバーシップを削除する手順は次のとおりです。

Python

  1. 作業ディレクトリに chat_membership_delete_app.py という名前のファイルを作成します。

  2. 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()

  3. コードで、次のように置き換えます。

    • API_KEY: Chat API のサービス エンドポイントを構築するために作成した API キー。

    • SPACE: スペース名。Chat API の spaces.list メソッドまたはスペースの URL から取得できます。

    • MEMBER: メンバーシップ名。Chat API の spaces.members.list メソッドから取得できます。アプリのメンバーシップを削除するには、MEMBER を app に置き換えます。

  4. 作業ディレクトリで、サンプルをビルドして実行します。

    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 スペースを管理するをご覧ください。