Channels

该 API 现在支持将您的频道或视频标记为“面向儿童”。此外,channel 和 video 资源现在还包含一个属性,用于标识该频道或视频的“面向儿童”状态。《YouTube API 服务条款》和《开发者政策》也于 2020 年 1 月 10 日进行了更新。如需了解详情,请参阅 YouTube Data API 服务和 YouTube API 服务的服务条款的修订历史记录。

channel 资源包含 YouTube 频道的相关信息。

方法

该 API 支持以下 channels 资源方法:

list
返回符合请求条件的零个或多个 channel 资源的集合。立即试用。
update
更新频道的元数据。请注意,此方法目前仅支持更新 channel 资源的 brandingSettings 和 invideoPromotion 对象及其子属性。立即试用。

资源表示法

以下 JSON 结构显示了 channels 资源的格式:

{
  "kind": "youtube#channel",
  "etag": etag,
  "id": string,
  "snippet": {
    "title": string,
    "description": string,
    "customUrl": string,
    "publishedAt": datetime,
    "thumbnails": {
      (key): {
        "url": string,
        "width": unsigned integer,
        "height": unsigned integer
      }
    },
    "defaultLanguage": string,
    "localized": {
      "title": string,
      "description": string
    },
    "country": string
  },
  "contentDetails": {
    "relatedPlaylists": {
      "likes": string,
      "favorites": string,
      "uploads": string
    }
  },
  "statistics": {
    "viewCount": unsigned long,
    "subscriberCount": unsigned long,  // this value is rounded to three significant figures
    "hiddenSubscriberCount": boolean,
    "videoCount": unsigned long
  },
  "topicDetails": {
    "topicIds": [
      string
    ],
    "topicCategories": [
      string
    ]
  },
  "status": {
    "privacyStatus": string,
    "isLinked": boolean,
    "longUploadsStatus": string,
    "madeForKids": boolean,
    "selfDeclaredMadeForKids": boolean
  },
  "brandingSettings": {
    "channel": {
      "title": string,
      "description": string,
      "keywords": string,
      "trackingAnalyticsAccountId": string,
      "unsubscribedTrailer": string,
      "defaultLanguage": string,
      "country": string
    },
    "watch": {
      "textColor": string,
      "backgroundColor": string,
      "featuredPlaylistId": string
    }
  },
  "auditDetails": {
    "overallGoodStanding": boolean,
    "communityGuidelinesGoodStanding": boolean,
    "copyrightStrikesGoodStanding": boolean,
    "contentIdClaimsGoodStanding": boolean
  },
  "contentOwnerDetails": {
    "contentOwner": string,
    "timeLinked": datetime
  },
  "localizations": {
    (key): {
      "title": string,
      "description": string
    }
  }
}

属性

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

属性
kind string
标识 API 资源的类型。该值将为 youtube#channel。
etag etag
此资源的 ETag。
id string
YouTube 用于唯一标识频道的 ID。
snippet object
snippet 对象包含有关频道的基本详细信息,例如其标题、说明和缩略图。
snippet.title string
频道的标题。
snippet.description string
频道的说明。属性值的长度上限为 1,000 个字符。
snippet.customUrl string
频道的自定义网址。YouTube 帮助中心介绍了获取自定义网址的资格要求以及如何设置网址。
snippet.publishedAt datetime
频道的创建日期和时间。该值采用 ISO 8601 格式指定。
snippet.thumbnails object
与频道关联的缩略图的映射。对于映射中的每个对象,键是缩略图的名称,值是包含缩略图其他信息的对象。

在应用中显示缩略图时,请确保您的代码使用的图片网址与 API 响应中返回的网址完全一致。例如,您的应用不应在 API 响应中返回的网址中使用 http 网域,而应使用 https 网域。

频道缩略图网址仅在 https 网域中可用,这也是网址在 API 响应中的显示方式。如果您的应用尝试从 http 网域加载 YouTube 图片,您可能会在应用中看到损坏的图片。新创建的频道的缩略图可能为空,最多可能需要一天时间才能填充。
snippet.thumbnails.(key) object
有效的键值包括:
  • default - 默认缩略图。视频(或引用视频的资源,例如播放列表项或搜索结果)的默认缩略图宽 120 像素,高 90 像素。频道的默认缩略图宽 88 像素,高 88 像素。
  • medium - 缩略图的高分辨率版本。对于视频(或引用视频的资源),此图片的宽度为 320 像素,高度为 180 像素。对于频道,此图片的宽度和高度均为 240 像素。
  • high - 缩略图的高分辨率版本。对于视频(或引用视频的资源),此图片的宽度为 480 像素,高度为 360 像素。对于频道,此图片的尺寸为 800 像素(宽)x 800 像素(高)。
