本页面列出了 YouTube Data API (v3) 变更和文档更新。订阅此更新日志。
2024 年 10 月 30 日
该 API 现在支持识别包含逼真的加工或合成 (A/S) 内容的视频。详细了解与 A/S 内容相关的 YouTube 政策。
色情/色情相关内容的示例包括:
- 让真实人物做出实际上并未说过或做过的言论或行为
- 修改真实事件或地点的视频片段
- 生成逼真但实际并未发生的场景
如需指明视频是否包含 A/S 内容,请设置 status.containsSyntheticMedia
属性。您可在调用 videos.insert
或 videos.update
方法时设置此属性。如果已设置,系统会在 video
资源中返回该属性。
2024 年 4 月 30 日
注意:这是弃用通知。
此更新包含以下更改:
该 API 不再支持插入或检索频道讨论。此项变更与 YouTube 网站上支持的功能保持一致,该网站不支持向频道发送评论。
2024 年 3 月 13 日
注意:这是一条废弃公告。
此更新包含以下更改:
captions.insert
和 captions.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.list
、captions.update
、captions.download
和 captions.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
方法的 myRecentSubscribers
和 mySubscribers
参数定义,以提及 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
资源支持两个新属性:
snippet.videoOwnerChannelId
属性用于标识上传了播放列表视频的频道的 ID。snippet.videoOwnerChannelTitle
属性用于标识上传播放列表视频的频道名称。
2021 年 1 月 28 日
此更新包含以下更改:
-
playlistItems.delete
、playlistItems.insert
、playlistItems.list
、playlistItems.update
、playlists.delete
、playlists.list
和playlists.update
方法都支持新的playlistOperationUnsupported
错误。当请求尝试执行对特定播放列表不允许的操作时,就会出现此错误。例如,用户无法从其上传的视频播放列表中删除视频,也无法删除播放列表本身。在所有情况下,此错误都会返回
400
HTTP 响应代码(Bad Request)。 -
文档中已移除
playlistItems.list
方法的watchHistoryNotAccessible
和watchLaterNotAccessible
错误。虽然用户的观看记录和稍后观看列表确实无法通过 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
对象可能为空,并且最多可能需要一天时间才能填充完毕。 statistics.videoCount
属性仅反映频道的公开视频数量,即使对频道所有者也是如此。此行为与 YouTube 网站上显示的计数一致。- 如果渠道关键字(在
brandingSettings.channel.keywords
媒体资源中标识)超出 500 个字符的允许长度上限,或者包含未转义引号 ("
),则可能会被截断。请注意,500 个字符的限制并非针对每个关键字,而是针对所有关键字的总长度。 此行为与 YouTube 网站上的一致。
2020 年 9 月
注意:这是一条废弃公告。
此更新涉及以下 API 变更。所有变更将于 2020 年 9 月 9 日(即本公告发布日期)当天或之后生效。有鉴于此,开发者不应再依赖下面列出的任何 API 功能。
-
以下 API 资源、方法、参数和资源属性将立即弃用,并将于本公告发布日期当天或之后停止使用:
- 以下
channel
资源属性:statistics.commentCount
属性brandingSettings.image
对象及其所有子属性brandingSettings.hints
列表及其所有子属性
channels.list
方法的categoryId
过滤器参数guideCategories
资源和guideCategories.list
方法
- 以下
-
如果 API 请求将
managedByMe
参数设置为true
,则channels.list
方法的 API 响应不再包含prevPageToken
属性。此更改不会影响其他channels.list
请求的prevPageToken
属性,也不会影响任何请求的nextPageToken
属性。 -
我们已于 2016 年 8 月 11 日宣布弃用
channel
资源的contentDetails.relatedPlaylists.watchLater
和contentDetails.relatedPlaylists.watchHistory
属性。playlistItems.insert
方法和playlistItems.delete
方法对这些播放列表的支持现在也完全弃用,并且这两个属性已从文档中移除。 -
channels.list
方法的mySubscribers
参数已于 2013 年 7 月 30 日宣布为已弃用,现已从文档中移除。使用subscriptions.list
方法及其mySubscribers
参数检索经过身份验证的用户频道的订阅者列表。 -
channel
资源的invideoPromotion
对象及其所有子属性已于 2017 年 11 月 27 日宣布为已弃用,现已从文档中移除。
2020 年 7 月 29 日
我们简化了收取 API 请求配额的流程,移除了与 part
参数相关的额外费用。此更新立即生效,我们仅会针对被调用的方法收取基本费用。如需详细了解简化配额,请点击此处。
此次变更的影响是,大多数 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
方法的 autoLevels
和 stabilize
参数现已废弃,并且这两个参数已从文档中移除。系统会忽略这些值,它们不会影响新上传视频的处理方式。
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 帮助中心,详细了解“面向儿童的内容”。
channel
和 video
资源支持两个新属性,以便内容创作者和观看者能够识别面向儿童的内容:
-
借助
selfDeclaredMadeForKids
属性,内容创作者可以指定频道或视频是否属于面向儿童的内容。
对于渠道,可以在调用channels.update
方法时设置此属性。对于视频,可以在调用videos.insert
或videos.update
方法时设置此属性。
请注意,只有在频道所有者对 API 请求授权的情况下,包含channel
或video
资源的 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 界面 |
---|---|---|
1,234 | 1230 | 1230 |
12,345 | 12300 | 1.23 万 |
123,456,000 | 123000 | 12.3 万 |
1,234,567,000 | 1230000 | 123 万 |
12,345,678 | 12300000 | 1230 万 |
123,456,789 | 123000000 | 1.23 亿 |
2019 年 4 月 4 日
此更新包含以下更改:
-
API 参考文档已更新,以更好地解释每种方法的常见用例,并通过 APIs 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 的可用代码示例的页面。
-
我们更新了 Java、JavaScript、PHP 和 Python 的快速入门指南。修订后的指南介绍了如何使用 APIs 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 资源中的属性相对应的键值对列表。然后,它会将这些属性转换为可在insert
和update
操作中使用的 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-auth
和google-auth-oauthlib
库,而不是已废弃的oauth2client
库。除了这项更改之外,该工具现在还提供已安装的 Python 应用和 Python 网络服务器应用的完整代码示例,它们使用的授权流程略有不同。如需查看完整示例(以及此次变更),请执行以下操作:
- 前往交互式代码段工具或任何 API 方法(例如
channels.list
方法)的文档。 - 点击代码示例上方的
Python
标签页。 - 点击标签页上方的切换开关,可从查看摘要切换为查看完整示例。
- 该标签页现在应显示使用
InstalledAppFlow
授权流程的完整代码示例。示例上方的说明对此进行了说明,并提供了指向 Web 服务器应用示例的链接。 - 点击链接以切换到 Web 服务器示例。该示例使用 Flask Web 应用框架和其他授权流程。
所有这些示例均可下载并在本地运行。如果您想运行这些示例,请参阅代码段工具说明中有关在本地运行完整代码示例的说明。
- 前往交互式代码段工具或任何 API 方法(例如
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 日
此更新包含以下更改:
-
注意:这是一条废弃公告。
以下
video
资源属性即将弃用。虽然这些属性将在 2017 年 12 月 1 日之前受支持,但我们无法保证在此之前视频会继续返回这些属性的值。同样,在该日期之前,用于设置这些属性值的videos.insert
和videos.update
请求不会生成错误,但传入的数据可能不会存储。
2017 年 5 月 17 日
此更新包含以下更改:
-
API 参考文档已更新,使代码段更普遍且更具互动性。介绍 API 方法(例如
channels.list
或videos.rate
)的页面现在提供了一款交互式工具,可让您查看和自定义 Java、JavaScript、PHP、Python、Ruby、Apps Script 和 Go 中的代码段。对于任何给定的方法,该工具会显示一个或多个用例的代码段,并且每个用例都会描述调用该方法的常用方法。例如,您可以调用
channels.list
方法来检索有关特定频道或当前用户频道的数据。您还可以与代码示例互动:
-
修改参数和属性值,并且代码段会动态更新以反映您提供的值。
-
在代码段和完整示例之间切换。代码段显示了调用 API 方法的代码部分。完整示例包含该代码段以及用于授权和发送请求的样板代码。您可以通过命令行或本地 Web 服务器复制和运行完整示例。
-
点击按钮即可执行请求。(如需执行请求,您需要授权该工具代表您调用 API。)
请注意,此工具已取代推出此工具的网页上的 APIs Explorer。(每个页面都会显示一个链接,因此您还可以选择在 API Explorer 中加载正在处理的请求。)
-
-
Data API 代码段工具也已更新,采用了新的界面,提供上述所有功能。本页介绍的主要新功能包括:
- 支持写入数据的 API 请求。
- 支持 Java 示例。
- 更灵活、更全面的样板代码,用于授权用户和构建 API 请求。
2017 年 4 月 27 日
此更新包含以下更改:
- 新的快速入门指南介绍了如何设置一个可发出 YouTube Data API 请求的简单应用。目前,我们提供了 Android、Apps Script、Go、Java、JavaScript、Node.js、PHP、Python 和 Ruby 版指南。
2017 年 3 月 30 日
此更新包含以下更改:
channel
资源的新topicDetails.topicCategories[]
属性包含描述频道内容的维基百科网址列表。这些网址与资源的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 的完整列表包含在 channel
和 video
资源的 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
的子类别)已被移除。
另请注意,这里还有几个父类别(
Entertainment
、Gaming
、Lifestyle
、Music
和Sports
)。任何与子类别(例如Tennis
)相关联的视频也将与父类别 (Sports
) 相关联。
2016 年 11 月 10 日
此更新包含以下更改:
-
正如 2016 年 8 月 11 日首次公布的那样,要弃用 Freebase 和 Freebase API,您需要对主题 ID 进行一些更改。主题 ID 用于标识与
channel
和video
资源相关联的主题,您还可以使用topicId
搜索参数查找与特定主题相关的频道或视频。从 2017 年 2 月 10 日起,YouTube 将开始返回一小部分主题 ID,而不是目前为止所返回更为细化的那组 ID。另请注意,我们不保证频道和视频会与任何主题相关联,这与当前的 API 行为一致。
为便于您为这些变更做好 API 客户端准备,我们更新了以下 API 参数和属性的定义,以列出之后将受支持的主题 ID。请注意,所有属性的类别列表都是相同的。
channel
资源的topicDetails.topicIds[]
属性。video
资源的topicDetails.relevantTopicIds[]
属性。search.list
方法的topicId
参数。
-
注意:这是弃用通知。
以下属性即将弃用:
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.embedHeight
和player.embedWidth
属性用于标识嵌入式播放器的尺寸。只有当 API 请求为maxHeight
或maxWidth
参数中的至少一个指定值时,才会返回这些属性。本文修订历史记录条目稍后会介绍这两个新参数。 -
新的
hasCustomThumbnail
属性用于指明视频上传者是否已为视频提供了自定义缩略图。请注意,只有视频上传者才能看到此属性。 -
新的
fpbRatingReasons[]
用于指明视频获得 FPB(南非)分级的原因。 -
新的
mcstRating
用于标识视频在越南获得的分级。
-
-
videos.list
方法支持两个新参数:maxHeight
和maxWidth
。在检索video
资源中的player
部分时,您可以使用形参之一或同时使用这两个形参。默认情况下,
player.embedHtml
属性中返回的<iframe>
的高度为 360 像素。调整宽度以匹配视频的宽高比,从而确保嵌入式播放器不会为视频加框。例如,如果视频的宽高比为 16:9,则播放器的宽度为 640 像素。借助这些新参数,您可以指定嵌入代码应使用与应用布局相适应的高度和/或宽度,而不是默认尺寸。API 服务器会根据需要缩放播放器尺寸,以确保嵌入的播放器不会在视频周围显示黑边。请注意,这两个参数都指定了嵌入式播放器的最大尺寸。因此,如果同时指定了两个参数,则其中一个维度仍可能会小于该维度允许的上限。
例如,假设某个视频的宽高比为 16:9。因此,如果未设置
maxHeight
或maxWidth
参数,player.embedHtml
标记将包含 640x360 播放器。- 如果
maxHeight
参数设置为720
,且未设置maxWidth
参数,则该 API 会返回 1280x720 播放器。 - 如果
maxWidth
参数设置为960
,并且未设置maxHeight
参数,则该 API 会返回 960x540 的播放器。 - 如果
maxWidth
参数设为960
,且maxHeight
参数设为450
,该 API 会返回 800x450 播放器。
新的
player.embedHeight
和player.embedWidth
属性(如上所述)用于标识播放器的尺寸。 - 如果
-
-
现有方法、属性和参数的更新
-
我们更新了
channelSection
资源说明,以指明在未设置定位数据的情况下,一个频道最多可以创建 10 个频道架(包含定位数据)。此外,
channelSection
资源的targeting
属性已更新,以反映定位选项只能使用 API 进行设置。如果使用 YouTube 网站上的界面修改频道版块,系统会删除定位选项。 -
更正了
i18nLanguage
资源的snippet.name
属性的定义,以反映该值表示语言名称,因为它是使用i18nLanguage.list
方法的hl
参数指定的语言编写的。 -
playlistItem
资源的contentDetails.note
属性已更新,以指明属性值的长度上限为 280 个字符。 -
playlistItem
资源的contentDetails.startAt
和contentDetails.endAt
属性已废弃。如果这些字段在playlistItems.insert
或playlistItems.update
请求中设置,则会被忽略。 -
playlistItems.delete
和playlistItems.update
方法现在支持onBehalfOfContentOwner
参数,其他几种方法也已支持该参数。使用该方法的请求还需要使用可访问https://www.googleapis.com/auth/youtubepartner
范围的令牌进行授权。 -
search.list
方法的publishedBefore
和publishedAfter
参数已更新,以指明参数值是包含边界值的。例如,如果设置了publishedBefore
参数,则 API 会返回在指定时间之前或创建的资源。 -
video
资源的contentDetails.contentRating.grfilmRating
属性支持另外三个值:grfilmK12
、grfilmK15
和grfilmK18
。 -
更新了
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.watchHistory
和contentDetails.relatedPlaylists.watchLater
属性时,它们始终分别包含值HL
和WL
。此外,只有在授权用户检索有关用户自己频道的数据时,才会包含这些属性。
-
2016 年 9 月 15 日
此更新包含以下更改:
-
2016 年 8 月 11 日修订历史记录更新讨论了与主题 ID 相关的几项更改,其中包括支持的主题 ID 集将于 2017 年 2 月 10 日起发生变化。我们将于 2016 年 11 月 10 日之前公布受支持的主题列表。
-
以下变更现已生效。我们在 2016 年 8 月 11 日的修订历史记录更新中提供了以下变更通知:
-
如果在调用
activities.list
方法时将home
参数设为true
,则 API 响应现在包含的内容与未登录的 YouTube 用户在首页上看到的内容类似。这是一个细微的更改,旨在提供比 2016 年 8 月 11 日修订历史记录更新中所述行为更好的用户体验。该更新已声明使用
home
参数的请求将返回空列表。 -
对于所有渠道,
channel
资源的contentDetails.relatedPlaylists.watchHistory
和contentDetails.relatedPlaylists.watchLater
属性现在分别包含HL
和WL
的值。需要说明的是,只有获得授权且检索用户自己频道相关数据的用户才能看到这些属性。这些属性始终包含值
HL
和WL
,即使是授权用户检索与用户自己的频道相关的数据也是如此。因此,您无法通过该 API 检索观看记录和稍后观看播放列表 ID。此外,现在请求检索频道观看记录或“稍后观看”播放列表的播放列表详情 (
playlists.list
) 或播放列表内容 (playlistItems.list
) 会返回空列表。此行为适用于新值HL
和WL
,以及您的 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 将返回空的结果集。
-
以下 API 字段和参数将于 2016 年 9 月 12 日弃用:
-
activities.list
方法的home
参数可让授权用户检索将在 YouTube 首页上为该用户显示的活动 Feed。在 2016 年 9 月 12 日之后使用此参数的请求将返回空列表。 -
channel
资源的contentDetails.relatedPlaylists.watchHistory
和contentDetails.relatedPlaylists.watchLater
属性仅对检索用户自己频道相关数据的授权用户可见。2016 年 9 月 12 日之后,对于所有渠道,contentDetails.relatedPlaylists.watchHistory
将返回值HL
,contentDetails.relatedPlaylists.watchLater
属性将返回值WL
。2016 年 9 月 12 日之后,如果请求检索频道观看记录或稍后观看列表的播放列表详情 (
playlists.list
),系统将返回一个空列表。在该时间过后,检索其中任何一个播放列表中播放列表项 (playlistItems.list
) 的请求也将返回一个空列表。这适用于新值HL
和WL
,以及您的 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
参数会按用户订阅频道的时间(从后往前)检索已验证用户频道的订阅者列表。请注意,新参数仅支持检索已验证用户频道的最近 1000 位订阅者。如需检索完整的订阅者列表,请使用
mySubscribers
参数。该参数不会按特定顺序返回订阅者,也不会限制可检索的订阅者数量。 -
针对 activity、playlistItem、playlist、search result、缩略图和视频资源更新了
snippet.thumbnails.(key)
属性的定义,请注意,某些视频可以使用额外的缩略图图片大小。standard
图片的宽度为 640 像素,高度为 480 像素。maxres
图片宽 1280 像素,高 720 像素。
-
更新了
channelSection.list
方法的part
参数的定义,以指出检索targeting
部分需要消耗2
配额单元。 -
现在,如果未正确授权的请求尝试检索
video
资源的fileDetails
、processingDetails
或suggestions
部分,videos.list
方法会返回 forbidden (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
属性用于指定视频的投影格式。有效的属性值为360
和rectangular
。 -
video
资源的recordingDetails.location
和fileDetails.recordingLocation
属性已更新,以说明这两个属性之间的区别:recordingDetails.location
属性用于标识视频所有者希望与视频关联的位置。此位置可修改、可在公开视频中搜索;对于公开视频,此位置可能会向用户显示。fileDetails.recordingLocation
属性值不可变,表示与上传的原始视频文件相关联的位置。该值仅对视频所有者可见。
-
channel
资源的contentDetails.relatedPlaylists.favorites
属性的定义已更新,以指明该属性值可能包含引用空播放列表且无法提取的播放列表 ID。这是因为收藏视频功能已被弃用。请注意,此属性不受 API 弃用政策的约束。 -
更新了
ineligibleAccount
错误(可由comments.insert
、comments.update
、commentThreads.insert
或commentThreads.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.label
和snippet.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.insert
、channelSections.update
和channelSections.delete
方法会返回此错误,表明指定的频道版块无法创建、更新或删除。badRequest (400)
styleRequired
channelSections.insert
和channelSections.update
方法会返回此错误,以表明 API 请求中提交的channelSection
资源必须为snippet.style
属性指定一个值。badRequest (400)
typeRequired
channelSections.insert
和channelSections.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.title
和snippet.categoryId
属性设置值,则会出现此错误。
2015 年 12 月 18 日
根据欧盟 (EU) 法律规定,您必须向欧盟境内的最终用户提供某些披露信息并征得其同意。因此,对于欧盟境内的最终用户,您必须遵守《欧盟地区用户意见征求政策》。我们在 YouTube API 服务条款中添加了关于这项要求的通知。
2015 年 11 月 19 日
API 现在支持为 playlist
和 video
资源的 snippet.title
和 snippet.description
属性、channelSection
资源的 snippet.title
属性以及 channel
资源的 snippet.description
属性设置和检索本地化文本。
-
设置本地化商品名和说明
在为资源调用
insert
或update
方法时,您可以为该资源设置本地化值。如需为资源设置本地化值,请执行以下两项操作:-
确保为资源的
snippet.defaultLanguage
属性设置了值。该属性用于标识资源的snippet.title
和snippet.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.list
、channelSections.list
、playlists.list
或videos.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.update
、channelSections.insert
、channelSections.update
、playlists.insert
、playlists.update
、videos.insert
和videos.update
方法支持此错误。badRequest (400)
localizationValidationError
此错误表示资源的 localizations
对象中的某个值无法验证。例如,如果对象包含无效的语言代码,就可能会出现此错误。channels.update
、channelSections.insert
、channelSections.update
、playlists.insert
和playlists.update
方法支持此错误。
2015 年 11 月 4 日
此更新包含以下更改:
-
对现有资源和方法的更新
-
search.list
方法的order
参数已更新,以提示您,如果您按viewCount
对直播进行排序,API 结果会按直播仍在进行时的并发观看者数量进行排序。 -
search.list
方法的relatedToVideoId
参数已更新,以指明,如果设置了该参数,则唯一支持的其他参数为part
、maxResults
、pageToken
、regionCode
、relevanceLanguage
、safeSearch
、type
(必须设置为video
)和fields
。此更新并未反映 API 行为的变化。 -
更新了
video
资源的snippet.publishedAt
属性的定义,以指出该属性值(用于指定视频的发布日期和时间)可能与视频的上传时间不同。例如,如果视频在上传时设为私享,之后又设为公开,则此属性值会指定视频的公开时间。更新后的定义还说明了如何为私享视频和不公开列出的视频填充此值。这项更改并不反映 API 行为的变化。
-
video
资源的status.publishAt
属性的定义已更新,以注明以下事项:- 如果您在调用
videos.update
方法时设置了此属性的值,则还必须将status.privacyStatus
属性值设置为private
,即使视频已设为私享也是如此。 - 如果请求将某个视频安排在过去某个时间发布,则该视频会立即发布。因此,将
status.publishAt
属性设为过去的日期和时间的效果与将视频的privacyStatus
从private
更改为public
的效果相同。
- 如果您在调用
-
video
资源的contentDetails.contentRating.cncRating
属性用于指定法国电影分级委员会的视频分级。此属性取代了现已废弃的contentDetails.contentRating.fmocRating
属性。 -
channel
资源的 brandingSettings.channel.keywords 的定义已更新,以正确反映属性值包含以空格分隔的字符串列表,而不是逗号分隔的列表,如之前所述。此更新并不表示 API 行为发生了变化。 -
thumbnails.set
方法的文档已更新,以准确反映请求的正文包含您要上传并与视频关联的缩略图。请求正文不包含thumbnail
资源。之前,文档指出在调用此方法时不应提供请求正文。此更新并不表示 API 行为发生了变化。 -
activity
资源的说明已更新,以反映activities.list
方法目前不包含与新视频评论相关的资源。资源的snippet.type
和contentDetails.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.delete
、captions.download
、captions.insert
、captions.list
和captions.update
方法现在支持onBehalfOfContentOwner
参数,其他一些方法也已支持该参数。使用该方法的请求还需要使用可访问https://www.googleapis.com/auth/youtubepartner
范围的令牌进行授权。
-
-
新错误和更新后的错误
-
API 现在支持以下错误:
错误详情 videos.rate
HTTP 响应代码 badRequest (400)
原因 emailNotVerified
说明 用户必须先验证其电子邮件地址,然后才能对视频进行评分。 videos.rate
HTTP 响应代码 badRequest (400)
原因 videoPurchaseRequired
说明 只有租借视频的用户才能对租借视频进行评分。 -
subscriptions.delete
和subscriptions.insert
方法不再支持accountClosed
和accountSuspended
错误。
-
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 提供了三种定位选项。用户必须满足频道版块的所有定位设置,才能看到该版块。
-
targeting.languages[]
:YouTube 应用语言列表。如果用户选择上述某种语言,则可以看到相应的频道版块。 -
targeting.regions[]
:YouTube 首选内容区域列表。无论是选择了上述某个区域的用户,还是系统为这些用户自动选择了其中某个区域的用户,都可以看到渠道版块。 -
targeting.countries[]
:显示频道版块的国家/地区列表。列表中的每个值都是 ISO 3166-1 alpha-2 国家/地区代码。
-
-
更正了
video
资源的contentDetails.duration
属性的定义,以反映该值可以反映小时、天等。 -
channelSections.delete
、playlistItems.delete
、playlists.delete
、subscriptions.delete
和videos.delete
方法的文档已更正,以反映这些方法在成功时都返回 HTTP204
响应代码 (No Content
)。
-
-
新错误和更新后的错误
-
该 API 现在支持以下错误:
错误类型 错误详情 说明 badRequest (400)
targetInvalidCountry
如果插入的 channelSection
资源包含无效的targeting.countries[]
属性值,则channelSections.insert
和channelSections.update
方法会返回此错误。badRequest (400)
targetInvalidLanguage
如果插入的 channelSection
资源包含targeting.languages[]
属性的无效值,channelSections.insert
和channelSections.update
方法会返回此错误。badRequest (400)
targetInvalidRegion
如果插入的 channelSection
资源包含无效的targeting.regions[]
属性值,则channelSections.insert
和channelSections.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
方法不再支持invalidMetadata
和videoNotFound
错误。
-
2015 年 4 月 16 日
此更新包含以下更改:
-
我们更新了迁移指南,以说明如何迁移仍在使用 v2 API 中的评论功能的应用。
本指南还指出了 v2 API 不支持但 v3 API 支持的一些评论功能。其中包括:
- 检索有关频道的评论
- 检索与频道相关的所有评论会话,这意味着 API 响应可以包含与该频道或其任何视频相关的评论。
- 更新评论的文本
- 将评论标记为垃圾评论
- 设置评论的审核状态
-
订阅推送通知指南已更新,以反映通知仅推送到 Google PubSubHubBub 中心,而不会像之前所述那样同时推送到 Superfeedr 中心。
2015 年 4 月 9 日
此更新包含以下更改:
-
通过 API 的新
commentThread
和comment
资源,您可以检索、插入、更新、删除和管理评论。-
commentThread
资源包含有关 YouTube 评论会话的信息,该会话由顶级评论以及对该评论的回复(如果有)组成。commentThread
资源可以表示与视频或频道相关的评论。顶级评论和回复实际上是嵌套在
commentThread
资源中的comment
资源。请务必注意,commentThread
资源不一定包含对某条评论的所有回复,如果您想检索特定评论的所有回复,则需要使用comments.list
方法。此外,有些评论没有回复。该 API 支持对
commentThread
资源使用以下方法:commentThreads.list
- 检索评论会话列表。您可以使用此方法检索与特定视频或频道相关联的评论。commentThreads.insert
- 创建新的顶级评论。(使用comments.insert
方法回复现有评论。)commentThreads.update
– 修改顶级评论。
-
comment
资源包含一条 YouTube 评论的相关信息。comment
资源可以表示与视频或频道相关的评论。此外,评论可以是顶级评论,也可以是对顶级评论的回复。对于
comment
资源,该 API 支持以下方法:comments.list
- 检索评论列表。使用此方法可检索特定评论的所有回复。comments.insert
- 回复现有评论。comments.update
- 修改评论。comments.markAsSpam
- 将一条或多条评论标记为垃圾评论。comments.setModerationStatus
- 设置一条或多条评论的审核状态。例如,您可以清除某条评论以便公开显示,或拒绝某条评论不适合显示。与评论相关联的频道或视频的所有者必须授权该 API 请求。comments.delete
- 删除评论。
请注意,若要调用
comments.insert
、comments.update
、comments.markAsSpam
、comments.setModerationStatus
、comments.delete
、commentThreads.insert
和commentThreads.update
方法,必须使用2015 年 4 月 2 日的修订记录中所述的 API 的新https://www.googleapis.com/auth/youtube.force-ssl
作用域。 -
-
新版订阅推送通知指南介绍了该 API 新支持通过 PubSubHubBub(适用于可通过网络访问的资源的服务器到服务器发布/订阅协议)接收推送通知。当频道执行以下任意活动时,您的 PubSubHubBub 回调服务器可以收到 Atom Feed 通知:
- 上传视频
- 更新视频标题
- 更新视频的说明
-
迁移指南也已更新,指出了对推送通知的新支持。不过,由于 v2 API 支持许多在 v3 API 中不支持的其他类型的推送通知,因此该指南的已弃用部分中仍会提及 PubSubHubBub 支持。
-
对于以前支持
https://www.googleapis.com/auth/youtube
范围的任何 API 方法,API 的新https://www.googleapis.com/auth/youtube.force-ssl
范围现在都是有效的范围。 -
API 现在支持以下错误:
错误类型 错误详情 说明 badRequest (400)
invalidRating
如果请求的 rating
参数包含非预期的值,videos.rate
方法会返回此错误。 -
subscriptions.insert
方法不再支持subscriptionLimitExceeded
错误,该错误之前表示使用请求标识的订阅者超出了订阅速率限制。
2015 年 4 月 2 日
此更新包含以下更改:
-
新的
captions
资源表示 YouTube 字幕轨道。一个字幕轨道只能与一个 YouTube 视频相关联。 -
我们还更新了迁移指南,介绍如何迁移仍在使用 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 支持和不支持的功能。这些功能之前已提供,并且仍然列在指南的其他标签页中。例如,介绍如何更新频道的视频内宣传广告系列数据的新功能也列在频道(个人资料)标签页下。
-
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.reason
和contentDetails.recommendation.seedResourceId
属性将包含视频推荐原因的相关信息。请注意,我们不保证响应中包含的推荐视频数量会是任何特定数量。 -
检索新的订阅视频 - v3 API 不会检索仅包含最近上传到 API 用户订阅的频道的视频的列表。不过,您可以使用 v3 API 查找新的订阅视频,只需调用
activities.list
方法并将home
形参值设置为true
即可。在 API 响应中,如果
snippet.type
属性的值为upload
,则资源对应于新的订阅视频。请注意,我们无法保证响应中包含的订阅新视频的数量。 -
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.list
、channelSections.list
、guideCategories.list
、playlistItems.list
、playlists.list
、subscriptions.list
、videoCategories.list
和videos.list
方法都支持id
参数,该参数可用于指定以英文逗号分隔的 ID(视频 ID、频道 ID 等)列表。使用这些方法,您可以通过单个请求检索多个资源的列表。
经过这些更改,该指南现在会指出旧版 (v2) API 中支持的所有功能,这些功能将在当前 API 版本 (v3) 中被弃用。
-
2015 年 3 月 4 日
此更新包含以下更改:
-
channelSections.delete
和channelSections.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.insert
和playlistItems.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 日
此更新包含以下更改:
-
search.list
方法现在支持relevanceLanguage
参数,您可以通过该参数请求与特定语言最相关的结果。我们还更新了 YouTube Data API (v3) 迁移指南,以说明如何使用此新参数。该参数解决了当前 API 版本 (v3) 与已废弃的旧版 (v2) 之间之前存在的功能差距。
-
YouTube Data API (v3) 迁移指南也已更新,其中指出 v2 API 提供的用于描述电影、预告片、电视节目、电视季和电视剧集的特殊 Feed 和元数据字段已废弃。
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.title
和snippet.categoryId
属性的定义都已更新,以阐明 API 处理videos.update
方法调用的方式。如果您调用该方法来更新video
资源的snippet
部分,则必须为这两个属性设置值。如果您尝试更新
video
资源的snippet
部分,但没有为这两个属性设置值,API 会返回invalidRequest
错误。该错误的说明也已更新。 -
video
资源的contentDetails.contentRating.oflcRating
属性用于标识视频的新西兰电影和文学分级办公室 (OFLC) 分级,现在支持两个新分级:oflcRp13
和oflcRp16
。这两个值分别对应于RP13
和RP16
评分。 -
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
资源还包含三个部分(snippet
、contentDetails
和subscriberSnippet
),每个部分的费用为 2 个单位。请注意,配额费用可能会在未经警告的情况下发生变化。
-
video
资源现在支持 43 种新的内容分级系统,这些系统用于确定视频从各个国家/地区分级机构获得的分级。新支持的分级系统来自阿根廷、奥地利、比利时、保加利亚、智利(电视)、智利(电影)、捷克共和国、哥伦比亚、丹麦、埃及、爱沙尼亚、芬兰、法国、希腊、香港、冰岛、印度尼西亚、爱尔兰、以色列、意大利、肯尼亚、拉脱维亚、卢森堡、马来西亚、马尔代夫、马耳他、荷兰、尼日利亚、挪威、秘鲁、菲律宾、葡萄牙、罗马尼亚、新加坡、斯洛伐克、南非、瑞典、瑞士、台湾、泰国和委内瑞拉。
2014 年 5 月 28 日
此更新包含以下更改:
-
search.list
方法现在支持location
和locationRadius
参数,可让您搜索与地理位置相关联的视频。请求必须为这两个参数都指定值,才能根据位置检索结果。如果请求仅包含这两个参数之一,API 将返回错误。-
location
参数用于指定圆形地理区域中心的纬度/经度坐标。 -
locationRadius
参数用于指定与视频相关联的位置距离相应区域中心的最大距离,如果该距离不超过此值,视频便会仍包含在搜索结果中。
-
2014 年 5 月 13 日
此更新包含以下更改:
-
channel
资源的invideoPromotion.items[]
属性已更新,以指明您通常只能为频道设置一个促销商品。如果您尝试插入过多促销商品,API 会返回tooManyPromotedItems
错误,其包含 HTTP400
状态代码。 -
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。您不应使用此值创建分页链接。请改用nextPageToken
和prevPageToken
属性值来确定是否显示分页链接。 -
watermarks.set
和watermarks.unset
方法已更新,以反映该 API 会针对对这些方法的成功请求返回 HTTP204
响应代码。
2014 年 5 月 2 日
此更新包含以下更改:
-
新的
i18nLanguage
资源用于标识 YouTube 网站支持的应用语言。应用语言也可称为界面语言。对于 YouTube 网站,系统会根据 Google 账号设置、浏览器语言或 IP 位置自动选择应用语言,用户也可以从 YouTube 网站页脚中手动选择所需的界面语言。该 API 支持用于列出受支持的应用语言的方法。在调用
videoCategories.list
和guideCategories.list
等 API 方法时,支持的语言可用作hl
参数的值。 -
新的
i18nRegion
资源用于标识 YouTube 用户可以选择作为首选内容区域的地理区域。内容区域也可称为内容语言区域。对于 YouTube 网站,系统可以根据 YouTube 网域或用户的 IP 位置等启发词语自动选择内容区域,用户也可以从 YouTube 网站页脚手动选择所需的内容区域。该 API 支持使用列出支持的内容区域的方法。调用
search.list
、videos.list
、activities.list
和videoCategories.list
等 API 方法时,可以将支持的区域代码用作regionCode
参数的值。
2014 年 4 月 7 日
此更新包含以下更改:
-
新增的
channelSection
资源包含频道选择推介的一组视频的相关信息。例如,版块可以展示某个频道最新上传的视频、最热门的上传视频或一个或多个播放列表中的视频。该 API 支持用于列出、插入、更新或删除频道版块的方法。您可以通过指定特定的频道 ID 或指定唯一频道版块 ID 来检索已验证用户的频道的频道版块列表。
错误文档也已更新,以说明 API 专门针对这些新方法支持的错误消息。
-
更新了
video
资源的fileDetails
对象的定义,以说明只有在视频的processingDetails.fileDetailsAvailability
属性的值为available
时,才会返回该对象。同样,
video
资源的suggestions
对象的定义也已更新,以说明仅当视频的processingDetails.tagSuggestionsAvailability
属性或其processingDetails.editorSuggestionsAvailability
属性的值为available
时,系统才会返回该对象。 -
更新了
videos.insert
和videos.update
方法的文档,以反映在调用这些方法时可以设置status.publishAt
属性。 -
channel
资源的invideoPromotion
对象的定义已更新,以说明只有频道所有者才能检索该对象。 -
videos.rate
方法的参数列表已更新,以反映该方法实际上并不支持onBehalfOfContentOwner
参数。这是文档错误,因为设置此参数的videos.rate
请求会返回500
错误。
2014 年 3 月 31 日
此更新包含以下更改:
-
借助
video
资源的新status.publishAt
属性,您可以指定私享视频的定时发布日期和时间。只有当视频的隐私状态为private
且从未发布过时,才能设置此属性。这一新属性不受弃用政策的约束。
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 将返回错误。 -
错误文档现已指定每种错误类型的 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 日
此更新包含以下更改:
-
YouTube Data API v3 现已受 YouTube API 服务条款中所述的弃用政策约束。请注意,列出受弃用政策约束的 API 页面明确排除了某些 v3 API 功能,使其不受此政策的约束。
2013 年 12 月 5 日
此更新包含以下更改:
-
search.list
方法的文档已更新,以正确反映您在提交搜索请求时无需为一个过滤器参数指定值。您可以为零个过滤条件参数或一个过滤条件参数设置值。 -
更新了
search.list
方法参数的定义,以指出如果您还为以下任一参数指定了值,则必须将type
参数的值设置为video
:eventType
videoCaption
videoCategoryId
videoDefinition
videoDimension
videoDuration
videoEmbeddable
videoLicense
videoSyndicated
videoType
-
上传的频道横幅图片的最小尺寸已缩减至 2048x1152 像素。(之前,最小尺寸为 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.list
和playlistItems.insert
方法现在支持onBehalfOfContentOwner
参数,其他一些方法已支持该参数。 -
contentDetails.contentRating.acbRating
属性现在可以指定电影的澳大利亚分级委员会 (ACB) 分级,也可以指定儿童电视节目的澳大利亚通信和媒体管理局 (ACMA) 分级。 -
新的
contentDetails.contentRating.catvRating
和contentDetails.contentRating.catvfrRating
属性分别用于标识视频在加拿大电视分级制度和法语 Régie du cinéma 分级制度(在魁北克使用)下的分级。 -
videoCategory
资源的新snippet.assignable
属性用于指明更新后的视频或新上传的视频是否可以与该视频类别相关联。 -
添加了以下方法的代码示例:
activities.insert
(前往)channelBanners.insert
(Python)channels.update
(Python)playlistItems.list
(前往)search.list
(Go)thumbnails.set
(Java)videos.insert
(Go)
2013 年 10 月 24 日
此更新包含以下更改:
-
该 API 包含两项额外功能,旨在帮助查找并推介直播内容:
搜索结果中的新
snippet.liveBroadcastContent
属性用于指明视频或频道资源是否有直播内容。有效的属性值为upcoming
、active
和none
。-
video
资源的新snippet.liveBroadcastContent
属性用于指明视频是即将开始还是正在进行的直播。以下列表介绍了该属性的可能值:upcoming
– 视频是尚未开始的直播。active
- 视频正在直播。none
– 视频不是即将开始或正在进行的直播。这是仍可在 YouTube 上观看的已播放完毕的直播的媒体资源价值。
-
video
资源的新liveStreamingDetails
属性是一个对象,其中包含有关直播视频的元数据。如需检索此元数据,请在part
参数值的资源部分列表中添加liveStreamingDetails
。元数据包含以下新属性:liveStreamingDetails.actualStartTime
- 广播的实际开始时间。(当广播的状态为active
时,该值将出现。)liveStreamingDetails.actualEndTime
- 广播实际结束的时间。(广播结束后,此值将显示。)liveStreamingDetails.scheduledStartTime
- 预定的直播开始时间。liveStreamingDetails.scheduledEndTime
- 预定的直播结束时间。如果属性值为空或属性不存在,则广播将无限期进行下去。liveStreamingDetails.concurrentViewers
- 观看直播的人数。
如需检索此元数据,请在调用
videos.list
、videos.insert
或videos.update
方法时,将liveStreamingDetails
添加到part
参数值中。
请注意,我们于 2013 年 10 月 1 日发布了用于识别直播内容的另外两项功能:
search.list
方法的eventType
参数和搜索结果的snippet.liveBroadcastContent
属性。 -
-
videos.insert
方法现在支持notifySubscribers
参数,该参数用于指明 YouTube 是否应向订阅相应视频频道的用户发送有关新视频的通知。该参数的默认值为True
,表示订阅者将收到有关新上传视频的通知。不过,如果频道所有者上传的视频很多,则可能更倾向于将此值设为False
,以免向频道的订阅者发送有关每个新视频的通知。 -
调用
channels.update
方法时可以修改的属性列表已更新,以包含invideoPromotion.items[].customMessage
和invideoPromotion.items[].websiteUrl
属性。此外,该列表已修改,以识别可修改的brandingSettings
属性。这些brandingSettings
属性已可修改,因此文档变更并不反映对 API 现有功能所做的更改。 -
playlists.insert
、playlists.update
和playlists.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.bannerTvLowImageUrl
、brandingSettings.image.bannerTvMediumImageUrl
和brandingSettings.image.bannerTvHighImageUrl
这三个新属性,用于指定电视应用频道页上显示的横幅图片的网址。 -
搜索结果中的新
snippet.liveBroadcastContent
属性用于指明视频或频道资源是否有直播内容。有效的属性值包括upcoming
、active
和none
。- 对于
video
资源,值为upcoming
表示视频是尚未开始的直播,而值为active
则表示视频正在进行直播。 - 对于
channel
资源,值upcoming
表示频道有一个尚未开始的预定直播,而值acive
表示频道正在进行直播。
- 对于
-
在
watermark
资源中,targetChannelId
属性已从对象更改为字符串。现在,targetChannelId
属性本身会指定该值本身,而不是包含用于指定水印图片所链接频道的 YouTube 频道 ID 的子属性。因此,我们移除了资源的targetChannelId.value
属性。 -
thumbnails.set
方法现在支持onBehalfOfContentOwner
参数,其他一些方法也已支持该参数。 -
search.list
方法现在支持eventType
参数,该参数将搜索限制为仅返回进行中、即将到来或已完成的广播事件。 -
新的
contentDetails.contentRating.mibacRating
属性用于标识视频从意大利的 Ministero dei Beni e delle Attivitaculturei e del Turismo 获得的分级。 -
该 API 现在支持以下错误:
错误类型 错误详情 说明 badRequest
invalidImage
如果提供的图片内容无效, thumbnails.set
方法会返回此错误。forbidden
videoRatingDisabled
如果正在评分的视频的所有者已停用该视频的评分功能, videos.rate
方法会返回此错误。
2013 年 8 月 27 日
此更新包含以下更改:
-
新的
watermark
资源用于标识在播放指定频道的视频时显示的图片。您还可以指定图片要链接到的目标频道以及时间详情,这些信息将决定水印何时在视频播放期间显示以及显示多长时间。watermarks.set
方法用于上传和设置频道的水印图片。watermarks.unset
方法用于删除频道的水印图片。错误文档介绍了 API 专门针对
watermarks.set
和watermarks.unset
方法支持的错误消息。 -
channel
资源的新statistics.hiddenSubscriberCount
属性包含一个布尔值,用于指明频道的订阅人数是否处于隐藏状态。因此,如果频道的订阅人数是公开显示的,则该属性的值为false
。 -
playlists.list
方法现在支持onBehalfOfContentOwner
和onBehalfOfContentOwnerChannel
参数。其他几种方法已经支持这两个参数。 -
videos.list
方法现在支持regionCode
参数,该参数用于标识应为其检索图表的内容区域。此参数只能与chart
参数结合使用。此参数值是 ISO 3166-1 alpha-2 国家/地区代码。 -
error documentation
描述了以下新的常见请求错误,多个 API 方法都可能会出现此错误:错误类型 错误详情 说明 forbidden
insufficientPermissions
与为请求提供的 OAuth 2.0 令牌关联的范围不足以访问请求的数据。
2013 年 8 月 15 日
此更新包含以下更改:
-
channel
资源的invideoPromotion
对象具有以下新增和更新的属性:-
该 API 现在支持将网站指定为宣传内容。为此,请将
invideoPromotion.items[].id.type
属性值设置为website
,并使用新的invideoPromotion.items[].id.websiteUrl
属性指定网址。此外,还可以使用新的invideoPromotion.items[].customMessage
属性定义要显示的促销活动自定义消息。链接可以指向关联的网站、商家网站或社交网站。如需详细了解如何为您的内容启用链接,请参阅 YouTube 帮助中心针对关联的网站和商家网站的说明。
添加宣传链接,即表示你同意这些链接不会用来将流量重定向到未经授权的网站,并且你确认这些链接符合 YouTube 的 AdWords 政策、YouTube 广告政策、YouTube 社区准则和 YouTube 服务条款。
-
与用于在视频播放期间显示推广内容的时间设置相关的属性已经过调整:
-
invideoPromotion.timing
对象已移至invideoPromotion.items[].timing
。现在,您可以通过此对象自定义invideoPromotion.items[]
列表中每个促销商品的时间数据。 -
新的
invideoPromotion.defaultTiming
对象用于指定促销活动的默认时间设置。这些设置用于指定在您频道的某个视频播放期间宣传商品的展示时间。您可以使用invideoPromotion.items[].timing
对象替换任何给定宣传内容的默认时间。 -
新的
invideoPromotion.items[].timing.durationMs
属性用于指定促销信息的展示时长(以毫秒为单位)。invideoPromotion.defaultTiming
对象还包含durationMs
字段,用于指定所促销商品的默认展示时长。
-
-
invideoPromotion.items[].type
和invideoPromotion.items[].videoId
属性均已移至invideoPromotion.items[].id
对象。
-
-
subscriptions.list
方法现在支持onBehalfOfContentOwner
和onBehalfOfContentOwnerChannel
参数。其他几种方法已支持这两个参数。 -
在
thumbnails.set
请求的 API 响应中,kind
属性值已从youtube#thumbnailListResponse
更改为youtube#thumbnailSetResponse
。 -
添加了以下方法的代码示例:
channels.update
(Java、Python)playlists.insert
(.NET、PHP)subscriptions.insert
(PHP、Python)thumbnails.set
(PHP、Python)videos.insert
(PHP)videos.list
(菲律宾比索)videos.rate
(Python)videos.update
(Java、PHP、Python)
请注意,
playlistItems.insert
方法的 Python 示例也已被移除,因为它演示的功能现在由videos.rate
方法处理。 -
error documentation
描述了以下新的请求上下文错误,任何支持mine
请求参数的 API 方法都可能会出现此错误:错误类型 错误详情 说明 badRequest
invalidMine
在经过身份验证的用户是 YouTube 合作伙伴的请求中,不能使用 mine
参数。您应该移除mine
参数,通过移除onBehalfOfContentOwner
参数验证 YouTube 用户的身份,或者提供onBehalfOfContentOwnerChannel
参数(如果调用的方法可用)作为合作伙伴的频道之一。
2013 年 8 月 8 日
此更新包含以下更改:
-
YouTube Data API 使用入门指南的配额使用部分已更新,以体现视频上传配额费用从大约 16000 个单元到大约 1600 个单元的变动。
2013 年 7 月 30 日
此更新包含以下更改:
-
在
channelBanner
资源中,kind
属性的值已从youtube#channelBannerInsertResponse
更改为youtube#channelBannerResource
。系统会在响应channelBanners.insert
请求时返回此资源。 -
channel
资源的新brandingSettings.channel.profileColor
属性用于指定与频道内容相得益彰的醒目颜色。此属性值是一个井号 (#
),后跟一个包含六个字符的十六进制字符串,例如#2793e6
。 -
现在,该 API 支持指定订阅是针对频道的所有活动,还是仅针对新上传的视频。
subscription
资源的新contentDetails.activityType
属性用于标识订阅者将收到通知的活动类型。有效的属性值为all
和uploads
。 -
videos.list
方法支持新的参数,用于检索 YouTube 上最热门视频的排行榜:chart
参数用于标识您要检索的图表。目前唯一支持的值是mostPopular
。请注意,chart
参数是一个过滤条件参数,这意味着它不能与其他过滤条件参数(id
和myRating
)在同一请求中使用。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.insert
、channels.update
、videos.getRating
和videos.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 方法。该内容管理系统用户无权代表指定的内容所有者执行操作。 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.insert
或playlists.update
方法时设置播放列表标签。 -
onBehalfOfContentOwner
参数之前仅适用于channels.list
和search.list
方法,现在也适用于videos.insert
、videos.update
和videos.delete
方法。请注意,在调用videos.insert
方法时使用此参数时,请求还必须为新的onBehalfOfContentOwnerChannel
参数指定一个值,该值用于标识要将视频添加到的频道。该频道必须与onBehalfOfContentOwner
参数指定的内容所有者相关联。该参数表明请求的授权凭据标识了代表参数值中指定的内容所有者的 YouTube 内容管理系统用户。用户进行身份验证时使用的 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 日
此更新包含以下更改:
-
通过新的
channelBanners.insert
方法,您可以上传横幅图片,随后可使用channel
资源的新brandingSettings.image.bannerExternalUrl
属性将其设置为频道的横幅图片。 -
更新了
channels.update
方法的文档,以列出在调用该方法时可以修改的属性。 -
video
资源文档不再将unspecified
列为suggestions.processingErrors[]
、suggestions.processingHints[]
、suggestions.processingWarnings[]
和suggestions.editorSuggestions[]
属性的有效属性值。 -
videos.list
方法的maxResults
参数现在的默认值为5
。 -
error documentation
现在会列出channelBanners.insert
和subscriptions.list
方法的错误。此外,它还针对channels.update
方法列出了几个新错误。
2013 年 5 月 14 日
此更新包含以下更改:
2013 年 5 月 10 日
此更新包含以下更改:
-
YouTube 不再标识实验性 API 功能和服务。我们现在改为提供受弃用政策约束的 YouTube API 的列表。
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
参数,您可以检索经过身份验证的用户评分为like
或dislike
的视频列表。myRating
参数和id
参数现在都被视为过滤器参数,这意味着 API 请求必须明确指定其中一个参数。(以前,id
参数是此方法的必需参数。)对于尝试检索视频评分信息但未获得相应授权的请求,该方法会返回
forbidden
错误。 -
随着
myRating
参数的引入,videos.list
方法也进行了更新,以支持分页。但请注意,只有使用myRating
参数的请求才支持分页参数。(对于使用id
参数的请求,不支持分页参数和信息。)-
maxResults
参数指定 API 可以在结果集中返回的视频数量上限,pageToken
参数用于标识您要检索的结果集中的特定页面。 -
为响应
videos.list
请求而返回的youtube#videoListResponse
资源现在包含pageInfo
对象,该对象包含结果总数和当前结果集中包含的结果数等详细信息。youtube#videoListResponse
资源还可以包含nextPageToken
和prevPageToken
属性,每个属性都提供一个令牌,可用于检索结果集中的特定页面。
-
-
videos.insert
方法支持以下新参数:autoLevels
- 将此参数值设置为true
,以指示 YouTube 自动优化视频的光线和色彩。stabilize
- 将此参数值设为true
,即可指示 YouTube 通过消除相机移动导致的抖动来调整视频。
-
为以下资源的
snippet
添加了channelTitle
属性:playlistItem
- 此属性用于指定添加播放列表项的频道的名称。playlist
- 该属性用于指定创建播放列表的频道的名称。subscription
- 该属性用于指定订阅频道的名称。
-
为以下方法添加了代码示例:
activities.insert
(Ruby)playlistItems.list
(.NET)search.list
(.NET)subscriptions.insert
(Java、Ruby)videos.insert
(.NET、Ruby)
-
借助
subscriptions.list
方法的新mySubscribers
参数,您可以检索当前经过身份验证的用户的订阅者列表。此参数只能在获得适当授权的请求中使用。注意:此功能旨在替换
channels.list
方法当前支持的mySubscribers
参数。该参数将被弃用。 -
在
video
资源中,属性值unspecified
不再是以下任何属性的可选值: -
包含意外参数的 API 请求现在会返回
badRequest
错误,而报告的错误原因是unexpectedParameter
。 -
当播放列表包含的允许项数已达到上限时,
playlistItems.insert
方法返回的错误。该错误现在报告为forbidden
错误,错误原因为playlistContainsMaximumNumberOfVideos
。
2013 年 4 月 19 日
此更新包含以下更改:
-
借助新的
videos.rate
方法,用户可以为视频设置like
或dislike
分级,或从视频中移除分级。错误文档也已更新,以列出 API 在响应
videos.rate
方法调用时可能返回的错误。 -
缩略图图片在 API 文档中现在标识为单独的资源,而新的
thumbnails.set
方法可让您将自定义视频缩略图上传到 YouTube,并为视频设置。错误文档也已更新,以列出 API 在响应
thumbnails.set
方法调用时可能返回的错误。请注意,此更改并不会真正影响返回缩略图的现有资源。缩略图图片会以与之前相同的方式在这些资源中返回,不过文档现在列出了该 API 可能会返回的不同缩略图大小的名称。
-
channel
资源的新brandingSettings
部分用于标识频道的频道页和视频观看页面的设置、文本和图片。 -
playlistItem
资源包含以下新属性:-
新的
status
对象用于封装播放列表项的状态信息,而status.privacyStatus
属性用于标识播放列表项的隐私状态。
-
-
video
资源包含以下新属性:-
status.publicStatsViewable
属性用于指明观看页面上的扩展视频统计信息是否可公开查看。默认情况下,这些统计信息都是可见的,并且即使此属性的值设为false
,视频的观看次数和评分等统计信息仍会公开显示。您可以在调用videos.insert
或videos.update
方法时设置此属性的值。 -
contentDetails.contentRating
对象封装了视频根据各种分级方案获得的分级。以下列表列出了支持的分级制度,并提供了各个分级制度对应房源的链接。该属性定义标识了每个系统支持的评分值。国家/地区 分级制度 属性 美国 美国电影协会 (MPAA) contentDetails.contentRating.mpaaRating
美国 美国电视分级制度 contentDetails.contentRating.tvpgRating
澳大利亚 澳大利亚分类委员会 (ACB) contentDetails.contentRating.acbRating
巴西 Leaveamento de Justiça, Classificação, Qualificação e Títulos contentDetails.contentRating.djctqRating
加拿大 加拿大家庭视频分级系统 (CHVRS) contentDetails.contentRating.chvrsRating
法国 法国文化部 contentDetails.contentRating.fmocRating
德国 Freiwillige Selbstkontrolle der Filmwirtschaft (FSK) contentDetails.contentRating.fskRating
英国 英国电影分级委员会 (BBFC) contentDetails.contentRating.bbfcRating
印度 印度中央电影分级委员会 (CBFC) contentDetails.contentRating.cbfcRating
日本 映映管理委员会 (EIRIN) contentDetails.contentRating.eirinRating
韩国 您的账号 contentDetails.contentRating.kmrbRating
墨西哥 广播、电视和电影总局 (RTC) contentDetails.contentRating.rtcRating
新西兰 英国电影与文学分级局 contentDetails.contentRating.oflcRating
俄罗斯 俄罗斯联邦国家电影注册机构 contentDetails.contentRating.russiaRating
西班牙 艺术视听学院 (ICAA) contentDetails.contentRating.icaaRating
-
-
playlistItems.update
方法的文档已更新,以反映必须在作为请求正文发送的资源中指定snippet.resourceId
属性。 -
search.list
方法现在支持以下功能:-
新的
forMine
参数将搜索限制为仅检索经过身份验证的用户的视频。 -
order
参数现在支持按标题的字母顺序 (order=title
) 或视频数量的降序排序 (order=videoCount
) 对结果进行排序。 -
新的
safeSearch
参数用于指明搜索结果是否应包含受限内容。
-
-
videos.insert
方法支持下表列出的几个新错误:错误类型 错误详情 说明 badRequest
invalidCategoryId
snippet.categoryId
属性指定了无效的类别 ID。使用videoCategories.list
方法检索支持的类别。badRequest
invalidRecordingDetails
metadata specifies invalid recording details.
badRequest
invalidVideoGameRating
请求元数据指定的视频游戏分级无效。 badRequest
invalidVideoMetadata
请求元数据无效。 -
onBehalfOfContentOwner
参数已从videos.update
和videos.delete
方法支持的参数列表中移除。
2013 年 3 月 12 日
此更新包含以下更改:
-
以下资源的
snippet
中添加了channelTitle
属性: -
search.list
方法支持以下新参数:-
channelType
参数可让您将搜索频道限制为检索所有频道或仅检索节目。 -
videoType
参数可让您将搜索限制为检索所有视频,或仅检索电影或节目剧集。
-
-
video
资源recordingDetails
部分的定义已更新,指出只有在设置了视频的地理位置数据或录制时间后,系统才会为该视频返回该对象。 -
playlistItems.update
方法现在会返回invalidSnippet
错误,如果 API 请求未指定有效的代码段,就会返回此错误。 -
有些 API 方法支持专用于 YouTube 内容合作伙伴的新参数。YouTube 内容合作伙伴包括影视工作室、唱片公司,以及在 YouTube 上提供内容的其他内容创作者。
-
onBehalfOfContentOwner
参数表示请求的授权凭据标识了代表参数值中指定的内容所有者执行操作的 YouTube CMS 用户。用户进行身份验证时使用的 CMS 账号必须与指定的 YouTube 内容所有者相关联。此参数适用于拥有和管理多个不同 YouTube 频道的内容合作伙伴。借助此参数,这些合作伙伴只需进行一次身份验证,即可访问其所有视频和频道数据,而无需为每个频道分别提供身份验证凭据。
channels.list
、search.list
、videos.delete
、videos.list
和videos.update
方法均支持此参数。 -
managedByMe
参数由channels.list
方法支持,用于指示 API 返回onBehalfOfContentOwner
参数指定的内容所有者拥有的所有频道。 -
search.list
方法支持forContentOwner
参数,该参数会指示 API 将搜索结果限制为仅包含onBehalfOfContentOwner
参数指定的内容所有者拥有的资源。
-
2013 年 2 月 25 日
此更新包含以下更改:
-
对于
video
资源,该 API 支持几个新的部分和属性:-
新的
fileDetails
、processingDetails
和suggestions
部分可为视频所有者提供有关其上传视频的信息。此数据对于支持视频上传且包含以下内容的应用非常有用:- 处理状态和进度
- 在处理视频时遇到的错误或其他问题
- 缩略图图片的可用性
- 有关如何提高视频或元数据质量的建议
- 有关上传到 YouTube 的原始文件的详细信息
只有视频拥有者才能检索到所有这些部分。以下列表简要介绍了新部分,而
video
资源文档定义了每个部分包含的所有属性。-
fileDetails
对象包含上传到 YouTube 的视频文件的相关信息,包括文件的分辨率、时长、音频和视频编解码器、串流比特率等。 -
processingProgress
对象包含有关 YouTube 处理已上传视频文件的进度的信息。该对象的属性可识别当前的处理状态,并估算 YouTube 完成处理视频所需的剩余时间。此部分还会指明视频是否有不同类型的数据或内容(例如文件详情或缩略图)。此对象旨在进行轮询,以便视频上传者跟踪 YouTube 处理上传的视频文件的进度。
-
suggestions
对象包含一些建议,可帮助您找出有助于提升所上传视频质量或元数据的优化建议。
-
contentDetails
部分包含四个新属性。这些媒体资源可以通过未经身份验证的请求检索。dimension
- 表示视频提供 2D 还是 3D 格式。definition
- 指示视频是标清还是高清。caption
- 表示视频是否有字幕。licensedContent
- 指示视频是否包含 YouTube 内容合作伙伴提出版权主张的内容。
-
status
部分包含两个新属性。视频所有者可以在插入或更新视频时为这两个属性设置值。这些属性也可通过未经身份验证的请求进行检索。embeddable
- 指示视频是否可以嵌入到其他网站中。license
- 指定视频的许可。有效值为creativeCommon
和youtube
。
-
-
针对
videos.list
、videos.insert
和videos.update
方法更新了part
参数的定义,以列出上述新添加的部分以及无意中省略的recordingDetails
部分。 -
channel
资源的新contentDetails.googlePlusUserId
属性用于指定与频道关联的 Google+ 个人资料 ID。此值可用于生成指向 Google+ 个人资料的链接。 -
现在,每个缩略图对象都会指定图片的宽度和高度。目前,缩略图图片会在
activity
、channel
、playlist
、playlistItem
、search result
、subscription
和video
资源中返回。 -
playlistItems.list
现在支持videoId
参数,该参数可与playlistId
参数结合使用,以便仅检索代表指定视频的播放列表项。如果在播放列表中找不到该参数所标识的视频,则 API 会返回
notFound
错误。 -
移除了
channel
资源的snippet.channelId
属性。资源的id
属性提供相同的值。
2013 年 1 月 30 日
此更新包含以下更改:
-
新的错误页面列出了 API 可以返回的错误。该页面包含可能出现在多个不同 API 方法中的常规错误,以及特定于方法的错误。
2013 年 1 月 16 日
此更新包含以下更改:
-
下方列表中所示方法和语言的代码示例现已可用:
activities.insert
- JavaplaylistItems.insert
- PythonplaylistItems.list
- Java、JavaScript、PHP、Python、Rubyplaylists.insert
- Java、JavaScript、Pythonsearch.list
- Java、JavaScript、Python、Rubyvideos.insert
- Java
-
现在,当 YouTube 将视频添加到自动生成的 YouTube 频道时,
activity
资源可以报告channelItem
操作。(YouTube 会通过算法识别 YouTube 网站上流量较高的主题,并自动为这些主题生成频道。) -
更新了以下
search.list
参数:q
参数不再被指定为过滤器,这意味着 ....relatedToVideo
参数已重命名为relatedToVideoId
。published
形参已替换为publishedAfter
和publishedBefore
这两个新形参,如下所述。
-
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.type
为channelItem
时,此属性才会存在。activity
contentDetails.channelItem.resourceId
object
用于标识添加到渠道的资源的对象。与其他 resourceId
属性一样,它包含一个kind
属性,用于指定资源类型,例如视频或播放列表。它还仅包含以下属性之一:videoId
、playlistId
等,用于指定该资源的唯一标识 ID。channel
status
object
此对象封装了有关频道隐私权状态的信息。 channel
status.privacyStatus
string
频道的隐私状态。有效值为 private
和public
。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 方法检索有效值的列表。