File

JSON representation
Status
DateRange
- JSON representation
RelativeDateRange
Format

Represents a File resource. A file contains the metadata for a report run. It shows the status of the run and holds the URLs to the generated report data if the run is finished and the status is

"REPORT_AVAILABLE"

JSON representation

JSON representation
{ "id": string, "reportId": string, "etag": string, "status": enum (`Status`), "fileName": string, "kind": string, "dateRange": { object (`DateRange`) }, "format": enum (`Format`), "lastModifiedTime": string, "urls": { "browserUrl": string, "apiUrl": string } }

{
  "id": string,
  "reportId": string,
  "etag": string,
  "status": enum (Status),
  "fileName": string,
  "kind": string,
  "dateRange": {
    object (DateRange)
  },
  "format": enum (Format),
  "lastModifiedTime": string,
  "urls": {
    "browserUrl": string,
    "apiUrl": string
  }
}

Fields
`id`	`string (int64 format)` The unique ID of this report file.
`reportId`	`string (int64 format)` The ID of the report this file was generated from.
`etag`	`string` Etag of this resource.
`status`	`enum (Status)` The status of the report file.
`fileName`	`string` The filename of the file.
`kind`	`string` Identifies what kind of resource this is. Value: the fixed string `"dfareporting#file"` .
`dateRange`	`object (DateRange)` The date range for which the file has report data. The date range will always be the absolute date range for which the report is run.
`format`	`enum (Format)` The output format of the report. Only available once the file is available.
`lastModifiedTime`	`string (int64 format)` The timestamp in milliseconds since epoch when this file was last modified.
`urls`	`object` The URLs where the completed report file can be downloaded.
`urls.browserUrl`	`string` The URL for downloading the report data through a browser.
`urls.apiUrl`	`string` The URL for downloading the report data through the API.

Status

Enums
`PROCESSING`
`REPORT_AVAILABLE`
`FAILED`
`CANCELLED`
`QUEUED`

DateRange

Represents a date range.

JSON representation
{ "startDate": string, "endDate": string, "relativeDateRange": enum (`RelativeDateRange`), "kind": string }

Fields
`startDate`	`string` The start date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
`endDate`	`string` The end date of the date range, inclusive. A string of the format: "yyyy-MM-dd".
`relativeDateRange`	`enum (RelativeDateRange)` The date range relative to the date of when the report is run.
`kind`	`string` The kind of resource this is, in this case `dfareporting#dateRange` .

RelativeDateRange

Enums
`TODAY`
`YESTERDAY`
`WEEK_TO_DATE`
`MONTH_TO_DATE`
`QUARTER_TO_DATE`
`YEAR_TO_DATE`
`PREVIOUS_WEEK`
`PREVIOUS_MONTH`
`PREVIOUS_QUARTER`
`PREVIOUS_YEAR`
`LAST_7_DAYS`
`LAST_30_DAYS`
`LAST_90_DAYS`
`LAST_365_DAYS`
`LAST_24_MONTHS`
`LAST_14_DAYS`
`LAST_60_DAYS`

Format

Enums
`CSV`
`EXCEL`