File

import type { File } from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";

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".

interface File {

dateRange?: DateRange;

etag?: string;

fileName?: string;

format?: "CSV" | "EXCEL";

id?: bigint;

kind?: string;

lastModifiedTime?: bigint;

reportId?: bigint;

status?:

| "PROCESSING"

| "REPORT_AVAILABLE"

| "FAILED"

| "CANCELLED"

| "QUEUED";

urls?: {

apiUrl?: string;

browserUrl?: string;

};

}

§Properties

dateRange?: DateRange

[src]

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.

etag?: string

[src]

Etag of this resource.

fileName?: string

[src]

The filename of the file.

format?: "CSV" | "EXCEL"

[src]

The output format of the report. Only available once the file is available.

id?: bigint

[src]

The unique ID of this report file.

kind?: string

[src]

Identifies what kind of resource this is. Value: the fixed string "dfareporting#file".

lastModifiedTime?: bigint

[src]

The timestamp in milliseconds since epoch when this file was last modified.

reportId?: bigint

[src]

The ID of the report this file was generated from.

status?: "PROCESSING" | "REPORT_AVAILABLE" | "FAILED" | "CANCELLED" | "QUEUED"

[src]

The status of the report file.

urls?: {

apiUrl?: string;

browserUrl?: string;

}

[src]

The URLs where the completed report file can be downloaded.