修订历史记录

本页面列出了 YouTube Data API (v3) 变更和文档更新。订阅此更新日志订阅

2024 年 10 月 30 日

该 API 现在支持识别包含逼真的加工或合成 (A/S) 内容的视频。详细了解 与 A/S 内容相关的 YouTube 政策

色情/色情相关内容的示例包括:

  • 呈现真实人物的言论或行为,但实际并非本人所为
  • 加工有关真实事件或地点的视频片段
  • 生成逼真但实际并不存在的场景

如需指明视频是否包含 A/S 内容,请设置 status.containsSyntheticMedia 属性。您可以在调用 videos.insertvideos.update 方法时设置此属性。如果已设置,系统会在 video 资源中返回该属性。

2024 年 4 月 30 日

注意:这是一条废弃公告。

此更新包含以下更改:

该 API 不再支持插入或检索频道讨论。此项变更与 YouTube 网站上支持的功能保持一致,该网站不支持向频道发送评论。

2024 年 3 月 13 日

注意:这是一条废弃公告。

此更新包含以下更改:

captions.insertcaptions.update 方法的 sync 参数已废弃。自 2024 年 4 月 12 日起,YouTube 将停止支持此参数。

因此,在插入或更新字幕轨道时,开发者必须添加时间信息,否则上传将会失败。

2024 年 3 月 12 日

此更新包含以下更改:

captions 资源的文档已更新,其中指出 snippet.name 字段的允许长度上限为 150 个字符。如果曲目名称长度超过此限制,API 将返回 nameTooLong 错误。

2024 年 3 月 7 日

注意:这是一条废弃公告。

channel 资源属性 brandingSettings.channel.moderateComments 已废弃。自 2024 年 3 月 7 日起,YouTube 将停止支持此参数。

2024 年 1 月 31 日

此更新包含以下更改:

借助 channels.list 方法的新 forHandle 参数,您可以通过指定频道的 YouTube 标识名来检索有关该频道的信息。

2023 年 11 月 9 日

由于 videoId 资源并非使用 API 调用返回,因此移除了对 Comments 下的 videoId 资源的所有引用。

2023 年 9 月 12 日

注意:这是一条废弃公告。

comments.markAsSpam 方法已被弃用多年。YouTube 已不再支持此方法,并且通过 API 也不再支持此方法。

在引用 comments.markAsSpam 方法的所有文档中添加了废弃通知。

2023 年 8 月 22 日

search.list 方法现在支持 videoPaidProductPlacement 参数。借助此参数,您可以过滤搜索结果,使其仅包含创作者标记为包含付费宣传内容的视频。

2023 年 8 月 18 日

video 资源的 liveStreamingDetails.concurrentViewers 的定义已更新,以指出 YouTube Data API 返回的并发观看人数可能与通过 YouTube 数据分析获得的经过处理和去除垃圾内容的并发观看人数不同。YouTube 帮助中心提供了有关直播指标的更多信息。

2023 年 8 月 7 日

正如2023 年 6 月 12 日宣布的那样,search.list 方法的 relatedToVideoId 参数已被废弃。该参数已不再受支持,并且 API 文档中已移除对该参数的引用。

2023 年 6 月 28 日

thumbnails.set 方法现在支持 uploadRateLimitExceeded 错误,该错误表示频道在过去 24 小时内上传了过多缩略图,应稍后重试。

2023 年 6 月 12 日

注意:这是一条废弃公告。

search.list 方法的 relatedToVideoId 参数已被弃用。自 2023 年 8 月 7 日起,YouTube 将停止支持此参数。

目前,我们已在 search.list 方法的文档中添加了废弃通知。我们将于 2023 年 8 月 7 日当天或之后从 search.list 文档中彻底移除此参数。

此外,API 实现指南中演示如何检索相关视频的示例已被移除。

2022 年 8 月 22 日

video.statistics 字段的类型注解从无符号长整数更正为字符串。

2022 年 8 月 5 日

YouTube 更改了字幕 ID 的生成方式,并将为所有字幕轨道分配新的字幕 ID。对于存储 caption_id 值的应用,此更改可能不向后兼容,但不会影响不存储 caption_id 值的应用。

在 2022 年 12 月 1 日之前,captions.listcaptions.updatecaptions.downloadcaptions.delete 方法将同时支持旧版和新版字幕轨 ID。不过,自 2022 年 12 月 1 日起,YouTube 将停止支持旧字幕轨 ID。届时,使用旧字幕轨 ID 调用上述任何 API 方法都会导致 captionNotFound 错误。

为应对这项变更,您应计划在 2022 年 12 月 1 日之前完全替换所有存储的字幕轨道数据。这意味着,对于您存储字幕轨数据的任何视频,您都应删除当前存储的数据,然后调用 captions.list 方法来检索视频的当前字幕轨,并像往常一样将数据存储在 API 响应中。

2022 年 7 月 12 日

YouTube API 服务的《服务条款》已更新。如需了解详情,请参阅 YouTube API 服务条款 - 修订记录

2022 年 4 月 27 日

更新了 videos.insert 方法说明,其中指出上传视频的文件大小上限已从 128GB 增加到 256GB。

2022 年 4 月 8 日

subscriptions.list 方法的 myRecentSubscribersmySubscribers 参数定义已更新,以指明 API 返回的订阅者数量上限可能有限。 此更改是文档更正,而非 API 行为更改。

2021 年 12 月 15 日

正如我们在 2021 年 11 月 18 日宣布的那样,随着在整个 YouTube 平台上将视频不喜欢数设为不公开的变更video 资源的 statistics.dislikeCount 属性现已设为不公开。

您可以访问 YouTube 官方博客,详细了解此变更。

2021 年 11 月 18 日

在整个 YouTube 平台上不再公开视频“踩”的次数的变更相符,video 资源的 statistics.dislikeCount 属性将于 2021 年 12 月 13 日变为私享。这意味着,只有在视频所有者对 API 请求进行了身份验证后,该媒体资源才会包含在 videos.list 端点的 API 响应中。

videos.rate 端点不受此更改的影响。

如果开发者不公开显示不喜欢数,但仍需要为其 API 客户端显示不喜欢数,则可以申请列入许可名单以获得豁免。如需申请豁免,您必须填写此申请表单

您可以访问 YouTube 官方博客,详细了解此变更。

2021 年 7 月 2 日

注意:这是一条废弃公告。

commentThreads.update 端点已废弃,不再受支持。 此端点重复了通过其他 API 端点提供的功能。您可以改为调用 comments.update

方法,如果您的代码需要 commentThreads 资源,请对 commentThreads.list 方法进行二次调用。

2021 年 7 月 1 日

所有使用 YouTube API 服务的开发者都必须完成 API 合规性审核,才能获得超过默认配额分配(1 万个单位)的配额。到目前为止,开发者需要填写并提交 YouTube API 服务 - 审核和配额增加表单,才能完成合规性审核流程和申请额外的配额单元分配。

为阐明这些流程并更好地满足使用我们 API 服务的开发者的需求,我们添加了三个新表单和一份填写这些表单的指南:

  • 已通过审核的开发者申请表单:已通过 API 合规性审核的开发者可以填写并提交此较短的表单,申请延长所分配的配额。
  • 申诉表单:如果 API 项目未通过合规性审核(或被拒绝增加配额单元),开发者可以填写并提交此表单。
  • 控制权变更表单:如果开发者或代表开发者运营 API 客户端的任何一方发生与 API 项目相关的控制权变更(例如,通过股票买卖、合并或其他形式的企业交易),则必须填写并提交此表单。这样,YouTube 的 API 团队便可以更新我们的记录、审核新 API 项目的用例合规性,以及验证开发者的当前配额分配。

每种新表单都会告知我们您打算如何使用 YouTube API,以便我们更好地为您提供帮助。

如需了解详情,请参阅我们新推出的 API 合规性审核指南

2021 年 5 月 12 日

注意:这是一条废弃公告。

此更新涵盖以下 API 变更:

  • channel 资源的 contentDetails.relatedPlaylists.favorites 属性已废弃。如2016 年 4 月 28 日的修订历史记录条目所述,收藏视频功能已被废弃多年。

    在此更新之前,如果 API 客户端尝试将视频添加到不存在的收藏夹播放列表,该 API 仍会创建一个新播放列表。今后,在这种情况下,系统将不会创建播放列表,并且 API 将返回错误。根据之前的公告,尝试通过添加、修改或删除内容来修改收藏夹播放列表的做法也已废弃,并且可能会随时开始返回错误。

  • 以下 channel 资源属性已废弃。YouTube 工作室界面和 YouTube 上已不再支持这些媒体资源。因此,这些版本也无法再通过 API 使用。

    • brandingSettings.channel.defaultTab
    • brandingSettings.channel.featuredChannelsTitle
    • brandingSettings.channel.featuredChannelsUrls[]
    • brandingSettings.channel.profileColor
    • brandingSettings.channel.showBrowseView
    • brandingSettings.channel.showRelatedChannels

    所有这些属性均已从 channel 资源表示法中移除,并且其定义也已从资源的属性列表中移除。此外,与这些属性相关的错误已从特定于方法的文档中移除。

  • 以下 channelSection 资源属性已废弃。YouTube 工作室界面和 YouTube 上已不再支持这些媒体资源。因此,这些版本也无法再通过 API 使用。

    • snippet.style
    • snippet.defaultLanguage
    • snippet.localized.title
    • localizations
    • localizations.(key)
    • localizations.(key).title
    • targeting
    • targeting.languages[]
    • targeting.regions[]
    • targeting.countries[]

    与此更改同时,由于 channelSection.list 方法支持的功能不受支持,因此 channelSection.list 方法的 hl 参数也已废弃。

    所有这些属性均已从 channelSection 资源表示法中移除,并且其定义也已从资源的属性列表中移除。此外,与这些属性相关的错误已从特定于方法的文档中移除。

  • 对于 channelSection 资源的 snippet.type 属性,以下值已废弃。YouTube 频道页面已不再支持这些值,因此通过 API 使用这些值也已不再受支持。

    • likedPlaylists
    • likes
    • postedPlaylists
    • postedVideos
    • recentActivity
    • recentPosts
  • playlist 资源的 snippet.tags[] 属性已废弃。YouTube 已不再支持此媒体资源,因此,您也无法通过 API 使用此媒体资源。

2021 年 2 月 9 日

playlistItem 资源支持两个新属性:

2021 年 1 月 28 日

此更新包含以下更改:

  • playlistItems.deleteplaylistItems.insertplaylistItems.listplaylistItems.updateplaylists.deleteplaylists.listplaylists.update 方法都支持新的 playlistOperationUnsupported 错误。当请求尝试执行对特定播放列表不允许的操作时,就会出现此错误。例如,用户无法从其上传的视频播放列表中删除视频,也无法删除播放列表本身。

    在所有情况下,此错误都会返回 400 HTTP 响应代码(Bad Request)。

  • 文档中已移除 playlistItems.list 方法的 watchHistoryNotAccessiblewatchLaterNotAccessible 错误。虽然用户的观看记录和稍后观看列表确实无法通过 API 访问,但 API 不会返回这些特定错误。

2020 年 10 月 15 日

开发者政策中新增了以下两个部分:

  • 新版第 III.E.4.i 部分提供了有关通过 YouTube 嵌入式播放器收集和发送的数据的更多信息。在用户与嵌入的 YouTube 播放器互动以表明播放意图之前,您对通过任何 YouTube 嵌入式播放器发送给我们的所有用户数据负责。您可以将“自动播放”设置为 false,以限制在用户与播放器互动之前与 YouTube 分享的数据。
  • 新版第 III.E.4.j 节与在将内容嵌入您的网站和应用之前检查内容的“面向儿童”(MFK) 状态有关。您有责任了解您在 API 客户端上嵌入的视频何时属于面向儿童的内容,并相应地处理从嵌入式播放器收集的数据。因此,您必须先使用 YouTube Data API 服务检查内容的状态,然后才能通过任何 YouTube 嵌入式播放器将其嵌入到 API 客户端。

新版查找视频的“面向儿童”状态指南介绍了如何使用 YouTube Data API 服务查询视频的 MFK 状态。

与这些更改同时,我们在嵌入式播放器参数文档中添加了一条提醒,说明如果您启用自动播放,系统会在用户与播放器无任何互动的情况下进行播放;因此,系统会在网页加载时收集和共享播放数据。

2020 年 10 月 8 日

