設定一或多則留言的審核狀態。API 要求必須由與留言相關的頻道或影片的擁有者授權。
配額影響:呼叫此方法的配額費用為 50 個單位。
常見用途
要求
HTTP 要求
POST https://www.googleapis.com/youtube/v3/comments/setModerationStatus
授權
這項要求至少需要以下其中一個範圍的授權 (進一步瞭解驗證和授權)。
範圍 |
---|
https://www.googleapis.com/auth/youtube.force-ssl |
參數
下表列出這項查詢支援的參數。這裡列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
id |
string id 參數會指定以逗號分隔的 ID 清單,指出您要更新審核狀態的留言。 |
|
moderationStatus |
string 指出指定留言的新管理狀態。 可接受的值如下:
|
|
選用參數 | ||
banAuthor |
boolean 如果希望系統自動拒絕留言作者撰寫的任何其他留言,請使用 banAuthor 參數。如要將作者停權,請將參數值設為 true 。注意:只有在 moderationStatus 參數也設為 rejected 的情況下,這個參數才有效。 |
要求主體
呼叫這個方法時,不要提供要求主體。
回應
如果成功,這個方法會傳回 HTTP 204
回應代碼 (No Content
)。
錯誤
下表說明 API 呼叫這個方法時可能會傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
badRequest (400) |
banWithoutReject |
只有在 moderationStatus 參數值為 rejected 時,才能使用 banAuthor 參數。 |
badRequest (400) |
operationNotSupported |
非根據 Google+ 資料的留言具備的管理功能有限。 |
badRequest (400) |
processingFailure |
API 伺服器無法成功處理要求。雖然這可能是暫時性錯誤,但通常表示要求的輸入內容無效。 |
forbidden (403) |
forbidden |
權限不足,無法設定一或多則留言的審核狀態。要求可能未經過妥善授權。 |
notFound (404) |
commentNotFound |
找不到要求要更新的一或多則留言。請檢查要求的 id 參數值,確認值正確無誤。 |
試試看!
使用 APIs Explorer 呼叫這個 API,並查看 API 要求和回應。