Reports

report 资源用于标识报告的特定实例。该资源用于标识报告包含数据的时间段,以及可供下载报告的网址。

方法

下表显示了该 API 针对 report 资源支持的方法。

方法
get 检索特定报告的元数据。
list 列出已为指定报告作业生成的报告。

JSON 资源表示法

以下 JSON 结构显示了 report 资源的格式:

{
  "id": string,
  "jobId": string,
  "startTime": timestamp,
  "endTime": timestamp,
  "createTime": timestamp,
  "jobExpireTime": timestamp,
  "downloadUrl": string
}

属性

下表定义了此资源中显示的属性:

属性
id string
YouTube 为唯一标识举报而分配的 ID。每份报告都与一个作业相关联,但一个作业可能与多个报告 ID 相关联。
jobId string
创建相应报告的作业的 ID。
startTime timestamp
报告实例涵盖的时间段的开始时间。包含性值是采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式的时间戳,精确到微秒。示例:"2015-10-02T15:01:23.045678Z"。
endTime timestamp
报告实例涵盖的时间段的结束时间。不含上限的值是采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,精确到微秒。示例:"2015-10-02T15:01:23.045678Z"。
createTime timestamp
作业的创建日期和时间。该属性值是采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,精确到微秒。示例:"2015-10-02T15:01:23.045678Z"。
jobExpireTime timestamp
与报告关联的作业的过期日期和时间,或将要过期的日期和时间。该属性值是采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式的时间戳,精确到微秒。示例:"2015-10-02T15:01:23.045678Z".

如果与报告作业关联的报告类型已被弃用,或者为该作业生成的报告长时间未被下载,则此属性具有相应的值。此值表示 YouTube 将不再为相应作业生成新报告的日期。

如果您有指定了过期日期的作业,则应更新系统,以便在过期日期之前停止请求报告。在某些情况下,您可以获取替代报告。
downloadUrl string
可供下载报告的网址。属性值的最大长度为 1, 000 个字符。

如需检索报告,请向此网址发送 HTTP GET 请求。在请求中,使用您的授权令牌作为标头值,设置 Authorization HTTP 请求标头。

使用 gzip

您可以在下载请求中启用 gzip 压缩,以减少下载报告所需的带宽。虽然您的应用需要额外的 CPU 时间来解压缩 API 响应,但消耗更少的网络资源带来的好处通常会超过这一成本。

如需接收 gzip 编码的响应,请将 Accept-Encoding HTTP 请求标头设置为 gzip,如以下示例所示:

Accept-Encoding: gzip