Method: customEmojis.list

列出向已通过身份验证的用户显示的自定义表情符号。

自定义表情符号仅适用于 Google Workspace 账号，并且管理员必须为组织启用自定义表情符号。如需了解详情，请参阅了解 Google Chat 中的自定义表情符号和管理自定义表情符号权限。

需要用户身份验证，并具有以下某个授权范围：

  • https://www.googleapis.com/auth/chat.customemojis.readonly
  • https://www.googleapis.com/auth/chat.customemojis

HTTP 请求

GET https://chat.googleapis.com/v1/customEmojis

网址采用 gRPC 转码语法。

查询参数

参数
pageSize

integer

可选。返回的自定义表情符号的数量上限。服务返回的自定义表情符号数量可能会少于此值。如果未指定，则默认值为 25。最大值为 200；大于 200 的值会更改为 200。
pageToken

string

可选。（如果从上一个查询继续）。

从上一个列出自定义表情符号的调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，过滤条件值应与提供页面令牌的调用相一致。传递其他值可能会导致意外结果。
filter

string

可选。查询过滤条件。

支持按创作者过滤。

如需按创作者过滤，您必须指定有效的值。目前，只有 creator("users/me") 和 NOT creator("users/me") 支持按自定义表情符号是否由发起通话的用户创建进行过滤。

例如，以下查询会返回调用方创建的自定义表情符号：

creator("users/me")

无效查询会被拒绝并显示 INVALID_ARGUMENT 错误。

请求正文

请求正文必须为空。

响应正文

用于列出自定义表情符号的响应。

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

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

object (CustomEmoji)

无序列表。自定义表情符号列表。
nextPageToken

string

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

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

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