本页面列出了 YouTube Reporting API 和 YouTube Analytics API 的 API 变更和文档更新。这两个 API 都支持开发者访问 YouTube 数据分析数据,但访问方式有所不同。订阅此更新日志。
2024 年 11 月 15 日
注意:以下变更将于 2024 年 11 月 18 日生效。
YouTube Analytics (Targeted Queries) API 文档已更新,其中指出,对于流量来源报告,如果查询的视频数量 X 日期范围内的天数的乘积超过 5 万,API 的 reports.query
方法现在会返回错误。例如,用于检索 500 个视频 ID 的数据的查询最多可以请求 100 天内的数据。
如需减少请求返回的行数,请将查询拆分为多个查询,指定更少的视频或设置更短的日期范围。一般来说,建议对大型数据集使用批量报告。
2024 年 5 月 6 日
YouTube 数据分析(定位查询)API 支持针对频道生成以下三个新报告:
-
按 DMA 划分的用户活动报告是一种地理位置报告,按特定媒体市场区域 (DMA) 提供用户活动统计信息。对于此报告,您必须将
filters
参数值设置为country==US
。 -
会员取消订阅报告会提供统计信息,显示用户取消频道会员资格的原因。
此报告使用新的
membershipsCancellationSurveyReason
维度,用于指定用户取消频道会员资格的原因。它还会使用新的membershipsCancellationSurveyResponses
指标,该指标表示因该原因而取消的频道会员数量。
此外,观众黏度报告已得到增强,支持以下三个新指标:
2024 年 4 月 7 日
YouTube Analytics(定位查询)API 进行了一些与内容所有者播放列表报告相关的更新。这些更新与我们于 2024 年 1 月 19 日宣布的与频道播放列表报告相关的更新相同。
以下修订历史记录条目提供的信息与 2024 年 1 月 19 日的条目几乎相同。不过,请注意,内容所有者播放列表报告将在 2024 年 12 月 31 日之前支持 isCurated
维度,而频道播放列表报告将在 2024 年 6 月 30 日之前支持该维度。
-
注意:这是一条废弃公告。
isCurated
维度已弃用,不再适用于内容所有者播放列表报告。2024 年 12 月 31 日当天或之后,我们将不再支持此插件。该维度的定义已相应更新。如需在移除
isCurated
维度时保留向后兼容性,您还必须更新代码,以便仅针对播放列表报告检索playlistViews
指标,而不是views
指标。由于播放列表报告仍支持views
指标(但含义有所不同),因此即使您不更新指标名称,该 API 仍会返回数据。当然,您可以修改应用以检索和显示views
和playlistViews
。除了
isCurated
维度之外,新报告不再支持以下 API 功能:- 新版频道播放列表报告不支持地理位置过滤条件(例如
continent
和subcontinent
)。 - 新版频道播放列表报告不再支持
redViews
和estimatedRedMinutesWatched
指标。这些指标之前在 YouTube 工作室中不可用,因此此项更改使 API 功能与工作室应用中提供的功能保持一致。 - 频道播放列表报告不再支持将
subscribedStatus
和youtubeProduct
维度用作过滤条件。这些过滤条件尚未在 YouTube 工作室中提供,因此此项更改使 API 功能与工作室应用中提供的功能保持一致。
- 新版频道播放列表报告不支持地理位置过滤条件(例如
-
内容所有者报告文档的播放列表报告部分已更新,以更详细地说明播放列表报告支持的指标类型:
-
内容所有者可以通过播放列表报告查看以下新的播放列表内指标。请注意,只有在用于检索报告的 API 请求不使用
isCurated
维度时,这些指标才受支持。如需了解每项指标的定义,请参阅指标文档: -
views
指标的行为现在取决于检索播放列表报告的 API 请求是否使用了isCurated
维度:- 如果请求包含
isCurated
维度,views
指标就是播放列表内指标,表示视频在内容所有者的播放列表中获得的观看次数。 - 如果请求不包含
isCurated
维度,views
指标是一种汇总视频指标,用于指定内容所有者播放列表中的视频的总观看次数,无论这些观看是在播放列表情境中进行的与否。汇总总数仅包括与拥有播放列表的频道相关联的内容所有者拥有的视频的观看次数。
在这些不使用isCurated
维度的报告中,playlistViews
指标表示视频在播放列表情境中的观看次数。该指标会统计播放列表中所有视频的观看次数,无论这些视频归哪个频道所有。
- 如果请求包含
-
对于每个播放列表报告,内容所有者报告文档现在都包含表格,其中会显示该报告支持的指标,具体取决于 API 请求是否包含
isCurated
维度。如需查看示例,请参阅定义基于时间的播放列表报告的部分。
2024 年 1 月 19 日
YouTube 数据分析(有针对性的查询)API 进行了与频道播放列表报告相关的多项更新。更新包括已废弃的维度和多个新指标和更新指标:
-
注意:这是一条废弃公告。
isCurated
维度已在频道报告中废弃。2024 年 6 月 30 日当天或之后,此版本将不再受支持。该维度的定义已相应更新。如需在移除
isCurated
维度时保留向后兼容性,您还必须更新代码,以便仅针对播放列表报告检索playlistViews
指标,而不是views
指标。由于播放列表报告仍支持views
指标(但含义有所不同),因此即使您不更新指标名称,该 API 仍会返回数据。当然,您可以修改应用以检索和显示views
和playlistViews
。除了
isCurated
维度之外,新报告不再支持以下 API 功能:- 新版频道播放列表报告不支持地理位置过滤条件(例如
continent
和subcontinent
)。 - 新版频道播放列表报告不再支持
redViews
和estimatedRedMinutesWatched
指标。这些指标之前在 YouTube 工作室中不可用,因此此项更改使 API 功能与工作室应用中提供的功能保持一致。 - 频道播放列表报告不再支持将
subscribedStatus
和youtubeProduct
维度用作过滤条件。这些过滤条件尚未在 YouTube 工作室中提供,因此此项更改使 API 功能与工作室应用中提供的功能保持一致。
- 新版频道播放列表报告不支持地理位置过滤条件(例如
-
频道报告文档的播放列表报告部分已更新,以更详细地说明播放列表报告支持的指标类型:
-
频道的播放列表报告支持以下新的播放列表内指标。 内容所有者报告尚不支持这些指标。请注意,只有在用于检索报告的 API 请求不使用
isCurated
维度时,这些指标才受支持。如需了解每项指标的定义,请参阅指标文档: -
views
指标的行为现在取决于检索播放列表报告的 API 请求是否使用了isCurated
维度:- 如果请求包含
isCurated
维度,views
指标就是播放列表内指标,表示视频在频道播放列表中的观看次数。 - 如果请求不包含
isCurated
维度,views
指标是一个汇总视频指标,用于指定频道播放列表中的视频的总观看次数,无论这些观看是在播放列表情境中进行的与否。汇总总数仅包括播放列表所属频道拥有的视频的观看次数。
在这些不使用isCurated
维度的报告中,playlistViews
指标表示视频在播放列表情境中的观看次数。该指标会统计播放列表中所有视频的观看次数,无论这些视频归哪个频道所有。
- 如果请求包含
-
对于每个播放列表报告,频道报告文档现在包含表格,其中会显示该报告支持的指标,具体取决于 API 请求是否包含
isCurated
维度。如需查看示例,请参阅定义基于时间的播放列表报告的部分。
2023 年 12 月 4 日
YouTube Analytics(定位查询)API 已更新,可合并两个 insightTrafficSourceType
维度值。以前,此维度会区分作为播放列表一部分播放的视频 (PLAYLIST
) 和来自列出播放列表中所有视频的页面的观看(YT_PLAYLIST_PAGE
)。今后,这两种类型的观看将与 PLAYLIST
维度值相关联。
2022 年 12 月 15 日
YouTube 数据分析(定位查询)API 支持两个新维度和一个新报告:
-
新增了按城市显示用户活动情况的报告。此报告适用于频道和内容所有者。 此报告包含新的
city
维度,用于标识 YouTube 对用户活动发生地所做的估算城市。 -
新的
creatorContentType
维度用于标识与数据行中的用户活动指标相关联的 YouTube 内容类型。支持的值包括LIVE_STREAM
、SHORTS
、STORY
和VIDEO_ON_DEMAND
。creatorContentType
维度是所有频道和内容所有者视频报告支持的可选维度。 -
YouTube 数据分析 API 请求示例指南现已包含这两个新维度的示例。
-
文档中已移除对
7DayTotals
和30DayTotals
维度的引用。我们已于 2019 年 10 月宣布弃用这些维度。
2022 年 8 月 26 日
YouTube Analytics(定位查询)API 和 YouTube Reporting(批量报告)API 都支持新的流量来源详细信息值:
- 在 YouTube Analytics API(定位查询)API 中,如果
insightTrafficSourceType
维度的值为SUBSCRIBER
,则可以将insightTrafficSourceDetail
值设置为podcasts
,这表示流量是从播客目标页面引荐的。 - 在 YouTube Reporting(批量报告)API 中,如果
traffic_source_type
维度的值为3
,则traffic_source_detail
值可以设置为podcasts
,这表示流量是从播客目标页面引荐的。
2022 年 2 月 11 日
gender
维度的一组有效值将于 2022 年 8 月 11 日当天或之后发生变化。这可能导致您的 API 实现变得不向后兼容。根据 YouTube API 服务条款的向后不兼容性更改部分,我们会在变更生效前 6 个月通知您。请在 2022 年 8 月 11 日之前更新您的 API 实现,以确保顺利过渡到新一组值。
具体更改如下:
- 在 YouTube Analytics(定位查询)API 中,
gender
维度目前支持两个值:female
和male
。自 2022 年 8 月 11 日起,该维度将支持三个值:female
、male
和user_specified
。 - 在 YouTube Reporting (Bulk Reports) API 中,
gender
维度目前支持三个值:FEMALE
、MALE
和GENDER_OTHER
。 2022 年 8 月 11 日当天或之后,支持的一组值将更改为FEMALE
、MALE
和USER_SPECIFIED
。
2022 年 2 月 9 日
自 2021 年 12 月 13 日起,我们更新了两个指标,以排除循环播放的剪辑带来的流量。这项变更会影响 YouTube Analytics(定位查询)API 和 YouTube Reporting(批量报告)API。
- 自 2021 年 12 月 13 日起,YouTube 数据分析(定位查询)API 中的
averageViewDuration
和averageViewPercentage
指标均会排除循环播放的剪辑带来的流量。 - 自 2021 年 12 月 13 日起,YouTube Reporting (Bulk Reports) API 中的
average_view_duration_seconds
和average_view_duration_percentage
指标均会排除循环播放的剪辑带来的流量。
2022 年 2 月 2 日
此 YouTube 报告(批量报告)API 支持新的流量来源维度值,用于指示观看次数来自实时重定向:
- 在 YouTube Reporting(批量报告)API 中,
traffic_source_type
维度支持值28
。
对于此类流量来源,traffic_source_detail
维度用于指定引荐观看者的渠道 ID。
2020 年 9 月 23 日
此 YouTube Analytics(定位查询)API 和 YouTube Reporting(批量报告)API 都支持一个新的流量来源维度值,用于指示观看者是通过在 YouTube Shorts 观看体验中垂直滑动而被引荐的:
- 在 YouTube Analytics API(有针对性的查询)API 中,
insightTrafficSourceType
维度支持值SHORTS
。 - 在 YouTube Reporting(批量报告)API 中,
traffic_source_type
维度支持值24
。
系统不会为这种新流量来源类型填充流量来源详细维度(YouTube Analytics API 中的 insightTrafficSourceDetail
或 YouTube Reporting API 中的 traffic_source_detail
)。
2020 年 7 月 20 日
此更新涵盖了影响 YouTube Analytics(定位查询)API 的两项变更:
- YouTube 数据分析报告组的大小上限从 200 个实体增加到了 500 个实体。
reports.query
方法的filters
参数用于标识在检索 YouTube Analytics 数据时应应用的过滤条件列表。该参数支持为video
、playlist
和channel
过滤条件指定多个值,并且可为这些过滤条件指定的 ID 数量上限已从 200 个 ID 增加到 500 个 ID。
2020 年 2 月 13 日
此更新包含与 YouTube Analytics(定位查询)API 和 YouTube Reporting(批量报告)API 相关的以下变更。您可以访问 YouTube 帮助中心,详细了解这些变更。
在这两个 API 中,通知的一组可能的流量来源详细信息值将发生变化。
在定位查询中,系统会将通知报告为 insightTrafficSourceType=NOTIFICATION
。在批量报告中,通知会报告为 traffic_source_type=17
。
新值将与上传的视频和直播(以前报告为 uploaded
)相关的通知拆分为两类:
uploaded_push
- 在视频上传时向订阅者发送的推送通知带来的观看次数uploaded_other
- 由非推送通知(例如在上传视频时向订阅者发送的电子邮件或收件箱通知)带来的观看次数。
系统会针对 2020-01-13(2020 年 1 月 13 日)开始的时间范围返回这些值。
另请注意,这些值并非代表通知本身,而是促成特定 YouTube 观看的流量来源。例如,如果某个报告行显示 views=3
、traffic_source_type=17
(NOTIFICATION
) 和 traffic_source_detail=uploaded_push
,则表示有 3 次观看是由于观看者点击了在视频上传时发送的推送通知。
2019 年 10 月 15 日
此更新包含与 YouTube Analytics(有针对性的查询)API 相关的以下变更:
-
注意:这是一条废弃公告。
YouTube 即将停止支持“
7DayTotals
”和“30DayTotals
”维度。在 2020 年 4 月 15 日之前,您仍然可以使用这些维度检索数据。在该日期当天或之后,如果尝试使用7DayTotals
或30DayTotals
维度检索报告,系统会返回错误。请注意,用户可以使用
day
维度进行查询,并汇总或派生 7 天或 30 天内的相关数据,以重现这些维度的一些数据。例如:- 7 天内的观看次数可以通过汇总该时间段内每天的观看次数来计算。
- 7 天内的观看者百分比的计算方法为:将每天的观看次数乘以当天的观看者百分比,即可得出当天观看视频时处于登录状态的观看者人数。然后,您可以将整个时间段内的已登录观看者数量相加,然后除以该时间段内的总观看次数,以便得出整个时间段内的观看者百分比。
- 系统无法计算 7 天内的唯一身份观看者人数,因为同一观看者在不同天可能会被计算为唯一身份观看者。不过,您或许可以使用
month
维度(而非30DayTotals
维度)推断 30 天内唯一身份观看者数的数据。请注意,month
维度是指日历月,而30DayTotals
维度是根据指定的开始日期和结束日期计算 30 天的时间段。
2019 年 6 月 27 日
此更新包含与 YouTube Analytics(有针对性的查询)API 相关的以下变更:
-
由于该 API 的版本 1 现已完全弃用,因此文档已更新,移除了对该版本的引用,包括废弃通知和介绍如何更新到版本 2 的迁移指南。
2018 年 11 月 1 日
此更新包含与 YouTube Analytics(有针对性的查询)API 相关的以下变更:
-
该 API 的版本 1 现已废弃。如果您尚未更新 API 客户端,请尽快更新以使用 API 版本 2,以最大限度地减少服务中断。如需了解详情,请参阅迁移指南。
请注意,我们最初于 2018 年 4 月 26 日宣布了此弃用计划。
2017 年 9 月 17 日
此更新包含与 YouTube Analytics(有针对性的查询)API 相关的以下变更:
-
数据模型概览文档中新增的数据匿名化部分说明,如果指标未达到特定阈值,YouTube 数据分析中的一些数据会受到限制。这种情况可能在各种情况下发生。在实践中,这意味着如果出现以下情况,报告可能不会包含您的所有(或任何)数据:
-
视频或频道在指定时间段内流量有限
或
-
您选择的过滤条件或维度(例如流量来源或国家/地区)的值未达到特定阈值。
新版中还将讨论 YouTube 数据分析报告中可能会受到限制的数据类型。
-
-
频道报告和内容所有者报告文档已更新,以反映播放位置、流量来源和设备类型/操作系统报告不再支持
redViews
和estimatedRedMinutesWatched
指标。
2018 年 6 月 18 日
此更新对 YouTube Analytics(有针对性的查询)API 进行了以下更改:
- 以下方法的范围要求已发生变化:
- 对
reports.query
方法的请求必须有权访问https://www.googleapis.com/auth/youtube.readonly
范围。 - 对
groupItems.list
方法的请求必须有权访问以下任一内容:https://www.googleapis.com/auth/youtube
作用域
或https://www.googleapis.com/auth/youtube.readonly
范围
和
https://www.googleapis.com/auth/yt-analytics.readonly
范围
第一种方法使用一个范围(恰好是读写范围),而第二种方法使用两个只读范围。
- 对
2018 年 5 月 23 日
此更新对 YouTube Analytics(有针对性的查询)API 进行了以下更改:
- “API 概览”中新增了一个部分,即汇总指标和已删除内容,其中介绍了 API 响应如何处理与已删除资源(例如视频、播放列表或频道)关联的数据。
- 我们更新了 API 概览的最佳实践部分,以提醒您可以使用 YouTube Data API 检索 YouTube Analytics API 响应中标识的资源的其他元数据。如 YouTube API 服务开发者政策(III.E.4.b 至 III.E.4.d 部分)中所述,API 客户端必须在 30 天后从该 API 中删除或刷新存储的资源元数据。
2018 年 5 月 22 日
此更新包含与 YouTube Reporting(批量报告)API 相关的以下变更:
- 以下变更目前定于 2018 年 7 月生效,新政策将在全球范围内应用于所有报告和报告作业。
-
变更生效后,大多数 API 报告(包括回填报告)将在生成之日后保留 60 天。不过,包含历史数据的报告自生成之日起 30 天内可用。
在此公告发布之前,所有 API 报告自生成之日起 180 天内可用。需要明确的是,当此政策变更生效后,您将无法再通过 API 访问超过 30 天的历史数据报告。所有其他超过 60 天报告也将无法再访问。因此,文档现在指出,在政策更改之前创建的报告最长可保留 180 天。
-
变更生效后,当您安排定期生成报告作业时,YouTube 将从当天开始生成报告,并涵盖安排作业前 30 天的日期范围。在变更之前,当您安排定期生成报告作业时,YouTube 会生成涵盖安排作业时间之前 180 天内的报告。
-
-
更新了最佳实践部分,以提醒您可以使用 YouTube Data API 检索报告中标识的资源的其他元数据。如 YouTube API 服务开发者政策(III.E.4.b 至 III.E.4.d 部分)中所述,API 客户端必须在 30 天后从该 API 中删除或刷新存储的资源元数据。
-
报告特性部分已更新,其中指出,即使报告数据未经过过滤,包含 2018 年 6 月 1 日或之后时间段内数据的报告也不会提及在报告生成日期前至少 30 天被删除的 YouTube 资源。
-
API 概览的历史数据部分已更新,其中指出,当您安排新的报告作业时,历史报告通常会在几天内发布。之前,文档中指出此类报告最长可能需要 30 天才能生成。
-
更新了 API 概览的回填数据部分,以更明确地将回填数据定义为替换之前提交的数据集的数据集。
2018 年 4 月 26 日
YouTube Analytics(定位到查询)API 版本 2 (v2) 现已公开发布。下表列出了与新版 API 相关的产品和文档变更:
-
v2 API 与 v1 API 几乎完全相同。不过,您可能需要更新代码,以反映下列更改。新版迁移指南详细介绍了所有这些变更。
- API 的版本已从
v1
更改为v2
。 - API 请求的基础网址已从
https://www.googleapis.com/youtube/analytics/v1
更改为https://youtubeanalytics.googleapis.com/v2
。 reports.query
方法的多个参数已更新名称。具体而言,如果参数名称包含连字符(例如 v1 API 中的end-date
),则在 v2 API 中应使用驼峰式命名法 (endDate
),而不是连字符。由于该 API 用于创建和管理组的方法已将参数名称采用驼峰式命名法,因此此更改可确保整个 API 中的参数名称保持一致。- v2 API 不支持发送到 Google 的全球 HTTP 批量端点 (
www.googleapis.com/batch
) 的批量请求。如果您要在 v2 API 中发送批量请求,则需要改用端点https://youtubeanalytics.googleapis.com/v2
。
此外,v2 API 不支持部分 v1 功能:
reports.query
方法不再支持alt
、quotaUser
和userIp
请求参数。- v2 API 不提供支持由对不同 API 的请求组成的批次的批量端点。(不过,批处理可以包含对同一 API 的不同方法的请求。)此弃用不局限于 YouTube 数据分析 API,因为 Google 将弃用其所有 API 中的全局批量处理端点。
- v2 API 不支持 API v1 中支持的 JSON-RPC 协议。再次说明,此弃用并非仅限于 YouTube Analytics API。
- API 的版本已从
-
注意:这是一条废弃公告。
该 API 的版本 1 (v1) 现已废弃,将在 2018 年 10 月 31 日之前受支持。在此日期之后,所有针对 v1 API 的请求都将停止运行。因此,请务必在 2018 年 10 月 31 日之前升级到 v2 API,以免无法通过 API 访问 YouTube Analytics 数据。
2018 年 2 月 21 日
此更新对 YouTube Analytics(有针对性的查询)API 进行了以下更改:
- 观看者受众特征报告会根据观看者的年龄段和性别汇总观看统计信息,但不再支持
youtubeProduct
维度,该维度用于标识用户活动发生的 YouTube 服务。
2018 年 1 月 18 日
此更新包含以下更改:
-
YouTube Reporting API(批量报告)
operating_system
维度(用于标识发生了观看的设备的软件系统)现在支持以下值:25
:KaiOS
-
YouTube Analytics API(定位查询)
operatingSystem
维度支持维度值KAIOS
。
2017 年 12 月 20 日
此更新包含与 YouTube Reporting API 相关的两项变更:
-
API 服务器现在支持对下载报告的请求进行 gzip 压缩。请注意,其他类型的 API 请求不支持 gzip 压缩。启用 gzip 压缩可减少每个 API 响应所需的带宽。虽然您的应用需要额外的 CPU 时间来解压缩 API 响应,但节省网络资源的好处通常会超过这一成本。
如需接收 gzip 编码的响应,请将
Accept-Encoding
HTTP 请求标头设置为gzip
,如以下示例所示:Accept-Encoding: gzip
API 概览和
report
资源的downloadUrl
属性定义中介绍了此功能。 -
age group
和gender
维度的文档已更正,以显示 API 为这些维度返回的实际值。请注意,这是文档更正,并不反映 API 功能或行为的变化。具体而言,以下值已发生变化:age_group
维度的值使用大写字母,在“AGE
”字样与年龄段数字之间包含下划线,并使用下划线(而非连字符)。因此,age13-17
和age18-24
等值已分别更正为AGE_13_17
和AGE_18_24
。gender
维度的值使用大写字母。因此,值female
、male
和gender_other
已更正为FEMALE
、MALE
和GENDER_OTHER
。
2017 年 8 月 10 日
2016 年 8 月 10 日,本文档宣布废弃 YouTube Analytics API 的 earnings
指标。(同时,该 API 添加了对名为 estimatedRevenue
的新指标的支持,该指标提供相同的数据。)
由于 earnings
指标是一项核心指标,因此在该公告发布之日起一年内,我们会继续支持该指标。不过,一年的期限已结束,earnings
指标已不再受支持。因此,指定 earnings
指标的 API 请求现在会返回 400
HTTP 响应代码。如果您尚未更新应用以使用 estimatedRevenue
指标(而非 earnings
指标),请尽快进行更新。
更新了 API 文档,移除了对 earnings
指标的剩余引用。
2017 年 7 月 6 日
此更新包含以下更改:
-
YouTube Analytics API(定位查询)
-
API 文档已更新,以反映以下事实:API 响应包含请求日期范围内所有可查询指标的最后一天的数据。
例如,如果请求指定的结束日期为 2017 年 7 月 5 日,并且请求的所有指标的值仅可供查看 2017 年 7 月 3 日的数据,则 2017 年 7 月 3 日将是响应中包含数据的最后一天。(即使所请求的部分指标的数据在 2017 年 7 月 4 日有数据,也是如此。)
-
adType
维度现在支持值reservedBumperInstream
,表示用户必须看完最长为 6 秒的不可跳过视频广告才能观看视频。广告格式与auctionBumperInstream
广告相同,但此类型是指以预订方式(而非竞价)出售的广告。
-
-
YouTube Reporting API(批量报告)
-
ad_type
维度现在支持值20
,该值表示按预订方式销售的超前贴片广告。导视广告是不可跳过的视频广告,最长 6 秒,用户必须看完广告才能观看视频。请注意,此维度的值19
也适用于通过竞价(而非预订)方式销售的超前贴片广告。 -
以下 YouTube Reporting API 报告的报告作业已被删除:
channel_basic_a1
channel_province_a1
channel_playback_location_a1
channel_traffic_source_a1
channel_device_os_a1
channel_subtitles_a1
channel_combined_a1
content_owner_basic_a2
content_owner_province_a1
content_owner_playback_location_a1
content_owner_traffic_source_a1
content_owner_device_os_a1
content_owner_subtitles_a1
content_owner_combined_a1
content_owner_asset_basic_a1
content_owner_asset_province_a1
content_owner_asset_playback_location_a1
content_owner_asset_traffic_source_a1
content_owner_asset_device_os_a1
content_owner_asset_combined_a1
我们已于 2016 年 9 月 15 日宣布弃用这些报告类型,并且在 2016 年 12 月 15 日之后,系统不再为这些报告类型生成报告。之前生成的报告自生成之日起仍可供使用 180 天。因此,您最晚可查看 2017 年 6 月 15 日的部分报告。不过,由于这些报告已不再可用,因此与这些报告关联的作业也无需再运行。
-
2017 年 5 月 24 日
以下 YouTube Reporting API 报告的所有报告作业均已删除:
content_owner_ad_performance_a1
content_owner_asset_estimated_earnings_a1
content_owner_estimated_earnings_a1
我们已于 2016 年 6 月 22 日宣布弃用这些报告类型,并且自 2016 年 9 月 22 日起,系统不再为这些报告类型生成报告。之前生成的报告自生成之日起仍可供使用 180 天。因此,您最晚可查看 2017 年 3 月 22 日的部分报告。不过,由于这些报告已不再可用,因此与这些报告关联的作业也无需再运行。
2017 年 5 月 22 日
此更新包含以下更改:
-
YouTube Reporting API(批量报告)
- 用于标识用于分享视频的服务的
sharing_service
维度现在支持以下值:85
:YouTube Music86
:YouTube Gaming87
:YouTube Kids88
:YouTube TV
此外,文档中用于标识值
52
的名称已更新为 Kakao (Kakao Talk),以便更清晰地将其与值73
(Kakao Story) 区分开来。此变更不会反映 API 行为或与这些服务分享的视频分类的任何变化。
- 用于标识用于分享视频的服务的
-
YouTube Analytics API(定位查询)
sharingService
维度现在支持以下值:YOUTUBE_GAMING
YOUTUBE_KIDS
YOUTUBE_MUSIC
YOUTUBE_TV
2017 年 3 月 28 日
能够通过创作者工作室中的 YouTube 数据分析访问收入数据的频道所有者现在还可以通过 YouTube Analytics API 访问这些收入数据:
-
该 API 支持以下与收入相关的指标:
adImpressions
cpm
estimatedAdRevenue
estimatedRedPartnerRevenue
estimatedRevenue
grossRevenue
monetizedPlaybacks
playbackBasedCpm
以下报告支持这些指标:
2017 年 3 月 17 日
此更新包含以下更改:
-
YouTube Analytics API 支持
redViews
和estimatedRedMinutesWatched
指标,这两个指标都与 YouTube Red 观看人数相关。事实上,该 API 实际上已经支持这些指标一段时间了,而且 YouTube Reporting API 已于 2016 年 9 月 15 日宣布支持这两项指标。redViews
指标用于确定 YouTube Red 会员观看某个视频的次数。estimatedRedMinutesWatched
指标用于标识 YouTube Red 会员观看视频的时长(分钟)。
频道报告和内容所有者报告文档已更新,其中会显示哪些报告支持这两个新指标。已支持“
views
”和“estimatedMinutesWatched
”指标的所有报告都支持这些维度。
2017 年 3 月 3 日
此更新包含以下更改:
-
YouTube Reporting API(批量报告)
-
date
维度的定义已更正,以指明该维度值是指从指定日、月、年的凌晨 12:00(太平洋时间)开始,到当天晚上 11:59(太平洋时间)结束的时间段。太平洋时间为 UTC-7 或 UTC-8,具体取决于季节。虽然日期通常表示 24 小时的时间段,但当时钟向前调整时,日期表示 23 小时的时间段;当时钟向后调整时,日期表示 25 小时的时间段。(之前,该文档中指出,每个日期代表一个独特的 24 小时时段,太平洋时间始终为 UTC-8。)
请注意,此更正并不代表实际 API 行为发生了变化。
operating_system
维度用于标识发生了观看的设备的软件系统,现在支持以下值:22
:Tizen23
:Firefox24
:RealMedia
-
content_owner_basic_a1
报告类型的所有报告作业均已删除。自 2016 年 8 月 19 日起,此报告类型已被完全弃用,但之前生成的content_owner_basic_a1
报告自生成之日起仍可供使用 180 天。因此,部分报告最晚可在 2017 年 2 月 19 日访问。不过,由于这些报告已不再可用,因此与这些报告关联的作业也无需再运行。
-
-
YouTube Analytics API(定位查询)
-
我们更正了与
time periods
相关的维度的说明,以指出维度值是指从指定日期、月份和年份的凌晨 12:00(太平洋时间)开始,到当天晚上 11:59(太平洋时间)结束的时间段。太平洋时间为 UTC-7 或 UTC-8,具体取决于季节。虽然日期通常表示 24 小时的时间段,但当时钟向前调整时,日期表示 23 小时的时间段;当时钟向后调整时,日期表示 25 小时的时间段。(之前,该文档中指出太平洋时间为 UTC-8,但并未提及一天可能不代表 24 小时。)
请注意,此更正并不代表实际 API 行为发生了变化。
-
渠道报告文档已更新,其中指出渠道报告目前不包含收入或广告效果指标。因此,
https://www.googleapis.com/auth/yt-analytics-monetary.readonly
范围目前不授予对频道报告中的货币数据的访问权限。 operatingSystem
维度支持三个新的维度值:FIREFOX
REALMEDIA
TIZEN
-
2017 年 2 月 8 日
YouTube Analytics API 现在支持可选的 include-historical-channel-data
参数。请注意,仅在检索内容所有者报告时,此参数才相关。
借助此参数,内容所有者可以指明 API 响应应包含频道与内容所有者关联之前的时间段内的观看时长和观看数据。默认参数值为 false
,这意味着默认情况下,API 响应仅包含频道与内容所有者关联之后的观看时长和观看数据。
如果 API 请求检索多个渠道的数据,这些规则也适用:
- 如果参数值为
false
,则为任何给定频道返回的观看时长和观看次数数据均基于该频道与内容所有者关联的日期。
请务必注意,不同的频道与内容所有者关联的日期可能不同。如果 API 请求要检索多个渠道的数据,并且参数值为false
,则 API 响应将包含根据各个渠道的关联日期计算的观看时长和观看数据。 - 如果参数值为
true
,则响应会根据 API 请求中指定的开始日期和结束日期,返回所有频道的观看时长和观看数据。
2016 年 12 月 15 日
以下 YouTube Reporting API 报告已不再受支持,并已从文档中移除。每种报告都有较新版本可用。(我们于 2016 年 9 月 15 日发布了关于弃用这些报告的公告。)
-
频道报告
channel_basic_a1
- 已被channel_basic_a2
报告取代。channel_province_a1
- 已被channel_province_a2
报告取代。channel_playback_location_a1
- 已被channel_playback_location_a2
报告取代。channel_traffic_source_a1
- 已被channel_traffic_source_a2
报告取代。channel_device_os_a1
- 已被channel_device_os_a2
报告取代。channel_subtitles_a1
- 已被channel_subtitles_a2
报告取代。channel_combined_a1
- 已被channel_combined_a2
报告取代。
-
内容所有者报告
content_owner_basic_a2
- 已被content_owner_basic_a3
报告取代。content_owner_province_a1
- 已被content_owner_province_a2
报告取代。content_owner_playback_location_a1
- 已被content_owner_playback_location_a2
报告取代。content_owner_traffic_source_a1
- 已被content_owner_traffic_source_a2
报告取代。content_owner_device_os_a1
- 已被content_owner_device_os_a2
报告取代。content_owner_subtitles_a1
- 已被content_owner_subtitles_a2
报告取代。content_owner_combined_a1
- 已被content_owner_combined_a2
报告取代。content_owner_asset_basic_a1
- 已被content_owner_asset_basic_a2
报告取代。content_owner_asset_province_a1
- 已被content_owner_asset_province_a2
报告取代。content_owner_asset_playback_location_a1
- 已被content_owner_asset_playback_location_a2
报告取代。content_owner_asset_traffic_source_a1
- 已被content_owner_asset_traffic_source_a2
报告取代。content_owner_asset_device_os_a1
- 已被content_owner_asset_device_os_a2
报告取代。content_owner_asset_combined_a1
- 已被content_owner_asset_combined_a2
报告取代。
API 参考文档中的当前报告类型列表也已更新。
2016 年 11 月 11 日
此更新包含以下更改:
-
片尾画面报告
-
片尾画面尺寸
end_screen_element_type
:与统计信息关联的片尾画面元素的类型。end_screen_element_id
:YouTube 用来唯一标识片尾画面元素的 ID。
片尾画面指标
注意:我们从 2016 年 5 月 1 日开始提供有关片尾画面指标的数据。
end_screen_element_impressions
:片尾动画元素展示次数总和。系统会为每次显示的片尾画面元素记录一次展示。end_screen_element_clicks
:片尾画面元素被点击的次数。end_screen_element_click_rate
:片尾画面元素的点击率。
-
以下报告已不再受支持,并已从文档中移除。每种报告都有较新版本可用。(我们已于 2016 年 6 月 22 日发布了有关这些报告的弃用公告。)
content_owner_ad_performance_a1
- 已被content_owner_ad_rates_a1
报告取代。content_owner_estimated_earnings_a1
- 已被content_owner_estimated_revenue_a1
报告取代。content_owner_asset_estimated_earnings_a1
- 已被content_owner_asset_estimated_revenue_a1
报告取代。
-
以下列表中的指标已完全弃用,不再受支持。正如我们在 2016 年 8 月 10 日所宣布的那样,我们已支持引用相同数据的新指标。下表显示了已废弃的指标名称和新指标名称:
已弃用的指标 新指标 adEarnings
estimatedAdRevenue
impressionBasedCpm
cpm
impressions
adImpressions
redPartnerRevenue
estimatedRedPartnerRevenue
- 每月每部视频在全球范围内带来的广告收入
- 每个国家/地区每个视频的每日广告收入
- 每个资产的每月全球广告收入
- 每项资产在每个国家/地区的每日广告收入
- 版权主张(此报告不包含收入数据)
-
该 API 支持与 YouTube Red 观看人数相关的两个新指标:
red_views
:YouTube Red 会员观看视频的次数。red_watch_time_minutes
:YouTube Red 会员观看视频的时长(分钟)。
-
该 API 支持 20 个报告的新版本。所有新版本都支持新的
red_views
和red_watch_time_minutes
指标。对于每种报告,新报告类型 ID 中的数字比旧报告类型 ID 中的数字多 1 位。(如本修订记录中所述,这些报告的旧版本现已废弃。)例如,
channel_basic_a1
报告现已废弃,并已替换为channel_basic_a2
报告。以下列表列出了新的报告类型 ID:
频道视频报告
内容所有者视频报告
内容所有者资产报告
-
注意:这是一条废弃公告。
请注意,如果您已经有用于创建上述任何旧版报告的作业,则需要为已重命名的报告创建新的作业。随着新报告版本的发布,以下报告版本已废弃:
channel_basic_a1
channel_province_a1
channel_playback_location_a1
channel_traffic_source_a1
channel_device_os_a1
channel_subtitles_a1
channel_combined_a1
content_owner_basic_a2
content_owner_province_a1
content_owner_playback_location_a1
content_owner_traffic_source_a1
content_owner_device_os_a1
content_owner_subtitles_a1
content_owner_combined_a1
content_owner_asset_basic_a1
content_owner_asset_province_a1
content_owner_asset_playback_location_a1
content_owner_asset_traffic_source_a1
content_owner_asset_device_os_a1
content_owner_asset_combined_a1
如果您有任何此类报告的作业,YouTube 在 2016 年 12 月 15 日之后不会再为这些作业生成新报告。生成的报告将在生成之日起 180 天内仍可供访问。
-
content_owner_basic_a1
报告已被完全弃用,并从文档中移除。YouTube 将不再生成此类新报告,但已生成的报告仍会在生成之日起 180 天内可用。content_owner_basic_a1
报告的替代报告是content_owner_basic_a2
报告,如2016 年 5 月 19 日的修订历史记录条目中所述。 -
新发布的 YouTube API 服务《服务条款》(以下简称“新版《服务条款》”)在 YouTube 工程和开发者博客中进行了详细讨论,对当前《服务条款》进行了大量更新。除了更新后的条款(自 2017 年 2 月 10 日起生效)之外,此更新还包含一些辅助文件,旨在帮助说明开发者必须遵循的政策。
更新版条款的修订记录中介绍了完整的新文档。此外,日后对修订版条款或这些证明文件所做的更改也会在修订记录中说明。您可以通过该文档中的链接订阅 RSS Feed,以便查看该修订记录中的更改。
-
YouTube Analytics API(定位查询)
-
注意:这是一条废弃公告。
下表中列出的指标即将弃用。同时,我们还将推出与相同数据相关的新指标。实际上,这意味着旧指标将被重命名,但在表格中列出的弃用日期之前,YouTube 数据分析 API 将支持这两个指标名称。
旧指标名称 新指标名称 支持日期 earnings
estimatedRevenue
2017 年 8 月 10 日 adEarnings
estimatedAdRevenue
2016 年 11 月 4 日 redPartnerRevenue
estimatedRedPartnerRevenue
2016 年 11 月 4 日 impressionBasedCpm
cpm
2016 年 11 月 4 日 impressions
adImpressions
2016 年 11 月 4 日 请注意,
earnings
指标是一项核心指标,因此我们将从本公告发布之日起一年内继续支持该指标。其他非核心指标将在 2016 年 11 月 4 日之前支持三个月。例如,在 2016 年 11 月 4 日之前,API 请求可以指定
impressionBasedCpm
指标、cpm
指标,或同时指定这两个指标。不过,在该日期之后,系统将仅支持cpm
指标。 insightTrafficSourceType
维度支持两个新的维度值:CAMPAIGN_CARD
:此流量来源仅适用于内容所有者报告。这表示观看次数来自已声明版权的用户上传视频,内容所有者使用这些视频来宣传所观看的内容。END_SCREEN
:这些数据与来自其他视频片尾画面的观看次数相关。
对于这两个新流量来源,您还可以检索
traffic source detail
报告。在这两种情况下,insightTrafficSourceDetail
维度都用于标识将观看者引导至目标视频的视频。-
adType
维度现在支持值auctionBumperInstream
,表示用户必须看完最长为 6 秒的不可跳过视频广告才能观看视频。
-
-
YouTube Reporting API(批量报告)
traffic_source_type
维度现在支持以下值:19
:此流量来源仅适用于内容所有者报告。这表示观看次数来自已声明版权的用户上传视频,内容所有者使用这些视频来宣传所观看的内容。20
:这些数据与来自其他视频片尾画面的观看次数相关。
对于这两个新流量来源,
traffic_source_detail
维度用于标识将观看者引荐至您的视频的视频。-
该 API 的核心指标列表已更正,将
estimated_partner_revenue
列为核心指标,并从该列表中移除了earnings
。(YouTube Reporting API 从未支持earnings
指标。) -
ad_type
维度现在支持值19
,该值表示导视广告,即最长 6 秒钟的不可跳过的视频广告,用户必须看完广告才能观看视频。
-
YouTube Analytics API(定位查询)
- 以下渠道报告支持的指标列表已更新,其中包含卡片指标。我们实际上是在 2016 年 6 月 28 日才开始支持在这些报告中显示卡片指标,当天的修订历史记录条目详细介绍了这一变更。报告如下:
- 美国各州的基本用户活动
- 特定时间段内美国各州的用户活动
- 用户活动(按省份)
- 按订阅状态划分的用户活动情况
- 按省份划分的用户活动情况(按订阅状态)
- 热门视频(按州)
- 订阅者或非订阅者观看次数最多的视频
-
我们已更正频道受众群体黏度报告和内容所有者受众群体黏度报告的过滤条件列表,以反映
video
过滤条件是必需的,而group
过滤条件不受支持。以前,这两份报告的文档中错误地指出,您可以使用这两个过滤条件中的任一过滤条件或不使用任何过滤条件来检索报告。
- 以下渠道报告支持的指标列表已更新,其中包含卡片指标。我们实际上是在 2016 年 6 月 28 日才开始支持在这些报告中显示卡片指标,当天的修订历史记录条目详细介绍了这一变更。报告如下:
-
YouTube Reporting API(批量报告)
- 在API 概览中,介绍如何检索报告下载网址的部分已更正,其中指出 YouTube 确实会为没有数据的日子生成可下载的报告。这些报告包含标题行,但不包含其他数据。我们已于 2016 年 4 月 12 日在同一文档的报告特征部分更新了此信息。
content_owner_asset_cards_a1
报告中的维度列表已更正,以反映该报告使用card_id
维度。之前,文档错误地将维度名称列为card_title
。
-
我们更新了 API 概览的报告特性部分,以明确说明报告在生成之日起 180 天内可通过 API 访问。
之前,文档中指出,报告涵盖的时间段最长可回溯到发送 API 请求之日的前 180 天。虽然原始文本在技术上也是正确的,但充其量也只是比较混乱。
-
该 API 支持三个报告的新版本。其中两个报告还包含新指标和重命名指标:
-
content_owner_ad_rates_a1
报告是content_owner_ad_performance_a1
报告的新版本。新命名的报告与之前的版本完全相同。 -
我们重命名了两个具有新版本的报告:
content_owner_estimated_earnings_a1
报告的新版本名为content_owner_estimated_revenue_a1
。content_owner_asset_estimated_earnings_a1
报告的新版本名为content_owner_asset_estimated_revenue_a1
。
这两份新命名的报告在以下方面与其前身有所不同:
- 他们添加了新的
estimated_partner_red_revenue
指标,用于估算 YouTube Red 订阅带来的总收入。 - 它们会添加新的
estimated_partner_transaction_revenue
指标,该指标会估算扣除合作伙伴要求的所有退款后,付费内容和粉丝赞助等交易所产生的收入。 - 他们将
estimated_partner_ad_sense_revenue
指标重命名为estimated_partner_ad_auction_revenue
。 - 他们将
estimated_partner_double_click_revenue
指标重命名为estimated_partner_ad_reserved_revenue
。
请注意,如果您已经有用于创建这些报告的旧版作业,则需要为已重命名的报告创建新作业。随着新版报告的发布,
content_owner_ad_performance_a1
、content_owner_estimated_earnings_a1
和content_owner_asset_estimated_earnings_a1
报告已被弃用。如果您有任何此类报告的作业,请不要指望 YouTube 会在 2016 年 9 月 22 日之后为这些作业生成新的报告。生成的报告将在生成之日起 180 天内仍可供访问。
-
-
reportType
资源的id
属性的定义已更新,以反映当前可用的报告集。 -
我们已在文档中更正了两个指标的名称,使其与报告中显示的名称一致。这只是文档修复,并不反映实际报告内容的变化:
estimated_partner_adsense_revenue
指标的名称已更新为estimated_partner_ad_sense_revenue
。不过,请注意,此指标仅显示在本次更新中被弃用的两个报告中。如上所述,在这些报告的较新版本中,此指标已重命名为estimated_partner_ad_auction_revenue
。estimated_partner_doubleclick_revenue
指标的名称已更新为estimated_partner_double_click_revenue
。再次提醒一下,此指标仅显示在此次更新中被弃用的两个报告中。如上所述,在这些报告的较新版本中,此指标已重命名为estimated_partner_ad_reserved_revenue
。
-
Reporting API 的维度文档已更新,不再列出
elapsed_video_time_percentage
和audience_retention_type
属性。目前,通过 API 提供的任何报告都不支持这些维度。 -
该 API 支持面向内容所有者的用户活动报告的新版本。新报告的报告类型 ID 为
content_owner_basic_a2
。与报告的旧版content_owner_basic_a1
不同,新版支持likes
和dislikes
指标。如果您已经有用于创建
content_owner_basic_a1
报告的作业,则仍需要为content_owner_basic_a2
报告创建新作业。YouTube 不会自动将内容所有者迁移到新版报告,也不会自动创建作业来生成新版报告。在某些实现中,出现意外的新作业可能会导致破坏性更改。随着新报告的发布,
content_owner_basic_a1
报告已被弃用。如果您有此报告的作业,YouTube 在 2016 年 8 月 19 日之后不会再为该作业生成新报告。生成的报告将在生成之日起 180 天内仍可供访问。 -
reportType
、job
和report
资源都支持一个新属性,用于确定关联的资源是否代表已废弃的报告类型:-
reportType
资源的deprecateTime
属性指定报告类型将被弃用的日期和时间。只有已宣布废弃的报告才具有此属性的值,该值表示 YouTube 将停止生成该类型报告的日期。在宣布某种报告类型已废弃后,YouTube 会再生成该类型的报告三个月。例如,2016 年 5 月 19 日的此更新宣布了
content_owner_basic_a1
报告的弃用。因此,该报告类型的deprecateTime
指定了 2016 年 8 月 19 日的时间,之后 YouTube 将停止生成该类型的报告。 -
job
资源的expireTime
属性指定作业已过期或将过期的日期和时间。如果与作业关联的报告类型已废弃,或者系统长时间未下载为作业生成的报告,则此属性会具有值。该日期表示 YouTube 会在该日期之后不再为该作业生成新报告。 -
report
资源的jobExpireTime
属性指定与报告关联的作业已过期或将过期的日期和时间。此属性包含与job
资源中的expireTime
属性相同的值,如本列表中的上一个条目所述。
-
-
如果您尝试为已废弃的报告创建作业,
jobs.create
方法现在会返回400
HTTP 响应代码 (Bad Request
)。此外,该方法的文档现在列出了导致 API 请求失败的几种其他原因。 -
YouTube 现在会生成涵盖首次安排报告作业前 180 天的数据。以前,Reporting API 不会提供任何历史数据。此项变更会影响所有作业,包括在此公告发布之前创建的作业。
系统会在历史报告可用后立即发布,但大约需要一个月的时间才能发布作业的所有历史数据。因此,在安排报告作业运行一个月后,您将能够访问大约 7 个月的数据。(在此公告发布前创建的所有作业的所有历史数据应在公告发布后的 1 个月内发布。)
请注意,系统仅提供 2015 年 7 月 1 日之后的历史数据。因此,2015 年 12 月 28 日之前创建的作业将只有不到 180 天的历史数据。
这些更改在 Reporting API 概览的新版历史数据部分中都有介绍。
-
YouTube Reporting API 概览的报告特性部分已更新,其中进行了以下更改:
-
文档现在指出,报告在生成后可保留 180 天,因此 API 客户端可以下载。之前,文档中指出,报告涵盖的时间范围最多可回溯到发送 API 请求的日期之前 6 个月。
-
文档已更新,以反映以下事实:该 API 现在会为没有数据可用的那几天生成可下载的报告。这些报告将包含标题行,但不包含其他数据。
-
-
YouTube Reporting API 即将支持一组由系统自动生成的报告,其中包含广告收入数据或 YouTube Red 订阅收入数据。此类报告将面向已可以在 YouTube 创作者工作室中访问可手动下载的收入报告的内容所有者提供。因此,新 API 功能将支持以编程方式访问这些数据。
为准备发布系统管理的报告,我们现宣布以下 API 变更:
-
job
资源的新systemManaged
属性用于指明该资源是否描述了生成系统管理报告的作业。YouTube 会自动为 YouTube 内容所有者生成系统管理的报告,内容所有者无法修改或删除用于创建这些报告的作业。 -
jobs.list
方法的新includeSystemManaged
参数用于指明 API 响应是否应包含系统管理的报告的作业。该参数的默认值为false
。 -
jobs.reports.list
方法的新startTimeAtOrAfter
参数表示,只有当报告中最早的数据在指定日期当天或之后时,API 响应才应包含报告。同样,startTimeBefore
参数表示,只有当报告中最早的数据早于指定日期时,API 响应才应包含报告。与该方法的
createdAfter
参数(与报告的创建时间相关)不同,新参数与报告中的数据相关。 -
reportType
资源的新systemManaged
属性用于指明该资源是否描述了系统管理的报告。 -
reportTypes.list
方法的新includeSystemManaged
参数用于指明 API 响应是否应包含系统管理的报告。该参数的默认值为false
。
-
- 在 YouTube Reporting API 中,
sharing_service
维度支持以下新值:82
:iOS 系统活动对话框83
:Google 收件箱84
:Android 信息
- 在 YouTube Analytics API 中,
sharingService
维度支持以下新值:ANDROID_MESSENGER
:Android 信息INBOX
:Google 收件箱IOS_SYSTEM_ACTIVITY_DIALOG
:iOS 系统活动对话框
playback_location_type
维度支持两个新的维度值:7
:这些数据与在 YouTube 首页或主屏幕、用户的订阅动态或其他 YouTube 浏览功能中发生的观看次数相关。8
:这些数据与直接在 YouTube 搜索结果页上发生的观看次数有关。
traffic_source_type
维度现在支持将18
用作维度值。此值表示视频观看次数来自列出播放列表中所有视频的网页。此来源不同于来源类型14
,后者表示观看发生在视频作为播放列表的一部分播放时。insightPlaybackLocationType
维度支持两个新的维度值:BROWSE
:这些数据与在 YouTube 首页或主屏幕、用户的订阅动态或其他 YouTube 浏览功能中发生的观看次数相关。SEARCH
:这些数据与直接在 YouTube 搜索结果页上发生的观看次数有关。
insightTrafficSourceType
维度现在支持将YT_PLAYLIST_PAGE
用作维度值。此值表示视频观看次数来自列出播放列表中所有视频的网页。此来源不同于PLAYLIST
来源类型,后者表示观看发生在视频作为播放列表的一部分播放时。- 在 YouTube Reporting API 中,
operating_system
维度使用值21
来识别通过 Chromecast 进行的观看。 - 在 YouTube Analytics API 中,
operatingSystem
维度使用值CHROMECAST
来识别通过 Chromecast 进行的观看。 -
YouTube 数据分析 API 现在支持三个新的播放详情维度,可用于各种频道和内容所有者报告:
liveOrOnDemand
:此维度表示报告中的数据是描述直播期间发生的用户活动,还是描述直播结束后发生的用户活动。subscribedStatus
:此维度表示数据中的用户活动指标是否与订阅了视频或播放列表频道的观看者相关联。youtubeProduct
:此维度用于标识发生用户活动的 YouTube 媒体资源。可能的值包括核心 YouTube 网站(或 YouTube 应用)、YouTube Gaming 和 YouTube Kids。
我们更新了相关文档,以介绍面向频道和内容所有者提供的新播放详情报告。此外,我们还更新了许多其他报告,以说明其中一个或多个维度可视需要用作这些报告中的维度和/或过滤条件。
-
说明报告的表格格式已更改,以便您更轻松地确定可用于检索各个报告的有效维度、指标和过滤条件组合。下表介绍了频道的“设备类型”报告,并显示了新格式:
目录 尺寸: 必填 deviceType 使用 0 或更大的值 day、liveOrOnDemand、subscribedStatus、youtubeProduct 指标: 使用 1 或更多 观看次数、estimatedMinutesWatched 过滤器: 使用 0 或 1 country、province、continent、subContinent 使用 0 或 1 视频、组 使用 0 或更大的值 operatingSystem、liveOrOnDemand、subscribedStatus、youtubeProduct -
YouTube Analytics API 现在会自动从支持多个值的过滤条件(
video
、playlist
和channel
)中移除 API 用户无法检索数据的实体。以前,如果 API 用户无法访问至少一个指定项的数据,API 服务器只会返回错误。例如,假设用户提交了一个 API 请求,其中
video
过滤条件列出了 20 个视频 ID。用户拥有其中 18 个视频。但是,其中一个视频 ID 用于标识另一个频道拥有的视频,而另一个 ID 用于标识已被删除且因此不存在的视频。在这种情况下,API 服务器现在会舍弃用户无法访问的两个视频,而不是返回错误,并且 API 响应包含 API 用户拥有的 18 个视频的数据。 -
如果您请求空的 YouTube 数据分析
group
的数据,API 现在会返回空的数据集,而不是错误。 -
如果您尝试向组添加实体,但没有权限访问该实体,YouTube Analytics API 的
groupItems.insert
方法现在会返回未经授权 (403
HTTP 响应代码) 错误。以前,该 API 允许您将实体添加到组,但后来在您尝试检索该组的报告数据时返回了未经授权的错误。 -
YouTube Analytics API 的
groups.list
方法现已支持分页。如果 API 响应不包含所有可用群组,则响应的nextPageToken
参数会指定一个可用于检索下一页结果的令牌。将该方法的pageToken
参数设置为该值,以检索其他结果。 -
YouTube 数据分析 API 现在支持
redPartnerRevenue
指标,该指标会报告所选报告维度通过 YouTube Red 订阅赚取的估算总收入。该指标的值反映了音乐和非音乐内容带来的收入,并会在月底进行调整。YouTube Analytics API 的内容所有者报告列表已更新,以指明支持
redPartnerRevenue
指标的视频报告: -
YouTube Analytics API 的热门视频报告定义现已反映出,此报告还支持以下收入指标:
earnings
、adEarnings
、grossRevenue
、monetizedPlaybacks
、playbackBasedCpm
、impressions
和impressionBasedCpm
。 -
我们已更正 YouTube Reporting API 的
date
维度文档,以反映日期是指从太平洋时间凌晨 12:00 (UTC-8) 开始的 24 小时。之前,文档中指出该日期的开始时间为凌晨 12:00(格林尼治标准时间)。此外,我们更新了 YouTube Analytics API 文档,其中指出所有与日期相关的维度(
day
、7DayTotals
、30DayTotals
和month
)均以太平洋时间凌晨 12:00 (UTC-8) 开始的日期为准。 -
YouTube Reporting API 的
jobs.reports.list()
方法现在支持createdAfter
查询参数。如果指定,此参数表示 API 响应应仅列出在指定日期和时间之后创建的报告,包括包含回填数据的新报告。请注意,该参数值与报告的创建时间有关,而不是与返回的数据关联的日期。该参数值采用 RFC3339 世界协调时间 (UTC)“Zulu”格式的时间戳,精确到微秒。示例:
"2015-10-02T15:01:23.045678Z"
。YouTube Reporting API 最佳实践也已更新,其中介绍了如何使用
createdAfter
参数来避免反复处理同一报告。 -
job
资源的createTime
属性和report
资源的startTime
、endTime
和createTime
属性的定义均已更正,以指明属性值的精确度为微秒,而不是纳秒。此外,所有定义现在都准确反映了属性值是时间戳。 -
更新了 YouTube Analytics API 的
sharingService
维度文档,在其中添加了可能的维度值列表。该列表包含一些新受支持的服务。YouTube Reporting API 的
sharing_service
维度定义也已更新,以列出新支持的值。大于59
的枚举值是列表中的新值。 -
新的 YouTube Reporting API 用于检索包含面向频道或内容所有者的 YouTube 数据分析数据的批量数据报告。该 API 专为可以导入大型数据集并提供数据过滤、排序和挖掘工具的应用而设计。
每个 YouTube Reporting API 报告都包含一组预定义的维度和指标。(YouTube Analytics API 报告也使用指标和维度。)在报告中,每行数据都有唯一的维度值组合。您可以根据维度值汇总各行数据,以便计算各个视频、国家/地区、直播视频、订阅用户等的指标。
您可以使用此 API 安排报告作业,每个作业都用于指定 YouTube 应生成的报告。设置作业后,YouTube 会生成可异步下载的每日报告。每份报告包含一个 24 小时的独特时间段的数据。
-
虽然这两个 API 不同,但开发者都可以通过 YouTube Analytics API 和 YouTube Reporting API 检索 YouTube 数据分析数据。由于这两个 API 都提供对类似数据集的访问权限,因此这两个 API 的文档将作为一组文档发布。
-
我们对 API 文档进行了重构,以便您更轻松地理解 API。因此,这些变更并非介绍新功能:
-
该文档现在包含一个页面,其中列出了所有可用的频道报告,另一个页面则列出了所有可用的内容所有者报告。之前,该文档针对频道视频报告、频道播放列表报告等分别提供了单独的页面。
-
新版数据模型概览旨在更清晰地介绍该 API 的运作方式。具体而言,本文档旨在更好地说明 YouTube 如何使用指标、维度和过滤条件来计算报告值。
-
该 API 的
reports.query
方法(用于检索报告)现已单独记录。该页面上的信息之前曾显示在其他页面上。新页面旨在帮助您更轻松地确定检索报告所需发送的信息。
-
-
新的
adEarnings
指标包含来自 Google 出售的所有广告来源的总估算收入(净收入)。这不是核心指标。对于已支持earnings
指标的任何报告,该 API 都支持adEarnings
指标。此外,我们还更正了
earnings
指标的定义,以反映其值包含来自所有 Google 出售的广告来源以及非广告来源的总估算收入。之前,该定义错误地指出该指标仅包含来自广告来源的收入。 -
primaryAdGrossRevenue
指标已弃用。请改用grossRevenue
指标检索收入数据。 -
除了已废弃的
primaryAdGrossRevenue
指标之外,广告效果报告也不再支持monetizedPlaybacks
和playbackBasedCpm
指标。不过,仍有几个视频报告支持这些指标。 -
该 API 现在支持视频报告中的两个新指标:
videosAddedToPlaylists
和videosRemovedFromPlaylists
。我们更新了频道和内容所有者的视频报告列表,以便您找到支持新指标的报告。videosAddedToPlaylists
- 查询范围内的视频被添加到任何 YouTube 播放列表的次数。这些视频可能已添加到视频所有者的播放列表或其他频道的播放列表中。videosRemovedFromPlaylists
- 查询范围内的视频从任何 YouTube 播放列表中移除的次数。视频可能已从视频所有者的播放列表或其他频道的播放列表中移除。
这两个指标都包括“稍后观看”播放列表等默认播放列表。不过,系统不会统计视频自动添加到其中的播放列表,例如频道的“上传内容”播放列表或用户的观看记录。另请注意,这些指标反映的是添加和删除的绝对数量。因此,如果用户将视频添加到播放列表,然后将其移除,再将其重新添加,则相关指标会显示该视频已添加到两个播放列表,并从一个播放列表中移除。
从 2014 年 10 月 1 日开始,系统会提供这些指标的数据。
-
自本公告发布之日起,
favoritesAdded
和favoritesRemoved
指标已被弃用。这两个指标都是核心指标,并且受服务条款中规定的弃用政策的约束。 -
借助新的
currency
参数,您可以以美元 (USD
) 以外的币种检索收入指标。如果设置了该参数,API 会将earnings
、grossRevenue
、playbackBasedCpm
和impressionBasedCpm
指标的值转换为指定币种。返回的值是使用每天变化的汇率计算得出的估算值。该参数值是 ISO 4217 货币代码(由三个字母组成)。默认值为
USD
。参数定义包含支持的货币代码列表。 -
该 API 现在支持创建和管理 YouTube 数据分析组,以及检索这些组的报告数据。
-
创建和管理群组
本次更新引入了用于创建和管理组的
group
和groupItem
资源。group
资源代表数据分析群组,这是一个由最多 200 个频道、视频、播放列表或资产组成的自定义集合。该 API 支持此资源的list
、insert
、update
和delete
方法。groupItem
资源表示 Google Analytics 组中的项。该 API 支持此资源的list
、insert
和delete
方法。
例如,您可以使用
groups.insert
方法创建一个组,然后使用groupItems.insert
方法向该组添加项。 -
检索群组的报告数据
维度文档已更新,其中包含
group
维度,该维度可用作许多频道报告和内容所有者报告的过滤条件。使用group
过滤条件时,API 会返回该组中所有项的数据。请注意,该 API 目前不支持为素材资源组创建报告。
如需详细了解 YouTube 数据分析组,请访问 YouTube 帮助中心。
-
-
该 API 不再支持
show
维度。 -
现在,当
video
、playlist
、channel
和show
维度用作过滤条件时,该 API 支持为这些维度指定多个值。如需指定多个值,请将filters
参数值设置为应过滤 API 响应的视频、播放列表、频道或节目 ID 的逗号分隔列表。参数值最多可指定 200 个 ID。如果您为同一过滤条件指定多个值,还可以将该过滤条件添加到为请求指定的维度列表中。即使过滤条件未列为特定报告的受支持维度,也是如此。如果您将过滤条件添加到维度列表中,则该 API 还会使用过滤条件值对结果进行分组。
如需详细了解此功能,请参阅
filters
参数定义。 -
现在,在检索渠道报告时,您可以通过将
ids
参数的值设置为channel==MINE
,检索已验证用户渠道的数据。(您仍然可以将ids
参数设置为channel==CHANNEL_ID
,以检索指定渠道的数据。) -
该 API 现在支持播放列表报告,其中包含与播放列表中发生的视频观看次数相关的统计信息。播放列表报告适用于频道和内容所有者。
所有播放列表报告都支持“
views
”和“estimatedMinutesWatched
”指标,部分报告还支持“averageViewDuration
”指标。此外,所有播放列表报告都支持以下新指标。请注意,这些指标仅反映在网页上发生的播放列表观看次数。
playlistStarts
:观看者发起播放播放列表的次数。viewsPerPlaylistStart
:每次启动播放列表时发生的视频观看次数的平均值。averageTimeInPlaylist
:观看者在播放列表启动后观看播放列表中视频的预估平均时长(以分钟为单位)。
任何用于检索播放列表报告的请求都必须使用
isCurated
过滤条件,该过滤条件必须设置为1
(isCurated==1
)。 -
该 API 现在支持观众黏度报告。此报告衡量的是视频在吸引受众群体方面的吸引力。该报告新增了
elapsedVideoTimeRatio
维度,用于衡量相应指标值所对应的视频播放时长:-
audienceWatchRatio
指标用于确定在视频的给定时间点观看视频的观看者的绝对比例。该比率的计算方法是将视频的某个片段的观看次数与视频的总观看次数进行比较。请注意,在一次视频观看中,视频的某个部分可能会被观看多次(或根本不被观看)。例如,如果用户反复快退并观看视频的同一部分,则该视频部分的绝对比率可能会大于
1
。 -
relativeRetentionPerformance
指标显示视频在播放期间吸引观众继续观看的能力,与 YouTube 上所有时长相近的视频相比。值为 0 表示该视频的观众黏度低于所有时长相近的其他视频,值为 1 表示该视频的观众黏度高于所有时长相近的其他视频。如果中位数值为 0.5,则表示一半时长相近的视频的观众黏度较高,而另一半时长相近的视频的观众黏度较低。
您还可以使用
audienceType
过滤条件,以便报告仅返回与自然观看次数、TrueView 插播广告观看次数或 TrueView 展示广告观看次数相关的数据。(自然观看是指用户执行某些操作(例如搜索视频或点击推荐视频)所直接产生的观看次数。) -
-
该 API 支持与注释相关的多项新指标。您可以使用之前支持
annotationClickThroughRate
和annotationCloseRate
指标的任何报告检索下列指标。annotationImpressions
:注释展示次数总数。annotationClickableImpressions
:显示且可点击的注释数量。annotationClosableImpressions
:显示且可关闭的注释数量。annotationClicks
:点击的注释总数。annotationCloses
:已关闭注释的总数。
所有新指标均为核心指标,并受弃用政策的约束。不过,请注意,自 2013 年 7 月 16 日起,新指标的数据就已可用。(
annotationClickThroughRate
和annotationCloseRate
指标的数据自 2012 年 6 月 10 日起可用。) -
GOOGLE_SEARCH
不再作为insightTrafficSourceType
维度的单独值进行报告。相反,Google 搜索结果带来的引荐现在归因于EXT_URL
流量来源类型。因此,您也无法再检索将insightTrafficSourceType
过滤条件设为GOOGLE_SEARCH
的insightTrafficSourceDetail
报告。 -
内容所有者报告文档已更新,其中指出现在可以针对内容所有者主张所有权或上传的内容检索
subscribersGained
和subscribersLost
指标。内容所有者的第一份基本统计数据报告中会显示这项更改,该报告现在支持
claimedStatus
和uploaderType
过滤条件。 -
示例请求文档已重新设计,采用与最近针对频道和内容所有者报告发布的标签页格式类似的格式,将示例分门别类。在新设计中,示例分为以下类别:
- 基本统计数据
- 基于时间
- 地理位置
- 播放位置
- 流量来源
- 设备/操作系统
- 受众特征
- 社交
- 收入/广告(仅适用于内容所有者报告)
-
请求示例文档现在包含有关如何在渠道报告或内容所有者报告中检索省级数据的新示例。
-
美国各州和华盛顿特区专属的省级指标:此报告会按省/直辖市/自治区显示频道视频的观看次数和其他统计信息。数据涵盖美国各州和华盛顿特区。该示例使用
province
维度,还使用filters
参数将响应限制为仅包含美国的结果。 -
加利福尼亚州的观看者受众特征(年龄段和性别):此报告会检索加利福尼亚州观看频道视频或内容所有者声明的内容的观看者的年龄段和性别方面的统计信息。此示例使用
filters
参数来确保响应仅包含特定省份的数据。
-
-
更新了
province
维度的定义,以指出当dimensions
参数值中包含province
时,请求还必须在filters
参数值中添加country==US
,以将数据限制为仅限美国。 -
列出受支持的频道和内容所有者报告的文件已重新设计。每份文档都不会提供列出所有可能报告的表格,而是会将报告分门别类:
- 基本统计数据
- 基于时间
- 地理位置
- 播放位置
- 流量来源
- 设备/操作系统
- 受众特征
- 社交
- 热门视频
每份文档都会以标签页列表的形式显示这些类别,您可以点击任意标签页查看该类别中受支持的报告。
-
该 API 现在支持三个新的地理维度:
province
、continent
和subContinent
。-
借助
province
维度,您可以检索美国各州和哥伦比亚特区的统计信息。该 API 支持对此维度的两种用法: -
subContinent
维度用于指定联合国 (UN) 统计区域代码,用于标识大陆的子区域。此维度也只能用作过滤条件。由于每个子区域只与一个大洲相关联,因此在使用
subContinent
过滤条件时,无需同时使用continent
过滤条件。(事实上,如果请求同时使用这两个维度,API 会返回错误。)
-
-
相关文档已更正,
insightTrafficSourceDetail
维度不将insightTrafficSourceType
值PROMOTED
作为有效的过滤条件值。 -
YouTube 数据分析 API 现在受服务条款中所述的弃用政策约束。不过,该 API 的非核心维度和非核心指标不受弃用政策的约束。维度和指标页面已更新,以列出核心维度和核心指标。此外,我们还更新了这些页面上的定义,以明确标识核心维度和指标。
-
该 API 现在支持将
EXTERNAL_APP
用作insightPlaybackLocationType
维度的值。与此更新一同,自 2013 年 9 月 10 日起,系统不再将播放分类为MOBILE
播放,但在此日期之前发生的移动播放仍会使用该值进行分类。此次更新后,移动播放现在会被分类为
WATCH
、EMBEDDED
或EXTERNAL_APP
播放,具体取决于发生播放的应用类型。 -
该 API 现在支持将
PLAYLIST
用作insightTrafficSourceType
维度的值。此值表示视频观看是通过播放列表引荐的。以前,这些视图会使用维度的YT_OTHER_PAGE
类别进行分类。 -
该 API 现在支持按多个维度和指标对报告进行排序。“请求示例”文档中包含一个新示例(按多个维度/指标对请求进行排序),该示例演示了此功能。该请求会检索流量来源数据,并且
sort
参数值为day,-views
。结果会按时间顺序排序,但在每天的结果集中,第一行包含带来最多观看次数的流量来源的数据,第二行包含带来次多观看次数的来源的数据,以此类推。 -
该 API 现在支持两个新维度:
deviceType
和operatingSystem
,可用于检索与观看者观看视频时所用设备相关的数据。该 API 支持使用任一维度或这两个维度的报告。-
借助
deviceType
报告,您可以检索不同类型设备(包括桌面设备、移动设备和平板电脑)的观看次数和估算观看时长。您还可以使用operatingSystem
过滤器来限制设备类型报告,使其仅包含运行特定操作系统(例如 Android 或 iOS)的设备的统计信息。 -
借助
operatingSystem
报告,您可以检索不同操作系统(例如 Android、iOS、Linux 等)的观看次数和预计观看时长。您还可以使用deviceType
过滤条件,将操作系统报告限制为仅包含特定类型设备(例如移动设备或平板电脑)的统计信息。
-
-
示例请求文档已更新,其中包含三个适用于频道的设备报告和三个适用于内容所有者的设备报告。
-
insightPlaybackLocationType
维度可能会返回值YT_OTHER
,用于标识未使用该维度的其他值进行分类的视图。 -
YouTube 不再标识实验性 API 功能和服务。现在,我们提供受弃用政策约束的 YouTube API 列表。
-
该 API 现在支持同时检索观看时长指标(
estimatedMinutesWatched
、averageViewDuration
和averageViewPercentage
)以及其他指标,包括观看指标、互动指标、收入指标和广告效果指标。可用的频道报告和内容所有者报告列表已更新,以反映此变化。(由于观看时长指标可在其他列出的报告中检索,因此列表实际上更短。)
API 请求示例文档也已更新。
-
使用
insightPlaybackLocationDetail
和insightTrafficSourceDetail
维度的报告已通过以下方式得到增强:-
它们现在支持可选的
country
过滤条件。 -
内容所有者现在可以使用以下任意新的
filter
组合检索这些报告。请注意,所有这些组合还支持可选的country
过滤器。-
播放位置详情
channel,insightPlaybackLocationType==EMBEDDED
show,insightPlaybackLocationType==EMBEDDED
claimedStatus,insightPlaybackLocationType==EMBEDDED
uploaderType,insightPlaybackLocationType==EMBEDDED
uploaderType,claimedStatus,insightPlaybackLocationType==EMBEDDED
-
流量来源详情
channel,insightTrafficSourceType
show,insightTrafficSourceType
claimedStatus,insightTrafficSourceType
uploaderType,insightTrafficSourceType
uploaderType,claimedStatus,insightTrafficSourceType
-
-
-
新的API 请求示例文档提供了示例,演示了如何使用 YouTube Analytics API 检索许多不同类型的报告。每个示例都包含对请求检索的报告的简要说明,然后显示请求的维度、指标、过滤条件和排序参数。
-
insightTrafficSourceType
维度现在支持将SUBSCRIBER
用作有效值。此维度用于识别通过 YouTube 首页上的动态或 YouTube 订阅功能引荐的视频观看。如果您根据此流量来源进行过滤,insightTrafficSourceDetail
字段将指定带来观看的首页 Feed 或其他页面。 -
该 API 现在支持两个新指标:
annotationClickThroughRate
和annotationCloseRate
,它们与观看者与视频中显示的注释的互动相关。我们更新了频道报告和内容所有者报告列表,以便您了解哪些报告支持新指标。annotationClickThroughRate
- 观看者点击的注释与可点击注释的总展示次数的比率。annotationCloseRate
- 观看者关闭的注释与注释总展示次数的比率。
-
该 API 现已支持收入和广告效果指标,以及新的广告效果报告。只有参与 YouTube 合作伙伴计划的 YouTube 内容合作伙伴才能访问这些指标和报告。
-
新支持的报告支持基于播放的广告效果指标和基于展示的广告效果指标。如需详细了解广告效果报告,请参阅内容所有者报告文档。
-
新受支持的指标列在下方。内容所有者报告列表已更新,其中列出了支持这些指标的报告(包括两个新报告)。
earnings
- 所有 Google 出售的广告来源带来的总估算收入。grossRevenue
- 来自 Google 或 DoubleClick 合作伙伴的估算毛收入。primaryAdGrossRevenue
- 估算的总收入,系统会对报告涵盖的 Google 或 DoubleClick 合作伙伴视频播放次数进行汇总,并按主要广告类型对其进行分类。monetizedPlaybacks
- 至少有一次广告展示的播放次数。playbackBasedCpm
- 每千次播放的估算总收入。impressions
- 投放的经过验证的广告展示次数。impressionBasedCpm
- 每千次广告展示的估算总收入。
注意:如需了解完整的详细信息,请参阅指标定义。
-
任何用于检索收入或广告效果指标的请求都必须发送一个授权令牌,该令牌使用新的
https://www.googleapis.com/auth/yt-analytics-monetary.readonly
范围授予访问权限。
-
-
API 文档已重新整理,以便在不同的页面上介绍不同类型的报告。因此,我们现在会在单独的页面中介绍不同类型的频道报告和内容所有者报告。
-
该 API 的参考指南现在包含一个示例部分,其中包含代码示例,演示了如何使用 Java、JavaScript、Python 和 Ruby 客户端库调用该 API。JavaScript 代码示例与示例应用文档中详细介绍的示例相同。
-
API 参考指南现已添加 APIs Explorer,可让您调用 API、查看 API 请求,以及在响应中检索真实数据。
-
该 API 支持面向频道和内容所有者的多种新报告,详情如下。每份报告均可作为频道报告或内容所有者报告提供。维度和指标页面也相应更新。
-
“播放位置”报告会指明在不同类型的网页或应用中发生的视频观看次数。
-
“播放位置详细信息”报告会标识为指定视频带来最多观看次数的嵌入式播放器。与播放位置报告相比,此报告可提供更精细的数据视图,因为它会识别与热门嵌入式播放器相关联的网址。
-
“流量来源”报告会显示来自不同类型引荐来源的视频观看次数。
-
“流量来源详细信息”报告会标识为指定视频和指定流量来源类型带来最多观看次数的引荐来源。例如,此报告可以显示向特定视频发送了最多流量的相关视频。此报告支持多种流量来源。
-
观看时长报告会提供观看者观看您的内容所花费的时长。报告可以汇总特定时间范围(例如一天、过去七天、过去 30 天等)或国家/地区的数据。如果报告按天或国家/地区汇总数据,还可以指定每次观看视频的平均时长,以及用户观看每个视频的平均百分比。
-
-
YouTube Analytics API 现已面向所有开发者推出。您可以在 APIs console 的 Services 面板中为项目激活该 API,而无需先请求访问权限。
-
新增的使用入门部分概述了构建使用 YouTube Analytics API 的应用的前提条件和基本步骤。
-
新增的了解配额用量部分提供了有关优化 API 配额用量的准则。API 服务器会为每个请求计算查询费用,并从您的 API 使用配额中扣除相应费用。由于不同类型的报告的查询费用可能差异很大,因此您应计划高效使用配额,并且您的应用应仅请求实际需要的指标和数据。
-
更新了时间维度部分,说明这些维度表示 Google Analytics 报告应根据时间段汇总数据。该 API 现在支持以下额外的时态维度:
7DayTotals
- 报告中的数据将汇总,因此每行都包含七天时间段的数据。30DayTotals
- 报告中的数据将进行汇总,以便每行包含 30 天内的数据。month
- 报告中的数据将按日历月汇总。
同样,可用报告部分也已更新,以反映该 API 对使用这些维度的报告的支持。
-
更新了报告实体维度部分,其中指出用于检索内容所有者报告的 API 请求必须使用以下维度之一(
video
、channel
或show
)或claimedStatus
和uploaderType
维度的受支持组合来过滤数据。 -
该 API 现在支持为热门视频报告提供两个新的排序选项。这些报告可作为频道报告或内容所有者报告提供,包含按国家/地区划分的各项指标(观看次数、评论数、赞的次数等),并按视频对这些指标进行细分。现在,您可以根据在视频观看页面上订阅或退订频道的用户数对这些报告进行排序。
-
我们更新了
subscribersGained
和subscribersLost
指标的定义,以说明频道可以在多个位置(包括视频观看页面、频道页面和 YouTube 首页上显示的导视面板)获得或失去订阅者。当这些指标显示在特定于视频的报告中时,其中仅包含指定视频的观看页面中的统计数据。
YouTube Reporting API 支持三个新的片尾画面报告,以及这些报告的新维度和指标。这些报告会提供视频停止播放后显示的片尾画面的展示次数和点击次数统计信息。
YouTube 帮助中心提供了有关如何为视频添加片尾画面的更多详细信息。
2016 年 11 月 8 日
此更新对 YouTube Analytics API 进行了以下更改:
2016 年 10 月 27 日
YouTube 现在会自动为有权在 YouTube 创作者工作室的报告部分查看相应报告的内容所有者生成一组由系统管理的广告收入报告。新的系统管理 API 报告旨在以程序化方式访问可在手动下载的创作者工作室报告中获取的数据。
系统管理的报告概览简要介绍了新报告,并说明了通过 API 检索这些报告的过程。此流程与检索 YouTube 数据分析的批量报告略有不同,因为合作伙伴无需安排作业即可生成报告。
reportType
资源的 id
属性已更新,其中包含您可以通过 API 访问的系统管理报告的列表:
2016 年 9 月 27 日
注意:这是一条废弃公告。
YouTube Analytics API 的 uniques
指标已被弃用。这不是一个核心指标,将在 2016 年 10 月 31 日之前受支持。
2016 年 9 月 15 日
此更新包含以下 YouTube Reporting API 变更:
2016 年 8 月 19 日
此更新包含以下 YouTube Reporting API 变更:
2016 年 8 月 11 日
此更新包含以下更改:
2016 年 8 月 10 日
此更新包括以下变更:
2016 年 7 月 18 日
此更新包括以下变更:
2016 年 6 月 28 日
YouTube 数据分析 API 文档已更新,以反映对多个频道和内容所有者报告中的卡片指标的支持。新支持的指标包括:
以下类型的报告支持这些指标:
2016 年 6 月 22 日
此更新包含以下 YouTube Reporting API 变更。第一个更改与 API 总体相关,其余更改仅会影响内容所有者报告:
2016 年 5 月 19 日
此更新包含以下 YouTube Reporting API 变更:
2016 年 4 月 12 日
此更新包含以下变更,所有这些变更都仅会影响 YouTube Reporting API:
2016 年 3 月 28 日
YouTube Reporting API 和 YouTube Analytics API 现在会返回更多分享服务的观看统计信息。
2016 年 3 月 16 日
此更新包含以下更改,这些更改会影响 YouTube Reporting API 和 YouTube Analytics API:
YouTube Reporting API
YouTube Analytics API
2016 年 2 月 8 日
更新了 YouTube Analytics API 支持的指标列表,卡片指标不再列为该 API 支持的指标。(该 API 的任何报告都未记录为支持任何卡片指标。)
请注意,您仍然可以使用 YouTube Reporting API 检索卡片指标,该 API 支持许多频道和内容所有者报告中的这些指标。
2016 年 1 月 6 日
YouTube Reporting API 和 YouTube Analytics API 现在都明确识别通过 Chromecast 设备产生的观看。
2015 年 12 月 21 日
在文档中,annotation_clickable_impressions
和 annotation_closable_impressions
指标的名称已更新为与报告中返回的名称一致。以前,这些名称记录为 clickable_annotation_impressions
和 closable_annotation_impressions
。
2015 年 12 月 18 日
根据欧盟 (EU) 法律,您必须向欧盟境内的最终用户披露相关信息并征求他们的意见。因此,对于欧盟境内的最终用户,您必须遵守《欧盟地区用户意见征求政策》。我们已在 YouTube API 服务条款中添加了关于此要求的通知。
2015 年 12 月 15 日
此更新包含以下变更,所有这些变更都会影响 YouTube 数据分析 API:
2015 年 11 月 10 日
此更新包含以下更改:
2015 年 10 月 29 日
此更新包含以下更改:
2015 年 10 月 8 日
此更新包含以下更改:
2015 年 9 月 24 日
此更新包含以下更改:
2015 年 8 月 20 日
此更新包含以下更改:
2015 年 7 月 22 日
此次更新包含多项变更,所有这些变更仅适用于内容所有者:
2015 年 6 月 1 日
此更新包含以下更改:
2015 年 3 月 31 日
此更新包含以下更改:
2015 年 3 月 16 日
此更新包含以下更改:
2015 年 2 月 25 日
此更新包含以下更改:
2015 年 2 月 13 日
此更新包含以下更改:
2014 年 8 月 28 日
此更新包含以下更改:
2014 年 7 月 16 日
此更新包含以下更改:
2014 年 1 月 31 日
此更新包含以下更改:
2014 年 1 月 16 日
此更新包含以下更改:
2014 年 1 月 6 日
此更新包含以下更改:
2013 年 9 月 30 日
此更新包含以下更改:
2013 年 7 月 16 日
此更新包含以下更改:
2013 年 5 月 23 日
此更新包含以下更改:
2013 年 5 月 10 日
此更新包含以下更改:
2013 年 5 月 6 日
此更新包含以下更改:
2013 年 5 月 3 日
此更新包含以下更改:
2013 年 3 月 28 日
此更新包含以下更改:
2013 年 3 月 21 日
此更新包含以下更改:
2013 年 2 月 4 日
此更新包含以下更改:
2012 年 11 月 14 日
此更新包含以下更改:
2012 年 10 月 2 日
此更新包含以下更改:
2012 年 9 月 12 日
此更新包含以下更改: