Subscriptions

subscription 资源包含 YouTube 用户订阅的相关信息。订阅会在用户向频道添加新视频时或在 YouTube 上执行其他操作(例如上传视频、为视频评分或评论视频)时通知用户。

方法

该 API 支持 subscriptions 资源的以下方法:

list
返回与 API 请求条件匹配的订阅资源。 立即试用
插入
为经过身份验证的用户的频道添加订阅。立即试用
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.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 px,高度为 90 px。频道的默认缩略图宽度为 88px,高度为 88px。
  • 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 px,高度为 90 px。频道的默认缩略图宽度为 88px,高度为 88px。
  • 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
图片的高度。