public static final class ExportSavedReportRequest.Builder extends GeneratedMessageV3.Builder<ExportSavedReportRequest.Builder> implements ExportSavedReportRequestOrBuilderRequest proto for the configuration of a report run.
Protobuf type google.ads.admanager.v1.ExportSavedReportRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExportSavedReportRequest.BuilderImplements
ExportSavedReportRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExportSavedReportRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
build()
public ExportSavedReportRequest build()| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest |
|
buildPartial()
public ExportSavedReportRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest |
|
clear()
public ExportSavedReportRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ExportSavedReportRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
clearFileName()
public ExportSavedReportRequest.Builder clearFileName()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 |
ExportSavedReportRequest.Builder |
This builder for chaining. |
clearFormat()
public ExportSavedReportRequest.Builder clearFormat()Required. The export format requested.
.google.ads.admanager.v1.ExportSavedReportRequest.Format format = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
clearIncludeIds()
public ExportSavedReportRequest.Builder clearIncludeIds()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 |
ExportSavedReportRequest.Builder |
This builder for chaining. |
clearIncludeReportProperties()
public ExportSavedReportRequest.Builder clearIncludeReportProperties()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 |
ExportSavedReportRequest.Builder |
This builder for chaining. |
clearIncludeTotalsRow()
public ExportSavedReportRequest.Builder clearIncludeTotalsRow()Whether or not to include a row containing metric totals.
bool include_totals_row = 5;
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExportSavedReportRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
clearReport()
public ExportSavedReportRequest.Builder clearReport()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 |
ExportSavedReportRequest.Builder |
This builder for chaining. |
clone()
public ExportSavedReportRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
getDefaultInstanceForType()
public ExportSavedReportRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFileName()
public 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 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 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ExportSavedReportRequest other)
public ExportSavedReportRequest.Builder mergeFrom(ExportSavedReportRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ExportSavedReportRequest |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExportSavedReportRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ExportSavedReportRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExportSavedReportRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ExportSavedReportRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
setFileName(String value)
public ExportSavedReportRequest.Builder setFileName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe fileName to set. |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
setFileNameBytes(ByteString value)
public ExportSavedReportRequest.Builder setFileNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for fileName to set. |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
setFormat(ExportSavedReportRequest.Format value)
public ExportSavedReportRequest.Builder setFormat(ExportSavedReportRequest.Format value)Required. The export format requested.
.google.ads.admanager.v1.ExportSavedReportRequest.Format format = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ExportSavedReportRequest.FormatThe format to set. |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
setFormatValue(int value)
public ExportSavedReportRequest.Builder setFormatValue(int value)Required. The export format requested.
.google.ads.admanager.v1.ExportSavedReportRequest.Format format = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for format to set. |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
setIncludeIds(boolean value)
public ExportSavedReportRequest.Builder setIncludeIds(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe includeIds to set. |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
setIncludeReportProperties(boolean value)
public ExportSavedReportRequest.Builder setIncludeReportProperties(boolean value)Whether or not to include the report properties (e.g. network, user, date generated...) in the generated report.
bool include_report_properties = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe includeReportProperties to set. |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
setIncludeTotalsRow(boolean value)
public ExportSavedReportRequest.Builder setIncludeTotalsRow(boolean value)Whether or not to include a row containing metric totals.
bool include_totals_row = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe includeTotalsRow to set. |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExportSavedReportRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|
setReport(String value)
public ExportSavedReportRequest.Builder setReport(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe report to set. |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
setReportBytes(ByteString value)
public ExportSavedReportRequest.Builder setReportBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for report to set. |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExportSavedReportRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ExportSavedReportRequest.Builder |
|