此更新涵盖与 channel 资源相关的三项细微更改:

  • snippet.thumbnails 对象用于标识频道的缩略图,对于新创建的频道,此对象可能为空,并且最长可能需要 1 天的时间才能填充。
  • statistics.videoCount 属性仅反映频道的公开视频数量,即使对频道所有者也是如此。此行为与 YouTube 网站上显示的计数一致。
  • 如果渠道关键字(在 brandingSettings.channel.keywords 媒体资源中标识)超出 500 个字符的允许长度上限,或者包含未转义引号 ("),则可能会被截断。请注意,500 个字符的限制不是针对每个关键字的限制,而是针对所有关键字的总长度限制。 此行为与 YouTube 网站上的行为一致。

2020 年 9 月

注意:这是一条废弃公告。

此更新涵盖以下 API 变更。所有变更将于本公告发布之日(2020 年 9 月 9 日)当天或之后生效。因此,开发者不应再依赖下列任何 API 功能。

  • 以下 API 资源、方法、参数和资源属性将立即弃用,并将在本公告发布之日或之后停止运行:
  • 如果 API 请求将 managedByMe 参数设置为 true,则 channels.list 方法的 API 响应不再包含 prevPageToken 属性。这项更改不会影响其他 channels.list 请求的 prevPageToken 属性,也不会影响任何请求的 nextPageToken 属性。
  • 我们已于 2016 年 8 月 11 日宣布弃用 channel 资源的 contentDetails.relatedPlaylists.watchLatercontentDetails.relatedPlaylists.watchHistory 属性。playlistItems.insert 方法和 playlistItems.delete 方法对这些播放列表的支持现已完全废弃,这两个属性也已从文档中移除。
  • channels.list 方法的 mySubscribers 参数已于 2013 年 7 月 30 日宣布弃用,并已从文档中移除。使用 subscriptions.list 方法及其 mySubscribers 参数检索经过身份验证的用户频道的订阅者列表。
  • channel 资源的 invideoPromotion 对象及其所有子属性已从文档中移除,这些属性已于 2017 年 11 月 27 日宣布废弃。

2020 年 7 月 29 日

我们移除了与 part 参数相关的额外费用,从而简化了针对 API 请求收取配额的流程。自即日起,我们将仅收取所调用方法的基本费用。如需详细了解简化配额,请点击此处

此次变更的影响是,大多数 API 调用的配额费用会略有降低,而有些 API 调用的费用仍会保持不变。此项变更不会增加任何 API 调用的费用。总体而言,可能的影响是,您分配的配额(可在 Google Cloud 控制台中查看)会略微延长。

我们强烈建议所有开发者为其项目完成合规性审核,以确保能够继续访问 YouTube API 服务。

此修订历史记录条目最初发布于 2020 年 7 月 20 日。

2020 年 7 月 28 日

通过 2020 年 7 月 28 日之后创建的未验证 API 项目通过 videos.insert 端点上传的所有视频都将被限制为私享观看模式。如需解除此限制,每个项目都必须接受审核,以验证其是否符合服务条款

如果创作者使用未经验证的 API 客户端上传视频,系统会向其发送一封电子邮件,说明其视频已锁定为私享,并告知他们可以使用官方或经过审核的客户端来避免此限制。

2020 年 7 月 28 日之前创建的 API 项目目前不受此更改的影响。不过,我们强烈建议所有开发者为其项目完成合规性审核,以确保能够继续访问 YouTube API 服务。

2020 年 7 月 21 日

[更新时间:2020 年 7 月 28 日。]此修订历史记录条目中提及的文档更新已于 2020 年 7 月 28 日重新发布。

昨天,我们发布了与配额扣减流程相关的文档更新。 不过,由于意外情况,配额更改尚未生效。因此,为确保准确性,我们已还原相关文档。为避免混淆,我们已移除说明此项更改的修订历史记录条目,并将于近期重新发布。

2020 年 7 月 7 日

注意:这是一条废弃公告。

videos.insert 方法的 autoLevelsstabilize 参数现已废弃,并且这两个参数已从文档中移除。系统会忽略这些值,它们不会影响新上传视频的处理方式。

2020 年 6 月 15 日

新的遵守 YouTube 开发者政策指南提供了相关指南和示例,可帮助您确保 API 客户端遵守 YouTube API 服务条款政策(API 服务条款)的特定部分。

本指南深入介绍了 YouTube 如何强制执行《API 服务条款》的某些方面,但并不取代任何现有文档。本指南介绍了开发者在 API 合规性审核期间经常会问的一些常见问题。我们希望通过帮助您了解我们如何解读和执行政策,简化您的功能开发流程。

2020 年 6 月 4 日

注意:这是对之前的弃用公告的更新。

频道公告功能现已完全弃用。此项变更最初于 2020 年 4 月 17 日宣布,现已生效。因此,activities.insert 方法已不再受支持,activities.list 方法也不再返回频道公告。如需了解详情,请访问 YouTube 帮助中心

2020 年 4 月 17 日

注意:这是一条废弃公告。

YouTube 即将弃用频道公告功能。因此,activities.insert 方法将被弃用,activities.list 方法将停止返回频道公告。这些变更将于 2020 年 5 月 18 日当天或之后在该 API 中生效。如需了解详情,请访问 YouTube 帮助中心

2020 年 3 月 31 日

此更新包含以下更改:

  • 新资源和方法

    • 新的 member 资源代表 YouTube 频道的频道会员。会员向创作者提供定期的金钱支持,并获得特殊福利。例如,当创作者为聊天开启会员专享模式时,只有会员才能聊天。

      此资源取代了 sponsor 资源,后者在 YouTube Live Streaming API 中有所介绍。sponsor 资源现已废弃,API 客户端应更新对 sponsors.list 方法的调用,改用 members.list 方法。

    • 新的 membershipsLevel 资源用于标识由授权 API 请求的创作者管理的定价级别。 membershipsLevels.list 方法会检索创作者的所有会员等级的列表。

2020 年 1 月 10 日

该 API 现在支持识别面向儿童的内容(YouTube 称之为“面向儿童的内容”)。如需详细了解“面向儿童的内容”,请访问 YouTube 帮助中心。

channelvideo 资源支持两个新属性,可让内容创作者和观看者识别面向儿童的内容:

  • 借助 selfDeclaredMadeForKids 属性,内容创作者可以指定频道视频是否为面向儿童的内容。

    对于渠道,可以在调用 channels.update 方法时设置此属性。对于视频,可以在调用 videos.insertvideos.update 方法时设置此属性。

    请注意,只有在频道所有者授权了 API 请求的情况下,此属性才会包含在包含 channelvideo 资源的 API 响应中。
  • 借助 madeForKids 属性,任何用户都可以检索频道视频的“面向儿童”状态。例如,状态可能会根据 selfDeclaredMadeForKids 属性的值确定。如需详细了解如何为频道、视频或直播设置观众群,请访问 YouTube 帮助中心

我们还更新了 YouTube API 服务的《服务条款》和《开发者政策》。如需了解详情,请参阅 YouTube API 服务条款 - 修订历史记录。YouTube API 服务《服务条款》和《开发者政策》的变更将于 2020 年 1 月 10 日(太平洋时间)生效。

2019 年 9 月 10 日

API 参考文档已更新,以反映 YouTube 上报告订阅人数的方式发生了变化,因此 API 响应中也发生了变化。此次变更生效后,如果订阅人数超过 1,000 人,YouTube Data API 服务返回的订阅人数会向下舍入到小数点后 3 位。此更改会影响 channel 资源的 statistics.subscriberCount 属性。

注意:即使用户发送了针对其自己频道数据的授权请求,这项变更也会影响此媒体资源价值。频道所有者仍可以在 YouTube 工作室中看到确切的订阅人数。

例如,如果某个频道有 123,456 名订阅者,则 statistics.subscriberCount 属性将包含值 123000。下表显示了订阅人数在 API 响应中是如何舍入的,以及在其他公开显示的 YouTube 界面中是如何缩写的示例:

订阅人数示例 YouTube Data API 公开显示的 YouTube 界面
1,234 1230 1230
12,345 12300 1.23 万
123,456 123000 12.3 万
1,234,567 1230000 123 万
12,345,678 12300000 1230 万
123,456,789 123000000 1.23 亿

2019 年 4 月 4 日

此更新包含以下更改:

  • API 参考文档已更新,以便更好地说明每种方法的常见用例,并通过 API Explorer 微件提供动态的高质量代码示例。如需查看示例,请参阅 channels.list 方法的文档。现在,介绍 API 方法的页面上有两个新元素:

    • 借助 API Explorer 微件,您可以选择授权范围、输入示例参数和属性值,然后发送实际 API 请求并查看实际 API 响应。该 widget 还提供全屏视图,用于显示完整的代码示例,这些示例会动态更新以使用您输入的镜重范围和值。

    • 常见用例部分介绍了本页中介绍的方法的一个或多个常见用例。例如,您可以调用 channels.list 方法来检索特定渠道的数据,或检索当前用户渠道的数据。

      您可以使用该部分中的链接,在 API Explorer 中填充适用于您的用例的示例值,也可以打开已填充这些值的全屏 API Explorer。这些更改旨在让您更轻松地查看直接适用于您尝试在自己的应用中实现的用例的代码示例。

    目前,代码示例支持 Java、JavaScript、PHP、Python 和 curl。

  • 代码示例工具也已更新为新界面,提供上述所有功能。借助该工具,您可以探索不同方法的用例、将值加载到 API Explorer 中,以及打开全屏 API Explorer 以获取 Java、JavaScript、PHP 和 Python 中的代码示例。

    与此同时,我们移除了之前列出了适用于 Java、JavaScript、PHP 和 Python 的代码示例的页面。

  • JavaJavaScriptPHPPython 的快速入门指南已更新。修订版指南介绍了如何使用 API Explorer 中的代码示例,通过 API 密钥运行一个示例,通过 OAuth 2.0 客户端 ID 运行另一个示例。

请注意,上述更改取代了 2017 年添加到 API 文档中的交互式工具。

2018 年 7 月 9 日

此更新包含以下更改:

  • 更新了 channel 资源的 snippet.thumbnails 属性的定义,以指出在应用中显示缩略图时,您的代码应使用与 API 响应中返回的图片网址完全相同的图片网址。例如,您的应用不应在 API 响应中返回的网址中使用 http 网域,而应使用 https 网域。

    自 2018 年 7 月起,频道缩略图网址将仅在 https 网域中提供,API 响应中显示的网址就是如此。在此之后,如果您的应用尝试从 http 网域加载 YouTube 图片,您可能会在应用中看到损坏的图片。

  • 注意:这是一条废弃公告。

    video 资源的 recordingDetails.location.altitude 属性已废弃。我们无法保证视频会针对此属性返回值。同样,即使 API 请求尝试为该属性设置值,也可能不会存储传入数据。

2018 年 6 月 22 日

实现指南(以前称为“实现和迁移指南”)已更新,其中移除了有关从 v2 API 迁移到 v3 API 的说明。此外,我们还移除了 v3 API 中已废弃的功能(例如收藏的视频)的说明。

2017 年 11 月 27 日

此更新包含以下更改:

  • 注意:这是一条废弃公告。

    YouTube 将不再支持精选视频精选网站功能,这些功能在 API 中通过 channel 资源的 invideoPromotion 对象受支持。因此,该对象及其所有子属性都已废弃。

    在 2017 年 12 月 14 日之前,您仍可以检索和设置 invideoPromotion 数据。在付款日期后:

    • 在调用 channels.list 时尝试检索 invideoPromotion 部分将返回空 invideoPromotion,或者根本不会返回任何 invideoPromotion 数据。
    • 在调用 channels.update 时尝试更新 invideoPromotion 数据将至少在 2018 年 5 月 27 日之前返回成功响应,但这些尝试将被视为无操作,这意味着它们实际上不会执行更新。

    2018 年 5 月 27 日之后,这些请求可能会返回错误消息,例如指明 invalidPromotion 是无效的部分。

2017 年 11 月 16 日

此更新包含以下更改:

  • 交互式代码段工具现在支持 Node.js 代码示例。几乎所有 API 方法(例如 channels.list 方法)的文档中也都包含这些示例。

    可自定义的示例旨在为您提供特定于使用情形的 Node.js 应用入门点。该功能类似于 Node.js 快速入门指南中的代码。不过,这些示例确实包含一些快速入门中未提及的实用函数:

    • removeEmptyParameters 函数接受与 API 请求参数对应的键值对列表,并移除没有值的参数。
    • createResource 函数接受与 API 资源中的属性对应的键值对列表。然后,它会将这些属性转换为可在 insertupdate 操作中使用的 JSON 对象。以下示例展示了一组属性名称和值,以及代码为它们创建的 JSON 对象:
      # Key-value pairs:
      {'id': 'ABC123',
       'snippet.title': 'Resource title',
       'snippet.description': 'Resource description',
       'status.privacyStatus': 'private'}
      
      # JSON object:
      {
       'id': 'ABC123',
       'snippet': {
         'title': 'Resource title',
         'description': 'Resource description',
       },
       'status': {
         'privacyStatus': 'private'
       }
      }

    所有这些示例均可下载并在本地运行。如需了解详情,请参阅代码段工具说明中在本地运行完整代码示例的前提条件。

2017 年 10 月 25 日

此更新包含以下更改:

  • 交互式代码段工具中的 Python 代码示例已更新为使用 google-authgoogle-auth-oauthlib 库,而不是已废弃的 oauth2client 库。

    除了这项变更之外,该工具现在还为已安装的 Python 应用和 Python Web 服务器应用提供了完整的代码示例,这两种应用使用的授权流程略有不同。如需查看完整示例(以及此次变更),请执行以下操作:

    1. 前往交互式代码段工具或任何 API 方法(例如 channels.list 方法)的文档。
    2. 点击代码示例上方的 Python 标签页。
    3. 点击标签页上方的切换开关,即可从查看摘要切换为查看完整示例。
    4. 该标签页现在应显示使用 InstalledAppFlow 授权流程的完整代码示例。示例上方的说明对此进行了说明,并提供了指向 Web 服务器应用示例的链接。
    5. 点击链接以切换到 Web 服务器示例。该示例使用 Flask Web 应用框架和其他授权流程。

    所有这些示例均可下载并在本地运行。如果您想运行这些示例,请参阅代码段工具说明中有关在本地运行完整代码示例的说明。

2017 年 8 月 29 日

此更新包含以下更改:

  • 更新了 search.list 方法的 forContentOwner 参数的定义,以指明如果该参数设置为 true,则 type 参数必须设置为 video
  • 更新了 search.list 方法的 regionCode 参数定义,以明确说明该参数会将搜索结果限制为可在指定区域观看的视频。
  • YouTube 更新了品牌徽标和图标。您可以从品牌推广指南页面下载新的“由 YouTube 开发”徽标。该页面上还会显示其他新的 YouTube 徽标和图标,您也可以从 YouTube 品牌网站下载这些徽标和图标。

2017 年 7 月 24 日

此更新包含以下更改:

  • 我们推出了适用于 iOS 的全新 YouTube Data API 快速入门指南。该指南介绍了如何在使用 Objective-C 或 Swift 编写的简单 iOS 应用中使用 YouTube Data API。
  • YouTube Data API 的交互式代码段工具现在包含文档,其中介绍了该工具的一些功能:
    • 执行 API 请求
    • 在代码段和完整代码示例之间切换
    • 使用样板函数
    • 加载现有资源(适用于更新方法)

    注意:该工具还嵌入在 API 方法的 API 参考文档中(示例)。

2017 年 6 月 1 日

此更新包含以下更改:

2017 年 5 月 17 日

此更新包含以下更改:

  • API 参考文档已更新,以使代码段更常见且更具互动性。介绍 API 方法(例如 channels.listvideos.rate)的页面现在提供了一款交互式工具,可让您查看和自定义 Java、JavaScript、PHP、Python、Ruby、Apps Script 和 Go 中的代码段。

    对于任何给定方法,该工具都会显示一个或多个用例的代码段,每个用例都描述了调用该方法的常用方法。例如,您可以调用 channels.list 方法来检索特定渠道或当前用户渠道的数据。

    您还可以与代码示例互动:

    • 修改参数和属性值,代码段会动态更新以反映您提供的值。

    • 在代码段和完整示例之间切换。代码段显示了调用 API 方法的代码部分。完整示例包含该代码段以及用于授权和发送请求的样板代码。您可以通过命令行或本地 Web 服务器复制和运行完整示例。

    • 点击按钮即可执行请求。(如需执行请求,您需要授权该工具代表您调用 API。)

    请注意,此工具已取代了可用页面上的 API Explorer。(每个页面都会显示一个链接,以便您也可以选择在 API Explorer 中加载您正在处理的请求。)

  • Data API 代码段工具也已更新,采用了新的界面,提供上述所有功能。本页介绍的主要新功能包括:

    • 支持写入数据的 API 请求。
    • 支持 Java 示例。
    • 更灵活、更全面的样板代码,用于授权用户和构建 API 请求。

2017 年 4 月 27 日

此更新包含以下更改:

2017 年 3 月 30 日

此更新包含以下更改:

  • channel 资源的新 topicDetails.topicCategories[] 属性包含用于描述频道内容的 Wikipedia 网址列表。这些网址与资源的 topicDetails.topicIds[] 属性中返回的主题 ID 相对应。
  • playlistItem 资源的新 contentDetails.videoPublishedAt 属性用于标识视频发布到 YouTube 的时间。该资源已包含 snippet.publishedAt 属性,该属性用于标识内容添加到播放列表的时间。
  • channel 资源一样,video 资源现在会返回 topicDetails.topicCategories[] 属性,其中包含用于描述视频内容的 Wikipedia 网址列表。对于 video 资源,网址对应于资源的 topicDetails.relevantTopicIds[] 属性中返回的主题 ID。
  • video 资源的新 contentDetails.contentRating.mpaatRating 属性用于标识美国电影协会为电影预告片或预览片指定的评分。

2017 年 2 月 27 日

正如我们在 2016 年 8 月 11 日最初宣布的那样,YouTube 已将支持的主题 ID 列表改为由我们精选的列表。支持的主题 ID 的完整列表包含在 channelvideo 资源的 topicDetails 属性以及 search.list 方法的 topicId 参数中。

请注意,精选列表进行了以下几项更改:

  • 以下主题已添加为 Society 的子主题:
    名称主题 ID
    企业/m/09s1f
    健康/m/0kt51
    军事/m/01h6rj
    政治/m/05qt0
    宗教/m/06bvp
  • Animated cartoon 主题(以前是 Entertainment 的子主题)已被移除。
  • Children's music 主题(以前是 Music 的子主题)已被移除。

因此,与视频相关的主题现在始终会在 video 资源的 topicDetails.relevantTopicIds[] 属性值中返回。

2016 年 11 月 29 日

此更新包含以下更改:

  • 自 2017 年 2 月 10 日起,我们将对支持的主题 ID 列表进行以下三项细微更改:

    • Professional wrestling 类别之前是 Sports 类别的子类别,现在是 Entertainment 的子类别。
    • TV shows 类别(属于 Entertainment 的子类别)是新类别。
    • Health 类别(以前是 Lifestyle 的子类别)已被移除。

    另请注意,还有一些父级类别(EntertainmentGamingLifestyleMusicSports)。与子类别(例如 Tennis)关联的任何视频也将与父类别(Sports)关联。

2016 年 11 月 10 日

此更新包含以下更改:

  • 正如我们在 2016 年 8 月 11 日首次宣布的那样,由于 Freebase 和 Freebase API 已被弃用,因此我们需要对与主题 ID 相关的多个方面做出更改。主题 ID 用于标识与 channelvideo 资源相关的主题,您还可以使用 topicId 搜索参数查找与特定主题相关的频道或视频。

    自 2017 年 2 月 10 日起,YouTube 将开始返回一小组主题 ID,而不是目前返回的更精细的 ID 组。此外,请注意,频道和视频不一定会与任何主题相关联,这与当前的 API 行为一致。

    为便于您为这些变更做好 API 客户端准备,我们更新了以下 API 参数和属性的定义,以列出之后将受支持的主题 ID。请注意,所有媒体资源的类别列表都是相同的。

  • 注意:这是一条废弃公告。

    以下属性即将弃用:

    • channel 资源的 topicDetails.topicIds[] 属性。我们将在 2017 年 11 月 10 日之前继续支持此媒体资源。
    • video 资源的 topicDetails.relevantTopicIds[] 属性。我们将在 2017 年 11 月 10 日之前继续支持此媒体资源。
    • video 资源的 topicDetails.topicIds[] 属性。2017 年 2 月 10 日之后,此属性将不包含值。(在此日期之后,topicDetails.relevantTopicIds[] 属性值将用于标识与视频相关联的所有主题。)

  • 由于 Freebase 已被弃用,因此文档中已移除使用 Freebase 主题进行搜索指南。该指南提供了代码示例,展示了应用如何与 Freebase API 搭配使用。

    此外,我们还从 search.list 方法的文档中移除了与主题 ID 相关的多个代码示例。

2016 年 11 月 2 日

此更新包含以下更改:

  • 新属性和参数

    • video 资源包含多个新属性:

      • player.embedHtml 属性包含一个 <iframe> 标记,您可以使用该标记嵌入用于播放视频的播放器。新的 player.embedHeightplayer.embedWidth 属性用于标识嵌入式播放器的尺寸。只有当 API 请求为 maxHeightmaxWidth 参数中的至少一个指定值时,才会返回这些属性。本文修订历史记录条目稍后会介绍这两个新参数。

      • 新的 hasCustomThumbnail 属性用于指明视频上传者是否为视频提供了自定义缩略图图片。请注意,只有视频上传者才能看到此属性。

      • 新的 fpbRatingReasons[] 用于指明视频获得 FPB(南非)分级的原因。

      • 新的 mcstRating 用于标识视频在越南获得的分级。

    • videos.list 方法支持两个新参数:maxHeightmaxWidth。在检索 video 资源中的 player 部分时,您可以使用任一参数或同时使用这两个参数。

      默认情况下,player.embedHtml 属性中返回的 <iframe> 的高度为 360 像素。宽度会调整为与视频的宽高比一致,从而确保嵌入式播放器不会在视频周围显示黑边。例如,如果视频的宽高比为 16:9,则播放器的宽度为 640 像素。

      借助这些新参数,您可以指定嵌入代码应使用与应用布局相适应的高度和/或宽度,而不是默认尺寸。API 服务器会酌情缩放播放器尺寸,以确保嵌入式播放器不会在视频周围显示黑边。请注意,这两个参数都指定了嵌入式播放器的最大尺寸。因此,如果同时指定这两个参数,一个维度可能仍小于该维度允许的最大值。

      例如,假设某个视频的宽高比为 16:9。因此,如果未设置 maxHeightmaxWidth 参数,player.embedHtml 标记将包含一个 640x360 播放器。

      • 如果 maxHeight 参数设置为 720,且未设置 maxWidth 参数,则该 API 会返回 1280x720 播放器。
      • 如果 maxWidth 参数设置为 960,并且未设置 maxHeight 参数,则该 API 会返回 960x540 的播放器。
      • 如果将 maxWidth 参数设置为 960,并将 maxHeight 参数设置为 450,则该 API 会返回 800x450 的播放器。

      上述新的 player.embedHeightplayer.embedWidth 属性用于标识播放器的尺寸。

  • 对现有方法、属性和参数的更新

    • channelSection 资源说明已更新,其中指出,如果不设置定位数据,频道最多可以创建 10 个搁架;如果设置定位数据,则最多可以创建 100 个搁架。

      此外,channelSection 资源的 targeting 属性已更新,以反映定位选项只能使用 API 进行设置。如果使用 YouTube 网站上的界面修改频道版块,系统会删除定位选项。

    • 更正了 i18nLanguage 资源的 snippet.name 属性的定义,以反映该值表示语言名称,因为它是使用 i18nLanguage.list 方法的 hl 参数指定的语言编写的。

    • playlistItem 资源的 contentDetails.note 属性已更新,其中指出属性值的长度上限为 280 个字符。

    • playlistItem 资源的 contentDetails.startAtcontentDetails.endAt 属性已废弃。如果这些字段在 playlistItems.insertplaylistItems.update 请求中设置,则会被忽略。

    • playlistItems.deleteplaylistItems.update 方法现在支持 onBehalfOfContentOwner 参数,其他一些方法已支持该参数。使用该方法的请求还需要使用可访问 https://www.googleapis.com/auth/youtubepartner 范围的令牌进行授权。

    • search.list 方法的 publishedBeforepublishedAfter 参数已更新,以指明参数值是包含边界的。例如,如果设置了 publishedBefore 参数,则 API 会返回在指定时间之前创建的资源。

    • video 资源的 contentDetails.contentRating.grfilmRating 属性支持另外三个值:grfilmK12grfilmK15grfilmK18

    • 更新了 videos.insert 方法说明,其中指出上传视频的文件大小上限已从 64GB 增加到 128GB。

  • 新增和更新的错误

    • 该 API 支持以下新错误:

      错误类型 错误详情 说明
      forbidden (403) homeParameterDeprecated activities.list 方法会返回此错误,以指明无法通过此 API 获取用户的主页面活动数据。如果您在未经授权的请求中将 home 参数设置为 true,可能会发生此错误。
      invalidValue (400) invalidContentDetails playlistItems.insert 方法会返回此错误,以指示请求中的 contentDetails 对象无效。出现此错误的一个原因是 contentDetails.note 字段的长度超过 280 个字符。
      forbidden (403) watchHistoryNotAccessible playlistItems.list 方法会返回此错误,表示请求尝试检索“观看记录”播放列表项,但无法使用该 API 检索这些项。
      forbidden (403) watchLaterNotAccessible playlistItems.list 方法会返回此错误,表示请求尝试检索“稍后观看”播放列表项,但无法使用该 API 检索这些项。
      badRequest (400) uploadLimitExceeded videos.insert 方法会返回此错误,以指示频道已超出其可以上传的视频数量。
      forbidden (403) forbiddenEmbedSetting videos.update 方法会返回此错误,以指示 API 请求尝试为视频设置无效的嵌入设置。请注意,部分频道可能无权为直播提供嵌入式播放器。如需了解详情,请访问 YouTube 帮助中心
    • 如果您将重复的视频插入播放列表,playlistItems.insert 方法不再返回错误。之前,某些播放列表(例如收藏夹)不允许添加重复内容,但现在已不再受支持,因此会出现此错误。一般来说,播放列表允许添加重复的视频。

  • 其他更新

    • 更新了 2016 年 9 月 15 日的修订历史记录条目,以明确说明每当响应中包含 channel 资源的 contentDetails.relatedPlaylists.watchHistorycontentDetails.relatedPlaylists.watchLater 属性时,它们始终分别包含值 HLWL。此外,只有在授权用户检索与用户自家频道相关的数据时,这些媒体资源才会包含在内。

2016 年 9 月 15 日

此更新包含以下更改:

  • 2016 年 8 月 11 日的修订历史记录更新中讨论了与主题 ID 相关的几项变更,包括从 2017 年 2 月 10 日起,支持的主题 ID 集将发生变化。我们将于 2016 年 11 月 10 日之前公布受支持的主题列表。

  • 以下变更现已生效。我们已在 2016 年 8 月 11 日的修订历史记录更新中通知了这些更改:

    • 如果将 home 参数设置为 true 调用 activities.list 方法,API 响应现在包含与未登录的 YouTube 用户在首页上看到的内容类似的内容。

      这是一个细微的更改,旨在提供比 2016 年 8 月 11 日修订历史记录更新中所述行为更好的用户体验。该更新指出,使用 home 参数的请求将返回空列表。

    • 对于所有渠道,channel 资源的 contentDetails.relatedPlaylists.watchHistorycontentDetails.relatedPlaylists.watchLater 属性现在分别包含 HLWL 的值。

      需要明确的是,只有在检索与用户自家频道相关的数据时,授权用户才能看到这些媒体资源。这些属性始终包含值 HLWL,即使是授权用户检索与用户自己的频道相关的数据也是如此。因此,您无法通过该 API 检索观看记录和稍后观看播放列表 ID。

      此外,现在,如果请求检索频道的观看记录或“稍后观看”播放列表的播放列表详情 (playlists.list) 或播放列表项 (playlistItems.list),则会返回空列表。这种行为适用于新值 HLWL,以及您的 API 客户端可能已存储的任何观看记录或稍后观看播放列表 ID。

  • 系统不再返回 video 资源的 fileDetails.recordingLocation 对象及其子属性。以前,只有视频所有者才能检索此类数据(例如父级 fileDetails 对象)。

2016 年 8 月 11 日

此更新包含以下更改:

  • 新发布的 YouTube API 服务《服务条款》(以下简称“新版《服务条款》”)在 YouTube 工程和开发者博客中进行了详细讨论,对当前《服务条款》进行了大量更新。除了更新后的条款(自 2017 年 2 月 10 日起生效)之外,此更新还包含一些辅助文件,旨在帮助说明开发者必须遵循的政策。

    更新版条款的修订记录中介绍了完整的新文档。此外,日后对修订版条款或这些证明文件所做的更改也会在修订记录中说明。您可以通过该文档中的链接订阅 RSS Feed,以便查看该修订记录中的更改。

  • 由于 Freebase 和 Freebase API 已废弃,因此与主题 ID 相关的多项内容发生了变化。主题 ID 在以下 API 资源和方法中使用:

    • channel 资源的 topicDetails 部分用于标识与频道相关的主题。
    • video 资源的 topicDetails 部分用于标识与视频相关的主题。
    • 借助 search.list 方法的 topicId 参数,您可以搜索与特定主题相关的视频或频道。

    这些功能的具体变更如下:

    • 自 2017 年 2 月 10 日起,YouTube 将开始返回一小组主题 ID,而不是目前返回的更精细的 ID 组。这组受支持的主题将识别体育篮球等高级类别,但不会识别特定球队或球员。我们将公布一系列受支持的主题,以便您有时间为应用做好相应准备,以应对这项变更。

    • 在 2017 年 2 月 10 日之前,您可以使用已检索到的任何 Freebase 主题 ID 搜索内容。不过,在此之后,您只能使用上文中所述的一小部分主题来按主题检索搜索结果。

    • 2017 年 2 月 10 日之后,如果您尝试使用不在较小一组受支持的主题 ID 中的主题 ID 搜索结果,该 API 将返回一个空的结果集。

  • 自 2016 年 9 月 12 日起,以下多个 API 字段和参数将被弃用:

    • activities.list 方法的 home 参数让已获授权的用户能够检索要显示在该用户 YouTube 首页上的活动 Feed。2016 年 9 月 12 日之后使用此参数的请求将返回空列表。

    • 只有检索用户自家频道相关数据的获授权用户才能看到 channel 资源的 contentDetails.relatedPlaylists.watchHistorycontentDetails.relatedPlaylists.watchLater 属性。2016 年 9 月 12 日之后,对于所有渠道,contentDetails.relatedPlaylists.watchHistory 将返回值 HLcontentDetails.relatedPlaylists.watchLater 属性将返回值 WL

      2016 年 9 月 12 日之后,如果请求检索频道观看记录或稍后观看列表的播放列表详情 (playlists.list),系统将返回一个空列表。在该时间之后,针对这两个播放列表中任一播放列表检索播放列表项 (playlistItems.list) 的请求也会返回空列表。这适用于新值 HLWL,以及您的 API 客户端可能已存储的任何观看记录或稍后观看播放列表 ID。

    • 2016 年 9 月 12 日之后,系统将不再返回 video 资源的 fileDetails.recordingLocation 对象或其任何子属性。只有视频的所有者才能检索此类数据,因为只有视频所有者才能检索父级 fileDetails 对象。

2016 年 6 月 13 日

此更新包含以下更改:

  • channel 资源的 contentDetails.googlePlusUserId 属性已废弃。以前,只有当频道与 Google+ 个人资料相关联时,此属性才会显示。废弃后,该属性将不再包含在任何 channel 资源中。

  • comment 资源的 snippet.authorGoogleplusProfileUrl 属性已废弃。以前,只有当频道与 Google+ 个人资料相关联时,此属性才会显示。废弃后,该属性将不再包含在任何 comment 资源中。

废弃后,系统将不会返回这两个属性,因此已从相应的资源文档中移除这两个属性。

2016 年 5 月 31 日

此更新包含以下更改:

  • subscriptions.list 方法的新 myRecentSubscribers 参数会按用户订阅频道的时间(从后往前)检索已验证用户频道的订阅者列表。

    请注意,新参数仅支持检索已通过身份验证的用户频道的最近 1,000 位订阅者。如需检索完整的订阅者列表,请使用 mySubscribers 参数。该参数不会按特定顺序返回订阅者,也不会限制可检索的订阅者数量。

  • 更新了activityplaylistItemplaylistsearch resultthumbnailvideo 资源的 snippet.thumbnails.(key) 属性定义,以指明某些视频支持其他缩略图图片尺寸。

    • standard 图片的宽度为 640 像素,高度为 480 像素。
    • maxres 图片的宽度为 1280 像素,高度为 720 像素。
  • 更新了 channelSection.list 方法的 part 参数的定义,以指出检索 targeting 部分需要消耗 2 配额单元。

  • 现在,如果未正确授权的请求尝试检索 video 资源的 fileDetailsprocessingDetailssuggestions 部分,videos.list 方法会返回禁止 (403) 错误。只有视频所有者才能看到这些部分。

2016 年 5 月 17 日

新的 Data API 代码段工具提供了适用于常见 YouTube Data API 用例的简短代码段。目前,代码段适用于 Apps Script、Go、JavaScript、PHP、Python 和 Ruby 中的所有只读 API 方法。

对于每种方法,该工具都会显示一个或多个用例的代码示例。例如,它为 search.list 方法提供了五个代码段:

  • 按关键字列出视频
  • 按地理位置列出视频
  • 列出直播
  • 搜索经过身份验证的用户的视频
  • 列出相关视频

对于每个用例,该工具都会显示 API 请求中使用的参数。您可以修改参数值,在这种情况下,该工具会更新代码段以反映您提供的参数值。

最后,该工具会显示对每个请求的 API 响应。如果您修改了请求参数,API 响应将基于您提供的参数值。请注意,您需要授权该工具代表您提交请求,以便显示 API 响应。

2016 年 4 月 28 日

此更新包含以下更改:

  • video 资源的新 contentDetails.projection 属性用于指定视频的投影格式。有效的属性值为 360rectangular

  • video 资源的 recordingDetails.locationfileDetails.recordingLocation 属性已更新,以说明这两个属性之间的区别:

    • recordingDetails.location 属性用于标识视频所有者希望与视频相关联的位置。此地点可修改,会出现在公开视频的搜索结果中,并且可能会向用户显示公开视频的地点信息。
    • fileDetails.recordingLocation 属性值不可变,表示与上传的原始视频文件关联的位置。只有视频所有者才能看到此值。

  • 更新了 channel 资源的 contentDetails.relatedPlaylists.favorites 属性的定义,以指出该属性值可能包含一个指向空播放列表且无法提取的播放列表 ID。这是因为收藏视频功能已被弃用。请注意,此属性不受 API 弃用政策的约束

  • 更新了 ineligibleAccount 错误(可由 comments.insertcomments.updatecommentThreads.insertcommentThreads.update 方法返回)的定义,以反映当用于授权 API 请求的 YouTube 账号尚未与用户的 Google 账号合并时,会发生此错误。

2016 年 4 月 20 日

此更新包含以下更改:

  • 更新了 channels.update 方法的 part 参数的定义,以指明 localizations 也是该参数的有效值。

  • “使用入门”指南的配额使用情况部分已更新为链接到 Google 开发者控制台,您可以在该控制台中查看实际配额和配额使用情况。

2016 年 3 月 16 日

此更新包含以下更改:

  • 对现有资源和方法的更新

    • channelBanner 资源文档已更新,其中指出上传的频道横幅图片的建议大小为 2560 像素 x 1440 像素。最小尺寸(2048 x 1152 像素)保持不变。

    • channel 资源的新 snippet.customUrl 属性用于标识与频道关联的自定义网址。(并非所有频道都有自定义网址。)YouTube 帮助中心介绍了获取自定义网址的资格要求以及如何设置自定义网址。

    • channel 资源的 brandingSettings.watch 对象及其所有子属性已废弃。

    • search.list 请求的 API 响应现在包含 regionCode 属性。此属性用于标识用于搜索查询的区域代码。地区代码会指示 API 返回指定国家/地区的搜索结果。

      此属性值是用于标识地区的双字母 ISO 国家/地区代码。i18nRegions.list 方法会返回受支持的区域列表。默认值为 US。如果指定了不受支持的区域,YouTube 可能仍会选择其他区域(而不是默认值)来处理查询。

    • 更新了 videoAbuseReportReason 资源的 snippet.labelsnippet.secondaryReasons[].label 属性的定义,以指明这些属性包含滥用报告原因的本地化标签文本。

      此外,videoAbuseReportReasons.list 方法现在支持 hl 参数,该参数用于指定 API 响应中标签文本应采用的语言。默认参数值为 en_US

    • video 资源的新 contentDetails.contentRating.ecbmctRating 属性用于标识土耳其文化和旅游部评估和分级委员会对视频的分级。

      此外,其他分级系统的 API 属性支持以下新属性值:

      • contentDetails.contentRating.fpbRating(南非)
        分级:10;属性值:fpb10
      • contentDetails.contentRating.moctwRating(台湾)
        分级:R-12;属性值:moctwR12
      • contentDetails.contentRating.moctwRating(台湾)
        分级:R-15;属性值:moctwR15
    • video 资源的 liveStreamingDetails.activeLiveChatId 属性包含与视频关联的有效实时聊天的 ID。只有当视频是当前正在直播且已启用实时聊天功能时,此属性值才会显示。直播结束和实时聊天结束后,系统将不再针对视频返回此属性。

    • video 资源的 status.rejectionReason 属性支持新属性值 legal

  • 该 API 支持以下新错误:

    错误类型 错误详情 说明
    badRequest (400) notEditable channelSections.insertchannelSections.updatechannelSections.delete 方法会返回此错误,以指明无法创建、更新或删除指定的频道版块。
    badRequest (400) styleRequired channelSections.insertchannelSections.update 方法会返回此错误,以指示在 API 请求中提交的 channelSection 资源必须为 snippet.style 属性指定值。
    badRequest (400) typeRequired channelSections.insertchannelSections.update 方法会返回此错误,以指示在 API 请求中提交的 channelSection 资源必须为 snippet.type 属性指定值。
    badRequest (400) processingFailure commentThreads.list 方法会返回此错误,以指示 API 服务器未能成功处理请求。虽然这可能是一个暂时性错误,但通常表示请求的输入无效。检查请求正文中的 commentThread 资源的结构,确保其有效。
    forbidden (403) commentsDisabled commentThreads.list 方法会返回此错误,以指示 videoId 参数标识的视频已停用评论。
    badRequest (400) commentTextTooLong commentThreads.insert 方法会返回此错误,以指示要插入的 comment 资源的 snippet.topLevelComment.snippet.textOriginal 属性中包含的字符数过多。
    invalidValue (400) videoAlreadyInAnotherSeriesPlaylist playlistItems.insert 方法会返回此错误,表示您尝试添加到播放列表中的视频已在另一个系列播放列表中。如需详细了解系列播放列表,请访问 YouTube 帮助中心
    badRequest (400) subscriptionForbidden subscriptions.insert 方法会返回此错误,表示您已达到订阅数量上限,或者您最近创建的订阅数量过多。如果是后一种情况,您可以在几个小时后重试请求。
    badRequest (400) invalidCategoryId videos.update 方法会返回此错误,以指明上传的 video 资源中的 snippet.categoryId 属性指定了无效的类别 ID。使用 videoCategories.list 方法检索受支持的类别。
    badRequest (400) invalidDescription videos.update 方法会返回此错误,以指明上传的 video 资源中的 snippet.description 属性指定了无效的值。
    badRequest (400) invalidPublishAt videos.update 方法会返回此错误,以指明上传的 video 资源中的 status.publishAt 属性指定了无效的安排发布时间。
    badRequest (400) invalidRecordingDetails videos.update 方法会返回此错误,以指明上传的 video 资源中的 recordingDetails 对象指定了无效的录制详细信息。
    badRequest (400) invalidTags videos.update 方法会返回此错误,以指明上传的 video 资源中的 snippet.tags 属性指定了无效的值。
    badRequest (400) invalidTitle videos.update 方法会返回此错误,以指明上传的 video 资源中的 snippet.title 属性指定了无效或空的视频名。
    badRequest (400) invalidVideoMetadata videos.update 方法会返回此错误,以指明请求元数据无效。如果请求更新了 video 资源的 snippet 部分,但未为 snippet.titlesnippet.categoryId 属性设置值,则会出现此错误。

2015 年 12 月 18 日

根据欧盟 (EU) 法律,您必须向欧盟境内的最终用户披露相关信息并征求他们的意见。因此,对于欧盟境内的最终用户,您必须遵守《欧盟地区用户意见征求政策》。我们已在 YouTube API 服务条款中添加了关于此要求的通知。

2015 年 11 月 19 日

该 API 现在支持为 playlistvideo 资源的 snippet.titlesnippet.description 属性、channelSection 资源的 snippet.title 属性以及 channel 资源的 snippet.description 属性设置和检索本地化文本。

  • 设置本地化商品名和说明

    您可以在调用资源的 insertupdate 方法时为资源设置本地化值。如需为资源设置本地化值,请执行以下两项操作:

    • 确保为资源的 snippet.defaultLanguage 属性设置了值。该属性用于标识资源的 snippet.titlesnippet.description 属性的语言。其值可以是任何受支持的应用语言或大多数其他 ISO 639-1:2002 语言代码。例如,如果您上传的视频的标题和说明使用的是英语,则应将 snippet.defaultLanguage 属性设置为 en

      关于更新 channel 资源的注意事项:如需为 channel 资源设置 snippet.defaultLanguage 属性,您实际上需要更新 brandingSettings.channel.defaultLanguage 属性。

    • localizations 对象添加到要更新的资源。每个对象键都是一个字符串,用于标识应用语言或 ISO 639-1:2002 语言代码,每个键都会映射到一个对象,其中包含资源的本地化标题(和说明)。

      以下示例代码段将资源的默认语言设置为英语。它还会为视频添加经过本地化处理的德语和西班牙语标题和说明:

      {
        "kind": "youtube#video",
        ...
        "snippet": {
          "title": "Playing soccer",
          "description": "We play soccer in the park on Sundays.",
          "defaultLanguage": "en",
          ...
        },
        "localizations":
          "de": {
            "title": "Fußball spielen",
            "description": "Wir spielen Fußball im Park am Sonntag"
          },
          "es": {
            "title": "Jugar al fútbol",
            "description": "Nosotros jugamos fútbol en el parque los domingos",
          }
        }
      }
    • 重要提示:请注意,更新资源的本地化数据时,您的 API 请求必须包含数据的所有现有本地化版本。例如,如果您在上述示例中发送了后续请求,以便为视频添加葡萄牙语数据,则该请求需要包含德语、西班牙语和葡萄牙语的本地化数据。

  • 检索本地化值

    该 API 支持通过两种方式检索资源的本地化值:

    • hl 参数添加到 channels.listchannelSections.listplaylists.listvideos.list 请求中,以检索YouTube 网站支持的特定应用语言的本地化数据。如果该语言有本地化资源详情,资源的 snippet.localized 对象将包含本地化值。不过,如果没有本地化详情,snippet.localized 对象将包含资源的默认语言版本的资源详情。

      例如,假设 videos.list 请求检索了上述视频的数据,其中包含本地化的德语和西班牙语数据。如果将 hl 参数设置为 de,则资源将包含以下数据:

      {
        "kind": "youtube#video",
        ...
        "snippet": {
          "title": "Playing soccer",
          "description": "We play soccer in the park on Sundays.",
          "defaultLanguage": "en",
          "localized": {
            "title": "Fußball spielen",
            "description": "Wir spielen Fußball im Park am Sonntag"
          }
          ...
        }
      }

      不过,如果将 hl 参数设为 frsnippet.localized 对象将包含英语标题和说明,因为英语是资源的默认语言,并且没有本地化的法语详细信息。

      重要提示hl 参数仅支持用于标识 YouTube 网站支持的应用语言的值。如需确定是否有其他语言的本地化文本,您需要检索资源的 localizations 部分并进行过滤,以确定是否存在本地化文本。

      例如,您需要检索完整的本地化列表,以确定是否有亚美英语的本地化文本。

    • 检索资源时,请在 part 参数值中添加 localizations,以检索该资源的所有本地化详细信息。如果您要检索的本地化数据所用的语言不是当前的 YouTube 应用语言,则需要使用此方法检索所有本地化数据,然后进行过滤以确定所需的本地化数据是否存在。

  • 与本地化文本值相关的错误

    该 API 还支持以下针对本地化文本值的新错误:

    错误类型 错误详情 说明
    badRequest (400) defaultLanguageNotSetError 此错误表示,由于未为相应资源设置 snippet.defaultLanguage 属性,因此尝试为资源插入或更新 localizations 对象的请求会失败。channels.updatechannelSections.insertchannelSections.updateplaylists.insertplaylists.updatevideos.insertvideos.update 方法支持此错误。
    badRequest (400) localizationValidationError 此错误表示资源的 localizations 对象中的某个值未通过验证。例如,如果对象包含无效的语言代码,就可能会发生此错误。channels.updatechannelSections.insertchannelSections.updateplaylists.insertplaylists.update 方法支持此错误。

