轉換 YouTube 聊天室訊息的狀態,並啟動與新狀態相關聯的任何程序。舉例來說,當你將進行中的意見調查狀態轉換為 closed 時,YouTube 就會結束該訊息的意見調查。呼叫這個方法前,請先確認即時投票訊息的 status 屬性值為 active。
配額影響:呼叫這個方法會產生 20 個單位的配額費用。
要求
HTTP 要求
POST https://www.googleapis.com/youtube/v3/liveChat/messages/transition
授權
這項要求需要至少下列其中一個範圍的授權 (進一步瞭解驗證和授權)。
| 範圍 |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
參數
下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。
| 參數 | ||
|---|---|---|
| 必要參數 | ||
id |
stringid 參數會指定要轉換至其他狀態的訊息專屬 ID。 |
|
status |
enumstatus 參數會識別訊息變更後的狀態。如要將訊息轉換為 closed 狀態,訊息繫結的輪詢 status 必須為 active。
你只能轉換至 closed,也就是關閉投票。
|
|
| 選用參數 | ||
part |
stringpart 參數會指定 API 回應中包含的 liveChatMessage 資源部分。支援的值為 id、snippet 和 authorDetails。
將參數值設為 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 要求和回應。