type ReportDownloadOptions (v202411)

  • ReportDownloadOptions represents the choices available when requesting a report download through the API.

  • You can select the report's format (CSV, TSV, XML, XLSX), control the inclusion of report properties and totals, and decide on gzip compression.

  • The default export format is CSV_DUMP, which is optimized for automated processing and lacks formatting and totals.

  • Currency values in reports are displayed as micros and follow specific formatting based on the currency type and API version.

  • Dates and times in reports adhere to the ISO 8601 standard for consistency.
Service
ReportService
Dependencies
getReportDownloadUrlWithOpt...
▼
ReportDownloadOptions

Represents the options for an API report download request. See ReportService.getReportDownloadUrlWithOptions.

Namespace
https://www.google.com/apis/ads/publisher/v202411

Field

exportFormat

ExportFormat

The ExportFormat used to generate the report. Default value is ExportFormat.CSV_DUMP.

Enumerations
TSV
The report file is generated as a list of Tab Separated Values.
TSV_EXCEL
The report file is generated as a list of tab-separated values for Excel.
CSV_DUMP
The report file is generated as a list of Comma Separated Values, to be used with automated machine processing.
  • There is no pretty printing for the output, and no total row.
  • Column headers are the qualified name e.g. "Dimension.ORDER_NAME".
  • Network currency Monetary amounts are represented as micros in the currency of the network.
  • Starting from v201705, local currency Monetary amounts are represented as currency symbol + ' ' + micros.
  • Dates are formatted according to the ISO 8601 standard YYYY-MM-DD
  • DateTimes are formatted according to the ISO 8601 standard YYYY-MM-DDThh:mm:ss[+-]hh:mm
XML
The report file is generated as XML.
XLSX
The report file is generated as an Office Open XML spreadsheet designed for Excel 2007+.

includeReportProperties

xsd:boolean

Whether or not to include the report properties (e.g. network, user, date generated...) in the generated report. Default is false.

includeTotalsRow

xsd:boolean

Whether or not to include the totals row. Default is true for all formats except ExportFormat.CSV_DUMP.

useGzipCompression

xsd:boolean

Whether or not to compress the report file to a gzip file. Default is true.

Regardless of value, gzip http compression is available from the URL by normal means.