snippet.thumbnails.(key).url string
图片的网址。如需了解在应用中使用缩略图网址的其他准则,请参阅 snippet.thumbnails 属性定义。
snippet.thumbnails.(key).width unsigned integer
图片的宽度。
snippet.thumbnails.(key).height unsigned integer
图片的高度。
snippet.defaultLanguage string
channel 资源的 snippet.title 和 snippet.description 属性中文本的语言。
snippet.localized object
snippet.localized 对象包含频道的本地化标题和说明,或者包含频道元数据的默认语言版本的频道标题和说明。
  • 如果 channels.list 请求使用 hl 参数指定了应返回本地化文本的语言,hl 参数值标识了 YouTube 应用语言,并且该语言有本地化文本,则本地化文本会在资源代码段中返回。
  • 如果未指定 hl 参数值,或者指定了值但指定语言的本地化元数据不可用,则系统会返回默认语言的元数据。
该属性包含只读值。使用 localizations 对象添加、更新或删除本地化元数据。
snippet.localized.title string
本地化的频道标题。
snippet.localized.description string
本地化的频道说明。
snippet.country string
与频道关联的国家/地区。如需设置此属性的值,请更新 brandingSettings.channel.country 属性的值。
contentDetails object
contentDetails 对象封装了有关频道内容的信息。
contentDetails.relatedPlaylists object
relatedPlaylists 对象是一个映射,用于标识与频道关联的播放列表,例如频道上传的视频或赞过的视频。您可以使用 playlists.list 方法检索这些播放列表。
contentDetails.relatedPlaylists.likes string
包含频道中赞过的视频的播放列表的 ID。使用 playlistItems.insert 和 playlistItems.delete 方法可向该列表添加项或从中移除项。
contentDetails.relatedPlaylists.favorites string
此属性已被废弃。

包含频道收藏视频的播放列表的 ID。使用 playlistItems.insert 和 playlistItems.delete 方法可向该列表添加内容或从中移除内容。

请注意,YouTube 已弃用收藏视频功能。例如,video 资源的 statistics.favoriteCount 属性已于 2015 年 8 月 28 日弃用。因此,由于历史原因,此属性值可能包含一个引用空播放列表的播放列表 ID,因此无法提取。
contentDetails.relatedPlaylists.uploads string
包含频道上传视频的播放列表的 ID。使用 videos.insert 方法上传新视频,并使用 videos.delete 方法删除之前上传的视频。
statistics object
statistics 对象封装了频道的统计信息。
statistics.viewCount unsigned long

频道中所有格式的所有视频的观看次数总和。

对于频道中的所有视频格式(长视频、直播和短视频),viewCount 会在视频开始播放时(包括自动播放、将指针悬停在视频上以及点击/点按播放)统计观看次数。

对于频道中的所有视频格式(长视频、直播和 Shorts 短视频),viewCount 会将多人在电视屏幕上一起观看(同看)的情况纳入考量。

statistics.commentCount unsigned long
此属性已被废弃。

频道的评论数量。
statistics.subscriberCount unsigned long
频道的订阅人数。此值会向下舍入到三位有效数字。如需详细了解订阅人数的四舍五入方式,请参阅修订历史记录或 YouTube 帮助中心。
statistics.hiddenSubscriberCount boolean
指明频道的订阅人数是否公开显示。
statistics.videoCount unsigned long
上传到频道的公开视频数量。请注意,该值仅反映频道公开视频的数量,即使对所有者也是如此。此行为与 YouTube 网站上显示的计数一致。
topicDetails object
topicDetails 对象封装了与频道关联的主题的相关信息。

重要提示:如需详细了解与主题 ID 相关的变更,请参阅 topicDetails.topicIds[] 属性定义和修订历史记录。
topicDetails.topicIds[] list
与频道关联的主题 ID 列表。

此属性已于 2016 年 11 月 10 日弃用。该 API 将一直受支持,直到 2017 年 11 月 10 日。

重要提示:由于 Freebase 和 Freebase API 已弃用,主题 ID 的工作方式自 2017 年 2 月 27 日起发生了变化。当时,YouTube 开始返回一小部分精选主题 ID。

topicDetails.topicCategories[] list
描述频道内容的维基百科网址列表。
status object
status 对象封装了有关频道隐私状态的信息。
status.privacyStatus string
频道的隐私状态。

此属性的有效值为:
  • private
  • public
  • unlisted
