修订历史记录

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

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 平台上的“踩”视频计数措施的变更,自 2021 年 12 月 13 日起,video 资源的 statistics.dislikeCount 属性将会设为不公开。这意味着,只有当 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 合规性审核,才能获得超过默认分配的 10,000 个 API 配额。迄今为止,合规审核流程和申请增加配额单元的申请都是由开发者填写并提交 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 方法的 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 响应代码(请求错误)。

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

2020 年 10 月 15 日

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

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

新的查找视频的 MadeForKids 状态指南介绍了如何使用 YouTube Data API 服务来查找视频的 MFK 状态。

除了这些变更之外,我们还在嵌入式播放器参数文档中添加了一条提醒,指出如果您启用自动播放,播放操作无需用户与播放器互动即可进行播放;因此,播放数据收集和共享会在网页加载时进行。

2020 年 10 月 8 日

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

  • 对于新创建的频道,用于标识频道的缩略图的 snippet.thumbnails 对象可能为空,最多可能需要一天时间才能填充完毕。
  • 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 属性。
  • channel 资源的 contentDetails.relatedPlaylists.watchLatercontentDetails.relatedPlaylists.watchHistory 属性已于 2016 年 8 月 11 日宣布已弃用。现在,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 TOS) 的特定部分。

本指南旨在深入说明 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 服务返回的订阅人数将向下舍入为三个有效数字。此更改会影响 channel 资源的 statistics.subscriberCount 属性。

注意:即使用户针对自己频道的相关数据发送了已获授权的请求,此更改也会影响此属性值。频道所有者仍然可以在 YouTube 工作室中查看确切的订阅人数。

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

订阅人数示例 YouTube Data API 公开显示的 YouTube 界面
1234 1230 1230
12,345 12300 1.23 万
123456 123000 12.3 万
1234567 1230000 123 万
12345678 12300000 1230 万
123,456,789 123000000 1.23 亿

2019 年 4 月 4 日

此更新包含以下更改:

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

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

    • 常见用例部分介绍了页面上介绍的方法的一个或多个常见用例。例如,您可以调用 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 即将停止对精选视频精选网站功能的支持,这些功能可通过 channel 资源的 invideoPromotion 对象在 API 中实现。因此,该对象(包括其所有子属性)将被弃用。

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

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

    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 网络服务器应用的完整代码示例,这些应用使用的授权流程略有不同。如需查看完整示例(以及此变更),请运行以下命令:

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

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

2017 年 8 月 29 日

此更新包含以下更改:

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

2017 年 7 月 24 日

此更新包含以下更改:

  • 新版 YouTube Data API 快速入门指南(iOS 版)现已发布。本指南介绍如何在以 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 脚本和 Go 编写的代码段。

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

    您还可与代码示例互动:

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

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

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

    请注意,此工具替换了提供页面上的 API Explorer。(每个页面都会显示一个链接,这样您还可以选择加载 API Explorer 中正在处理的请求。)

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

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

2017 年 4 月 27 日

此更新包含以下更改:

2017 年 3 月 30 日

此更新包含以下更改:

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

2017 年 2 月 27 日

YouTube 最初于 2016 年 8 月 11 日宣布已将受支持的主题 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 日发布的修订历史记录更新中说明了这些变更:

    • 如果在调用 activities.list 方法时将 home 参数设为 true,则 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 工程和开发者博客上详细介绍了新发布的 YouTube API 服务的《服务条款》(以下简称“更新后的条款”),其中对当前《服务条款》提供了丰富的更新内容。除了将于 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 不属于受支持的主题 ID 集合中较小的一组,该 API 将返回空的结果集。

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

    • 通过 activities.list 方法的 home 参数,授权用户可以检索活动 Feed,该 Feed 会在 YouTube 首页上显示给该用户。在 2016 年 9 月 12 日之后使用此参数的请求将返回一个空列表。

    • channel 资源的 contentDetails.relatedPlaylists.watchHistorycontentDetails.relatedPlaylists.watchLater 属性仅对检索用户自己频道相关数据的授权用户可见。2016 年 9 月 12 日之后,contentDetails.relatedPlaylists.watchHistory 将返回一个 HL 值,contentDetails.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 参数。该参数不会按特定顺序返回订阅者,而且不限制可检索的订阅者数量。

  • 我们为 activityplaylistItemplaylist搜索结果thumbnailvideo 资源更新了 snippet.thumbnails.(key) 属性的定义,以指明某些视频还可采用其他缩略图尺寸。

    • standard 图片宽 640 像素,高 480 像素。
    • maxres 图片的宽度为 1280 px,高度为 720 px。
  • channelSection.list 方法的 part 参数的定义已更新,以指明能够以 2 个配额单元的费用检索 targeting 部分。

  • 现在,当一个未正确授权的请求尝试检索 video 资源的 fileDetailsprocessingDetailssuggestions 部分时,videos.list 方法现在会返回 Forbidden (403) 错误。这些部分仅供视频所有者使用。

2016 年 5 月 17 日

新的 Data API 代码段工具提供了适用于常见 YouTube Data API 用例的简短代码段。代码段目前可用于 Apps 脚本、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 Developers Console,您可以在那里查看实际配额和配额使用情况。

