从聊天室中移除成员

本指南介绍了如何对 Google Chat API 的 Membership 资源使用 delete() 方法从聊天室中移除成员，也称为删除成员资格。如果聊天室管理员是聊天室中的唯一管理员，则无法将其移除。请先将其他用户指定为聊天室管理员，然后再移除这些成员资格。

如果您是 Google Workspace 管理员，则可以从 Google Workspace 组织中的任何聊天室中移除用户、Google 群组或 Chat 应用。

Membership 资源表示有人为用户或 Google Chat 应用发出了加入聊天室的邀请、用户或 Google Chat 应用已加入聊天室，还是未加入聊天室。

前提条件

Node.js

  • Google Chat 聊天室。如需使用 Google Chat API 创建聊天室，请参阅创建聊天室。如需在 Chat 中创建聊天室，请参阅帮助中心文档。

以用户的身份从聊天室中移除成员

如需从启用了用户身份验证的聊天室中移除用户、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。您可以通过调用 ListSpaces() 方法或从聊天室的网址获取该 ID。
  • MEMBER_NAME：成员 name 中的 ID。您可以通过调用 ListMemberships() 方法来获取 ID。

如果成功，响应正文会返回包含 '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 项目，然后执行以下操作：

  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 方法或聊天室的网址获取该名称。

    • 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 聊天室。