ReportRequest

import type { ReportRequest } from "https://googleapis.deno.dev/v1/doubleclicksearch:v2.ts";

A request object used to create a DoubleClick Search report.

interface ReportRequest {

columns?: ReportApiColumnSpec[];

downloadFormat?: string;

filters?: {

column?: ReportApiColumnSpec;

operator?: string;

values?: any[];

}[];

includeDeletedEntities?: boolean;

includeRemovedEntities?: boolean;

maxRowsPerFile?: number;

orderBy?: {

column?: ReportApiColumnSpec;

sortOrder?: string;

}[];

reportScope?: {

adGroupId?: bigint;

adId?: bigint;

advertiserId?: bigint;

agencyId?: bigint;

campaignId?: bigint;

engineAccountId?: bigint;

keywordId?: bigint;

};

reportType?: string;

rowCount?: number;

startRow?: number;

statisticsCurrency?: string;

timeRange?: {

changedAttributesSinceTimestamp?: string;

changedMetricsSinceTimestamp?: string;

endDate?: string;

startDate?: string;

};

verifySingleTimeZone?: boolean;

}

§Properties

columns?: ReportApiColumnSpec[]

[src]

The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set in the same stanza.\ The maximum number of columns per request is 300.

downloadFormat?: string

[src]

Format that the report should be returned in. Currently csv or tsv is supported.

filters?: {

column?: ReportApiColumnSpec;

operator?: string;

values?: any[];

}[]

[src]

A list of filters to be applied to the report.\ The maximum number of filters per request is 300.

includeDeletedEntities?: boolean

[src]

Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.

includeRemovedEntities?: boolean

[src]

Determines if removed entities should be included in the report. Defaults to false.

maxRowsPerFile?: number

[src]

Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are 1000000 to 100000000, inclusive.

orderBy?: {

column?: ReportApiColumnSpec;

sortOrder?: string;

}[]

[src]

Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.\ The maximum number of orderings per request is 300.

reportScope?: {

adGroupId?: bigint;

adId?: bigint;

advertiserId?: bigint;

agencyId?: bigint;

campaignId?: bigint;

engineAccountId?: bigint;

keywordId?: bigint;

}

[src]

The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.

reportType?: string

[src]

Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data about a keyword. See the Types of Reports reference for the columns that are available for each type.

rowCount?: number

[src]

Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to 10000.

startRow?: number

[src]

Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.

statisticsCurrency?: string

[src]

Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower), advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower).

timeRange?: {

changedAttributesSinceTimestamp?: string;

changedMetricsSinceTimestamp?: string;

endDate?: string;

startDate?: string;

}

[src]

If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.

verifySingleTimeZone?: boolean

[src]

If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.