type ReportDownloadOptions (v202405)
Represents the options for an API report download request.
See ReportService.getReportDownloadUrlWithOptions.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202405
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-05-15 UTC.
[null,null,["Last updated 2024-05-15 UTC."],[[["`ReportDownloadOptions` represents the choices for downloading an API report, utilized by `ReportService.getReportDownloadUrlWithOptions`."],["It allows customization of the report's format (e.g., CSV, TSV, XML, XLSX), inclusion of report properties and totals row, and gzip compression."],["`ExportFormat.CSV_DUMP` is the default format, offering machine-readable data with specific formatting for currency and date/time values."],["The `includeReportProperties` and `includeTotalsRow` options provide control over additional report content."],["Compression of the report file can be enabled using the `useGzipCompression` option."]]],["The `ReportService` uses `ReportDownloadOptions` to manage API report downloads. Key options include `exportFormat`, which defines the file type (TSV, CSV_DUMP, XML, XLSX), with CSV_DUMP having specific formatting and data representation rules. `includeReportProperties` includes additional report details. `includeTotalsRow` determines if a totals row is present, except for CSV_DUMP. Finally, `useGzipCompression` sets whether the file should be compressed, with HTTP compression being available regardless.\n"]]
