本頁面由 Cloud Translation API 翻譯而成。

LiveChatBans: insert

禁止特定使用者加入聊天室。API 要求必須獲得頻道擁有者或與停權有關的聊天室管理員授權。

常見用途

POST https://www.googleapis.com/youtube/v3/liveChat/bans

這項要求需要至少下列其中一個範圍的授權 (進一步瞭解驗證和授權)。

內容範圍
`https://www.googleapis.com/auth/youtube`
`https://www.googleapis.com/auth/youtube.force-ssl`

下表列出此查詢支援的參數。這裡列出的參數全都是查詢參數。

參數
必要參數
`part`	`string` 在這項作業中，`part` 參數有兩個用途。它會識別寫入作業設定的屬性，以及 API 回應傳回的屬性。將參數值設為 `snippet`。

在要求主體中提供 liveChatBan 資源。針對該資源：

您必須指定下列屬性的值：
- snippet.liveChatId
- snippet.type
- snippet.bannedUserDetails.channelId
您可以設定下列屬性的值：
- snippet.banDurationSeconds

如果成功的話，這個方法會在回應內文中傳回 liveChatBan 資源。

下表列出 API 回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息的說明文件。

錯誤類型	錯誤詳細資料	說明
`forbidden (403)`	`insufficientPermissions`	您沒有必要的權限，無法將使用者停權指定的聊天室。
`forbidden (403)`	`liveChatBanInsertionNotAllowed`	無法建立指定的停權限制。如果該要求試圖將即時通訊擁有者或其他管理員停權，就可能發生這個錯誤。
`invalidValue (400)`	`invalidChannelId`	找不到指定的頻道 ID。
`invalidValue (400)`	`invalidLiveChatId`	要求中指定的 `snippet.liveChatId` 值無效。請檢查相關聯的 `liveBroadcast` 資源，確認含有正確的值。
`notFound (404)`	`liveChatNotFound`	找不到指定的聊天室。檢查相關聯的 `liveBroadcast` 資源，確保 `snippet.liveChatId` 屬性設為正確的值。
`notFound (404)`	`liveChatUserNotFound`	系統找不到您嘗試停權的聊天室使用者。
`required (400)`	`bannedUserChannelIdRequired`	在要求主體中提交的 `liveChatBan` 資源必須指定 `snippet.bannedUserDetails.channelId` 屬性的值。
`required (400)`	`liveChatIdRequired`	在要求主體中提交的 `liveChatBan` 資源必須指定 `snippet.liveChatId` 屬性的值。

使用 APIs Explorer 呼叫這個 API 並查看 API 要求和回應。