此页面由 Cloud Translation API 翻译。

列出聊天室

本指南介绍了如何使用 Google Chat API 的 Space 资源中的 list 资源列出聊天室。列出聊天室会返回一个分页且可过滤的聊天室列表。

Space 资源代表用户和 Chat 应用可以发送消息、共享文件以及开展协作的地方。聊天室分为以下几种类型：

私信 (DM) 是两位用户或一位用户与一个 Chat 应用之间的对话。
群聊是指三个或更多用户与 Chat 应用之间的对话。
已命名聊天室是用户在其中发送消息、共享文件和开展协作的永久性位置。

使用应用身份验证列出聊天室时，系统会列出 Chat 应用有权访问的聊天室。使用用户身份验证功能列出空间时，系统会列出经过身份验证的用户有权访问的空间。

前提条件

Python

Python 3.6 或更高版本
pip 软件包管理工具
适用于 Python 的最新 Google 客户端库。如需安装或更新它们，请在命令行界面中运行以下命令：
```
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
```
一个启用了并配置了 Google Chat API 的 Google Cloud 项目。如需了解相关步骤，请参阅构建 Google Chat 应用。
为 Chat 应用配置授权。列表聊天室支持以下两种身份验证方法：
- 具有 chat.spaces.readonly 或 chat.spaces 授权范围的用户身份验证。
- 具有 chat.bot 授权范围的应用身份验证。

Node.js

Node.js 和 npm
适用于 Node.js 的最新 Google 客户端库。如需安装这些软件包，请在命令行界面中运行以下命令：
```
npm install @google-cloud/local-auth @googleapis/chat
```
一个启用了并配置了 Google Chat API 的 Google Cloud 项目。如需了解相关步骤，请参阅构建 Google Chat 应用。
为 Chat 应用配置授权。列表聊天室支持以下两种身份验证方法：
- 具有 chat.spaces.readonly 或 chat.spaces 授权范围的用户身份验证。
- 具有 chat.bot 授权范围的应用身份验证。

列出需要用户验证身份的聊天室

如需列出 Google Chat 中的聊天室，请在请求中传递以下内容：

使用用户身份验证时，请指定 chat.spaces.readonly 或 chat.spaces 授权范围。
对 Space 资源调用 list 方法。

以下示例列出了经过身份验证的用户可以看到的已命名聊天室和群聊（但不包括被滤除的私信）：

Python

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

在 chat_space_list.py 中添加以下代码：

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.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.spaces.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists named spaces and group chats (but not direct messages)
    visible to the authenticated user.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().list(

          # An optional filter that returns named spaces or unnamed group chats,
          # but not direct messages (DMs).
          filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'

      ).execute()

    # Prints the returned list of spaces.
    print(result)

if __name__ == '__main__':
    main()

在您的工作目录中，构建并运行示例：
```
python3 chat_space_list.py
```

Node.js

在您的工作目录中，创建一个名为 list-spaces.js 的文件。

在 list-spaces.js 中添加以下代码：

const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* List Chat spaces.
* @return {!Promise<!Object>}
*/
async function listSpaces() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.spaces.readonly',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.list({
    filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
  });
}

listSpaces().then(console.log);

在您的工作目录中，运行示例：
```
node list-spaces.js
```

Chat API 会返回已命名的聊天室和群聊的分页数组。

列出采用应用身份验证的聊天室

如需列出 Google Chat 中的聊天室，请在请求中传递以下内容：

使用应用身份验证时，请指定 chat.bot 授权范围。
对 Space 资源调用 list 方法。

以下示例列出了对 Chat 应用可见的已命名聊天室和群聊（但不包括私信）：

Python

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

在 chat_space_list_app.py 中添加以下代码：

from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Use the service endpoint to call Chat API.
result = chat.spaces().list(

        # An optional filter that returns named spaces or unnamed
        # group chats, but not direct messages (DMs).
        filter='spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'

    ).execute()

print(result)

在您的工作目录中，构建并运行示例：
```
python3 chat_space_list_app.py
```

Node.js

在您的工作目录中，创建一个名为 app-list-spaces.js 的文件。

在 app-list-spaces.js 中添加以下代码：

const chat = require('@googleapis/chat');

/**
* List Chat spaces.
* @return {!Promise<!Object>}
*/
async function listSpaces() {
  const scopes = [
    'https://www.googleapis.com/auth/chat.bot',
  ];

  const auth = new chat.auth.GoogleAuth({
    scopes,
    keyFilename: 'credentials.json',
  });

  const authClient = await auth.getClient();

  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  return await chatClient.spaces.list({
    filter: 'spaceType = "SPACE" OR spaceType = "GROUP_CHAT"'
  });
}

listSpaces().then(console.log);

在您的工作目录中，运行示例：
```
node app-list-spaces.js
```

Chat API 会返回分页的聊天室数组。

自定义分页或过滤列表

如需列出 Google Chat 中的聊天室，请传递以下可选查询参数，以自定义所列出的聊天室的分页或过滤所列出的聊天室：

pageSize：要返回的空格数量上限。服务返回的值可能会少于此值。如果未指定，则最多返回 100 个空格。最大值为 1,000；大于 1,000 的值将自动更改为 1,000。
pageToken：从上一个列表空间调用收到的页面令牌。提供此令牌即可检索后续页面。进行分页时，过滤条件值应与提供页面令牌的调用相匹配。传递其他值可能会导致意外结果。
filter：查询过滤条件。如需详细了解受支持的查询，请参阅 spaces.list 方法。

列出聊天室

前提条件

Python

Node.js

列出需要用户验证身份的聊天室

Python

Node.js

列出采用应用身份验证的聊天室

Python

Node.js

自定义分页或过滤列表

相关主题