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 列出特定聊天室的聊天室訊息。
streamList 程式碼範例 啟用伺服器串流連線，以低延遲接收特定聊天室的聊天室訊息。

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 資源會在廣播影片串流中插入廣告插播。

注意：控制提示點的 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 要求必須由頻道擁有者授權。