2015 年 11 月 4 日

此更新包含以下更改:

  • 对现有资源和方法的更新

    • search.list 方法的 order 参数已更新,以指明如果您按 viewCount 对直播进行排序,API 结果会按直播仍在进行时的并发观看者数量进行排序。

    • search.list 方法的 relatedToVideoId 参数已更新,以指明如果设置了该参数,则仅支持 partmaxResultspageTokenregionCoderelevanceLanguagesafeSearchtype(必须设置为 video)和 fields 这几个参数。此更新并不反映 API 行为的变化。

    • 更新了 video 资源的 snippet.publishedAt 属性的定义,以指出该属性值(用于指定视频的发布日期和时间)可能与视频的上传时间不同。例如,如果视频在上传时设为私享,之后再设为公开,则此属性值会指定视频的公开时间。更新后的定义还说明了如何为私享视频和不公开列出的视频填充此值。

      这项更改并不反映 API 行为的变化。

    • video 资源的 status.publishAt 属性的定义已更新,以提及:

      • 如果您在调用 videos.update 方法时设置了此属性的值,则还必须将 status.privacyStatus 属性值设置为 private,即使视频已设为私享也是如此。
      • 如果请求将视频安排在过去的某个时间发布,系统会立即发布该视频。因此,将 status.publishAt 属性设为过去的日期和时间的效果与将视频的 privacyStatusprivate 更改为 public 的效果相同。
    • video 资源的 contentDetails.contentRating.cncRating 属性用于指定法国电影分级委员会对视频的分级。此属性取代了现已废弃的 contentDetails.contentRating.fmocRating 属性。

    • channel 资源的 brandingSettings.channel.keywords 的定义已更新,以正确反映属性值包含以空格分隔的字符串列表,而不是逗号分隔的列表,如之前所述。此更新并不表示 API 行为发生了变化。

    • 更新了 thumbnails.set 方法的文档,以准确反映请求正文包含您要上传并与视频相关联的缩略图图片。请求正文不包含 thumbnail 资源。之前,文档中指出您不应在调用此方法时提供请求正文。此更新并不表示 API 行为发生了变化。

    • 更新了 activity 资源的说明,以反映 activities.list 方法目前不包含与新视频评论相关的资源。资源的 snippet.typecontentDetails.comment 也已更新。

  • 新增和更新的错误

    • 该 API 现在支持以下错误:

      错误详情
      activities.insert
      HTTP 响应代码badRequest (400)
      原因invalidMetadata
      说明kind 属性与提供的 ID 类型不匹配。
      commentThreads.update
      comments.insert
      comments.update
      HTTP 响应代码badRequest (400)
      原因commentTextTooLong
      说明要插入或更新的 comment 资源的 snippet.topLevelComment.snippet.textOriginal 属性包含的字符过多。
      playlistItems.insert
      playlistItems.update
      HTTP 响应代码forbidden (403)
      原因playlistItemsNotAccessible
      说明请求未获得正确授权,无法插入、更新或删除指定的播放列表项。
      playlists.delete
      playlists.insert
      playlists.update
      HTTP 响应代码badRequest (400)
      原因playlistForbidden
      说明此操作已被禁止,或者请求未获得适当授权。
      search.list
      HTTP 响应代码badRequest (400)
      原因invalidLocation
      说明location 和/或 locationRadius 参数值的格式不正确。
      search.list
      HTTP 响应代码badRequest (400)
      原因invalidRelevanceLanguage
      说明relevanceLanguage 参数值的格式不正确。
      subscriptions.insert
      HTTP 响应代码badRequest (400)
      原因subscriptionForbidden
      说明当满足以下任一条件时,就会发生此错误:
      • 您尝试创建的订阅已存在
      • 您的订阅数量已达到上限
      • 您尝试订阅自己的频道,但系统不支持此操作。
      • 您最近创建的订阅过多,需要等待几个小时后才能重试该请求。
      videos.update
      HTTP 响应代码badRequest (400)
      原因invalidDefaultBroadcastPrivacySetting
      说明请求尝试为默认广播设置无效的隐私设置。

