Method: customEmojis.list
列出通过身份验证的用户可以看到的自定义表情符号。要求进行用户身份验证。
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
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-11-12。
[null,null,["最后更新时间 (UTC):2024-11-12。"],[[["Lists custom emojis visible to the authenticated user, requiring user authentication and specific authorization scopes."],["Allows filtering by creator to see emojis created by the calling user or others."],["Supports pagination to retrieve large lists of custom emojis, with a default page size of 25 and a maximum of 200."],["Returns a list of custom emojis and a token for retrieving subsequent pages if available."],["Requires an empty request body and provides a structured JSON response containing emoji details."]]],["This document details how to list custom emojis in Google Chat via an HTTP GET request to `https://chat.googleapis.com/v1/customEmojis`. The request requires user authentication and supports optional query parameters: `pageSize` (default 25, max 200), `pageToken` (for pagination), and `filter` (to filter by emoji creator). The request body must be empty. The response includes a list of `customEmojis` and an optional `nextPageToken` for pagination. Authorization requires either `chat.customemojis` or `chat.customemojis.readonly` scope.\n"]]