type ReportDownloadOptions (v202402)
Represents the options for an API report download request.
See ReportService.getReportDownloadUrlWithOptions.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202402
Field
|
|
|
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-13 UTC.
[null,null,["Last updated 2024-02-13 UTC."],[[["ReportDownloadOptions represents the choices available when requesting an API report download."],["You can select the format of the report (CSV, TSV, XML, XLSX), control if report properties and totals are included, and if the report should be GZIP compressed."],["The default export format is CSV_DUMP, which is optimized for machine processing and doesn't include formatting or a totals row."],["Reports can include properties like network, user, and generation date by enabling the `includeReportProperties` option."],["GZIP compression is applied by default, making the report file smaller for faster downloads."]]],["The `ReportService` allows downloading reports via `getReportDownloadUrlWithOptions`. `ReportDownloadOptions` controls the download format and content. Key actions include setting `exportFormat` (TSV, TSV_EXCEL, CSV_DUMP, XML, XLSX), `includeReportProperties` (true/false), `includeTotalsRow` (true/false), and `useGzipCompression` (true/false). `exportFormat` dictates file structure (tab-separated, comma-separated, XML, or spreadsheet). CSV_DUMP is for automated processing without totals or pretty formatting. Report properties, totals rows, and gzip compression are configurable.\n"]]
