API 參考資料

本 API 參考資料說明如何使用 YouTube Live Streaming API 在 YouTube 上排定直播和影片串流。

資源類型

LiveBroadcasts

liveBroadcast 資源代表在 YouTube 上透過直播影片串流播放的活動。

如要進一步瞭解這項資源，請參閱其資源表示法和屬性清單。

方法	HTTP 要求	說明
相對於 https://www.googleapis.com/youtube/v3 的 URI
bind	POST /liveBroadcasts/bind	將 YouTube 直播綁定至串流，或移除直播和串流之間的現有綁定。一個廣播活動只能繫結至一個視訊串流，但視訊串流可以繫結至多個廣播活動。
delete	DELETE /liveBroadcasts	刪除廣播。
insert	POST /liveBroadcasts	建立廣播。
list	GET /liveBroadcasts	傳回符合 API 要求參數的 YouTube 直播清單。
transition	POST /liveBroadcasts/transition	變更 YouTube 直播的狀態，並啟動與新狀態相關的任何程序。舉例來說，當你將直播狀態切換為 testing 時，YouTube 就會開始將影片傳送至該直播的監控串流。呼叫此方法前，請確認與廣播綁定的串流 status.streamStatus 屬性值為 active。
update	PUT /liveBroadcasts	更新廣播。舉例來說，您可以修改 liveBroadcast 資源 contentDetails 物件中定義的廣播設定。
cuepoint	POST /liveBroadcasts/cuepoint	在直播中插入提示點。提示點可能會觸發廣告插播。

LiveChatBans

liveChatBan 資源會指出 YouTube 使用者和 YouTube 聊天室，並標示該使用者遭到禁止參與。

如要進一步瞭解這項資源，請參閱其資源表示法和屬性清單。

方法	HTTP 要求	說明
相對於 https://www.googleapis.com/youtube/v3 的 URI
delete	DELETE /liveChat/bans	移除禁止特定使用者參與聊天室的禁令，讓使用者可以重新加入聊天室。頻道擁有者或與遭停權直播聊天室相關的聊天室管理員必須授權 API 要求。
insert	POST /liveChat/bans	禁止特定使用者參與聊天室。頻道擁有者或與遭停權直播聊天室相關的聊天室管理員必須授權 API 要求。

LiveChatMessages

liveChatMessage 資源代表 YouTube 直播聊天室中的聊天訊息。這項資源可包含多種訊息類型的詳細資料，包括新發布的文字訊息或粉絲贊助活動。

直播功能預設為啟用，且在直播活動期間可供使用。(活動結束後，該活動的聊天室就會關閉)。

如要進一步瞭解這項資源，請參閱其資源表示法和屬性清單。

方法	HTTP 要求	說明
相對於 https://www.googleapis.com/youtube/v3 的 URI
delete	DELETE /liveChat/messages	刪除即時通訊訊息。頻道擁有者或與遭停權直播聊天室相關的聊天室管理員必須授權 API 要求。
insert	POST /liveChat/messages	在聊天室中新增訊息。
list	GET /liveChat/messages	列出特定聊天室的聊天室訊息。

LiveChatModerators

liveChatModerator 資源代表 YouTube 直播聊天室的管理員。聊天室管理員可以封鎖或解除使用者的聊天室權限、移除訊息，以及執行其他直播聊天室管理動作。

如要進一步瞭解這項資源，請參閱其資源表示法和屬性清單。

方法	HTTP 要求	說明
相對於 https://www.googleapis.com/youtube/v3 的 URI
delete	DELETE /liveChat/moderators	移除即時通訊管理員。這項要求必須由直播頻道的擁有者授權。
insert	POST /liveChat/moderators	為聊天室新增管理員。這項要求必須由直播頻道的擁有者授權。
list	GET /liveChat/moderators	列出聊天室管理員。這項要求必須由直播頻道的擁有者授權。

LiveStreams

liveStream 資源包含傳送至 YouTube 的影片串流相關資訊。這項串流會提供要向 YouTube 使用者播送的內容。建立後，liveStream 資源可繫結至一或多個 liveBroadcast 資源。

如要進一步瞭解這項資源，請參閱其資源表示法和屬性清單。

方法	HTTP 要求	說明
相對於 https://www.googleapis.com/youtube/v3 的 URI
delete	DELETE /liveStreams	刪除影片串流。
insert	POST /liveStreams	建立影片串流。你可以透過串流將影片傳送至 YouTube，然後向觀眾播放影片。
list	GET /liveStreams	傳回與 API 要求參數相符的影片串流清單。
update	PUT /liveStreams	更新影片串流。如果無法更新要變更的屬性，則必須使用正確的設定建立新的串流。

SuperChatEvents

superChatEvent 資源代表粉絲在 YouTube 直播期間購買的超級留言訊息。在 YouTube 直播聊天室中，超級留言會以兩種方式與其他訊息區隔開來：

• 超級留言會以顏色標示。
• 超級留言會在超級留言顯示區持續顯示一段時間。

超級留言的顏色、在超級留言顯示區置頂的時間長度，以及訊息長度上限，都取決於購買金額。如要進一步瞭解超級留言，請前往 YouTube 說明中心。

如要進一步瞭解這項資源，請參閱其資源表示法和屬性清單。

方法	HTTP 要求	說明
相對於 https://www.googleapis.com/youtube/v3 的 URI
list	GET /superChatEvents	列出頻道過去 30 天內直播的超級留言活動。

已淘汰的資源類型

FanFundingEvents

fanFundingEvent 資源代表 YouTube 頻道上的粉絲贊助事件。粉絲贊助功能可讓你以金錢支持 YouTube 創作者。當使用者一次性自願向頻道付款時，就會觸發粉絲贊助事件。請參閱 YouTube 說明中心，進一步瞭解粉絲贊助。

如要進一步瞭解這項資源，請參閱其資源表示法和屬性清單。

方法	HTTP 要求	說明
相對於 https://www.googleapis.com/youtube/v3 的 URI
list	GET /fanFundingEvents	列出頻道的粉絲贊助活動。API 要求必須由頻道擁有者授權。

LiveCuepoints

liveCuepoint 資源會在廣播影片串流中開始廣告插播。

注意：用於控制 Cuepoint 的 API 指令其實是 YouTube Content ID API 的一部分，其授權要求與管理 liveBroadcast 和 liveStream 資源的要求不同。

如要進一步瞭解這項資源，請參閱其資源表示法和屬性清單。

方法	HTTP 要求	說明
相對於 https://www.googleapis.com/ 的 URI
insert	POST /liveCuepoints	在直播中插入提示點。目前，使用這項方法的請求必須由與 YouTube 內容擁有者相關聯的帳戶授權。

贊助者

sponsor 資源代表 YouTube 頻道的贊助者。贊助者會定期向創作者提供金錢支持 (例如訂閱或會員費)，並獲得特別福利。舉例來說，創作者啟用聊天室的贊助者專屬模式後，贊助者就能使用聊天室。

如要進一步瞭解這項資源，請參閱其資源表示法和屬性清單。

方法	HTTP 要求	說明
相對於 https://www.googleapis.com/youtube/v3 的 URI
list	GET /sponsors	列出頻道的贊助商。API 要求必須由頻道擁有者授權。