以下範例說明如何使用 YouTube Data API (第 3 版) 執行與訂閱相關的函式。
擷取頻道的訂閱項目
呼叫 subscriptions.list
方法,擷取特定頻道的訂閱項目。您可以透過兩種方式識別管道:
-
如要擷取目前已驗證的使用者訂閱項目,請將
mine
參數的值設為true
。請注意,使用mine
參數的要求必須使用 OAuth 2.0 授權。https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list? part=snippet,contentDetails &mine=true
-
如要擷取其他頻道的訂閱項目,請將
channelId
參數的值設為該頻道的專屬 YouTube 頻道 ID。以下範例會擷取 YouTube 上 TED 頻道訂閱的頻道清單。https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list? part=snippet,contentDetails &channelId=UCAuUUnT6oDeKwE6v1NGQxug
注意:如果指定的頻道未公開顯示訂閱項目,且要求未經頻道擁有者授權,API 會傳回
403 (Forbidden)
HTTP 回應碼。
如需程式碼範例,請參閱 subscriptions.list
方法的說明文件。
新增訂閱項目
呼叫 subscriptions.insert
方法即可新增管道訂閱項目。這項要求必須使用 OAuth 2.0 授權。要求主體是 subscription
資源,可設定下列值:
snippet.resourceId.kind
包含youtube#channel
值。snippet.resourceId.channelId
屬性會識別訂閱的頻道。屬性值是專屬的 YouTube 頻道 ID。您可以透過多種方式取得頻道 ID,包括呼叫channels.list
方法或擷取頻道搜尋結果。
以下 API 要求會讓你訂閱 YouTube 上的 TED 頻道:
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.insert? part=snippet
要求主體如下:
{ "snippet": { "resourceId": { "kind": "youtube#channel", "videoId": "UCAuUUnT6oDeKwE6v1NGQxug" } } }
如需程式碼範例,請參閱 subscriptions.insert
方法的說明文件。
刪除訂閱項目
本範例會刪除訂閱。這項要求必須使用 OAuth 2.0 授權。這個範例有兩個步驟:
-
步驟 1:擷取已驗證使用者頻道的訂閱項目
呼叫
subscriptions.list
方法,擷取訂閱項目清單。上方擷取頻道訂閱項目的範例說明瞭如何提出這項要求。呼叫 API 的應用程式可以處理 API 回應,並使用每個訂閱的 ID 做為索引,顯示訂閱清單。在回應中,每個項目的
id
屬性會標示訂閱 ID,該 ID 可唯一識別相應的訂閱項目。您將在下一個步驟中使用該值,從清單中移除項目。 -
步驟 2:刪除訂閱項目
呼叫
subscriptions.delete
方法即可刪除訂閱項目。將要求的id
參數設為要移除的訂閱項目 ID。這項要求必須使用 OAuth 2.0 授權。如要在 APIs Explorer 中完成要求,您必須設定
id
屬性的值。https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.delete? id=SUBSCRIPTION_ID
如需程式碼範例,請參閱 subscriptions.delete
方法的說明文件。
擷取授權使用者頻道的訂閱者清單
如要擷取訂閱目前已驗證使用者頻道的頻道清單,請呼叫 subscriptions.list
方法,並將 mySubscribers
參數的值設為 true
。要求必須使用 OAuth 2.0 授權。
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.subscriptions.list? part=snippet,contentDetails &mySubscribers=true