status.isLinked boolean
指明频道数据是否标识了已关联到 YouTube 用户名或 Google+ 账号的用户。拥有其中一个链接的用户已经拥有公开的 YouTube 身份,这是执行多项操作(例如上传视频)的前提条件。
status.longUploadsStatus string
指明频道是否可以上传时长超过 15 分钟的视频。仅当频道所有者授权 API 请求时,系统才会返回此属性。如需详细了解此功能,请参阅 YouTube 帮助中心。

此属性的有效值如下:
  • allowed - 此频道可以上传时长超过 15 分钟的视频。
  • disallowed - 此频道无法或不符合条件上传时长超过 15 分钟的视频。只有在频道状态正常(根据 YouTube 社区准则)且其内容未在全球范围内被 Content ID 禁播的情况下,频道才有资格上传长视频。

    在频道所有者解决导致频道无法上传较长视频的问题后,频道将恢复为 allowed 或 eligible 状态。
  • eligible - 此频道可以上传时长超过 15 分钟的视频。不过,频道所有者必须先通过手机验证启用上传较长视频的功能。如需详细了解此功能,请参阅 YouTube 帮助中心。
status.madeForKids boolean
此值表示频道是否被标识为面向儿童,并包含频道当前的“面向儿童”状态。例如,状态可能是根据 selfDeclaredMadeForKids 属性的值确定的。如需详细了解如何为频道、视频或直播设置观众群,请参阅 YouTube 帮助中心。
status.selfDeclaredMadeForKids boolean
在 channels.update 请求中,此属性允许频道所有者将频道指定为面向儿童。仅当频道所有者授权 API 请求时,系统才会返回该属性值。
brandingSettings object
brandingSettings 对象封装了有关频道品牌的信息。
brandingSettings.channel object
channel 对象封装了频道页面的品牌属性。
brandingSettings.channel.title string
频道的标题。标题的长度上限为 30 个字符。
brandingSettings.channel.description string
频道说明,显示在频道页上的频道信息框中。属性值的长度上限为 1,000 个字符。
brandingSettings.channel.keywords string
与您的频道关联的关键字。该值是以空格分隔的字符串列表。如果频道关键字超出 500 个字符的长度上限,或者包含未转义的引号 ("),则可能会被截断。请注意,500 个字符的限制并非针对单个关键字,而是针对所有关键字的总长度。
brandingSettings.channel.trackingAnalyticsAccountId string
您要用来跟踪和衡量频道流量的 Google Analytics 账号的 ID。
brandingSettings.channel.unsubscribedTrailer string
在频道页的浏览视图中,应在精选视频模块中向未订阅的观看者播放的视频。已订阅的观看者可能会看到另一个视频,其中会突出显示频道近期的活动。

如果指定,该属性的值必须是频道所有者拥有的公开或不公开列出视频的 YouTube 视频 ID。
brandingSettings.channel.defaultLanguage string
channel 资源的 snippet.title 和 snippet.description 属性中文本的语言。
brandingSettings.channel.country string
与频道关联的国家/地区。更新此属性可设置 snippet.country 属性的值。
brandingSettings.watch object
注意:此对象及其所有子属性均已弃用。

watch 对象封装了频道视频观看页面的品牌属性。
brandingSettings.watch.textColor string
注意:此属性已被废弃。

视频观看页面品牌宣传区域的文字颜色。
brandingSettings.watch.backgroundColor string
注意:此属性已被废弃。

视频观看页面品牌区域的背景颜色。
brandingSettings.watch.featuredPlaylistId string
注意:此属性已被废弃。如果您尝试设置其值,API 会返回错误。
brandingSettings.image object
此属性及其所有子属性均已废弃。

image 对象封装了有关在频道的频道页或视频观看页上显示的图片的信息。
brandingSettings.image.bannerImageUrl string
此属性已被废弃。

YouTube 网站上频道页中显示的横幅图片的网址。图片尺寸为 1060 像素 x 175 像素。
brandingSettings.image.bannerMobileImageUrl string
此属性已被废弃。

移动应用中频道页上显示的横幅图片的网址。图片尺寸为 640 像素 x 175 像素。
brandingSettings.image.watchIconImageUrl string
此属性已被废弃。

视频播放器上方显示的图片的网址。这是一张高度为 25 像素、宽度可变(但不能超过 170 像素)的图片。如果您不提供此图片,系统会显示您的频道名称,而不是图片。
brandingSettings.image.trackingImageUrl string
此属性已被废弃。

1 像素 x 1 像素跟踪像素的网址,可用于收集频道或视频页面的观看统计信息。
brandingSettings.image.bannerTabletLowImageUrl string
此属性已被废弃。

在平板电脑应用中,频道页上显示的低分辨率横幅图片的网址。图片的大小上限为 1138 像素 x 188 像素。
brandingSettings.image.bannerTabletImageUrl string
此属性已被废弃。

在平板电脑应用中,频道页上显示的横幅图片的网址。图片尺寸为 1707px x 283px。
brandingSettings.image.bannerTabletHdImageUrl string
此属性已被废弃。

在平板电脑应用中的频道页上显示的高分辨率横幅图片的网址。图片的大小上限为 2276 像素 x 377 像素。
brandingSettings.image.bannerTabletExtraHdImageUrl string
此属性已被废弃。

在平板电脑应用中的频道页上显示的超高分辨率横幅图片的网址。图片的大小上限为 2560x424 像素。
brandingSettings.image.bannerMobileLowImageUrl string
此属性已被废弃。

在移动应用中的频道页上显示的低分辨率横幅图片的网址。图片的大小上限为 320 像素 x 88 像素。
brandingSettings.image.bannerMobileMediumHdImageUrl string
此属性已被废弃。

在移动应用中的频道页上显示的中等分辨率横幅图片的网址。图片的大小上限为 960 像素 x 263 像素。
brandingSettings.image.bannerMobileHdImageUrl string
此属性已被废弃。

在移动应用中的频道页上显示的高分辨率横幅图片的网址。图片的大小上限为 1280 像素 x 360 像素。
brandingSettings.image.bannerMobileExtraHdImageUrl string
此属性已被废弃。

在移动应用中的频道页上显示的超高分辨率横幅图片的网址。图片的大小上限为 1440 x 395 像素。
brandingSettings.image.bannerTvImageUrl string
此属性已被废弃。

在电视应用中的频道页上显示的超高分辨率横幅图片的网址。图片的最大尺寸为 2120 像素 x 1192 像素。
brandingSettings.image.bannerTvLowImageUrl string
此属性已被废弃。

在电视应用中,频道页上显示的低分辨率横幅图片的网址。图片的大小上限为 854 x 480 像素。
brandingSettings.image.bannerTvMediumImageUrl string
此属性已被废弃。

在电视应用中的频道页上显示的中等分辨率横幅图片的网址。图片大小上限为 1280 像素 x 720 像素。
brandingSettings.image.bannerTvHighImageUrl string
此属性已被废弃。

在电视应用中的频道页上显示的高分辨率横幅图片的网址。图片大小上限为 1920 像素 x 1080 像素。
brandingSettings.image.bannerExternalUrl string
此属性指定了横幅图片的位置,YouTube 会使用该图片为频道生成各种尺寸的横幅图片。
brandingSettings.hints[] list
此属性及其所有子属性均已废弃。

hints 对象封装了其他品牌信息属性。
brandingSettings.hints[].property string
此属性已被废弃。

属性。
brandingSettings.hints[].value string
此属性已被废弃。

属性的值。
auditDetails object
auditDetails 对象封装了多频道网络 (MCN) 在确定是否接受或拒绝特定频道时会评估的频道数据。请注意,任何检索此资源部分的 API 请求都必须提供包含 https://www.googleapis.com/auth/youtubepartner-channel-audit 范围的授权令牌。此外,当 MCN 决定接受或拒绝频道时,或在令牌签发之日起两周内,必须撤销使用该范围的任何令牌。
auditDetails.overallGoodStanding boolean
此字段指明渠道是否存在任何问题。目前,此字段表示对 communityGuidelinesGoodStanding、copyrightStrikesGoodStanding 和 contentIdClaimsGoodStanding 属性执行逻辑 AND 运算的结果,这意味着如果所有其他属性的值也为 true,则此属性的值为 true。不过,如果其中任何一个属性的值为 false,则此属性的值将为 false。但请注意,用于设置此属性值的方法可能会发生变化。
auditDetails.communityGuidelinesGoodStanding boolean
指明频道是否遵守 YouTube 的《社区准则》。
auditDetails.copyrightStrikesGoodStanding boolean
指示频道是否收到过任何版权警示。
auditDetails.contentIdClaimsGoodStanding boolean
指明频道是否有任何未解决的版权主张。
contentOwnerDetails object
contentOwnerDetails 对象封装了仅对已将频道与其内容管理器关联的 YouTube 合作伙伴可见的频道数据。
contentOwnerDetails.contentOwner string
与频道关联的内容所有者的 ID。
contentOwnerDetails.timeLinked datetime
频道与内容所有者关联的日期和时间。该值采用 ISO 8601 格式指定。
localizations object
localizations 对象封装了频道元数据的翻译。
localizations.(key) object
与键值对关联的本地化元数据的语言。该值是一个包含 BCP-47 语言代码的字符串。
localizations.(key).title string
本地化的频道标题。
localizations.(key).description string
本地化的频道说明。