2015 年 8 月 28 日

此更新包含以下更改:

  • 对现有资源和方法的更新

    • video 资源的 statistics.favoriteCount 属性已废弃。

      根据我们的弃用政策,在本公告发布后的至少一年内,此媒体资源仍将包含在 video 资源中。不过,该属性值现在始终设置为 0

2015 年 8 月 7 日

此更新包含以下更改:

  • 对现有资源和方法的更新

    • 更新了 video 资源的 snippet.tags[] 属性的定义,以详细说明 API 服务器如何计算该属性值的长度。请注意,此更新并不反映 API 行为的变化。

      具体而言,该定义现在说明,如果代码包含空格,API 服务器会将代码值视为用引号括起来,并且引号会计入字符数限制。因此,从字符数限制的角度来看,标记 Foo-Baz 包含 7 个字符,但标记 Foo Baz 包含 9 个字符。

    • commentThreads.insert 方法不再支持 shareOnGooglePlus 参数,该参数之前用于指明是否应将评论及其回复也发布到作者的 Google+ 个人资料中。如果请求提交该参数,API 服务器会忽略该参数,但会以其他方式处理请求。

2015 年 6 月 18 日

此更新包含以下更改:

  • 对现有资源和方法的更新

    • commentThreads.list 方法的新 order 参数用于指定 API 响应应按何种顺序列出评论会话。会话可以按时间或相关性排序。默认行为是按时间排序。

    • video 资源的新 snippet.defaultAudioLanguage 属性用于指定视频的默认音轨中使用的语言。

    • video 资源的 contentDetails.licensedContent 属性的定义已更新,以明确说明内容必须最初上传到与 YouTube 内容合作伙伴关联的频道,然后由该合作伙伴提出版权主张。这并不表示实际 API 行为发生了变化。

    • captions.deletecaptions.downloadcaptions.insertcaptions.listcaptions.update 方法现在支持 onBehalfOfContentOwner 参数,其他一些方法也已支持该参数。使用该方法的请求还需要使用可访问 https://www.googleapis.com/auth/youtubepartner 范围的令牌进行授权。

  • 新增和更新的错误

    • 该 API 现在支持以下错误:

      错误详情
      videos.rate
      HTTP 响应代码badRequest (400)
      原因emailNotVerified
      说明用户必须先验证其电子邮件地址,然后才能对视频进行评分。
      videos.rate
      HTTP 响应代码badRequest (400)
      原因videoPurchaseRequired
      说明只有租借了视频的用户才能对其进行评分。
    • subscriptions.deletesubscriptions.insert 方法不再支持 accountClosedaccountSuspended 错误。

