Reports.files

“文件”资源是生成报告所用的相关元数据。每个文件都与父报表相关联,且都包含报表执行状态以及指向实际报表数据的网址(执行结束后)的相关信息。

有关此类资源的方法列表,请参阅本页面的结尾部分。

资源表示形式

“文件”资源的表示形式。文件包含生成报表所需的元数据。它会显示生成状态,并在报表生成完毕,状态为“"REPORT_AVAILABLE"”后,保留指向所生成的报表数据的网址。

{
  "kind": "dfareporting#file",
  "etag": etag,
  "reportId": long,
  "id": long,
  "lastModifiedTime": long,
  "status": string,
  "fileName": string,
  "format": string,
  "dateRange": {
    "kind": "dfareporting#dateRange",
    "startDate": date,
    "endDate": date,
    "relativeDateRange": string
  },
  "urls": {
    "browserUrl": string,
    "apiUrl": string
  }
}
属性名称 说明 备注
dateRange nested object 文件内报表数据的日期范围。该日期范围始终是生成报表的绝对日期范围。
dateRange.endDate date 日期范围的结束日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
dateRange.kind string 所属资源种类,在本例中为 dfareporting#dateRange
dateRange.relativeDateRange string 相对于报表生成日期的日期范围。

可接受的值包括:
  • LAST_14_DAYS
  • LAST_24_MONTHS
  • LAST_30_DAYS
  • LAST_365_DAYS
  • LAST_60_DAYS
  • LAST_7_DAYS
  • LAST_90_DAYS
  • MONTH_TO_DATE
  • PREVIOUS_MONTH
  • PREVIOUS_QUARTER
  • PREVIOUS_WEEK
  • PREVIOUS_YEAR
  • QUARTER_TO_DATE
  • TODAY
  • WEEK_TO_DATE
  • YEAR_TO_DATE
  • YESTERDAY
可写入
dateRange.startDate date 日期范围的开始日期(含)。字符串格式为“yyyy-MM-dd”。 可写入
etag etag 此资源的 ETag。
fileName string 文件的名称。
format string 报表的输出格式,仅在提供报表文件后可用。

可接受的值包括:
  • CSV
  • EXCEL
id long 此报表文件的唯一 ID。
kind string 标识所属资源种类。值:固定字符串 "dfareporting#file"
lastModifiedTime long 此文件最后一次修改的时间戳(单位为毫秒,自纪元开始的时间算起)。
reportId long 生成此文件的报表的 ID。
status string 报表文件的状态。

可接受的值包括:
  • CANCELLED
  • FAILED
  • PROCESSING
  • REPORT_AVAILABLE
urls object 可下载已生成报表文件的网址。
urls.apiUrl string 通过 API 下载报表数据用到的网址。
urls.browserUrl string 通过浏览器下载报表数据用到的网址。

方法

您可以列出报表的所有文件,也可以按文件 ID 及其父报表的 ID 获取一个文件。

get
根据报表 ID 和文件 ID 检索报表文件。此方法支持媒体下载
list
列出报告的文件。