以下範例說明如何使用 YouTube Data API (v3) 執行與訂閱相關的函式。
擷取頻道的訂閱項目
呼叫 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。以下範例會擷取由 TED 頻道在 YouTube 上訂閱的頻道清單。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。在下一個步驟中,您將使用這個值從清單中移除項目。 -
步驟 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