Channels

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

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

方法

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

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

资源表示法

以下 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,
      "moderateComments": boolean,
      "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
频道说明。属性值的长度上限为 1000 个字符。
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 px,高度为 90 px。频道的默认缩略图宽度为 88 像素,高度为 88 像素。
  • medium - 较高分辨率版本的缩略图。对于视频(或引用视频的资源),此图片的宽度为 320 像素,高度为 180 像素。对于频道,此图片的宽度为 240 像素,高度为 240 像素。
  • high - 缩略图的高分辨率版本。对于视频(或引用视频的资源),此图片的宽度为 480 像素,高度为 360 像素。对于频道,此图片的宽度为 800 像素,高度为 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.titlesnippet.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.insertplaylistItems.delete 方法向列表中添加项或从中移除项。
contentDetails.relatedPlaylists.favorites string
此属性已弃用。

包含频道收藏视频的播放列表的 ID。使用 playlistItems.insertplaylistItems.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
频道的观看次数。
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 日起已弃用。在 2017 年 11 月 10 日之前,此功能会一直受到支持。

重要提示:由于 Freebase 和 Freebase API 已被弃用,因此从 2017 年 2 月 27 日起,主题 ID 的运作方式会有所不同。当时,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 禁播时,才有资格上传长视频。

    频道所有者在解决导致频道无法上传长视频的问题后,将恢复为 allowedeligible 状态。
  • eligible - 此频道符合上传时长超过 15 分钟的视频的条件。但是,频道所有者必须先前往 https://www.youtube.com/verify 启用上传较长视频的功能。如需详细了解此功能,请参阅 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
频道说明,显示在频道页面上的频道信息框中。属性值的长度上限为 1000 个字符。
brandingSettings.channel.keywords string
与您的频道相关的关键字。该值是一个以空格分隔的字符串列表。如果渠道关键字超过允许的大小上限(500 个字符)或包含未转义的引号 ("),则可能会被截断。请注意,500 个字符的限制不是每个关键字的限制,而是对所有关键字的总长度的限制。
brandingSettings.channel.trackingAnalyticsAccountId string
您用于跟踪和衡量频道流量的 Google Analytics(分析)帐号的 ID。
brandingSettings.channel.moderateComments boolean
此设置决定着用户在频道页上留下的评论是否需要由频道所有者批准才能公开显示。默认值为 false
brandingSettings.channel.unsubscribedTrailer string
应在面向订阅者的频道页浏览视图中,通过精选视频模块播放的视频。已订阅的观看者可能会看到其他突出显示近期频道活动的视频。

如果指定,则此属性的值必须是频道所有者拥有的公开或不公开视频的 YouTube 视频 ID。
brandingSettings.channel.defaultLanguage string
channel 资源的 snippet.titlesnippet.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 网站频道页上显示的横幅图片网址。图片大小为 1060x175 像素。
brandingSettings.image.bannerMobileImageUrl string
此属性已弃用。

在移动应用的频道页中显示的横幅图片网址。图片大小为 640px × 175px。
brandingSettings.image.watchIconImageUrl string
此属性已弃用。

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

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

显示在平板电脑应用的频道页面上的低分辨率横幅图片的网址。图片的尺寸上限为 1138x188 像素。
brandingSettings.image.bannerTabletImageUrl string
此属性已弃用。

在平板电脑应用的频道页面上显示的横幅图片的网址。图片大小为 1707x283 像素。
brandingSettings.image.bannerTabletHdImageUrl string
此属性已弃用。

高分辨率横幅图片的网址,在平板电脑应用的频道页面上显示。图片的尺寸上限为 2276x377 像素。
brandingSettings.image.bannerTabletExtraHdImageUrl string
此属性已弃用。

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

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

中等分辨率的横幅图片的网址,在移动应用的频道页中显示。图片的最大尺寸为 960x263 像素。
brandingSettings.image.bannerMobileHdImageUrl string
此属性已弃用。

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

显示在移动应用的频道页中的高分辨率横幅图片的网址。图片的尺寸上限为 1440x395 像素。
brandingSettings.image.bannerTvImageUrl string
此属性已弃用。

超高分辨率横幅图片(在电视应用的频道页面上显示)的网址。图片的尺寸上限为 2120x1192 像素。
brandingSettings.image.bannerTvLowImageUrl string
此属性已弃用。

低分辨率横幅图片(在电视应用的频道页面上显示)的网址。图片的尺寸上限为 854x480 像素。
brandingSettings.image.bannerTvMediumImageUrl string
此属性已弃用。

中等分辨率横幅图片的网址,显示在电视应用的频道页面上。图片的尺寸上限为 1280x720 像素。
brandingSettings.image.bannerTvHighImageUrl string
此属性已弃用。

高分辨率横幅图片的网址,显示在电视应用的频道页面上。图片的尺寸上限为 1920x1080 像素。
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 范围的授权令牌。此外,如果多频道网络决定接受或拒绝频道,或者在令牌发放日期后的两周内,使用该范围的令牌都必须被撤消。
auditDetails.overallGoodStanding boolean
此字段指示相应频道是否存在任何问题。目前,此字段表示针对 communityGuidelinesGoodStandingcopyrightStrikesGoodStandingcontentIdClaimsGoodStanding 属性的逻辑 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
本地化渠道说明。