LiveChatMessages: transition

轉換 YouTube 聊天室訊息狀態,並啟動與新狀態相關聯的所有程序。舉例來說,如果你將即時意見調查的狀態轉換為「closed」,YouTube 就會結束該訊息的意見調查。呼叫這個方法之前,請確認即時意見調查訊息的 status 屬性值為 active

要求

HTTP 要求

POST https://www.googleapis.com/youtube/v3/liveChatMessages/transition

授權

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

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

參數

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

參數
必要參數
id string
id 參數會指定轉換至其他狀態的訊息專屬 ID。
status enum
status 參數可識別訊息的變化狀態。如要將訊息轉換為 closed 狀態,針對訊息繫結的輪詢,status 必須是 active

您只能將其轉換為 closed,表示意見調查已關閉。
選用參數
part string
part 參數會指定 API 回應將包含的 liveChatMessage 資源部分。支援的值為 idsnippetauthorDetails

將參數值設為 snippet,即可在回應主體中取得最終意見調查結果。

要求主體

呼叫此方法時,不要提供要求主體。

回應

如果成功,這個方法會在回應內文中傳回 liveChatMessages 資源

錯誤

下表顯示 API 為回應這個方法時,可能會傳回的錯誤訊息。詳情請參閱錯誤訊息說明文件。

錯誤類型 錯誤詳情 說明
forbidden (403) forbidden 您的權限不足,無法轉換指定訊息的狀態。
required (400) idRequired 必要的 id 參數必須指明要轉換狀態的訊息。
required (400) statusRequired API 要求必須指定 status 參數的值。
notFound (404) liveChatMessagesNotFound id 參數指定的訊息不存在。
forbidden (403) modificationNotAllowed 無法轉換指定的 liveChatMessage 資源狀態。id 參數可能會識別狀態無法轉換的訊息。

試試看!

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