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 图片，您可能会在应用中看到损坏的图片。新创建的频道的缩略图图片可能为空，最长可能需要 1 天时间才能填充。
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 属性定义。
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
频道的观看次数。
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 已废弃，因此自 2017 年 2 月 27 日起，主题 ID 的运作方式发生了变化。当时，YouTube 开始返回一小组精选主题 ID。
topicDetails.topicCategories[] list
用于描述频道内容的 Wikipedia 网址列表。
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
此属性已废弃。

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

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

平板电脑应用中频道页上显示的超高分辨率横幅图片的网址。图片大小上限为 2560 x 424 像素。
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
本地化的频道说明。