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
可供下载报告的网址。属性值的长度上限为 1000 个字符。

要检索报告，请向此网址发送 HTTP GET 请求。在请求中，设置 Authorization HTTP 请求标头，并将您的授权令牌用作标头值。

使用 gzip

您可以对下载请求启用 gzip 压缩，从而减少下载报告所需的带宽。虽然您的应用将需要额外的 CPU 时间来对 API 响应进行解压缩，但所用网络资源消耗的代价通常大于这一代价。

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

Accept-Encoding: gzip