Class ReportRequest

A request object used to create a DoubleClick Search report.

Inheritance
object
ReportRequest
Implements
Inherited Members
Namespace: Google.Apis.Doubleclicksearch.v2.Data
Assembly: Google.Apis.Doubleclicksearch.v2.dll
Syntax
public class ReportRequest : IDirectResponseSchema

Properties

Columns

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.

Declaration
[JsonProperty("columns")]
public virtual IList<ReportApiColumnSpec> Columns { get; set; }
Property Value
Type Description
IList<ReportApiColumnSpec>

DownloadFormat

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

Declaration
[JsonProperty("downloadFormat")]
public virtual string DownloadFormat { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Filters

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

Declaration
[JsonProperty("filters")]
public virtual IList<ReportRequest.FiltersData> Filters { get; set; }
Property Value
Type Description
IList<ReportRequest.FiltersData>

IncludeDeletedEntities

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

Declaration
[JsonProperty("includeDeletedEntities")]
public virtual bool? IncludeDeletedEntities { get; set; }
Property Value
Type Description
bool?

IncludeRemovedEntities

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

Declaration
[JsonProperty("includeRemovedEntities")]
public virtual bool? IncludeRemovedEntities { get; set; }
Property Value
Type Description
bool?

MaxRowsPerFile

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.

Declaration
[JsonProperty("maxRowsPerFile")]
public virtual int? MaxRowsPerFile { get; set; }
Property Value
Type Description
int?

OrderBy

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.

Declaration
[JsonProperty("orderBy")]
public virtual IList<ReportRequest.OrderByData> OrderBy { get; set; }
Property Value
Type Description
IList<ReportRequest.OrderByData>

ReportScope

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.

Declaration
[JsonProperty("reportScope")]
public virtual ReportRequest.ReportScopeData ReportScope { get; set; }
Property Value
Type Description
ReportRequest.ReportScopeData

ReportType

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.

Declaration
[JsonProperty("reportType")]
public virtual string ReportType { get; set; }
Property Value
Type Description
string

RowCount

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

Declaration
[JsonProperty("rowCount")]
public virtual int? RowCount { get; set; }
Property Value
Type Description
int?

StartRow

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

Declaration
[JsonProperty("startRow")]
public virtual int? StartRow { get; set; }
Property Value
Type Description
int?

StatisticsCurrency

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

Declaration
[JsonProperty("statisticsCurrency")]
public virtual string StatisticsCurrency { get; set; }
Property Value
Type Description
string

TimeRange

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

Declaration
[JsonProperty("timeRange")]
public virtual ReportRequest.TimeRangeData TimeRange { get; set; }
Property Value
Type Description
ReportRequest.TimeRangeData

VerifySingleTimeZone

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

Declaration
[JsonProperty("verifySingleTimeZone")]
public virtual bool? VerifySingleTimeZone { get; set; }
Property Value
Type Description
bool?

Implements