liveChatBan
资源用于标识被禁止参与的 YouTube 用户和 YouTube 实时聊天。
方法
该 API 支持 liveChatBans
资源的以下方法:
资源表示法
以下 JSON 结构显示了 liveChatBans
资源的格式:
{ "kind": "youtube#liveChatBan", "etag": etag, "id": string, "snippet": { "liveChatId": string, "type": string, "banDurationSeconds": unsigned long, "bannedUserDetails": { "channelId": string } } }
属性
下表定义了此资源中显示的属性:
属性 | |
---|---|
kind |
string 标识 API 资源类型。值为 youtube#liveChatBan 。 |
etag |
etag 此资源的 Etag。 |
id |
string YouTube 分配的 ID,用于明确标识此禁令。 |
snippet |
object snippet 对象会禁止用户,并包含有关禁止的详细信息。 |
snippet.liveChatId |
string 该禁令适用的实时聊天。与广播关联的实时聊天 ID 会在 liveBroadcast 资源的 snippet.liveChatId 属性中返回。 |
snippet.type |
string 禁止类型。 此属性的有效值包括:
|
snippet.banDurationSeconds |
unsigned long 此禁令的持续时间。仅当禁止类型为 temporary 时,才为此属性设置值。默认值为 300 (5 分钟)。 |
snippet.bannedUserDetails |
object 此对象包含用于识别被禁用户的信息。 |
snippet.bannedUserDetails.channelId |
string 被禁用户的 YouTube 频道 ID。 |