Subscriptions

subscription 资源包含有关 YouTube 用户订阅的信息。当某个用户向某个频道添加了新视频，或者其他用户在 YouTube 上进行了某种操作（例如上传视频、对视频评分或对视频进行评论）时，订阅就会通知该用户。

方法

对于 subscriptions 资源，该 API 支持以下方法：

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

资源表示法

以下 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.channelTitle string
订阅所属的频道的标题。
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 像素，高 88 像素。
  • medium – 更高分辨率版本的缩略图。对于视频（或引用视频的资源），该图片的宽度为 320 像素，高为 180 像素。对于频道，此图片宽 240 像素，高 240 像素。
  • high – 缩略图的高分辨率版本。对于视频（或引用视频的资源），该图片的宽度为 480 像素，高度为 360 像素。对于频道，此图片宽 800 像素，高 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 像素，高 88 像素。
  • medium – 更高分辨率版本的缩略图。对于视频（或引用视频的资源），该图片的宽度为 320 像素，高为 180 像素。对于频道，此图片宽 240 像素，高 240 像素。
  • high – 缩略图的高分辨率版本。对于视频（或引用视频的资源），该图片的宽度为 480 像素，高度为 360 像素。对于频道，此图片宽 800 像素，高 800 像素。
subscriberSnippet.thumbnails.(key).url string
图片的网址。
subscriberSnippet.thumbnails.(key).width unsigned integer
图片的宽度。
subscriberSnippet.thumbnails.(key).height unsigned integer
图片的高度。