LiveChatModerators: list

列出实时聊天的管理员。该请求必须由实时聊天频道的所有者授权。

常见使用场景

请求

HTTP 请求

GET https://www.googleapis.com/youtube/v3/liveChat/moderators

参数

下表列出了此查询支持的参数。列出的所有参数都是查询参数。

参数
必需参数
liveChatId string
liveChatId 参数用于指定 YouTube 实时聊天(API 应返回该管理员的聊天管理员)。与广播关联的实时聊天 ID 会在 liveBroadcast 资源的 snippet.liveChatId 属性中返回。
part string
part 参数用于指定 API 响应将包含的 liveChatModerator 资源部分。支持的值为 idsnippet
可选参数
maxResults unsigned integer
maxResults 参数用于指定结果集中应返回的最大项数。可接受的值包括050(含 0 和 5000)。默认值为 5
pageToken string
pageToken 参数用于标识结果集中应返回的特定网页。在 API 响应中,nextPageTokenprevPageToken 属性用于标识可检索的其他页面。

请求正文

调用此方法时请勿提供请求正文。

响应

如果成功,此方法将返回采用以下结构的响应正文:

{
  "kind": "youtube#liveChatModeratorListResponse",
  "etag": etag,
  "prevPageToken": string,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    liveChatModerator Resource
  ]
}

属性

下表定义了此资源中显示的属性:

属性
kind string
标识 API 资源类型。值为 youtube#liveChatModeratorListResponse
etag etag
此资源的 Etag。
prevPageToken string
可用作 pageToken 参数值以检索结果集中的上一页的令牌。
nextPageToken string
可用作 pageToken 参数值以检索结果集中的下一页的令牌。
pageInfo object
pageInfo 对象用于封装结果集的分页信息。
pageInfo.totalResults integer
结果集中的结果总数。
pageInfo.resultsPerPage integer
API 响应中包含的结果数。
items[] list
符合请求条件的管理员列表。

错误

该 API 不会定义此 API 方法所独有的任何错误消息。不过,此方法仍会返回错误消息文档中列出的常规 API 错误。

试试看!

使用 APIs Explorer 调用此 API,并查看 API 请求和响应。