File

  • A File resource holds the metadata for a report run and URLs to generated report data when the status is "REPORT_AVAILABLE".

  • The JSON representation of a File includes fields such as id, reportId, status, fileName, dateRange, format, and urls.

  • The status of a report file can be PROCESSING, REPORT_AVAILABLE, FAILED, CANCELLED, or QUEUED.

  • A DateRange specifies the time period for report data using start and end dates or a relative date range.

  • Report file data is available in either CSV or EXCEL 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 
{
  "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

Format

Enums
CSV
EXCEL