LiveChatBans
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
liveChatBan
資源會標示 YouTube 使用者,以及該使用者遭禁止參與的 YouTube 聊天室。
方法
這個 API 支援 liveChatBans
資源的下列方法:
- 插入
- 禁止特定使用者參與聊天室。API 要求必須由頻道擁有者或與停權相關的直播聊天室管理員授權。
立即試用。
- 刪除
- 移除禁止特定使用者參與聊天室的禁令,讓使用者能夠重新加入聊天室。API 要求必須由頻道擁有者或與停權相關的直播聊天室管理員授權。
立即試用。
屬性
下表定義了這個資源中顯示的屬性:
屬性 |
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。 |
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-06-06 (世界標準時間)。
[null,null,["上次更新時間:2025-06-06 (世界標準時間)。"],[[["\u003cp\u003eA \u003ccode\u003eliveChatBan\u003c/code\u003e resource identifies a YouTube user who is banned from a specific YouTube live chat.\u003c/p\u003e\n"],["\u003cp\u003eThe API allows channel owners or moderators to insert a \u003ccode\u003eliveChatBan\u003c/code\u003e to ban a user or delete one to remove the ban.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eliveChatBan\u003c/code\u003e can be either permanent or temporary, and the duration of a temporary ban can be specified in seconds.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eliveChatBan\u003c/code\u003e resource's \u003ccode\u003esnippet\u003c/code\u003e object includes the ID of the live chat, the type of ban, the ban duration (if temporary), and details of the banned user.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eliveChatBan\u003c/code\u003e resource has properties such as \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003eetag\u003c/code\u003e, and \u003ccode\u003eid\u003c/code\u003e, which provide general information about the resource, such as the resource type, its ETag, and the ban's unique ID.\u003c/p\u003e\n"]]],["The `liveChatBan` resource manages user bans in YouTube live chats. Key actions include: inserting a ban (`insert`) to prevent a user from participating, and deleting a ban (`delete`) to allow a user to rejoin. The resource identifies the banned user, the live chat, ban type (`permanent` or `temporary`), and ban duration in seconds. The resource properties include `kind`, `etag`, and `id`. Authorization from the channel owner or a moderator is required for both inserting and deleting.\n"],null,["# LiveChatBans\n\nA **liveChatBan** resource identifies a YouTube user and a YouTube live chat that the user is banned from participating in.\n\nMethods\n-------\n\nThe API supports the following methods for `liveChatBans` resources:\n\n[insert](/youtube/v3/live/docs/liveChatBans/insert)\n: Bans a specific user from participating in the live chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban.\n [Try it now](/youtube/v3/live/docs/liveChatBans/insert#try-it).\n\n[delete](/youtube/v3/live/docs/liveChatBans/delete)\n: Removes a ban that prevents a specific user from contributing to a live chat, thereby enabling the user to rejoin the chat. The API request must be authorized by the channel owner or a moderator of the live chat associated with the ban.\n [Try it now](/youtube/v3/live/docs/liveChatBans/delete#try-it).\n\nResource representation\n-----------------------\n\nThe following JSON structure shows the format of a `liveChatBans` resource: \n\n```carbon\n{\n \"#kind\": \"youtube#liveChatBan\",\n \"#etag\": etag,\n \"#id\": string,\n \"#snippet\": {\n \"#snippet.liveChatId\": string,\n \"#snippet.type\": string,\n \"#snippet.banDurationSeconds\": unsigned long,\n \"#snippet.bannedUserDetails\": {\n \"#snippet.bannedUserDetails.channelId\": string\n }\n }\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#liveChatBan`. |\n| `etag` | `etag` The Etag of this resource. |\n| `id` | `string` The ID that YouTube assigns to uniquely identify the ban. |\n| `snippet` | `object` The `snippet` object identifies the banned user and contains details about the ban. |\n| snippet.`liveChatId` | `string` The live chat to which the ban applies. The live chat ID associated with a broadcast is returned in the `liveBroadcast` resource's `snippet.liveChatId` property. |\n| snippet.`type` | `string` The type of ban. Valid values for this property are: - `permanent` - `temporary` |\n| snippet.`banDurationSeconds` | `unsigned long` The duration of the ban. Only set a value for this property if the ban's type is `temporary`. The default value is `300` (5 minutes). |\n| snippet.`bannedUserDetails` | `object` This object contains information that identifies the banned user. |\n| snippet.bannedUserDetails.`channelId` | `string` The banned user's YouTube channel ID. |"]]