Interface ExportSavedReportRequestOrBuilder (0.3.0)

public interface ExportSavedReportRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFileName()

public abstract String getFileName()

The file name of report download. The file extension is determined by export_format and gzip_compressed.

Defaults to "DFP Report" if not specified.

string file_name = 6;

Returns
Type Description
String

The fileName.

getFileNameBytes()

public abstract ByteString getFileNameBytes()

The file name of report download. The file extension is determined by export_format and gzip_compressed.

Defaults to "DFP Report" if not specified.

string file_name = 6;

Returns
Type Description
ByteString

The bytes for fileName.

getFormat()

public abstract ExportSavedReportRequest.Format getFormat()

Required. The export format requested.

.google.ads.admanager.v1.ExportSavedReportRequest.Format format = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ExportSavedReportRequest.Format

The format.

getFormatValue()

public abstract int getFormatValue()

Required. The export format requested.

.google.ads.admanager.v1.ExportSavedReportRequest.Format format = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for format.

getIncludeIds()

public abstract boolean getIncludeIds()

Whether or not to include the IDs if there are any (e.g. advertiser ID, order ID...) present in the report.

bool include_ids = 4;

Returns
Type Description
boolean

The includeIds.

getIncludeReportProperties()

public abstract boolean getIncludeReportProperties()

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

bool include_report_properties = 3;

Returns
Type Description
boolean

The includeReportProperties.

getIncludeTotalsRow()

public abstract boolean getIncludeTotalsRow()

Whether or not to include a row containing metric totals.

bool include_totals_row = 5;

Returns
Type Description
boolean

The includeTotalsRow.

getReport()

public abstract String getReport()

The name of a particular saved report resource.

A report will be run based on the specification of this saved report. It must have the format of "networks/{network_code}/reports/{report_id}"

string report = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The report.

getReportBytes()

public abstract ByteString getReportBytes()

The name of a particular saved report resource.

A report will be run based on the specification of this saved report. It must have the format of "networks/{network_code}/reports/{report_id}"

string report = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for report.