列出实时聊天的管理员。此请求必须获得实时聊天频道的所有者授权。
常见使用场景
请求
HTTP 请求
GET https://www.googleapis.com/youtube/v3/liveChat/moderators
参数
下表列出了此查询支持的参数。列出的所有参数都是查询参数。
参数 | ||
---|---|---|
必需参数 | ||
liveChatId |
string liveChatId 参数用于指定 YouTube 实时聊天,该 API 应返回管理员。与广播相关联的实时聊天 ID 会在 liveBroadcast 资源的 snippet.liveChatId 属性中返回。 |
|
part |
string part 参数指定 API 响应将包含的 liveChatModerator 资源部分。支持的值包括 id 和 snippet 。 |
|
可选参数 | ||
maxResults |
unsigned integer maxResults 参数指定结果集中应返回的商品数量上限。可接受的值包括0 到50 (含 0 和 10000)。默认值为 5 。 |
|
pageToken |
string pageToken 参数用于标识结果集中应返回的特定网页。在 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 |
object pageInfo 对象可封装结果集的分页信息。 |
pageInfo.totalResults |
integer 结果集中的结果总数。 |
pageInfo.resultsPerPage |
integer API 响应中包含的结果数量。 |
items[] |
list 符合请求条件的管理员列表。 |
错误
API 未定义此 API 方法特有的任何错误消息。不过,此方法可能仍会返回错误消息文档中列出的常规 API 错误。
试试看!
使用 APIs Explorer 调用此 API 并查看 API 请求和响应。