2015 年 4 月 27 日

此更新包含以下更改:

  • 新资源和方法

    • 新的 videoAbuseReportReason 资源包含有关视频被标记为包含滥用内容的原因的信息。借助 videoAbuseReportReasons.list 方法,您可以检索可能导致视频被举报的所有原因的列表。

    • 新的 videos.reportAbuse 方法提供了一种实际标记包含滥用内容的视频的方法。请求正文包含一个 JSON 对象,用于指定被举报的视频以及被认定为包含滥用内容的原因。您可以通过上述 videoAbuseReportReason.list 方法获取有效的原因。

      迁移指南也已更新,其中添加了举报滥用视频的示例。经过这项更改,v3 API 现在支持其计划支持的所有 v2 API 功能。迁移指南中也介绍了这些功能。

  • 对现有资源和方法的更新

    • search.list 方法的新 forDeveloper 过滤条件参数会限制搜索,使其仅检索通过开发者的应用或网站上传的视频。forDeveloper 参数可与 q 参数等可选搜索参数结合使用。

      启用此功能后,系统会自动为每个上传的视频添加项目编号,该编号与开发者的 Google 开发者控制台中的应用相关联。

      当搜索请求随后将 forDeveloper 参数设为 true 时,API 服务器会使用请求的授权凭据来识别开发者。因此,开发者可以将结果限制为仅显示通过开发者自己的应用或网站上传的视频,而不会显示通过其他应用或网站上传的视频。

      新功能提供的功能与 v2 API 支持的开发者代码功能类似,但不完全相同。

    • 借助 channel 资源的新 snippet.country 属性,频道所有者可以将其频道与特定国家/地区相关联。

      注意:如需为 channel 资源设置 snippet.country 属性,您实际上需要更新 brandingSettings.channel.country 属性。

    • 该 API 现在支持定位到 channelSection 资源。借助频道版块定位条件,您可以限制内容版块仅向符合特定条件的用户显示。

      该 API 提供了三种定位选项。用户必须满足频道版块的所有定位设置,才能看到该版块。

    • video 资源的 contentDetails.duration 属性的定义已更正,以反映该值可以反映小时、天等。

    • channelSections.deleteplaylistItems.deleteplaylists.deletesubscriptions.deletevideos.delete 方法的文档已更正,以反映这些方法在成功时都返回 HTTP 204 响应代码 (No Content)。

  • 新增和更新的错误

    • 该 API 现在支持以下错误:

      错误类型 错误详情 说明
      badRequest (400) targetInvalidCountry 如果插入的 channelSection 资源包含 targeting.countries[] 属性的无效值,channelSections.insertchannelSections.update 方法会返回此错误。
      badRequest (400) targetInvalidLanguage 如果插入的 channelSection 资源包含 targeting.languages[] 属性的无效值,channelSections.insertchannelSections.update 方法会返回此错误。
      badRequest (400) targetInvalidRegion 如果插入的 channelSection 资源包含 targeting.regions[] 属性的无效值,channelSections.insertchannelSections.update 方法会返回此错误。
      badRequest (400) operationNotSupported 如果 API 用户无法插入评论来回复 snippet.parentId 属性标识的顶级评论,comments.insert 方法会返回此错误。在 commentThread 资源中,snippet.canReply 属性用于指示当前查看者是否可以回复会话。
      badRequest (400) invalidChannelId 如果请求中的 channelId 参数指定了无效的渠道 ID,search.list 方法会返回此错误。
      badRequest (400) subscriptionForbidden 如果 API 用户尝试订阅用户自己的频道,subscriptions.insert 方法会返回此错误。
    • captions.update 方法不再支持 invalidMetadatavideoNotFound 错误。

2015 年 4 月 16 日

此更新包含以下更改:

  • 迁移指南已更新,其中介绍了如何迁移仍在使用 v2 API 中的评论功能的应用。

    该指南还介绍了 v2 API 不支持但 v3 API 支持的多项评论功能。其中包括:

    • 检索有关频道的评论
    • 检索与频道相关的所有评论会话,这意味着 API 响应可以包含与该频道或其任何视频相关的评论。
    • 更新评论文字
    • 将评论标记为垃圾评论
    • 设置评论的审核状态

  • 订阅推送通知指南已更新,以反映通知仅推送到 Google PubSubHubBub 中心,而不会像之前所述那样同时推送到 Superfeedr 中心。

2015 年 4 月 9 日

此更新包含以下更改:

  • 借助该 API 的新 commentThreadcomment 资源,您可以检索、插入、更新、删除和审核评论。

    • commentThread 资源包含有关 YouTube 评论会话的信息,该会话由顶级评论以及对该评论的回复(如果有)组成。commentThread 资源可以表示与视频或频道相关的评论。

      顶级评论和回复实际上是嵌套在 commentThread 资源中的 comment 资源。请务必注意,commentThread 资源不一定包含对某条评论的所有回复,如果您想检索特定评论的所有回复,则需要使用 comments.list 方法。此外,某些评论没有回复。

      该 API 支持对 commentThread 资源使用以下方法:

      • commentThreads.list - 检索评论会话列表。您可以使用此方法检索与特定视频或频道相关联的评论。
      • commentThreads.insert - 创建新的顶级注释。(使用 comments.insert 方法回复现有评论。)
      • commentThreads.update - 修改顶级评论。

    • comment 资源包含有关单个 YouTube 评论的信息。comment 资源可以表示与视频或频道相关的评论。此外,评论可以是顶级评论,也可以是对顶级评论的回复。

      该 API 支持对 comment 资源使用以下方法:

    请注意,若要调用 comments.insertcomments.updatecomments.markAsSpamcomments.setModerationStatuscomments.deletecommentThreads.insertcommentThreads.update 方法,必须使用2015 年 4 月 2 日的修订记录中所述的 API 的新 https://www.googleapis.com/auth/youtube.force-ssl 作用域。

  • 新版订阅推送通知指南介绍了该 API 新支持通过 PubSubHubBub(一种适用于可通过网络访问的资源的服务器到服务器发布/订阅协议)接收推送通知。当频道执行以下任一活动时,您的 PubSubHubBub 回调服务器都可以接收 Atom Feed 通知:

    • 上传视频
    • 更新视频的标题
    • 更新视频的说明

  • 我们还更新了迁移指南,在其中说明了对推送通知的全新支持。不过,由于 v2 API 支持 v3 API 不支持的许多其他类型的推送通知,因此该指南的已废弃部分中仍会提及 PubSubHubBub 支持。

  • 该 API 的新 https://www.googleapis.com/auth/youtube.force-ssl 作用域现在是之前支持 https://www.googleapis.com/auth/youtube 作用域的任何 API 方法的有效作用域。

  • 该 API 现在支持以下错误:

    错误类型 错误详情 说明
    badRequest (400) invalidRating 如果请求包含 rating 参数的意外值,videos.rate 方法会返回此错误。
  • subscriptions.insert 方法不再支持 subscriptionLimitExceeded 错误,该错误之前表示使用请求标识的订阅者超出了订阅速率限制。

2015 年 4 月 2 日

此更新包含以下更改:

  • 新的 captions 资源表示 YouTube 字幕轨道。一个字幕轨道只能与一个 YouTube 视频相关联。

    该 API 支持用于列出插入更新下载删除字幕轨道的多种方法。

  • 迁移指南也已更新,其中介绍了如何迁移仍在使用 v2 API 中的字幕功能的应用。

  • API 的新 https://www.googleapis.com/auth/youtube.force-ssl 作用域要求通过 SSL 连接与 API 服务器进行通信。

    此新范围授予的访问权限与 https://www.googleapis.com/auth/youtube 范围相同。事实上,这两个镜重在功能上是相同的,因为 YouTube API 服务器只能通过 HTTPS 端点访问。因此,即使 https://www.googleapis.com/auth/youtube 作用域不需要 SSL 连接,实际上也无法通过其他方式发出 API 请求。

    调用 caption 资源的所有方法都需要使用新作用域。

2015 年 3 月 11 日

此更新包含以下更改:

  • YouTube Data API (v3) 迁移指南中包含一个名为 v3 API 中的新功能的新标签页,其中列出了 v3 API 支持但 v2 API 不支持的功能。这些功能之前在本指南的其他标签页中列出,现在仍在列出。例如,介绍如何更新频道的视频内宣传广告系列数据的新功能也列在频道(个人资料)标签页下。

  • YouTube Data API (v3) 迁移指南已更新,其中指出 v3 API 将支持以下 v2 API 功能:

  • YouTube Data API (v3) 迁移指南已更新,其中指出 v3 API 不支持以下 v2 API 功能:

    • 检索视频推荐 - v3 API 不会检索仅包含为当前 API 用户推荐的视频的列表。不过,您可以使用 v3 API 查找推荐视频,方法是调用 activities.list 方法并将 home 参数值设置为 true

      在 API 响应中,如果 snippet.type 属性的值为 recommendation,则相应资源对应于推荐视频。在这种情况下,contentDetails.recommendation.reasoncontentDetails.recommendation.seedResourceId 属性将包含有关推荐该视频的原因的信息。请注意,我们不保证响应中包含的推荐视频数量会是任何特定数量。

    • 检索频道建议

    • 检索新的订阅视频 - v3 API 不会检索仅包含最近上传到 API 用户订阅的频道的视频的列表。不过,您可以使用 v3 API 通过调用 activities.list 方法并将 home 参数值设置为 true 来查找新的订阅视频。

      在 API 响应中,如果 snippet.type 属性的值为 upload,则相应资源对应于新的订阅视频。请注意,我们无法保证响应中包含的订阅新视频的数量。

    • RSS Feed 支持

    • Feed 更新的推送通知 - v2 API 支持使用简单更新协议 (SUP) 或 PubSubHubbub 发送推送通知,以监控 YouTube 用户的用户活动 Feed。系统会在您订阅新频道、对视频进行评分、分享视频、将视频标记为收藏、对视频发表评论或上传视频时向您发送通知。

      v3 API 将支持使用 PubSubHubbub 协议发送推送通知,但这些通知仅涵盖视频上传以及视频标题或视频说明的更新。

    • 频道位置 - v2 API 使用 <yt:location> 标记来识别用户在频道的 YouTube 公开个人资料中输入的位置。虽然有些开发者使用此字段将频道与特定国家/地区相关联,但该字段的数据无法始终用于此目的。

    • 设置或检索开发者标记 - v2 API 支持在视频上传时将关键字(或开发者标记)与视频相关联。开发者代码不会向 YouTube 用户显示,但视频所有者可以检索与特定开发者代码匹配的视频。

      v3 API 将提供类似但不完全相同的功能。具体而言,开发者将能够搜索其应用上传的视频。启用此功能后,系统会自动为每个上传的视频添加项目编号,该编号与开发者的 Google 开发者控制台中的应用相关联。然后,开发者使用相同的项目编号搜索视频。

    • 按发布日期、观看次数或评分列出视频 - 在 v2 API 中,您可以使用 orderby 参数按位置、时长、发布日期、标题和其他多个值对播放列表中的视频进行排序。在 v3 API 中,播放列表项通常按位置从高到低排序,并且不提供其他排序选项。

      但也有一些例外情况。新上传的视频、收藏的视频、赞过的视频或最近观看的视频会自动添加为以下类型的播放列表的第一项(snippet.position=0)。因此,这些列表中的每个列表实际上都是按添加到列表的时间从新到旧排序的。

      • 用户上传的内容
      • 收藏的视频
      • 顶过的视频
      • 观看记录

      不过请注意,添加到“稍后观看”播放列表的新内容会添加为该列表中的最后一项,因此该列表实际上是按时间顺序排列的。

    • 批处理 - v3 API 支持 v2 API 支持的批处理用例之一。v3 API 的 channels.listchannelSections.listguideCategories.listplaylistItems.listplaylists.listsubscriptions.listvideoCategories.listvideos.list 方法都支持 id 参数,该参数可用于指定以英文逗号分隔的 ID 列表(视频 ID、频道 ID 等)。使用这些方法,您可以通过单个请求检索多个资源的列表。

    经过这些更改,该指南现在会标识旧版 (v2) API 中支持的所有功能,这些功能将在当前 API 版本 (v3) 中被弃用。

