本页面列出了 YouTube Reporting API 和 YouTube Analytics API 的 API 变更和文档更新。这两种 API 都能让开发者以不同的方式访问 YouTube 数据分析数据。订阅此更新记录。
2024 年 5 月 6 日
YouTube Analytics(定位查询)API 支持三种新的频道报告:
-
按特定媒体市场区域列出的用户活动 报告是按特定市场区域提供用户活动统计信息的地理位置报告 (DMA)。对于此报告,您必须将
filters
参数值设为country==US
。 -
同时观看人数 报告会显示同一次直播视频的不同部分同时观看人数 视频。
-
取消会员 报告提供了相关统计信息,显示用户取消订阅的原因 频道会员。
此报告使用新的
membershipsCancellationSurveyReason
维度,用于指定用户取消频道会员身份的原因。它还使用了新的membershipsCancellationSurveyResponses
指标,反映有多少频道会员功能因相应原因而被取消。
此外,受众群体 留存率报告有所改进,可支持三种新指标:
2024 年 4 月 7 日
YouTube Analytics(定位查询)API 有几项与内容所有者相关的更新 播放列表报告。这些更新与频道播放列表报告的相关更新相同 已于 2024 年 1 月 19 日宣布推出。
下面的修订历史记录条目提供了几乎
与 2024 年 1 月 19 日的参评申请中的信息相同。但请注意
播放列表报告将支持
isCurated
个维度,直到
2024 年 12 月 31 日,此维度在 2024 年 12 月 31 日之前仍可用于频道播放列表报告
2024 年 6 月 30 日。
-
注意:这是弃用通知。
isCurated
维度已弃用。以后不会再 2024 年 12 月 31 日当天或之后提供支持。该维度的定义已更新 。如需在移除
isCurated
时保持向后兼容性,请执行以下操作: 维度,您还必须更新代码以检索playlistViews
指标 ,而不再是仅适用于播放列表报告的views
指标。自views
以来 指标仍然适用于播放列表报告,虽然它们的含义不同, 如果您没有更新指标名称,系统仍会返回数据。当然,您可以修改自己的应用 检索并显示views
和playlistViews
。除了
isCurated
维度之外,以下 API 功能还可 不再支持在新版报告中:continent
和subcontinent
等位置过滤条件不适用 支持新的频道播放列表报告。- “
redViews
”和“estimatedRedMinutesWatched
”指标不再 支持新的频道播放列表报告。这些指标目前尚未在 YouTube 工作室中提供, 因此,此更改可使 API 功能与 Studio 应用中的功能保持一致。 subscribedStatus
和youtubeProduct
维度不再 可用作频道播放列表报告的过滤条件这些过滤条件尚未在下列国家/地区推出 因此,本次变更使 API 功能与 Studio 应用
-
播放列表报告 部分已更新,以更全面地说明 播放列表报告支持的指标类型:
-
播放列表报告支持下列新的播放列表内指标: 内容所有者。请注意,这些指标仅在 API 请求检索 因此报告不会使用
isCurated
维度。请参阅 metrics 每个指标的定义: -
views
的行为 指标现在取决于检索播放列表报告的 API 请求是否使用了 “isCurated
”维度:- 如果请求包含
isCurated
维度,则 “views
”指标属于播放列表内 该指标表示相应视频在 内容所有者的播放列表。 - 如果请求不包含
isCurated
维度, “views
”指标是一个汇总的视频指标,用于指定 观看次数中视频被观看的次数 - 。总计数据仅包含 与拥有播放列表的频道相关联的内容所有者所拥有的视频。
在这些不使用“isCurated
”维度的报告中, “playlistViews
”指标表示视频的观看次数 。该指标会统计播放列表中所有视频的观看次数 无论它们归哪个频道所有
- 如果请求包含
-
对于每种播放列表报告, 内容所有者报告 文档现在包含一些表格,这些表格显示了该报告所支持指标,具体取决于 API 请求是否包含
isCurated
维度。请参阅 基于时间的播放列表报告 示例。
2024 年 1 月 19 日
YouTube Analytics(定位查询)API 有几项与频道播放列表相关的更新 报告。这些更新包括一个已弃用的维度以及几个新增指标和指标更新:
-
注意:这是弃用通知。
isCurated
维度在渠道报告中已弃用。自 或 2024 年 6 月 30 日之后该维度的定义已相应更新。如需在移除
isCurated
时保持向后兼容性,请执行以下操作: 维度,您还必须更新代码以检索playlistViews
指标 ,而不再是仅适用于播放列表报告的views
指标。自views
以来 指标仍然适用于播放列表报告,虽然它们的含义不同, 如果您没有更新指标名称,系统仍会返回数据。当然,您可以修改自己的应用 检索并显示views
和playlistViews
。除了
isCurated
维度之外,以下 API 功能还可 不再支持在新版报告中:continent
和subcontinent
等位置过滤条件不适用 支持新的频道播放列表报告。- “
redViews
”和“estimatedRedMinutesWatched
”指标不再 支持新的频道播放列表报告。这些指标目前尚未在 YouTube 工作室中提供, 因此,此更改可使 API 功能与 Studio 应用中的功能保持一致。 subscribedStatus
和youtubeProduct
维度不再 可用作频道播放列表报告的过滤条件这些过滤条件尚未在下列国家/地区推出 因此,本次变更使 API 功能与 Studio 应用
-
播放列表报告 部分已更新,以更全面地说明 播放列表报告支持的指标类型:
-
频道的播放列表报告支持以下新的播放列表内指标。 内容所有者报告尚不支持这些指标。请注意,这些指标 仅当检索报告的 API 请求不使用
isCurated
维度。请参阅 metrics 每个指标的定义: -
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 Analytics(定位查询)API 支持两种新维度和一个新报告:
-
新报告可按城市显示用户活动。此报告适用于 channels 和 内容所有者。 此报告包含新的
city
维度,用于标识 YouTube 对发生用户活动所在的城市的估算值。 -
全新
creatorContentType
维度可确定与用户活动相关联的 YouTube 内容类型 指标。支持的值包括LIVE_STREAM
、SHORTS
、STORY
和VIDEO_ON_DEMAND
。所有系统都支持将“
creatorContentType
”维度用作可选维度 频道和内容所有者的视频报告。 -
YouTube Analytics API 请求示例指南现在提供了两种新维度的示例。
-
已引用
7DayTotals
和30DayTotals
维度 已从文档中移除。我们已于 10 月宣布弃用这些维度 2019 年。
2022 年 8 月 26 日
YouTube Analytics(定位查询)API 和 YouTube Reporting(批量报告)API 支持新的流量来源详情值:
- 在 YouTube Analytics API(定位查询)API 中,如果
insightTrafficSourceType
维度的值为SUBSCRIBER
,则insightTrafficSourceDetail
值可设为podcasts
,这表示流量是从 播客目标网页。 - 在 YouTube Reporting (Bulk Reports) API 中,如果
traffic_source_type
维度的值为3
,则traffic_source_detail
值 可设置为podcasts
,表示流量是从 播客目标网页。
2022 年 2 月 11 日
“gender
”维度的这组有效值将于 8 月或之后发生变化
2022 年 11 月 11 日。这可能是 API 实现中向后不兼容的更改。为了与
后退
不兼容的变更部分,此项变更为
会在生效前六个月公布。请更新您的 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 (Bulk Reports) API。
- 在 YouTube Analytics(定位查询)API 中,
averageViewDuration
和averageViewPercentage
均排除循环剪辑 截至 2021 年 12 月 13 日的流量。 - 在 YouTube Reporting (Bulk Reports) API 中,
average_view_duration_seconds
和average_view_duration_percentage
均排除循环剪辑 截至 2021 年 12 月 13 日的流量。
2022 年 2 月 2 日
此 YouTube Reporting (Bulk Reports) API 支持新的流量来源维度值, 表示相应观看次数来自 直播跳转:
- 在 YouTube Reporting (Bulk Reports) 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 (Bulk Reports) API 中,
traffic_source_type
维度支持24
值。
流量来源详情维度:
insightTrafficSourceDetail
(在 YouTube Analytics API 中)或
traffic_source_detail
在 YouTube Reporting API 中)对于这种新的流量来源类型,不会填充。
2020 年 7 月 20 日
此更新涵盖两项会影响 YouTube Analytics(定位查询)API 的更改:
- YouTube 分析工具报告的大小上限 实体已从 200 个增加到 500 个。
reports.query
方法的filters
参数用于标识在检索 YouTube 数据分析时应该应用的过滤器列表 数据。参数支持为video
,playlist
, 和channel
过滤条件,而 为这些过滤器指定的 ID 数量上限已从 200 个增加到 500 个。
2020 年 2 月 13 日
此更新包含与 YouTube 数据分析(定位的查询)相关的以下更改 API 和 YouTube Reporting (Bulk Reports) 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
,此行表示
观看者点击视频上传时发送的推送通知而产生的结果。
2019 年 10 月 15 日
此更新包含以下与 YouTube Analytics(定位查询)API 相关的更改:
-
注意:这是弃用通知。
YouTube 将不再支持
7DayTotals
和30DayTotals
维度。在 2020 年 4 月 15 日之前,您仍然可以使用这些维度检索数据。在该日期当天或之后,如果尝试使用7DayTotals
或30DayTotals
维度获取报告,则会返回错误。请注意,用户可以使用
day
维度进行查询,然后汇总或派生 7 天或 30 天时间段的数据,从而重现这些维度的部分数据。例如:- 通过汇总该时间段内每天的观看次数,可以计算出 7 天内的观看次数。
- 用每天的观看次数与某一天的 ViewerPercentage 乘积,可得到在当天观看视频时登录的观众数量,从而计算出 7 天内的 ViewerPercentage。然后,将整个时间段内的已登录观看者人数相加,除以该时间段的总观看次数,即可得出整个时间段的 ViewerPercentage。
- 无法计算 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 的以下更改:
- 以下方法的范围要求已更改:
<ph type="x-smartling-placeholder">
- </ph>
- 对
reports.query
方法的请求必须有权访问https://www.googleapis.com/auth/youtube.readonly
范围。 - 对
groupItems.list
方法的请求必须有权访问以下内容: <ph type="x-smartling-placeholder">- </ph>
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 (Bulk Reports) API 相关的以下更改:
- 以下变更目前预定于 2018 年 7 月生效,新政策将在全球范围内应用于所有报告和报告作业。
-
此变更生效后,大多数 API 报告(包括回填报告)将在生成之日后保留 60 天。不过,包含历史数据的报告将在生成之日后保留 30 天。
在本次公告发布之前,所有 API 报告在生成之日后都已保留 180 天。需要说明的是,此项政策变更生效后,超过 30 天的历史数据报告也将无法再通过该 API 访问。也无法再访问其他所有超过 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 (v2) 版本 2 现已公开发布。以下列表列出了与新 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
)使用驼峰式大小写格式 (endDate
),而不是在 v2 API 中使用连字符。此更改会使参数名称在整个 API 中保持一致,因为 API 的创建和管理组的方法已经为参数名称使用了驼峰式大小写格式。- v2 API 不支持发送到 Google 的全球 HTTP 批量端点 (
www.googleapis.com/batch
) 的批量请求。如果您使用 v2 API 发送批量请求,则需要改用端点https://youtubeanalytics.googleapis.com/v2
。
此外,还有一些 v1 功能在 v2 API 中不受支持:
reports.query
方法不再支持alt
、quotaUser
和userIp
请求参数。- v2 API 未提供支持由向不同 API 发出的请求组成的批次的批处理端点。(不过,一个批次可以包含对同一 API 的不同方法的请求。)此次弃用并非特定于 YouTube Analytics API,因为 Google 即将弃用其所有 API 中的全球批量端点。
- v2 API 不支持 JSON-RPC 协议,而 API v1 支持该协议。再次说明,此次弃用并非仅针对 YouTube Analytics API。
- API 的版本已从
-
注意:这是弃用通知。
版本 1 的 API (v1) 现已弃用,一直持续到 2018 年 10 月 31 日。向 v1 API 发出的所有请求都将在该日期后停止运行。因此,请务必在 2018 年 10 月 31 日之前升级到 v2 API,以免中断您通过该 API 访问 YouTube 数据分析数据的能力。
2018 年 2 月 21 日
此更新包含对 YouTube Analytics(定位查询)API 的以下更改:
- 观众特征报告,这种报告根据观看者的年龄段和性别不再支持
youtubeProduct
维度,该维度用于标识发生用户活动的 YouTube 服务。
2018 年 1 月 18 日
此更新包含以下更改:
-
YouTube Reporting API(批量报告)
operating_system
维度用于标识发生观看的设备的软件系统,现在支持以下值: <ph type="x-smartling-placeholder">- </ph>
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 月 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 游戏87
: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
维度用于标识发生观看的设备的软件系统,现在支持以下值: <ph type="x-smartling-placeholder">- </ph>
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
”维度支持三个新的维度值: <ph type="x-smartling-placeholder">- </ph>
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 中的数字大一个数字。(这些报告的旧版本现已弃用,如本修订历史记录后面部分所述。)例如,
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 天内仍可访问。如 2016 年 5 月 19 日的修订历史记录条目中所述,
content_owner_basic_a1
报告将替代content_owner_basic_a2
报告。 -
新发布的《YouTube API 服务的服务条款》(简称“更新后的条款”)在 YouTube 工程和开发者博客中进行了详细讨论,提供了大量对现行《服务条款》的更新。除了更新后的条款(将于 2017 年 2 月 10 日生效)之外,此次更新还包含一些支持文档,以帮助解释开发者必须遵守的政策。
如需了解完整的新文档,请参阅更新后的条款的修订历史记录。此外,将来对更新条款或支持文档进行的更改也会在修订历史记录中说明。您可以通过 RSS Feed 中的链接订阅修订历史记录中列有更改的内容。
-
YouTube Analytics API(定位查询)
-
注意:这是弃用通知。
下表中的指标即将弃用。与此同时,引入了引用相同数据的新指标。实际上,这意味着旧指标将被重命名,但 YouTube Analytics 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
”维度支持以下两个新的维度值: <ph type="x-smartling-placeholder">- </ph>
CAMPAIGN_CARD
:只有内容所有者报告支持此流量来源。它表示观看次数源自已声明版权的用户上传视频,内容所有者用于宣传所观看的内容。END_SCREEN
:此数据涉及源于另一视频的片尾画面的观看次数。
对于这两种新的流量来源,您还可以检索到
traffic source detail
报告。在这两种情况下,insightTrafficSourceDetail
维度均标识观看者通过哪个视频被推介。 -
adType
维度现在支持值auctionBumperInstream
,该值表示一个时长不超过 6 秒的不可跳过的视频广告,在用户观看视频之前播放。
-
-
YouTube Reporting API(批量报告)
- “
traffic_source_type
”维度现在支持以下值: <ph type="x-smartling-placeholder">- </ph>
19
:只有内容所有者报告支持此流量来源。它表示观看次数源自已声明版权的用户上传视频,内容所有者用于宣传所观看的内容。20
:此数据涉及源于另一视频的片尾画面的观看次数。
对于这两个新流量来源,
traffic_source_detail
维度均标识了观看者被引荐到的视频。 -
更正了 API 的核心指标列表,将
estimated_partner_revenue
列为核心指标,并从该列表中移除了earnings
。(YouTube Reporting API 从不支持“earnings
”指标)。 -
ad_type
维度现在支持使用19
值,该值指的是导视广告。导视广告是一种不可跳过的视频广告,时长上限为 6 秒,在用户观看视频前播放。
- “
-
YouTube Analytics API(定位查询)
- 我们更新了以下渠道报告支持的指标列表,在其中添加了卡片指标。我们实际上是在 2016 年 6 月 28 日添加了对这些报告中的卡片指标的支持,该日期的修订历史记录条目更详细地说明了更改。这些报告是:
<ph type="x-smartling-placeholder">
- </ph>
- 美国各州的基本用户活动
- 特定时间段内美国各州的用户活动
- 用户活动(按省份)
- 用户活动(按订阅状态划分)
- 各省/自治区/直辖市的用户活动(按订阅状态划分)
- 各州的热门视频
- 吸引已订阅或未订阅观看者的热门视频
-
我们更正了频道观众黏度报告和内容所有者观众黏度报告的过滤条件列表,以表明必须使用
video
过滤条件,而不支持group
过滤条件。之前,两种报告的文档均错误地指出,可以使用这两种过滤器之一或不使用这两种过滤器来检索报告。
- 我们更新了以下渠道报告支持的指标列表,在其中添加了卡片指标。我们实际上是在 2016 年 6 月 28 日添加了对这些报告中的卡片指标的支持,该日期的修订历史记录条目更详细地说明了更改。这些报告是:
<ph type="x-smartling-placeholder">
-
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
报告已被弃用。如果您有与该报告相关的作业,那么在 2016 年 8 月 19 日之后,YouTube 应该不会再为该作业生成新的报告。生成的报告在生成后的 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 不提供任何历史数据。此更改会影响所有职位,包括在本公告之前创建的职位。
历史报表可用后立即发布,但作业的所有历史数据发布大约需要一个月的时间。因此,在安排报告作业后的一个月内,您可以访问大约七个月的数据。(对于在本公告发布之前创建的职位,所有历史数据均应在本公告发布后的一个月内发布。)
请注意,系统仅提供 2015 年 7 月 1 日之后的历史数据。因此,对于 2015 年 12 月 28 日之前创建的职位,历史数据将少于 180 天。
报告 API 概览中新增的历史数据部分说明了所有这些更改。
-
我们更新了 YouTube Reporting API 概览的报告特征部分,纳入了以下更改:
-
该文档现在指出,报告在生成后的 180 天内可用,因此 API 客户端可供下载。此前文档指出,报告最早可追溯到 API 请求发送之日前六个月。
-
为反映这一情况,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
维度支持以下新值: <ph type="x-smartling-placeholder">- </ph>
82
:iOS 系统 activity 对话框83
:Google 收件箱84
:Android Messenger
- 在 YouTube Analytics API 中,
sharingService
维度支持以下新值: <ph type="x-smartling-placeholder">- </ph>
ANDROID_MESSENGER
:Android MessengerINBOX
:Google 收件箱IOS_SYSTEM_ACTIVITY_DIALOG
:iOS 系统 activity 对话框
- “
playback_location_type
”维度支持以下两个新的维度值: <ph type="x-smartling-placeholder">- </ph>
7
:此数据与 YouTube 首页或主屏幕上、用户的订阅 Feed 中或其他 YouTube 浏览功能中产生的观看次数有关。8
:此数据涉及 YouTube 搜索结果页上直接产生的观看次数。
- “
traffic_source_type
”维度现在支持将18
用作维度值。此值表示视频观看次数源自列出播放列表中所有视频的网页。此来源与来源类型14
不同,后者表示视频在作为播放列表的一部分播放时发生。 - “
insightPlaybackLocationType
”维度支持以下两个新的维度值: <ph type="x-smartling-placeholder">- </ph>
BROWSE
:此数据与 YouTube 首页或主屏幕上、用户的订阅 Feed 中或其他 YouTube 浏览功能中产生的观看次数有关。SEARCH
:此数据涉及 YouTube 搜索结果页上直接产生的观看次数。
- “
insightTrafficSourceType
”维度现在支持将YT_PLAYLIST_PAGE
用作维度值。此值表示视频观看次数源自列出播放列表中所有视频的网页。此来源与PLAYLIST
来源类型不同,后者表示观看是在作为播放列表的一部分播放时发生的。 - 在 YouTube Reporting API 中,“
operating_system
”维度使用值21
来标识通过 Chromecast 观看的次数。 - 在 YouTube Analytics API 中,
operatingSystem
维度使用值CHROMECAST
来标识通过 Chromecast 进行的观看。 -
YouTube Analytics API 现在支持 3 种新的播放详情维度,它们可用于各种频道报告和内容所有者报告:
liveOrOnDemand
:此维度可指明报告中的数据是否描述在直播期间发生的用户活动。subscribedStatus
:此维度用于指明数据中的用户活动指标是否与订阅了视频或播放列表频道的观看者相关联。youtubeProduct
:此维度用于标识发生用户活动的 YouTube 媒体资源。可能的值包括核心 YouTube 网站(或 YouTube 应用)、YouTube Gaming 和 YouTube Kids。
本文档已更新,指出了可供频道和内容所有者使用的新播放详情报告。此外,许多其他报告也已更新,以指明其中的一个或多个维度可以选择在这些报告中用作维度和/或过滤条件。
-
用于说明报告的表格的格式已更改,以便您更轻松地确定可用于检索各个报告的维度、指标和过滤条件的有效组合。下表,对“设备类型”进行了解释渠道报告,会显示新格式:
目录 尺寸: 必填 deviceType 请使用 0 或更多 day、liveOrOnDemand、subscribedStatus、youtubeProduct 指标: 使用 1 个或更多 views、estimatedMinutesWatched 过滤器: 请使用 0 或 1 country、等省、大洲、subContinent 请使用 0 或 1 video、group 请使用 0 或更大的数字 operatingSystem、liveOrOnDemand、subscribedStatus、youtubeProduct -
现在,YouTube Analytics API 会自动删除 API 用户无法从支持多个值(
video
、playlist
和channel
)的过滤条件中检索到的实体数据。以前,如果 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 Analytics API 现在支持
redPartnerRevenue
指标,该指标可针对选定的报告维度报告通过 YouTube Red 订阅赚取的估算收入总额。该指标的值反映的是音乐和非音乐内容带来的收入,可能会在月底调整。YouTube Analytics API 的内容所有者报告列表已更新,可标识支持
redPartnerRevenue
指标的视频报告: -
YouTube Analytics API 的热门视频报告定义现在表明,此报告还支持以下收入指标:
earnings
、adEarnings
、grossRevenue
、monetizedPlaybacks
、playbackBasedCpm
、impressions
和impressionBasedCpm
。 -
YouTube Reporting API 的
date
维度文档已更正,以反映从太平洋时间 (UTC-8) 零点开始的 24 小时时间段。之前,文档指出该日期从凌晨 12:00(格林尼治标准时间)开始。此外,YouTube Analytics API 文档也已更新,以指出所有与日期相关的维度(
day
、7DayTotals
、30DayTotals
和month
)均指从太平洋时间 (UTC-8) 零点开始的日期。 -
YouTube Reporting API 的
jobs.reports.list()
方法现在支持createdAfter
查询参数。如果已指定,则此参数表示 API 响应应仅列出在指定日期和时间之后创建的报告,包括含有回填数据的新报告。请注意,此参数值与报告的创建时间相关,而不是与返回数据关联的日期相关。参数值是采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)的时间戳格式精确到微秒。示例:
"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 数据分析数据的批量数据报告。它专为可以导入大型数据集以及提供用于过滤、排序和挖掘数据的工具的应用而设计。
每个 YouTube Reporting API 报告都包含一组预定义的维度和指标。(YouTube Analytics API 报告也使用指标和维度。)在报告中,每行数据都有一个唯一的维度值组合。您可以根据维度值来汇总各行的数据,以计算单个视频、国家/地区、直播视频、订阅用户等的指标。
您可以使用 API 安排报告作业的生成时间,每个报告作业都标识了 YouTube 应生成的报告。设置好作业后,YouTube 会生成可异步下载的每日报告。每份报告都包含唯一 24 小时的数据。
-
虽然 YouTube Analytics API 和 YouTube Reporting API 是不同的 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
资源代表一个 Analytics 群组,即一个最多包含 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 Analytics API 现在需遵循服务条款中所述的弃用政策。不过,该 API 的非核心维度和非核心指标不受弃用政策的约束。我们更新了维度和指标页面,在其中列出了核心维度和核心指标。此外,这些页面上的定义也已更新,以明确标识核心维度和指标。
-
该 API 现在支持将
EXTERNAL_APP
用作insightPlaybackLocationType
维度的值。经过此次更新,自 2013 年 9 月 10 日起,系统将不再将播放归类为MOBILE
播放,但在该日期之前发生的移动播放仍会归类为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 首页 Feed 或 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 支持许多针对频道和内容所有者的新报告,如下所述。每种报告都以频道报告或内容所有者报告的形式提供。维度和指标页面也进行了相应更新。
-
播放位置报告会指明在不同类型的网页或应用上产生的视频观看次数。
-
播放位置详情报告可找出为指定视频带来最多观看次数的嵌入式播放器。它通过识别与热门嵌入式播放器关联的网址,提供比播放位置报告更精细的视图。
-
流量来源报告可确定源自不同类型的引荐来源网址的视频观看次数。
-
流量来源详情报告可找出为指定视频和指定流量来源类型带来了最多观看次数的引荐来源网址。例如,此报告可能包含为某个特定视频带来最多流量的相关视频。此报告支持多个流量来源。
-
观看时长报告提供了观看者观看您的内容所花费的时间。这些报告可以汇总特定时间范围(例如某一天、过去 7 天、过去 30 天等)或国家/地区的数据。如果报告按日期或国家/地区汇总数据,则还可以指定每次视频观看的平均时长以及用户观看的每个视频的平均百分比。
-
-
YouTube Analytics API现已面向所有开发者提供。您可以从 APIs console 的服务面板中为项目激活此 API,而无需先请求访问权限。
-
新的使用入门部分概述了构建使用 YouTube Analytics API 的应用所需满足的前提条件和基本步骤。
-
新的了解配额使用情况部分提供了有关优化 API 配额使用情况的准则。API 服务器会计算每个请求的查询费用,该费用将从您的 API 使用配额中扣除。由于不同类型的报告具有截然不同的查询费用,因此您应计划高效利用配额,并且您的应用应仅请求其实际需要的指标和数据。
-
时间维度部分已更新,以指明这些维度用于指明 Google Analytics 报告应按时间段汇总数据。现在,该 API 支持以下其他时间维度:
7DayTotals
– 报告中的数据会经过汇总,因此每行都包含 7 天的数据。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 Analytics 批量报告的过程略有不同,因为合作伙伴无需安排作业即可生成报告。
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 Analytics 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 Analytics 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 日
此更新包含以下更改: