v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13111436.5 KB
reports

Generates and returns a report immediately.

post/doubleclicksearch/v2/reports/generate

Request body

rowCountinteger

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

startRowinteger

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

downloadFormatstring

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

includeDeletedEntitiesboolean

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

reportTypestring

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.

verifySingleTimeZoneboolean

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

maxRowsPerFileinteger

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.

statisticsCurrencystring

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

includeRemovedEntitiesboolean

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

Response

Successful response