2015 年 3 月 4 日

此更新包含以下更改:

  • channelSections.deletechannelSections.update 方法现在支持 onBehalfOfContentOwner 参数,其他一些方法已支持该参数。

  • 以下属性及其子属性已废弃:

    • brandingSettings.image.backgroundImageUrl
    • brandingSettings.image.largeBrandedBannerImageImapScript
    • brandingSettings.image.largeBrandedBannerImageUrl
    • brandingSettings.image.smallBrandedBannerImageImapScript
    • brandingSettings.image.smallBrandedBannerImageUrl

    注意:这些属性均未受 API 弃用政策的约束。

  • video 资源的新 contentDetails.contentRating.contentDetails.contentRating.djctqRatingReasons 属性用于说明视频获得 DJCQT(巴西)分级的原因。

  • 该 API 现在支持以下错误:

    错误类型 错误详情 说明
    notFound (404) channelNotFound 如果请求的 id 参数指定了无法找到的渠道,channels.update 方法会返回此错误。
    badRequest (400) manualSortRequiredinvalidValue 如果请求尝试设置播放列表项的位置,但播放列表未使用手动排序,playlistItems.insertplaylistItems.update 方法会返回此错误。例如,播放列表项可能会按日期或热门程度排序。您可以通过从请求正文中发送的资源中移除 snippet.position 元素来解决此错误。如果您希望播放列表项在列表中占据特定位置,则需要先将播放列表的排序设置更新为手动。您可以在 YouTube 视频管理器中调整此设置。
    forbidden (403) channelClosed 如果请求的 channelId 参数指定了已关闭的渠道,playlists.list 方法会返回此错误。
    forbidden (403) channelSuspended 如果请求的 channelId 参数指定了已暂停的频道,playlists.list 方法会返回此错误。
    forbidden (403) playlistForbidden 如果请求的 id 参数不支持请求,或者请求未获得适当授权,playlists.list 方法会返回此错误。
    notFound (404) channelNotFound 如果请求的 channelId 参数指定了无法找到的渠道,playlists.list 方法会返回此错误。
    notFound (404) playlistNotFound 如果请求的 id 参数指定了无法找到的播放列表,playlists.list 方法会返回此错误。
    notFound (404) videoNotFound 如果请求的 id 参数指定了无法找到的视频,videos.list 方法会返回此错误。
    badRequest (400) invalidRating 如果请求包含 rating 参数的意外值,videos.rate 方法会返回此错误。

2015 年 3 月 2 日

此更新包含以下更改:

2015 年 1 月 14 日

此更新包含以下更改:

  • YouTube Data API (v3) 迁移指南已更新,其中介绍了如何使用 v3 API 通过 JavaScript 上传视频。(如需了解详情,请参阅上传视频部分。)此功能类似于 v2 API 支持的基于浏览器的上传功能。请注意,迁移指南的此更改并非反映了实际的 API 更改,而是反映了可用于通过客户端 JavaScript 上传视频的新示例代码。

    由于支持使用 JavaScript 客户端库和 CORS 上传视频,因此迁移指南不再将基于浏览器的上传列为 v3 API 中可能被弃用的功能。

  • videos.insert 方法的文档已更新,其中包含上述新的 JavaScript 代码示例。YouTube Data API (v3) 的 JavaScript 代码示例列表也已更新。

2014 年 11 月 11 日

此更新包含以下更改:

  • 调用 search.list 方法的配额费用已更改为 100 个单位。

    重要提示:在许多情况下,您可以使用其他 API 方法以更低的配额费用检索信息。例如,请考虑以下两种查找上传到 GoogleDevelopers 频道的视频的方法。

    • 配额费用:100 个单位

      调用 search.list 方法并搜索 GoogleDevelopers

    • 配额费用:6 个单位

      调用 channels.list 方法以查找正确的频道 ID。将 forUsername 参数设置为 GoogleDevelopers,并将 part 参数设置为 contentDetails。在 API 响应中,contentDetails.relatedPlaylists.uploads 属性指定频道上传视频的播放列表 ID。

      然后,调用 playlistItems.list 方法,并将 playlistId 参数设置为所捕获的 ID,将 part 参数设置为 snippet

2014 年 10 月 8 日

此更新包含以下更改:

  • channel 资源包含两个新属性:

    • status.longUploadsStatus 属性用于指明频道是否有资格上传时长超过 15 分钟的视频。只有在频道所有者授权了 API 请求时,系统才会返回此属性。有效的属性值包括:

      • allowed - 频道可以上传时长超过 15 分钟的视频。
      • eligible - 频道可以上传时长超过 15 分钟的视频,但必须先启用此功能。
      • disallowed - 频道无法或不符合条件上传时长超过 15 分钟的视频。

      如需详细了解这些值,请参阅媒体资源定义。YouTube 帮助中心还提供了有关此功能的更多详细信息。

    • invideoPromotion.useSmartTiming 属性表示渠道的宣传广告系列是否使用“智能投放时间”。此功能会尝试在视频中更有可能被点击且不太可能干扰观看体验的时机展示宣传内容。此功能还会选择在每个视频中展示一个宣传信息。

  • 更新了 video 资源的 snippet.titlesnippet.categoryId 属性的定义,以阐明 API 处理对 videos.update 方法的调用的方式。如果您调用该方法来更新 video 资源的 snippet 部分,则必须为这两个属性设置值。

    如果您尝试更新 video 资源的 snippet 部分,但未为这两个属性设置值,则 API 会返回 invalidRequest 错误。我们还更新了该错误的说明。

  • video 资源的 contentDetails.contentRating.oflcRating 属性用于标识视频的新西兰电影和文学分级办公室 (OFLC) 分级,现在支持两个新分级:oflcRp13oflcRp16。这些值分别对应于 RP13RP16 分级。

  • channelBanners.insert 方法现在支持以下错误:

    错误类型 错误详情 说明
    badRequest bannerAlbumFull 频道所有者的 YouTube 频道海报图片专辑中包含的图片过多。频道所有者应前往 http://photos.google.com,前往影集页面,然后从该影集中移除部分图片。

2014 年 9 月 12 日

此更新包含以下更改:

  • 调用 search.list 方法的配额费用已从 1 个配额单位更改为 2 个配额单位,此外还需支付指定资源部分的费用。

2014 年 8 月 13 日

此更新包含以下更改:

  • subscriptions.insert 方法现在支持以下错误:

    错误类型 错误详情 说明
    badRequest subscriptionLimitExceeded 通过请求标识的订阅者已超出订阅速率限制。您可以在几个小时后尝试订阅更多内容。

2014 年 8 月 12 日

此更新包含以下更改:

  • 我们推出了一本名为将应用迁移到 YouTube Data API (v3) 的新指南,其中介绍了如何使用 YouTube Data API (v3) 执行 YouTube Data API (v2) 中提供的功能。旧版 API 自 2014 年 3 月 4 日起已被正式弃用。本指南旨在帮助您将仍在使用 v2 API 的应用迁移到最新的 API 版本。

2014 年 7 月 8 日

此更新包含以下更改:

  • playlists.insert 方法现在支持以下错误:

    错误类型 错误详情 说明
    badRequest maxPlaylistExceeded 如果频道已达到允许的播放列表数量上限,而无法创建播放列表,就会出现此错误。

2014 年 6 月 18 日

此更新包含以下更改:

2014 年 5 月 28 日

此更新包含以下更改:

  • search.list 方法现在支持 locationlocationRadius 参数,可让您搜索与地理位置相关联的视频。请求必须为这两个参数都指定值,才能根据位置检索结果。如果请求仅包含这两个参数之一,API 将返回错误。

    • location 参数用于指定圆形地理区域中心的纬度/经度坐标。

    • locationRadius 参数用于指定与视频相关联的位置距离相应区域中心的最大距离,如果该距离不超过此值,视频便会仍包含在搜索结果中。

2014 年 5 月 13 日

此更新包含以下更改:

  • channel 资源的 invideoPromotion.items[] 属性已更新,以提示您通常只能为频道设置一件宣传商品。如果您尝试插入的宣传信息过多,API 将返回 tooManyPromotedItems 错误,该错误的 HTTP 状态代码为 400

  • channelSection 资源现在可以包含有关几种新类型的精选内容的信息。channelSection 资源的 snippet.type 属性现在支持以下值:

    • postedPlaylists - 频道所有者发布到频道活动 Feed 中的播放列表
    • postedVideos - 频道所有者发布到频道活动 Feed 中的视频
    • subscriptions - 频道所有者订阅的频道

  • video 资源的新 contentDetails.contentRating.ifcoRating 属性用于标识视频从爱尔兰电影分级办公室获得的分级。

  • 更新了 watermark 资源的 position.cornerPosition 属性的定义,以指明水印始终显示在播放器的右上角。

  • 更新了 search.list 方法的 q 参数定义,以说明查询字词可以使用布尔 NOT (-) 运算符来排除与特定搜索字词相关联的视频。该值还可以使用布尔 OR (|) 运算符来查找与多个搜索字词中的一个相关联的视频。

  • 针对 search.list 调用的 API 响应中返回的 pageInfo.totalResults 属性的定义已更新,以指明该值是近似值,可能并不代表确切值。此外,最大值为 1,000,000。请勿使用此值创建分页链接。请改用 nextPageTokenprevPageToken 属性值来确定是否显示分页链接。

  • watermarks.setwatermarks.unset 方法已更新,以反映 API 会针对对这些方法的成功请求返回 HTTP 204 响应代码。

2014 年 5 月 2 日

此更新包含以下更改:

  • 新的 i18nLanguage 资源用于标识 YouTube 网站支持的应用语言。应用语言也称为界面语言。对于 YouTube 网站,系统可以根据 Google 账号设置、浏览器语言或 IP 位置自动选择应用语言,用户也可以从 YouTube 网站页脚手动选择所需的界面语言。

    该 API 支持用于列出受支持的应用语言的方法。在调用 videoCategories.listguideCategories.list 等 API 方法时,可以使用受支持的语言作为 hl 参数的值。

  • 新的 i18nRegion 资源用于标识 YouTube 用户可以选择作为首选内容区域的地理区域。内容区域也可以称为内容语言区域。对于 YouTube 网站,系统可以根据 YouTube 网域或用户的 IP 位置等启发词语自动选择内容区域,用户也可以从 YouTube 网站页脚手动选择所需的内容区域。

    该 API 支持用于列出受支持的内容区域的方法。调用 search.listvideos.listactivities.listvideoCategories.list 等 API 方法时,可以将支持的区域代码用作 regionCode 参数的值。

2014 年 4 月 7 日

此更新包含以下更改:

  • 新的 channelSection 资源包含频道选择精选的一组视频的相关信息。例如,某个版块可以展示频道的最新上传视频、最热门的上传视频,或一个或多个播放列表中的视频。

    该 API 支持用于列出插入更新删除频道版块的方法。您可以通过指定特定频道 ID 或指定唯一频道版块 ID 列表,检索已验证用户频道的频道版块列表。

    错误文档也已更新,其中介绍了 API 专门针对这些新方法支持的错误消息。

  • 更新了 video 资源的 fileDetails 对象的定义,以说明只有在视频的 processingDetails.fileDetailsAvailability 属性的值为 available 时,才会返回该对象。

    同样,video 资源的 suggestions 对象的定义也已更新,以说明只有在视频的 processingDetails.tagSuggestionsAvailability 属性或其 processingDetails.editorSuggestionsAvailability 属性的值为 available 时,才会返回该对象。

  • 更新了 videos.insertvideos.update 方法的文档,以反映在调用这些方法时可以设置 status.publishAt 属性。

  • 更新了 channel 资源的 invideoPromotion 对象的定义,以说明该对象只能由频道的所有者检索。

  • 更新了 videos.rate 方法的参数列表,以反映该方法实际上不支持 onBehalfOfContentOwner 参数。这是文档错误,因为设置此参数的 videos.rate 请求会返回 500 错误。

2014 年 3 月 31 日

此更新包含以下更改:

2014 年 3 月 13 日

此更新包含以下更改:

  • 该 API 现在支持 channel 资源的 contentOwnerDetails 部分。新部分包含与与频道相关联的 YouTube 合作伙伴相关的频道数据,包括与频道相关联的内容所有者的 ID,以及内容所有者与频道相关联的日期和时间。请注意,此新部分不受弃用政策的约束

  • 该文档现在列出了以下属性支持的字符长度上限:

    资源 属性 最大长度
    channel invideoPromotion.items[].customMessage 40 个字符
    video snippet.title 100 个字符
    video snippet.description 5000 字节
    video snippet.tags 500 个字符。请注意,属性值是一个列表,列表中各项之间的英文逗号会计入此限制。
  • channel 资源的 brandingSettings.watch.featuredPlaylistId 属性已废弃。如果您尝试设置其值,API 会返回错误。

  • 以下 video 资源属性已添加到可在插入更新视频时设置的值列表中:

  • 错误文档现已指定每种错误类型的 HTTP 响应代码。

  • 该 API 现在支持以下错误:

    错误类型 错误详情 说明
    badRequest (400) invalidCriteria 如果请求指定的过滤条件参数无法搭配使用,channels.list 方法会返回此错误。
    badRequest (400) channelTitleUpdateForbidden 如果您尝试更新频道的 brandingSettings 部分并更改 brandingSettings.channel.title 属性的值,channels.update 方法会返回此错误。(请注意,如果您省略该属性,API 不会返回错误。)
    badRequest (400) invalidRecentlyUploadedBy 如果 invideoPromotion.items[].id.recentlyUploadedBy 属性指定了无效的渠道 ID,channels.update 方法会返回此错误。
    badRequest (400) invalidTimingOffset 如果 invideoPromotion 部分指定了无效的计时偏移,channels.update 方法会返回此错误。
    badRequest (400) tooManyPromotedItems 如果 invideoPromotion 部分指定的宣传信息数量超出允许的上限,channels.update 方法会返回此错误。
    forbidden (403) promotedVideoNotAllowed 如果 invideoPromotion.items[].id.videoId 属性指定的视频 ID 找不到或无法用作宣传内容,channels.update 方法会返回此错误。
    forbidden (403) websiteLinkNotAllowed 如果 invideoPromotion.items[].id.websiteUrl 属性指定了不允许的网址,channels.update 方法会返回此错误。
    required (400) requiredTimingType 如果请求未指定 YouTube 应何时显示宣传内容的默认时间设置,channels.update 方法会返回此错误。
    required (400) requiredTiming channels.update 方法必须为每个宣传内容指定一个 invideoPromotion.items[].timing 对象。
    required (400) requiredWebsiteUrl channels.update 方法必须为每个宣传内容指定 invideoPromotion.items[].id.websiteUrl 属性。
    badRequest (400) invalidPublishAt 如果请求元数据指定的安排发布时间无效,videos.insert 方法会返回此错误。

2014 年 3 月 4 日

此更新包含以下更改:

2013 年 12 月 5 日

