Subscriptions

subscription 资源包含有关 YouTube 用户订阅的信息。当频道中添加新视频时，或者当其他用户在 YouTube 上执行了多项操作之一（例如上传视频、为视频评分或评论视频）时，系统会向订阅者发送通知。

方法

该 API 支持以下针对 subscriptions 资源的方法：

list
返回符合 API 请求条件的订阅资源。 立即试用。
insert
为经过身份验证的用户的频道添加订阅。 立即试用。
delete
删除订阅。 立即试用。

资源表示法

以下 JSON 结构显示了 subscriptions 资源的格式：

{
  "kind": "youtube#subscription",
  "etag": etag,
  "id": string,
  "snippet": {
    "publishedAt": datetime,
    "channelTitle": string,
    "title": string,
    "description": string,
    "resourceId": {
      "kind": string,
      "channelId": string,
    },
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  },
  "contentDetails": {
    "totalItemCount": unsigned integer,
    "newItemCount": unsigned integer,
    "activityType": string
  },
  "subscriberSnippet": {
    "title": string,
    "description": string,
    "channelId": string,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    }
  }
}

属性

下表定义了此资源中显示的属性：

属性
kind string
用于标识 API 资源的类型。该值为 youtube#subscription。
etag etag
相应资源的 ETag。
id string
YouTube 用于唯一标识订阅的 ID。
snippet object
snippet 对象包含有关订阅的基本详细信息，包括订阅的标题和用户订阅的频道。
snippet.publishedAt datetime
订阅的创建日期和时间。该值采用 ISO 8601 格式指定。
snippet.title string
订阅的标题。
snippet.description string
订阅的详细信息。
snippet.resourceId object
id 对象包含用户订阅的频道的相关信息。
snippet.resourceId.kind string
API 资源的类型。
snippet.resourceId.channelId string
YouTube 用于唯一标识用户订阅的频道的值。
snippet.channelId string
YouTube 用于唯一标识订阅者频道的 ID。resource_id 对象用于标识用户订阅的频道。
snippet.thumbnails object
与订阅关联的缩略图的映射。对于地图中的每个对象，键是缩略图的名称，值是包含有关缩略图的其他信息的对象。
snippet.thumbnails.(key) object
有效键值包括：
  • default - 相应资源的默认缩略图。视频（或引用视频的资源，例如播放列表项或搜索结果）的默认缩略图宽度为 120 像素，高度为 90 像素。频道的默认缩略图尺寸为 88 像素（宽）x 88 像素（高）。
  • medium - 缩略图的更高分辨率版本。对于视频（或引用视频的资源），此图片的宽度为 320 像素，高度为 180 像素。对于频道，此图片的宽度和高度均为 240 像素。
  • high - 缩略图图片的高分辨率版本。对于视频（或引用视频的资源），此图片的宽度为 480 像素，高度为 360 像素。对于频道，此图片的宽度和高度均为 800 像素。
snippet.thumbnails.(key).url string
图片的网址。
snippet.thumbnails.(key).width unsigned integer
图片的宽度。
snippet.thumbnails.(key).height unsigned integer
图片的高度。
contentDetails object
contentDetails 对象包含有关订阅的基本统计信息。
contentDetails.totalItemCount unsigned integer
订阅所指向的商品的大致数量。
contentDetails.newItemCount unsigned integer
自上次读取订阅内容以来，订阅中的新商品数量。
contentDetails.activityType string
相应订阅所适用的活动类型（仅限上传、所有活动）。

此属性的有效值为：
  • all
  • uploads
subscriberSnippet object
subscriberSnippet 对象包含有关订阅者的基本详细信息。
subscriberSnippet.title string
订阅者的频道标题。
subscriberSnippet.description string
订阅者频道的说明。
subscriberSnippet.channelId string
YouTube 为唯一标识订阅者的频道而分配的 ID。
subscriberSnippet.thumbnails object
订阅者频道的缩略图。
subscriberSnippet.thumbnails.(key) object
有效键值包括：
  • default - 相应资源的默认缩略图。视频（或引用视频的资源，例如播放列表项或搜索结果）的默认缩略图宽度为 120 像素，高度为 90 像素。频道的默认缩略图尺寸为 88 像素（宽）x 88 像素（高）。
  • medium - 缩略图的更高分辨率版本。对于视频（或引用视频的资源），此图片的宽度为 320 像素，高度为 180 像素。对于频道，此图片的宽度和高度均为 240 像素。
  • high - 缩略图图片的高分辨率版本。对于视频（或引用视频的资源），此图片的宽度为 480 像素，高度为 360 像素。对于频道，此图片的宽度和高度均为 800 像素。
subscriberSnippet.thumbnails.(key).url string
图片的网址。
subscriberSnippet.thumbnails.(key).width unsigned integer
图片的宽度。
subscriberSnippet.thumbnails.(key).height unsigned integer
图片的高度。