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 資源會在廣播視訊串流中啟動廣告插播。

注意:用於控制提示點的 API 指令其實是 YouTube Content ID API 的一部分,與管理 liveBroadcastliveStream 資源的要求不同。

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

方法 HTTP 要求 說明
相對於 https://www.googleapis.com/ 的 URI
insert POST /liveCuepoints 將提示點插入現場直播。以目前來說,只有與 YouTube 內容擁有者建立關聯的帳戶,才能對這個方法提出要求。

贊助者

sponsor 資源代表 YouTube 頻道的贊助商。贊助者為創作者提供定期的金錢贊助 (例如訂閱或訂閱費用),並獲得特殊福利。舉例來說,當創作者為聊天室啟用贊助者專屬模式時,贊助者就能參與聊天室。

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

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