Method: spaces.messagePins.list

列出聊天室中的消息固定内容。用户可以在聊天室中固定重要消息，以便轻松访问。如需了解详情，请参阅在 Google Chat 中固定或取消固定对话。

需要使用以下某个授权范围进行用户身份验证：

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

HTTP 请求

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messagePins

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。拥有固定项集合的父空间。格式：spaces/{space}

查询参数

参数
pageSize

integer

可选。返回的消息固定数量上限。服务返回的消息数量可能少于此值。最大值为 100。如果您使用的值超过 100，系统会自动将其更改为 100。如果未指定，则最多返回 100 条消息固定。负值会返回 INVALID_ARGUMENT 错误。
pageToken

string

可选。从之前的“列出消息固定”调用中收到的页面令牌。提供此参数可检索后续页面。

进行分页时，提供的所有其他参数应与提供页面令牌的调用相一致。向其他参数传递不同的值可能会导致意外结果。

请求正文

请求正文必须为空。

响应正文

用于列出消息固定内容的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "messagePins": [
    {
      object (MessagePin)
    }
  ],
  "nextPageToken": string
}
字段
messagePins[]

object (MessagePin)

指定聊天室中的已固定消息。
nextPageToken

string

您可以发送令牌作为 pageToken 来检索下一页结果。如果为空，则表示没有后续页面。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

如需了解详情，请参阅授权指南。