LiveChatBans: insert

禁止特定使用者參與聊天室。API 要求必須由頻道擁有者或與禁令相關聯的直播聊天室管理員授權。

常見用途

要求

HTTP 要求

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

授權

這項要求必須具備下列至少一個範圍的授權。如要進一步瞭解驗證和授權，請參閱「導入 OAuth 2.0 驗證」。

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

參數

下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。

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

要求主體

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

  • 您必須為下列屬性指定值：

    • snippet.liveChatId
    • snippet.type - 選擇下列其中一個選項：permanent 或 temporary
    • snippet.bannedUserDetails.channelId

  • 您可以為下列屬性設定值：

    • snippet.banDurationSeconds

回應

如果成功，這個方法會在回應主體中傳回 liveChatBan 資源。

錯誤

下表列出 API 在呼叫這個方法時可能傳回的錯誤訊息。詳情請參閱「YouTube Live Streaming 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 要求和回應。