type ReportDownloadOptions (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Represents the options for an API report download request.
See ReportService.getReportDownloadUrlWithOptions.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
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 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003e\u003ccode\u003eReportDownloadOptions\u003c/code\u003e represents the choices available when requesting an API report download.\u003c/p\u003e\n"],["\u003cp\u003eYou can select the \u003ccode\u003eexportFormat\u003c/code\u003e for the report, with \u003ccode\u003eCSV_DUMP\u003c/code\u003e as the default, and optionally include report properties and a totals row.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003euseGzipCompression\u003c/code\u003e option, enabled by default, allows for compressing the report file, although gzip HTTP compression is always available.\u003c/p\u003e\n"],["\u003cp\u003eThese options are used with the \u003ccode\u003eReportService.getReportDownloadUrlWithOptions\u003c/code\u003e method to customize report downloads.\u003c/p\u003e\n"]]],["The `ReportService` allows downloading reports via `getReportDownloadUrlWithOptions`. `ReportDownloadOptions` control the download format and content. Key options include `exportFormat` (TSV, TSV_EXCEL, CSV_DUMP, XML, XLSX), `includeReportProperties` (add report metadata), `includeTotalsRow` (include a totals row), and `useGzipCompression` (compress the file). The default `exportFormat` is CSV_DUMP. The default of including report properties is false, totals row is true except for CSV_DUMP, and using gzip compression is true.\n"],null,["# type ReportDownloadOptions (v202408)\n\n**Service** \n**ReportService** **Dependencies** \n[getReportDownloadUrlWithOpt...](/ad-manager/api/reference/v202408/ReportService#getReportDownloadUrlWithOptions \"getReportDownloadUrlWithOptions()\") \n▼\n**ReportDownloadOptions**\n\nRepresents the options for an API report download request.\nSee [ReportService.getReportDownloadUrlWithOptions](/ad-manager/api/reference/v202408/ReportService#getReportDownloadUrlWithOptions).\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\n\n| Field ----- ||\n|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `exportFormat` | ` `[ExportFormat](/ad-manager/api/reference/v202408/ReportService.ExportFormat)` ` The [ExportFormat](/ad-manager/api/reference/v202408/ReportService.ExportFormat) used to generate the report. Default value is [ExportFormat.CSV_DUMP](/ad-manager/api/reference/v202408/ReportService.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](/ad-manager/api/reference/v202408/NetworkService.Network#currencyCode). - 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+. \u003cbr /\u003e |\n| ### `includeReportProperties` | ` `xsd:`boolean` Whether or not to include the report properties (e.g. network, user, date generated...) in the generated report. Default is false. |\n| ### `includeTotalsRow` | ` `xsd:`boolean` Whether or not to include the totals row. Default is true for all formats except [ExportFormat.CSV_DUMP](/ad-manager/api/reference/v202408/ReportService.ExportFormat#CSV_DUMP). |\n| ### `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. \u003cbr /\u003e |"]]
