在 Google Chat 聊天室中更新用户的成员资格

本指南介绍了如何对 Google Chat API 的 Membership 资源使用 update() 方法来更改成员资格相关属性，例如将聊天室成员更改为聊天室管理员，或将聊天室管理员更改为聊天室成员。

如果您是 Google Workspace 管理员，则可以调用 update() 方法来更新 Google Workspace 组织中任何聊天室的成员资格。

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

前提条件

Node.js

• 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。

• 设置环境：
  • 创建 Google Cloud 项目。
  • 配置 OAuth 同意屏幕。
  • 启用和配置 Google Chat API，为 Chat 应用提供名称、图标和说明。
  • 安装 Node.js Cloud 客户端库。
  • 根据您要在 Google Chat API 请求中采用的身份验证方式创建访问凭据：
    • 如需以 Chat 用户身份进行身份验证，请创建 OAuth 客户端 ID 凭据，并将凭据保存为名为 client_secrets.json 的 JSON 文件，保存到本地目录中。
    • 如需以 Chat 应用的身份进行身份验证，请创建服务账号凭据，并将凭据保存为名为 credentials.json 的 JSON 文件。
• 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证， 选择授权范围。

本页中的代码示例使用 gRPC API 与 Google Cloud 客户端库交互。或者，您也可以使用 REST API 接口。如需详细了解 gRPC 和 REST 接口，请参阅 Google Chat API 概览。

更新会员资格

如需更新聊天室成员资格，请在请求中传递以下内容：

• 指定授权范围：
  • 使用用户身份验证时，请指定 chat.memberships 授权范围。
  • 使用应用身份验证（开发者预览版中提供）时，请指定 chat.app.memberships 授权范围。使用应用身份验证更新成员资格时，您只能更新 Chat 应用创建的聊天室中的成员资格。应用身份验证需要一次性管理员批准。
• 调用 UpdateMembership() 方法。
• 将 membership 作为 Membership 的实例传递，并加入以下代码：
  • name 字段设置为要更新的成员资格，其中包含聊天室 ID 和成员 ID。
  • 将要更新的会员资格字段设置为新值。
• 传递 updateMask 以指定要更新的会员资格方面，其中包括：
  • role：用户在 Chat 聊天室中的角色，决定了他们在聊天室中可以执行的操作。可能的值包括：
    • ROLE_MEMBER：聊天室成员。用户拥有基本权限，例如向聊天室发送消息。在 1 对 1 对话和未命名的群组对话中，所有人都有此角色。
    • ROLE_MANAGER：聊天室管理员。用户拥有所有基本权限，外加可管理空间的管理员权限，例如添加或移除成员。仅在 spaceType 为 SPACE（命名聊天室）的聊天室中受支持。

以用户身份将普通聊天室成员设为聊天室管理员

以下示例使用用户身份验证调用 Chat API，通过将 role 指定为 ROLE_MANAGER 将常规聊天室成员设为聊天室管理员：

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js

在 GitHub 上查看

import {createClientWithUserCredentials} from './authentication-utils.js';

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

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

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

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

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

main().catch(console.error);

如需运行该示例，请替换以下内容：

• SPACE_NAME：聊天室的 name 中的 ID。您可以通过调用 ListSpaces() 方法或从聊天室的网址中获取 ID。
• MEMBER_NAME：会员资格的 name 中的 ID。您可以通过调用 ListMemberships() 方法来获取 ID，也可以从使用 Chat API 异步创建会员资格后返回的响应正文中获取 ID。
• ROLE_NAME：更新后的角色，ROLE_MANAGER。

Google Chat API 会将指定的成员资格更新为聊天室管理员，并返回 Membership 的实例。

以用户身份将聊天室管理员设为常规成员

以下示例使用用户身份验证调用 Chat API，通过将 role 指定为 ROLE_MEMBER 将聊天室管理员设为常规聊天室成员：

Node.js

chat/client-libraries/cloud/update-membership-user-cred.js

在 GitHub 上查看

import {createClientWithUserCredentials} from './authentication-utils.js';

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

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

  // Initialize request argument(s)
  const request = {
    membership: {
      // Replace SPACE_NAME and MEMBER_NAME here
      name: 'spaces/SPACE_NAME/members/MEMBER_NAME',
      // Replace ROLE_NAME here with ROLE_MEMBER or ROLE_MANAGER
      role: 'ROLE_NAME'
    },
    updateMask: {
      // The field paths to update.
      paths: ['role']
    }
  };

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

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

main().catch(console.error);

如需运行该示例，请替换以下内容：

• SPACE_NAME：聊天室的 name 中的 ID。您可以通过调用 ListSpaces() 方法或从聊天室的网址中获取 ID。
• MEMBER_NAME：成员资格的 name 中的 ID。您可以通过调用 ListMemberships() 方法来获取 ID，也可以从使用 Chat API 异步创建会员资格后返回的响应正文中获取 ID。
• ROLE_NAME：更新后的角色，ROLE_MEMBER。

Google Chat API 会将指定的成员资格更新为聊天室管理员，并返回 Membership 实例。

通过 Chat 应用将普通聊天室成员设为聊天室管理员

开发者预览版：通过 Google Workspace 开发者预览版计划提供，可抢先体验某些功能。

应用身份验证需要一次性管理员批准。

创建 API 密钥

如需调用开发者预览版 API 方法，您必须使用 API 发现文档的非公开开发者预览版。要对请求进行身份验证，您必须传递 API 密钥。

如需创建 API 密钥，请打开应用的 Google Cloud 项目并执行以下操作：

