以下示例展示了如何使用 YouTube Data API (v3) 来执行与订阅相关的功能。
检索频道的订阅
调用 subscriptions.list
方法可检索特定频道的订阅。标识频道的方式有两种:
-
如需检索当前已通过身份验证的用户的订阅,请将
mine
参数的值设置为true
。请注意,使用 OAuth 2.0 的请求必须使用mine
参数。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 的应用可以使用每个订阅的 ID 作为键,处理 API 响应以显示订阅列表。在响应中,每个项目的
id
属性用于标识唯一标识相应订阅的订阅 ID。在下一步中,您将使用该值从列表中移除商品。 -
第 2 步:删除订阅
调用
subscriptions.delete
方法可删除订阅。将请求的id
参数设置为您要移除的订阅的订阅 ID。此请求必须使用 OAuth 2.0 授权。如需在 API 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