列出实时聊天的管理员。请求必须由实时聊天频道的所有者授权。
常见应用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
| 参数 | ||
|---|---|---|
| 必需参数 | ||
liveChatId |
stringliveChatId 参数用于指定 API 应返回管理员的 YouTube 实时聊天。与广播关联的实时聊天 ID 会在 liveBroadcast 资源的 snippet.liveChatId 属性中返回。 |
|
part |
stringpart 参数用于指定 API 响应将包含的 liveChatModerator 资源部分。支持的值包括 id 和 snippet。 |
|
| 可选参数 | ||
maxResults |
unsigned integermaxResults 参数用于指定结果集中应返回的项数上限。可接受的值介于 0 到 50(含)之间。默认值为 5。 |
|
pageToken |
stringpageToken 参数用于标识结果集中应返回的特定页面。在 API 响应中,nextPageToken 和 prevPageToken 属性用于标识可以检索的其他页面。 |
|
请求正文
调用此方法时,请勿提供请求正文。
响应
如果成功,此方法将返回采用以下结构的响应正文:
{
"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 |
objectThe pageInfo 对象封装了结果集的分页信息。 |
pageInfo.totalResults |
integer结果集中的结果总数。 |
pageInfo.resultsPerPage |
integerAPI 响应中包含的结果数。 |
items[] |
list与请求条件匹配的管理员列表。 |
错误
API 未定义任何特定于此 API 方法的出错提示。不过,此方法仍可能会返回出错提示文档中列出的一般 API 错误。
试试看!
使用 APIs Explorer 调用此 API,并查看 API 请求和响应。