更新聊天室

本指南将介绍如何使用 patch() 方法（针对 Google Chat API 的 Space 资源）来更新聊天室。更新聊天室可更改聊天室的相关属性，例如面向用户显示的显示名称、说明和准则。

如果您是 Google Workspace 管理员，则可以调用 patch() 方法 更新 Google Workspace 组织中的任何现有聊天室。

通过 Space 资源 代表用户和 Chat 扩展应用能够发送消息的位置， 共享文件和协作聊天室分为以下几种类型：

  • 私信 (DM) 是指两位用户或一位用户与 Chat 应用。
  • 群组聊天是指三人或更多用户与 Chat 应用之间的对话。
  • 命名聊天室是用户发送消息、共享文件和协作的永久性场所。

前提条件

Node.js

  • Google Chat 聊天室。如需使用 Google Chat API 创建聊天室，请参阅创建聊天室。要在 Chat 中创建账号，请按以下步骤操作： 请访问 帮助中心文档。

Python

Java

Apps 脚本

  • Google Chat 聊天室。要使用 Google Chat API 创建一个，请参阅 创建聊天室。要在 Chat 中创建账号，请按以下步骤操作： 请访问 帮助中心文档。

以用户身份更新聊天室

如要更新 Google Chat 中的现有聊天室，请按以下步骤操作： 用户身份验证，通过 在您的请求中：

  • 指定 chat.spaces 授权范围。
  • 调用 UpdateSpace() 方法。在请求中，您需要指定聊天室 name 字段，即 updateMask 字段，其中包含一个或多个要更新的字段，以及一个包含更新后的空格的 body 信息。

您可以更新显示名称、聊天室类型、历史记录状态等。要查看您可以更新的所有字段，请参阅 参考文档。

以下是更新现有聊天室的 displayName 字段的方法：

Node.js

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

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

// This sample shows how to update 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 = {
    space: {
      // Replace SPACE_NAME here
      name: 'spaces/SPACE_NAME',
      displayName: 'New space display name'
    },
    // The field paths to update. Separate multiple values with commas or use
    // `*` to update all field paths.
    updateMask: {
      // The field paths to update.
      paths: ['display_name']
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/update_space_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.spaces"]

# This sample shows how to update a space with user credential
def update_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.UpdateSpaceRequest(
        space = {
            # Replace SPACE_NAME here
            'name': 'spaces/SPACE_NAME',
            'display_name': 'New space display name'
        },
        # The field paths to update. Separate multiple values with commas.
        update_mask = 'displayName'
    )

    # Make the request
    response = client.update_space(request)

    # Handle the response
    print(response)

update_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/UpdateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.UpdateSpaceRequest;
import com.google.chat.v1.Space;
import com.google.protobuf.FieldMask;

// This sample shows how to update space with user credential.
public class UpdateSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      UpdateSpaceRequest.Builder request = UpdateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          // Replace SPACE_NAME here.
          .setName("spaces/SPACE_NAME")
          .setDisplayName("New space display name"))
        .setUpdateMask(FieldMask.newBuilder()
          // The field paths to update.
          .addPaths("display_name"));
      Space response = chatServiceClient.updateSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps 脚本

chat/advanced-service/Main.gs
/**
 * This sample shows how to update a space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces'
 * referenced in the manifest file (appsscript.json).
 */
function updateSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = 'spaces/SPACE_NAME';
  const space = {
    displayName: 'New space display name'
  };
  // The field paths to update. Separate multiple values with commas or use
  // `*` to update all field paths.
  const updateMask = 'displayName';

  // Make the request
  const response = Chat.Spaces.patch(space, name, {
    updateMask: updateMask
  });

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

如需运行此示例，请将 SPACE_NAME 替换为 空间的 name 字段。您可以通过调用 ListSpaces() 方法或从聊天室的网址中获取 ID。

Google Chat API 会返回反映更新的 Space 实例。

以 Google Workspace 管理员的身份更新聊天室

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

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

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

有关详情和示例，请参阅 以 Google Workspace 管理员的身份管理 Google Chat 聊天室。

将聊天室更新为 Chat 扩展应用

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

如要更新 Google Chat 中的现有聊天室，请按以下步骤操作： 应用身份验证， 请在请求中传递以下内容：

  • 指定 chat.app.spaces 授权范围。 通过应用身份验证，您只能更新所创建的聊天室 。
  • 调用 patch 方法 针对 Space 资源。在请求中，您需要指定聊天室 name 字段、包含要更新的一个或多个字段的 updateMask 字段，以及包含更新后的聊天室信息的 body。

你可以更新显示名称、聊天室类型、聊天记录状态、 权限设置等。如需查看您可以更新的所有字段，请参阅参考文档。

创建 API 密钥

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

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

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

    进入“凭据”页面

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

编写调用 Chat API 的脚本

以下是更新现有聊天室的 spaceDetails 字段的方法：

Python

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

  2. 在 chat_space_update_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.spaces"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then updates the specified space description and guidelines.
    '''

    # 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().patch(

      # The space to update, and the updated space details.
      #
      # Replace {space} with a space name.
      # Obtain the space name from the spaces resource of Chat API,
      # or from a space's URL.
      name='spaces/SPACE',
      updateMask='spaceDetails',
      body={

        'spaceDetails': {
          'description': 'This description was updated with Chat API!',
          'guidelines': 'These guidelines were updated with Chat API!'
        }

      }

    ).execute()

    # Prints details about the updated space.
    print(result)

if __name__ == '__main__':
    main()

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

    • API_KEY：您为了构建作业而创建的 API 密钥 Chat API 的服务端点。
    • 将 SPACE 替换为聊天室名称， 您可以从 spaces.list 方法 或通过聊天室网址发送。

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

    python3 chat_space_update_app.py

Google Chat API 会返回 Space 资源，反映了 更新。