此更新包含以下更改:

  • search.list 方法的文档已更新,以正确反映您在提交搜索请求时无需为恰好一个过滤条件参数指定值。您可以为零个过滤条件参数或一个过滤条件参数设置值。

  • 更新了 search.list 方法参数的定义,以提示您必须将 type 参数的值设置为 video,同时还必须为以下任一参数指定值:

    • eventType
    • videoCaption
    • videoCategoryId
    • videoDefinition
    • videoDimension
    • videoDuration
    • videoEmbeddable
    • videoLicense
    • videoSyndicated
    • videoType

  • 上传的频道横幅图片的尺寸下限已缩减为 2048 x 1152 像素。(之前的最小尺寸为 2120 像素 x 1192 像素。)此外,请注意,channel 资源文档指定了通过该 API 提供的所有横幅图片的大小上限。例如,电视应用的 brandingSettings.image.bannerTvImageUrl 图片的最大尺寸为 2120 像素 x 1192 像素,但实际图片可以是 2048 像素 x 1152 像素。YouTube 帮助中心提供了有关优化频道图片以便在不同类型的设备上显示的更多指南。

  • 更新了多个 channel 资源属性定义,以反映以下信息:

    • brandingSettings.channel.description 属性的值的长度上限为 1,000 个字符。
    • brandingSettings.channel.featuredChannelsTitle 属性的长度上限为 30 个字符。
    • brandingSettings.channel.featuredChannelsUrls[] 属性现在最多可列出 100 个频道。
    • brandingSettings.channel.unsubscribedTrailer 属性值(如果设置)必须指定频道所有者拥有的公开或不公开列出的视频的 YouTube 视频 ID。

  • channels.update 方法现在支持对 invideoPromotion.items[].promotedByContentOwner 属性进行更新。该属性用于指明在展示促销活动时是否显示内容所有者的名称。只有在使用 onBehalfOfContentOwner 参数代表内容所有者发出用于设置媒体资源价值的 API 请求时,才能设置此属性。

  • playlistItems.listplaylistItems.insert 方法现在支持 onBehalfOfContentOwner 参数,其他一些方法已支持该参数。

  • contentDetails.contentRating.acbRating 属性现在可以指定电影的澳大利亚分级委员会 (ACB) 分级,也可以指定儿童电视节目的澳大利亚通信和媒体管理局 (ACMA) 分级。

  • 新的 contentDetails.contentRating.catvRatingcontentDetails.contentRating.catvfrRating 属性分别用于标识视频在加拿大电视分类系统和法语魁北克电影分级制度下的分级。

  • videoCategory 资源的新 snippet.assignable 属性用于指示更新后的视频或新上传的视频能否与该视频类别相关联。

  • 添加了以下方法的代码示例:

2013 年 10 月 24 日

此更新包含以下更改:

  • 该 API 包含两项额外功能,旨在帮助您查找和展示直播内容:

    搜索结果中的新 snippet.liveBroadcastContent 属性用于指明视频或频道资源是否包含直播内容。有效的属性值为 upcomingactivenone

    请注意,我们于 2013 年 10 月 1 日发布了用于识别直播内容的另外两项功能:search.list 方法的 eventType 参数和搜索结果的 snippet.liveBroadcastContent 属性。

  • videos.insert 方法现在支持 notifySubscribers 参数,该参数用于指明 YouTube 是否应向订阅相应视频频道的用户发送有关新视频的通知。该参数的默认值为 True,表示会向订阅者发送有关新上传视频的通知。不过,如果频道所有者上传的视频很多,则可能更倾向于将此值设为 False,以免向频道的订阅者发送有关每个新视频的通知。

  • 调用 channels.update 方法时可修改的属性列表已更新,其中包含 invideoPromotion.items[].customMessageinvideoPromotion.items[].websiteUrl 属性。此外,该列表已修改,以识别可修改的 brandingSettings 属性。这些 brandingSettings 属性已经可以修改,因此文档变更并不反映 API 现有功能的更改。

  • playlists.insertplaylists.updateplaylists.delete 方法现在支持 onBehalfOfContentOwner 参数,其他几个方法已支持该参数。

  • playlists.insert 方法现在支持 onBehalfOfContentOwnerChannel 参数,其他一些方法也已支持该参数。

  • video 资源的 contentDetails.contentRating.tvpgRating 属性现在支持值 pg14,该值对应于 TV-14 评分。

  • 我们更正了搜索结果中包含的 snippet.liveBroadcastContent 属性的定义,以反映 live 是有效的属性值,但 active 不是有效的属性值。

  • video 资源的 contentDetails.contentRating.mibacRating 属性现在支持另外两种分级:

    • mibacVap (VAP) - 儿童应由成人陪同。
    • mibacVm6 (V.M.6) - 必须年满 6 周岁才能观看。
    • mibacVm12 (V.M.12) - 仅限 12 周岁及以上人士观看。

  • channel 资源的新 invideoPromotion.items[].promotedByContentOwner 属性用于指明在展示促销活动时是否显示内容所有者的姓名。只有在代表内容所有者发出用于设置此值的 API 请求时,才能设置此字段。如需了解详情,请参阅 onBehalfOfContentOwner 参数。

2013 年 10 月 1 日

此更新包含以下更改:

  • channel 资源的新 auditDetails 对象包含多频道网络 (MCN) 在确定是否接受或拒绝特定频道时会评估的频道数据。请注意,检索此资源部分的任何 API 请求都必须提供包含 https://www.googleapis.com/auth/youtubepartner-channel-audit 范围的授权令牌。此外,在 MCN 决定接受或拒绝频道时,或在令牌签发之日起两周内,必须撤消使用该范围的所有令牌。

  • channel 资源的 invideoPromotion.items[].id.type 属性现在支持值 recentUpload,表示宣传内容是指定频道中最近上传的视频。

    默认情况下,渠道与设置视频内宣传内容数据的渠道相同。不过,您可以将新 invideoPromotion.items[].id.recentlyUploadedBy 属性的值设置为另一个频道的频道 ID,以宣传该频道中最近上传的视频。

  • channel 资源包含三个新属性(brandingSettings.image.bannerTvLowImageUrlbrandingSettings.image.bannerTvMediumImageUrlbrandingSettings.image.bannerTvHighImageUrl),用于指定在电视应用的频道页上显示的横幅图片的网址。

  • 搜索结果中的新 snippet.liveBroadcastContent 属性用于指明视频或频道资源是否包含直播内容。有效的属性值为 upcomingactivenone

    • 对于 video 资源,值 upcoming 表示视频尚未开始直播,值 active 表示视频正在直播。
    • 对于 channel 资源,值 upcoming 表示频道有一个尚未开始的预定直播,而值 acive 表示频道正在进行直播。

  • watermark 资源中,targetChannelId 属性已从对象更改为字符串。targetChannelId 属性现在会自行指定该值,而不是包含用于指定水印图片所关联频道的 YouTube 频道 ID 的子属性。因此,我们移除了资源的 targetChannelId.value 属性。

  • thumbnails.set 方法现在支持 onBehalfOfContentOwner 参数,其他一些方法也已支持该参数。

  • search.list 方法现在支持 eventType 参数,该参数可限制搜索结果仅返回正在进行、即将进行或已完成的直播活动。

  • 新的 contentDetails.contentRating.mibacRating 属性用于标识视频获得的意大利文化和旅游部 (MiBACT) 分级。

  • 该 API 现在支持以下错误:

    错误类型 错误详情 说明
    badRequest invalidImage 如果提供的图片内容无效,thumbnails.set 方法会返回此错误。
    forbidden videoRatingDisabled 如果正在评分的视频的所有者已停用该视频的评分功能,videos.rate 方法会返回此错误。

2013 年 8 月 27 日

此更新包含以下更改:

  • 新的 watermark 资源用于标识在播放指定频道的视频期间显示的图片。您还可以指定图片将链接到的目标频道,以及用于确定水印在视频播放期间显示的时间和显示时长的时间详细信息。

    watermarks.set 方法用于上传和设置频道的水印图片。watermarks.unset 方法用于删除频道的水印图片。

    错误文档介绍了该 API 专门针对 watermarks.setwatermarks.unset 方法支持的错误消息。

  • channel 资源的新 statistics.hiddenSubscriberCount 属性包含一个布尔值,用于指示频道的订阅人数是否处于隐藏状态。因此,如果频道的订阅人数是公开显示的,则该属性的值为 false

  • playlists.list 方法现在支持 onBehalfOfContentOwneronBehalfOfContentOwnerChannel 参数。其他几种方法已支持这两个参数。

  • videos.list 方法现在支持 regionCode 参数,该参数用于标识应为其检索图表的内容区域。此参数只能与 chart 参数搭配使用。此参数值是 ISO 3166-1 alpha-2 国家/地区代码。

  • error documentation 描述了以下新的常见请求错误,多个 API 方法都可能会出现此错误:

    错误类型 错误详情 说明
    forbidden insufficientPermissions 与为请求提供的 OAuth 2.0 令牌关联的范围不足以访问请求的数据。

2013 年 8 月 15 日

此更新包含以下更改:

  • channel 资源的 invideoPromotion 对象具有以下新增和更新的属性:

  • subscriptions.list 方法现在支持 onBehalfOfContentOwneronBehalfOfContentOwnerChannel 参数。其他几种方法已支持这两个参数。

  • 在对 thumbnails.set 请求的 API 响应中,kind 属性值已从 youtube#thumbnailListResponse 更改为 youtube#thumbnailSetResponse

  • 添加了以下方法的代码示例:

    请注意,由于 playlistItems.insert 方法演示的功能现在由 videos.rate 方法处理,因此我们也移除了 playlistItems.insert 方法的 Python 示例。

  • error documentation 描述了以下新的请求上下文错误,任何支持 mine 请求参数的 API 方法都可能会出现此错误:

    错误类型 错误详情 说明
    badRequest invalidMine 在经过身份验证的用户是 YouTube 合作伙伴的请求中,不能使用 mine 参数。您应移除 mine 参数,通过移除 onBehalfOfContentOwner 参数以 YouTube 用户身份进行身份验证,或者通过提供 onBehalfOfContentOwnerChannel 参数(如果调用的方法可用)来充当合作伙伴的某个频道。

2013 年 8 月 8 日

此更新包含以下更改:

2013 年 7 月 30 日

