创建聊天室

本指南介绍了如何对 Google Chat API 的 Space 资源使用 create() 方法创建命名聊天室。

Space 资源表示用户和 Chat 应用可以发送消息、共享文件和协作的场所。聊天室有以下几种类型：

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

命名聊天室是用户发送消息、共享文件和协作的地方。命名聊天室可以包含 Chat 应用。已命名聊天室包含未命名群组对话和私信所不具备的额外功能，例如可以应用管理设置的聊天室管理员、说明以及添加或移除人员和应用。创建命名聊天室后，该聊天室的唯一成员就是经过身份验证的用户。该聊天室不包含其他用户或应用，甚至不包含创建它的 Chat 应用。如需向聊天室添加成员，请参阅创建成员资格。

如需创建包含多个成员的已命名聊天室（三人或更多人之间的未命名群聊、两人之间的私信对话，或一个人和调用 Chat API 的 Chat 应用），请改为设置聊天室。

前提条件

Node.js

Python

Java

Apps 脚本

以用户身份创建命名空间

如需使用用户身份验证创建命名空间，请在请求中传递以下内容：

  • 指定 chat.spaces.create 或 chat.spaces 授权范围。
  • 调用 CreateSpace() 方法，将 space 作为 Space 的实例传递，并包含以下字段：
    • 将spaceType设置成了 SPACE。
    • displayName 设置为聊天室的用户可见名称。
    • （可选）设置其他属性，例如：
      • spaceDetails - 聊天室的用户可见说明和一组指南。
      • predefinedPermissionSettings - 聊天室的预定义权限。 例如，您可以将其配置为允许所有成员或仅允许聊天室管理员发布消息。

以下是创建命名空间的方法：

Node.js

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

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

// This sample shows how to create a named 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: {
      spaceType: 'SPACE',
      // Replace DISPLAY_NAME here.
      displayName: 'DISPLAY_NAME'
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/create_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.create"]

def create_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        }
    )

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

    # Handle the response
    print(response)

create_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to create space with user credential.
public class CreateSpaceUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateSpaceRequest.Builder request = CreateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"));
      Space response = chatServiceClient.createSpace(request.build());

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

Apps 脚本

chat/advanced-service/Main.gs
/**
 * This sample shows how to create space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.create'
 * referenced in the manifest file (appsscript.json).
 */
function createSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };

  // Make the request
  const response = Chat.Spaces.create(space);

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

将命名聊天室创建为 Chat 应用

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

如需使用应用身份验证功能将用户邀请或添加到聊天室，请在请求中传递以下内容：

  • 指定 chat.app.spaces.create 或 chat.app.spaces 授权范围。
  • 对 Space 资源调用 create 方法。
  • 将 spaceType 设置为 SPACE。
  • 将 displayName 设置为聊天室的用户可见名称。在以下示例中，displayName 设置为 API-made。
  • 使用 customer 字段指定 Google Workspace 网域的客户 ID。
  • （可选）设置其他聊天室属性，例如 spaceDetails（面向用户显示的说明和一组聊天室准则）。

创建 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_space_create_named_app.py 的文件。

  2. 在 chat_space_create_named_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.create"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then creates a Chat space.
    '''

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

      # Details about the space to create.
      body = {

        # To create a named space, set spaceType to SPACE.
        'spaceType': 'SPACE',

        # The user-visible name of the space.
        'displayName': 'API-made',

        # The customer ID of the Workspace domain.
        'customer': 'CUSTOMER'
      }

      ).execute()

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

if __name__ == '__main__':
    main()

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

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

    • CUSTOMER：聊天室网域的客户 ID，格式为 customer/{customer}，其中 {customer} 是 Admin SDK 客户资源中的 ID。如需在 Chat 应用所属的 Google Workspace 组织中创建聊天室，请使用 customers/my_customer。

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

    python3 chat_space_create_named_app.py

在 Google Chat 中打开聊天室

如需前往相应聊天室，请使用聊天室的资源 ID 构建聊天室的网址。您可以在 Google Chat 响应正文中找到聊天室 name 的资源 ID。例如，如果聊天室的 name 为 spaces/1234567，您可以使用以下网址前往该聊天室：https://mail.google.com/chat/u/0/#chat/space/1234567。