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 在该日期后将不再生成该职位相关新报告的日期。

如果您有已确定失效日期的任务,则应在此日期之后更新系统,让 Google 不再要求报告。在某些情况下,系统可能会提供替代报告。
downloadUrl string
可用于下载报告的网址。属性值的长度上限为 1000 个字符。

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

使用 gzip

您可以对下载请求启用 gzip 压缩,以减少下载报告所需的带宽。虽然解压缩 API 响应时您的应用需要花费额外的 CPU 时间,但消耗的网络资源的优势通常大于费用。

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

Accept-Encoding: gzip