此更新包含以下更改:

  • channelBanner 资源中,kind 属性的值已从 youtube#channelBannerInsertResponse 更改为 youtube#channelBannerResource。系统会在响应 channelBanners.insert 请求时返回此资源。

  • channel 资源的新 brandingSettings.channel.profileColor 属性用于指定与频道内容相得益彰的醒目颜色。属性值为井号 (#) 后跟一个六位字符的十六进制字符串,例如 #2793e6

  • 该 API 现在支持指定订阅是针对频道的所有活动,还是仅针对新上传的内容。subscription 资源的新 contentDetails.activityType 属性用于标识订阅者将收到通知的活动类型。有效的属性值为 alluploads

  • videos.list 方法支持新的参数,用于检索 YouTube 上最热门视频的排行榜:

    • chart 参数用于标识要检索的图表。目前,唯一支持的值是 mostPopular。请注意,chart 参数是一个过滤参数,这意味着它不能与其他过滤参数(idmyRating)在同一请求中使用。
    • videoCategoryId 参数用于标识应检索哪个视频类别的图表。此参数只能与 chart 参数搭配使用。默认情况下,排行榜不限于特定类别。

  • video 资源的新 topicDetails.relevantTopicIds[] 属性提供了与视频或其内容相关的 Freebase 主题 ID 列表。视频中可能提及了这些主题的内容,或者出现了这些主题的内容。

  • video 资源的 recordingDetails.location.elevation 属性已重命名为 recordingDetails.location.altitude,其 fileDetails.recordingLocation.location.elevation 属性已重命名为 fileDetails.recordingLocation.location.altitude

  • video 资源的 contentDetails.contentRating 对象用于指定视频在各种分级体系(包括 MPAA 分级、TVPG 分级等)下的分级。对于每个分级系统,该 API 现在支持一个分级值,用于指示视频未分级。请注意,对于 MPAA 分级,“未分级”分级通常用于标识未经剪辑的电影版本,而剪辑版电影版本已获得官方分级。

  • video 资源的新 contentDetails.contentRating.ytRating 属性用于标识有年龄限制的内容。如果 YouTube 认定视频包含不适合未满 18 周岁用户的内容,则相应属性值为 ytAgeRestricted。如果该属性不存在或属性值为空,则表示内容尚未被标记为受年龄限制。

  • channels.list 方法的 mySubscribers 参数已废弃。使用 subscriptions.list 方法及其 mySubscribers 参数检索经过身份验证的用户频道的订阅者列表。

  • channelBanners.insertchannels.updatevideos.getRatingvideos.rate 方法现在都支持 onBehalfOfContentOwner 参数。该参数表示已通过身份验证的用户代表参数值中指定的内容所有者行事。

  • 更新了 channels.update 方法的文档,以反映该方法可用于更新 channel 资源的 brandingSettings 对象及其子属性。该文档现在还列出了可为 channel 资源的 invideoPromotion 对象设置的更新版属性列表。

  • error documentation 介绍了以下新错误:

    错误类型 错误详情 说明
    forbidden accountDelegationForbidden 此错误并非特定于某个 API 方法。表示已验证的用户无权代表指定的 Google 账号执行操作。
    forbidden authenticatedUserAccountClosed 此错误并非特定于某个 API 方法。表示已验证身份的用户的 YouTube 账号已关闭。如果用户是代表其他 Google 账号执行操作,则此错误表示该其他账号已关闭。
    forbidden authenticatedUserAccountSuspended 此错误并非特定于某个 API 方法。表示已验证身份的用户的 YouTube 账号已被中止。如果用户是代表其他 Google 账号执行操作,则此错误表示该其他账号已被中止。
    forbidden authenticatedUserNotChannel 此错误并非特定于某个 API 方法。表示 API 服务器无法识别与 API 请求关联的渠道。如果请求已获授权且使用 onBehalfOfContentOwner 参数,您还应设置 onBehalfOfContentOwnerChannel 参数。
    forbidden cmsUserAccountNotFound 此错误并非特定于某个 API 方法。CMS 用户不得代表指定的内容所有者执行操作。
    notFound contentOwnerAccountNotFound 此错误并非特定于某个 API 方法。未找到指定的内容所有者账号。
    badRequest invalidPart 此错误并非特定于某个 API 方法。请求的 part 参数指定了无法同时写入的部分。
    badRequest videoChartNotFound 如果请求指定了不受支持或不可用的视频排行榜,videos.list 方法会返回此错误。
    notFound videoNotFound videos.update 方法会返回此错误,表示找不到您尝试更新的视频。检查请求正文中的 id 属性的值,确保其正确无误。

2013 年 6 月 10 日

此更新包含以下更改:

  • 借助 channels.list 方法的新 forUsername 参数,您可以通过指定频道的 YouTube 用户名来检索频道相关信息。

  • activities.list 方法现在支持 regionCode 参数,该参数用于指示 API 返回与指定国家/地区相关的结果。如果已获授权用户在 YouTube 上的过往活动未提供足够的信息来生成活动信息流,YouTube 会使用此值。

  • 播放列表资源现在包含 snippet.tags 属性。该媒体资源只会返回给检索自己播放列表数据的获授权用户。获授权的用户还可以在调用 playlists.insertplaylists.update 方法时设置播放列表标记。

  • onBehalfOfContentOwner 参数之前仅适用于 channels.listsearch.list 方法,现在也适用于 videos.insertvideos.updatevideos.delete 方法。请注意,在调用 videos.insert 方法时使用此参数时,请求还必须为新的 onBehalfOfContentOwnerChannel 参数指定一个值,该值用于标识要将视频添加到的频道。该频道必须与 onBehalfOfContentOwner 参数指定的内容所有者相关联。

    该参数表示请求的授权凭据用于标识代表参数值中指定的内容所有者执行操作的 YouTube CMS 用户。用户进行身份验证时使用的 CMS 账号必须与指定的 YouTube 内容所有者相关联。

    此参数适用于拥有和管理多个不同 YouTube 频道的内容合作伙伴。借助此参数,这些合作伙伴只需进行一次身份验证,即可访问其所有视频和频道数据,而无需为每个频道分别提供身份验证凭据。

    具体而言,在此次版本中,内容合作伙伴现在可以使用此参数在其拥有的任何 YouTube 频道中插入、更新或删除视频。

  • error documentation 介绍了以下新错误:

    错误类型 错误详情 说明
    forbidden insufficientCapabilities 此错误并非特定于某个 API 方法。表示调用 API 的 CMS 用户没有足够的权限来执行请求的操作。此错误与 onBehalfOfContentOwner 参数的使用相关,该参数适用于多种 API 方法。
    unauthorized authorizationRequired 如果请求使用 home 参数但未获得适当授权,activities.list 方法会返回此错误。
  • channels 资源中,invideoPromotion.channelId 属性已被移除,因为渠道 ID 已使用资源的 id 属性指定。

  • 新版使用渠道 ID指南介绍了该 API 如何使用渠道 ID。对于从旧版 API 迁移且应用会为 default 用户请求内容或依赖于每个 YouTube 频道都有唯一用户名的开发者,本指南可能特别有用。

2013 年 5 月 22 日

此更新包含以下更改:

2013 年 5 月 14 日

此更新包含以下更改:

  • 独立页面现在会列出 Java.NETPHPRuby 的代码示例。

  • 列出 Python 代码示例的页面现在包含有关添加订阅、创建播放列表和更新视频的示例。

2013 年 5 月 10 日

此更新包含以下更改:

2013 年 5 月 8 日

此更新包含以下更改:

  • 频道资源现在支持 inVideoPromotion 对象,该对象封装了与频道关联的促销活动的相关信息。频道可以使用视频内宣传广告系列,在频道视频播放期间在视频播放器中展示宣传视频的缩略图。

    您可以通过在 channels.list 请求的 part 参数值中添加 invideoPromotion 来检索此类数据。

  • 新的 channels.update 方法可用于更新频道的视频内宣传广告系列数据。请注意,该方法仅支持对 channel 资源的 invideoPromotion 部分进行更新,尚不支持对该资源的其他部分进行更新。

2013 年 5 月 2 日

此更新包含以下更改:

  • 频道资源现在支持 status.isLinked 属性,该属性用于指明频道数据是否标识了已与 YouTube 用户名或 Google+ 账号相关联的用户。拥有其中一种关联的用户已经拥有公开的 YouTube 身份,这是执行多项操作(例如上传视频)的前提条件。

  • 订阅资源现在支持 subscriberSnippet 部分。该对象封装了订阅者频道的摘要数据。

  • 该 API 现支持 videos.getRating 方法,该方法用于检索已通过身份验证的用户对一个或多个视频列表所给出的评分。

  • 借助 videos.list 方法的新 myRating 参数,您可以检索已通过身份验证的用户评分为 likedislike 的视频列表。

    myRating 参数和 id 参数现在都被视为过滤条件参数,这意味着 API 请求必须仅指定其中一个参数。(以前,id 参数是此方法的必需参数。)

    如果请求尝试检索视频分级信息,但未获得正确的授权,该方法会返回 forbidden 错误。

  • 随着 myRating 参数的引入,videos.list 方法也已更新为支持分页。不过,请注意,只有使用 myRating 参数的请求支持分页参数。(对于使用 id 参数的请求,不支持分页参数和信息。)

    • maxResults 参数指定 API 可以在结果集中返回的视频数量上限,pageToken 参数用于标识您要检索的结果集中的特定页面。

    • 在响应 videos.list 请求时返回的 youtube#videoListResponse 资源现在包含 pageInfo 对象,其中包含结果总数和当前结果集中包含的结果数等详细信息。youtube#videoListResponse 资源还可以包含 nextPageTokenprevPageToken 属性,每个属性都提供一个令牌,可用于检索结果集中的特定页面。

  • videos.insert 方法支持以下新参数:

    • autoLevels - 将此参数值设置为 true,以指示 YouTube 自动优化视频的光线和色彩。
    • stabilize - 将此参数值设置为 true 可指示 YouTube 通过移除因相机运动而产生的抖动来调整视频。

  • 以下资源的 snippet 中添加了 channelTitle 属性:

    • playlistItem - 此属性用于指定添加播放列表项的频道的名称。
    • playlist - 此属性用于指定创建播放列表的频道的名称。
    • subscription - 此属性用于指定所订阅的频道的名称。

  • 添加了以下方法的代码示例:

  • 借助 subscriptions.list 方法的新 mySubscribers 参数,您可以检索当前已通过身份验证的用户的订阅者列表。此参数只能在获得适当授权的请求中使用。

    注意:此功能旨在取代目前为 channels.list 方法支持的 mySubscribers 参数。该参数将被弃用。

  • video 资源中,属性值 unspecified 不再是以下任何属性的可选值:

  • 现在,包含意外参数的 API 请求会返回 badRequest 错误,并且报告的错误原因为 unexpectedParameter

  • 更新了 playlistItems.insert 方法在播放列表已包含允许的项数量上限时返回的错误。该错误现在报告为 forbidden 错误,错误原因为 playlistContainsMaximumNumberOfVideos

2013 年 4 月 19 日

此更新包含以下更改:

2013 年 3 月 12 日

此更新包含以下更改:

  • 以下资源的 snippet 中添加了 channelTitle 属性:

    • activity - 该属性用于指定负责相应 activity 的渠道的名称。
    • search - 此属性用于指定与搜索结果标识的资源关联的渠道的名称。
    • video - 此属性用于指定上传视频的频道的名称。

  • search.list 方法支持以下新参数:

    • 借助 channelType 参数,您可以将频道搜索限制为检索所有频道,也可以限制为仅检索节目。

    • 借助 videoType 参数,您可以限制视频搜索,以检索所有视频,或者仅检索电影或节目分集。

  • 更新了 video 资源的 recordingDetails 部分的定义,以指出只有在视频的地理位置数据或录制时间已设置的情况下,系统才会为视频返回该对象。

  • playlistItems.update 方法现在会返回 invalidSnippet 错误,如果 API 请求未指定有效的代码段,就会返回此错误。

  • 多个 API 方法支持专门面向 YouTube 内容合作伙伴的新参数。YouTube 内容合作伙伴包括电影和电视工作室、唱片公司以及在 YouTube 上发布内容的其他内容创作者。

    • onBehalfOfContentOwner 参数表示请求的授权凭据标识了代表参数值中指定的内容所有者执行操作的 YouTube CMS 用户。用户进行身份验证时使用的 CMS 账号必须与指定的 YouTube 内容所有者相关联。

      此参数适用于拥有和管理多个不同 YouTube 频道的内容合作伙伴。借助此参数,这些合作伙伴只需进行一次身份验证,即可访问其所有视频和频道数据,而无需为每个频道分别提供身份验证凭据。

      channels.listsearch.listvideos.deletevideos.listvideos.update 方法均支持此参数。

    • managedByMe 参数由 channels.list 方法支持,用于指示 API 返回 onBehalfOfContentOwner 参数指定的内容所有者拥有的所有频道。

    • search.list 方法支持 forContentOwner 参数,该参数会指示 API 将搜索结果限制为仅包含 onBehalfOfContentOwner 参数指定的内容所有者拥有的资源。

2013 年 2 月 25 日

此更新包含以下更改:

  • 该 API 支持 video 资源的多个新部分和属性:

    • 新的 fileDetailsprocessingDetailssuggestions 部分可向视频所有者提供有关其上传视频的信息。这些数据对于支持视频上传的应用非常有用,其中包括:

      • 处理状态和进度
      • 在处理视频时遇到错误或其他问题
      • 缩略图图片的可用性
      • 有关如何提高视频或元数据质量的建议
      • 有关上传到 YouTube 的原始文件的详细信息

      所有这些部分都只能由视频所有者检索。下表简要介绍了新部分,video 资源文档定义了每个部分包含的所有属性。

      • fileDetails 对象包含上传到 YouTube 的视频文件的相关信息,包括文件的分辨率、时长、音频和视频编解码器、串流比特率等。

      • processingProgress 对象包含有关 YouTube 处理上传的视频文件的进度信息。该对象的属性可识别当前的处理状态,并估算 YouTube 完成处理视频所需的剩余时间。此部分还会指明视频是否有不同类型的数据或内容(例如文件详情或缩略图)。

        此对象旨在进行轮询,以便视频上传者跟踪 YouTube 处理上传的视频文件的进度。

      • suggestions 对象包含建议,可指出有机会改进上传视频的视频质量或元数据。

    • contentDetails 部分包含四个新属性。这些媒体资源可以通过未经身份验证的请求检索。

      • dimension - 指示视频是 2D 还是 3D 格式。
      • definition - 指示视频是标清还是高清。
      • caption - 指示视频是否提供字幕。
      • licensedContent - 指示视频是否包含 YouTube 内容合作伙伴提出版权主张的内容。

    • status 部分包含两个新属性。视频所有者可以在插入或更新视频时为这两个属性设置值。您还可以使用未经身份验证的请求检索这些媒体资源。

      • embeddable - 指示视频是否可以嵌入到其他网站中。
      • license - 指定视频的许可。有效值为 creativeCommonyoutube

  • 更新了 videos.listvideos.insertvideos.update 方法的 part 参数定义,以列出上述新添加的部分以及不小心遗漏的 recordingDetails 部分。

  • channel 资源的新 contentDetails.googlePlusUserId 属性指定与频道关联的 Google+ 个人资料 ID。此值可用于生成指向 Google+ 个人资料的链接。

  • 每个缩略图图片对象现在都指定了图片的宽度和高度。缩略图图片目前会在 activitychannelplaylistplaylistItemsearch resultsubscriptionvideo 资源中返回。

  • playlistItems.list 现在支持 videoId 参数,该参数可与 playlistId 参数结合使用,以便仅检索代表指定视频的播放列表项。

    如果在播放列表中找不到该参数标识的视频,API 会返回 notFound 错误。

  • 错误文档介绍了新的 forbidden 错误,该错误表示请求未获得对请求操作的适当授权。

  • 移除了 channel 资源的 snippet.channelId 属性。资源的 id 属性提供相同的值。

2013 年 1 月 30 日

此更新包含以下更改:

  • 新的错误页面列出了该 API 可能会返回的错误。该页面包含可能出现在多个不同 API 方法中的常规错误,以及特定于方法的错误。

2013 年 1 月 16 日

此更新包含以下更改:

  • 以下方法和语言的代码示例现已推出:

  • activity 资源现在可以报告 channelItem 操作,这种操作发生在 YouTube 将视频添加到自动生成的 YouTube 频道时。(YouTube 会通过算法识别在 YouTube 网站上表现突出的主题,并自动为这些主题生成频道。)

  • 更新了以下 search.list 参数:

    • q 参数不再被指定为过滤器,这意味着...
    • relatedToVideo 参数已重命名为 relatedToVideoId
    • published 参数已替换为两个新参数:publishedAfterpublishedBefore,如下所述。

  • search.list 方法支持以下新参数:

    参数名称 说明
    channelId string 返回由指定渠道创建的资源。
    publishedAfter datetime 返回在指定时间之后创建的资源。
    publishedBefore datetime 返回在指定时间之前创建的资源。
    regionCode string 返回指定国家/地区的资源。
    videoCategoryId string 过滤视频搜索结果,使其仅包含与指定视频类别相关联的视频。
    videoEmbeddable string 过滤视频搜索结果,以仅显示可在网页上的嵌入式播放器中播放的视频。将参数值设置为 true 以仅检索可嵌入的视频。
    videoSyndicated string 过滤视频搜索结果,仅包含可在 YouTube.com 之外播放的视频。将参数值设置为 true 可仅检索分销的视频。
  • 多个 API 资源支持新属性。下表列出了这些资源及其新属性:

    资源 属性名称 说明
    activity contentDetails.playlistItem.playlistItemId string YouTube 分配的播放列表项 ID,用于唯一标识播放列表中的项。
    activity contentDetails.channelItem object 一个对象,包含添加到频道的资源的相关信息。只有当 snippet.typechannelItem 时,此属性才会存在。
    activity contentDetails.channelItem.resourceId object 用于标识添加到渠道的资源的对象。与其他 resourceId 属性一样,它包含一个 kind 属性,用于指定资源类型,例如视频或播放列表。它还包含多个属性(videoIdplaylistId 等)中的其中一个,用于指定用于唯一标识该资源的 ID。
    channel status object 此对象封装了有关频道隐私权状态的信息。
    channel status.privacyStatus string 频道的隐私权状态。有效值为 privatepublic
    playlist contentDetails object 此对象包含有关播放列表内容的元数据。
    playlist contentDetails.itemCount unsigned integer 播放列表中的视频数量。
    playlist player object 此对象包含您用于在嵌入式播放器中播放播放列表的信息。
    playlist player.embedHtml string 用于嵌入播放播放列表的视频播放器的 <iframe> 标记。
    video recordingDetails object 此对象封装了用于标识或描述视频录制地点和时间的信息。
    video recordingDetails.location object 此对象包含与视频关联的地理定位信息。
    video recordingDetails.location.latitude double 纬度(以度为单位)。
    video recordingDetails.location.longitude double 经度(以度为单位)。
    video recordingDetails.location.elevation double 相对于地球表面的高度(以米为单位)。
    video recordingDetails.locationDescription string 描述视频录制地点的文本。
    video recordingDetails.recordingDate datetime 录制视频的日期和时间。该值采用 ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) 格式指定。
  • 现在,多个 API 方法的文档会指明必须在请求正文中指定或根据请求正文中的值进行更新的属性。下表列出了这些方法以及必需或可修改的属性。

    注意:其他方法的文档可能已列出必需和可修改的属性。

    方法 属性
    activities.insert 必需属性
    • snippet.description
    可修改的属性
    • snippet.description
    • contentDetails.bulletin.resourceId
    playlists.update 必需属性
    • id
    playlistItems.update 必需属性
    • id
    videos.update 必需属性
    • id
  • 如果您尝试create更新与同一频道中现有播放列表同名的新播放列表,API 不再报告 playlistAlreadyExists 错误。

  • 多个 API 方法支持新错误类型。下表列出了该方法和新支持的错误:

    方法 错误类型 错误详情 说明
    guideCategories.list notFound notFound 找不到由 id 参数标识的指南类别。使用 guideCategories.list 方法检索有效值列表。
    playlistItems.delete forbidden playlistItemsNotAccessible 请求未获得正确授权,无法删除指定的播放列表项。
    videoCategories.list notFound videoCategoryNotFound 找不到由 id 参数标识的视频类别。使用 videoCategories.list 方法检索有效值的列表。