2016 年 3 月 16 日

此更新包含以下更改:

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

    • channelBanner 资源文档已更新,以指明上传的频道横幅图片的建议尺寸为 2560x1440 像素。最小尺寸(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) 法律,Google 必须向欧盟境内的最终用户提供某些披露信息并征得他们的同意。因此,对于欧盟境内的最终用户,您必须遵守欧盟地区用户意见征求政策。我们已在 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 参数设置为 fr,则 snippet.localized 对象将包含英语标题和说明,因为英语是资源的默认语言,并且本地化的法语详情不可用。

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

      例如,您需要检索完整的本地化文本列表,以确定本地化文本是否提供阿巴拉契亚英语版。

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

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

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

    错误类型 错误详情 说明
    badRequest (400) defaultLanguageNotSetError 此错误表示尝试为某个资源插入或更新 localizations 对象的请求失败,因为没有为该资源设置 snippet.defaultLanguage 属性。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 Developers Console 中的应用相关联的项目编号标记上传的视频。

      如果搜索请求随后将 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 方法。此外,有些评论没有回复。

      对于 commentThread 资源,该 API 支持以下方法:

    • comment 资源包含一条 YouTube 评论的相关信息。comment 资源可以表示关于视频或频道的评论。此外,该评论可以是顶级评论或对顶级评论的回复。

      对于 comment 资源,该 API 支持以下方法:

      • comments.list - 检索评论列表。使用此方法可以检索对特定评论的所有回复。
      • comments.insert – 创建对现有评论的回复。
      • comments.update - 修改评论。
      • comments.markAsSpam – 举报一条或多条评论。
      • comments.setModerationStatus – 设置一条或多条评论的审核状态。例如,清除某条评论以供公开显示,或拒绝某条评论不适合显示。该 API 请求必须获得与评论相关联的频道或视频的所有者授权。
      • comments.delete - 删除评论。

    请注意,调用 comments.insertcomments.updatecomments.markAsSpamcomments.setModerationStatuscomments.deletecommentThreads.insertcommentThreads.update 方法需要该 API 的新 https://www.googleapis.com/auth/youtube.force-ssl 范围(如 2015 年 4 月 2 日的修订历史记录中所述)。

  • 新的订阅推送通知指南介绍了该 API 通过 PubSubHubBub(一种适用于 Web 可访问资源的服务器到服务器发布/订阅协议)对推送通知的新支持。当某个频道执行以下任意活动时,您的 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 Developers Console 中的应用相关联的项目编号标记上传的视频。然后,开发者会使用同一个项目编号搜索视频。

    • 按发布日期、观看次数或评分列出视频 - 在 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) 迁移指南已更新,介绍了如何使用 API v3 通过 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 属性(用于标识新西兰电影与文学分类办公室的视频分级)现在支持两个新分级: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 日

此更新包含以下更改:

  • 每种 API 方法的说明已更新,现在包含调用该方法所产生的配额费用。同样,part 参数的定义也已更新,以指定可在 API 调用中检索的每个部分的配额费用。例如,调用 subscriptions.insert 方法会产生大约 50 个单元的配额费用。subscription 资源还包含三个部分(snippetcontentDetailssubscriberSnippet),每个部分的费用都是两个单位。

    请注意,配额费用随时可能发生变化,恕不另行通知。

  • video 资源现在支持 43 个新的内容分级制度,这些分级制度用于标识视频获得的各国家级分级机构提供的分级。支持的国家/地区包括:阿根廷奥地利比利时、、保加利亚、智利、智利 (Television)、捷克哥伦比亚奥地利58、、、和{6、中国、中国、澳大利亚、中国、澳大利亚、澳大利亚、巴西、等等。{6{6{6/1}、中国、中国、中国、东南亚、中国大陆、中国大陆、中国香港、中国或泰国{6{6、澳大利亚、巴西、中国和澳大利亚{6

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 的值,该 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 属性的值的长度上限为 1000 个字符。
    • 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 属性用于标识视频根据加拿大电视分类系统和法语 Régie du cinéma 分级制度(分别在魁北克使用的分级制度)下的分级。

  • 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 范围的授权令牌。此外,如果多频道网络决定接受或拒绝频道,或者在令牌发出后的两周内,必须撤消使用该范围的任何令牌。

  • 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 属性用于标识视频收到的由意大利卫生部 (Minisero dei Beni e delle Attivita Culturali e del Turismo) 评定的评分。

  • 该 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 方法的 Python 示例还移除了,因为它演示的功能现在由 videos.rate 方法处理。

  • 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 上的活动无法提供足够的信息来生成活动 Feed 时,YouTube 会使用该值。

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

  • 以前,channels.listsearch.list 方法支持 onBehalfOfContentOwner 参数,现在 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 参数的请求不支持 Paging 参数和信息。)

    • 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 方法都支持此参数。

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

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

2013 年 2 月 25 日

此更新包含以下更改:

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

    • 新的 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
  • 如果您尝试创建更新的播放列表与同一频道中已存在的播放列表具有相同的标题,则 API 不会再报告 playlistAlreadyExists 错误。

  • 多种 API 方法支持新的错误类型。下表列出了该方法以及最新支持的错误:

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