ReportRequest class

A request object used to create a DoubleClick Search report.

Constructors

ReportRequest()
ReportRequest.fromJson(Map _json)

Properties

columns List<ReportApiColumnSpec>
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.
read / write
downloadFormat String
Format that the report should be returned in. Currently csv or tsv is supported.
read / write
filters List<ReportRequestFilters>
A list of filters to be applied to the report.
read / write
includeDeletedEntities bool
Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.
read / write
includeRemovedEntities bool
Determines if removed entities should be included in the report. Defaults to false.
read / write
maxRowsPerFile int
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.
read / write
orderBy List<ReportRequestOrderBy>
Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.
read / write
reportScope ReportRequestReportScope
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.
read / write
reportType String
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.
read / write
rowCount int
Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to [...]
read / write
startRow int
Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0.
read / write
statisticsCurrency String
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).
read / write
timeRange ReportRequestTimeRange
If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
read / write
verifySingleTimeZone bool
If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

toJson() Map
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited