此页面由 Cloud Translation API 翻译。

获取有关聊天室的详细信息

本指南介绍了如何对 Google Chat API 的 Space 资源使用 get() 方法，以查看聊天室的详细信息，例如显示名称、说明和准则。

如果您是 Google Workspace 管理员，则可以调用 get() 方法来检索 Google Workspace 组织中任何聊天室的详细信息。

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

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

通过应用身份验证进行身份验证后，Chat 应用可以获取其是成员的聊天室的详细信息。通过用户身份验证进行身份验证后，您可以获取经过身份验证的用户（作为聊天室成员或 Google Workspace 管理员）有权访问的聊天室。

前提条件

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 应用进行身份验证，选择授权范围。

已通过身份验证的用户或发起调用的 Chat 应用所属的 Google Chat 聊天室。如需以 Chat 应用的身份进行身份验证，请将 Chat 应用添加到聊天室。

Python

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

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

一个 Google Chat 聊天室，其中经过身份验证的用户或发起调用的 Chat 应用是该聊天室的成员。如需以 Chat 应用的身份进行身份验证，请将 Chat 应用添加到聊天室。

Java

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

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

一个 Google Chat 聊天室，其中经过身份验证的用户或发起调用的 Chat 应用是该聊天室的成员。如需以 Chat 应用的身份进行身份验证，请将 Chat 应用添加到聊天室。

Apps 脚本

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

设置环境：
- 创建 Google Cloud 项目。
- 配置 OAuth 权限请求页面。
- 为您的 Chat 应用启用和配置 Google Chat API，并为其指定一个名称、图标和说明。
- 创建一个独立的 Apps 脚本项目，然后开启高级聊天服务。
- 在本指南中，您必须使用用户身份验证或应用身份验证。如需以 Chat 应用的身份进行身份验证，请创建服务账号凭据。如需了解具体步骤，请参阅以 Google Chat 应用身份进行身份验证和授权。
根据您是要以用户身份还是以 Chat 应用的身份进行身份验证，选择授权范围。

已通过身份验证的用户或发起调用的 Chat 应用所属的 Google Chat 聊天室。如需以 Chat 应用的身份进行身份验证，请将 Chat 应用添加到聊天室。

获取聊天室

如需在 Google Chat 中获取聊天室，请在请求中传递以下内容：

授权范围：
- 使用用户身份验证时，请指定 chat.spaces.readonly 或 chat.spaces 授权范围。
- 使用应用身份验证时，请指定 chat.bot 授权范围或 chat.app.spaces 范围。chat.app.spaces 范围在开发者预览版中提供，需要一次性管理员批准。
调用 GetSpace() 方法，并传递要获取的空间的 name。请从 Google Chat 的 Space 资源或聊天室的网址获取聊天室名称。

以用户身份获取聊天室详情

下面展示了如何通过用户身份验证获取空间详情：

Node.js

chat/client-libraries/cloud/get-space-user-cred.js

在 GitHub 上查看

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

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

// This sample shows how to get 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.getSpace(request);

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

main().catch(console.error);

Python

chat/client-libraries/cloud/get_space_user_cred.py

在 GitHub 上查看

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.readonly"]

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

    # Initialize request argument(s)
    request = google_chat.GetSpaceRequest(
        # Replace SPACE_NAME here
        name = "spaces/SPACE_NAME",
    )

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

    # Handle the response
    print(response)

get_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetSpaceUserCred.java

在 GitHub 上查看

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to get space with user credential.
public class GetSpaceUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      GetSpaceRequest.Builder request = GetSpaceRequest.newBuilder()
        // Replace SPACE_NAME here
        .setName("spaces/SPACE_NAME");
      Space response = chatServiceClient.getSpace(request.build());

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

Apps 脚本

chat/advanced-service/Main.gs

在 GitHub 上查看

/**
 * This sample shows how to get space with user credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function getSpaceUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = 'spaces/SPACE_NAME';

  // Make the request
  const response = Chat.Spaces.get(name);

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

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

Chat API 会返回一个 Space 实例，其中详细介绍了指定聊天室。

以 Google Workspace 管理员的身份获取聊天室详细信息

如果您是 Google Workspace 管理员，则可以调用 GetSpace 方法来检索 Google Workspace 组织中任何聊天室的详细信息。

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

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

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

以 Chat 应用的形式获取聊天室详细信息

下面展示了如何通过应用身份验证获取空间详情：

Node.js

chat/client-libraries/cloud/get-space-app-cred.js

在 GitHub 上查看

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

// This sample shows how to get space with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

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

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/get_space_app_cred.py

在 GitHub 上查看

from authentication_utils import create_client_with_app_credentials
from google.apps import chat_v1 as google_chat

# This sample shows how to get space with app credential
def get_space_with_app_cred():
    # Create a client
    client = create_client_with_app_credentials()

    # Initialize request argument(s)
    request = google_chat.GetSpaceRequest(
        # Replace SPACE_NAME here
        name = "spaces/SPACE_NAME",
    )

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

    # Handle the response
    print(response)

get_space_with_app_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/GetSpaceAppCred.java

在 GitHub 上查看

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.GetSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to get space with app credential.
public class GetSpaceAppCred {

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithAppCredentials()) {
      GetSpaceRequest.Builder request = GetSpaceRequest.newBuilder()
        // Replace SPACE_NAME here
        .setName("spaces/SPACE_NAME");
      Space response = chatServiceClient.getSpace(request.build());

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

Apps 脚本

chat/advanced-service/Main.gs

在 GitHub 上查看

/**
 * This sample shows how to get space with app credential
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.bot'
 * used by service accounts.
 */
function getSpaceAppCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const name = 'spaces/SPACE_NAME';
  const parameters = {};

  // Make the request
  const response = Chat.Spaces.get(name, parameters, getHeaderWithAppCredentials());

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

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

Chat API 会返回一个 Space 实例，其中详细说明了指定聊天室。

获取有关聊天室的详细信息

前提条件

Node.js

Python

Java

Apps 脚本

获取聊天室

以用户身份获取聊天室详情

Node.js

Python

Java

Apps 脚本

以 Google Workspace 管理员的身份获取聊天室详细信息

以 Chat 应用的形式获取聊天室详细信息

Node.js

Python

Java

Apps 脚本

相关主题