1. 在 Google Cloud 控制台中，依次点击“菜单”图标 > API 和服务 > 凭据。

   进入“凭据”页面

2. 依次点击创建凭据 > API 密钥。
3. 系统会显示您的新 API 密钥。
   • 点击“复制”图标 以复制您的 API 密钥，以便在应用的代码中使用。您也可以在项目凭据的“API 密钥”部分找到该 API 密钥。
   • 点击限制密钥可更新高级设置并限制 API 密钥的使用。如需了解详情，请参阅应用 API 密钥限制。

编写用于调用 Chat API 的脚本

以下示例使用应用身份验证调用 Chat API，通过在 body（指定更新后的成员资格属性）中将 role 指定为 ROLE_MANAGER，将常规聊天室成员设为聊天室管理员：

注意：以下示例使用 REST API 接口与 Google API 客户端库搭配使用，而不是 gRPC API 接口。如需详细了解 gRPC 和 REST 接口，请参阅 Google Chat API 概览。

Python

1. 在您的工作目录中，创建一个名为 chat_membership_update_to_manager_app.py 的文件。

2. 在 chat_membership_update_to_manager_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 updates a specified space member to change
       it from a regular member to a space manager.
       '''
   
       # 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().patch(
   
           # The membership to update, and the updated role.
           #
           # Replace SPACE with a space name.
           # Obtain the space name from the spaces resource of Chat API,
           # or from a space's URL.
           #
           # Replace MEMBERSHIP with a membership name.
           # Obtain the membership name from the membership of Chat API.
           name='spaces/SPACE/members/MEMBERSHIP',
           updateMask='role',
           body={'role': 'ROLE_MANAGER'}
   
         ).execute()
   
       # Prints details about the updated membership.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. 在代码中进行以下替换：

   • API_KEY：您创建的用于构建 Chat API 服务端点的 API 密钥。

   • SPACE：聊天室名称，您可以通过 Chat API 中的 spaces.list 方法或聊天室的网址获取该名称。

   • MEMBERSHIP：会员名称，您可以通过 Chat API 中的 spaces.members.list 方法获取。

4. 在您的工作目录中，构建并运行该示例：

   python3 chat_membership_update_to_manager_app.py

将聊天室管理员设为 Chat 应用的常规成员

开发者预览版：通过 Google Workspace 开发者预览版计划提供，可抢先体验某些功能。

应用身份验证需要一次性管理员批准。

创建 API 密钥

如需调用开发者预览版 API 方法，您必须使用 API 发现文档的非公开开发者预览版。要对请求进行身份验证，您必须传递 API 密钥。

如需创建 API 密钥，请打开应用的 Google Cloud 项目并执行以下操作：

1. 在 Google Cloud 控制台中，依次选择“菜单”图标 > API 和服务> 凭据。

   进入“凭据”页面

2. 依次点击创建凭据 > API 密钥。
3. 系统会显示您的新 API 密钥。
   • 点击“复制”图标 以复制您的 API 密钥，以便在应用的代码中使用。您也可以在项目凭据的“API 密钥”部分找到该 API 密钥。
   • 点击限制密钥可更新高级设置并限制 API 密钥的使用。如需了解详情，请参阅应用 API 密钥限制。

编写用于调用 Chat API 的脚本

以下示例使用应用身份验证调用 Chat API，通过在指定更新后的成员资格属性的 body 中将 role 指定为 ROLE_MEMBER，将聊天室管理员设为常规聊天室成员：

注意：以下示例使用 REST API 接口与 Google API 客户端库搭配使用，而不是 gRPC API 接口。如需详细了解 gRPC 和 REST 接口，请参阅 Google Chat API 概览。

Python

1. 在工作目录中，创建一个名为 chat_membership_update_to_member_app.py 的文件。

2. 在 chat_membership_update_to_member_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 via user credentials,
       then updates a specified space member to change
       it from a regular member to a space manager.
       '''
   
       # 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().patch(
   
           # The membership to update, and the updated role.
           #
           # Replace SPACE with a space name.
           # Obtain the space name from the spaces resource of Chat API,
           # or from a space's URL.
           #
           # Replace MEMBERSHIP with a membership name.
           # Obtain the membership name from the membership of Chat API.
           name='spaces/SPACE/members/MEMBERSHIP',
           updateMask='role',
           body={'role': 'ROLE_MEMBER'}
   
         ).execute()
   
       # Prints details about the updated membership.
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. 在代码中，替换以下内容：

   • API_KEY：您为构建 Chat API 服务端点而创建的 API 密钥。

   • SPACE：聊天室名称，您可以通过 Chat API 中的 spaces.list 方法或聊天室的网址获取该名称。

   • MEMBERSHIP：会员名称，您可以通过 Chat API 中的 spaces.members.list 方法获取。

4. 在您的工作目录中，构建并运行该示例：

   python3 chat_membership_update_to_member_app.py

以 Google Workspace 管理员身份更新成员资格

如果您是 Google Workspace 管理员，则可以调用 update() 方法来更新 Google Workspace 组织中任何聊天室的成员资格。

如需以 Google Workspace 管理员身份调用此方法，请执行以下操作：

• 使用用户身份验证调用该方法，并指定支持使用管理员权限调用该方法的授权范围。
• 在请求中，将查询参数 useAdminAccess 指定为 true。

如需了解详情和示例，请参阅以 Google Workspace 管理员身份管理 Google Chat 聊天室。

相关主题

• 邀请或添加用户或 Google Chat 应用到聊天室。
• 获取有关用户或 Chat 应用会员资格的详细信息。
• 列出聊天室中的成员。
• 从聊天室中移除用户或 Chat 应用。