設定一或多則留言的管理狀態。API 要求必須由與留言相關聯的頻道或影片擁有者授權。
配額影響:呼叫這個方法會產生 50 個單位的配額費用。
常見用途
要求
HTTP 要求
POST https://www.googleapis.com/youtube/v3/comments/setModerationStatus
授權
這項要求必須至少具備下列其中一個範圍的授權 (進一步瞭解驗證和授權)。
| 範圍 |
|---|
https://www.googleapis.com/auth/youtube.force-ssl |
參數
下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。
| 參數 | ||
|---|---|---|
| 必要參數 | ||
id |
stringid 參數會指定以逗號分隔的清單,最多可包含 50 個 ID,用來識別要更新審核狀態的留言。 |
|
moderationStatus |
string指定留言的新管理狀態。 可接受的值如下:
|
|
| 選用參數 | ||
banAuthor |
booleanbanAuthor 參數可讓您指定自動拒絕留言作者撰寫的任何其他留言。將參數值設為 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 |
權限不足,無法設定一或多則留言的管理狀態。要求可能未獲得授權。如果嘗試管理已刪除或無效的留言 ID,也會傳回這項錯誤。 |
notFound (404) |
commentNotFound |
找不到要求嘗試更新的一或多則留言。檢查要求 id 參數的值,確保正確無誤。 |
試試看!
使用 APIs Explorer 呼叫這個 API,並查看 API 要求和回應。