public final class ExportSavedReportRequest extends GeneratedMessageV3 implements ExportSavedReportRequestOrBuilder
Request proto for the configuration of a report run.
Protobuf type google.ads.admanager.v1.ExportSavedReportRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILE_NAME_FIELD_NUMBER
public static final int FILE_NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
public static final int FORMAT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
INCLUDE_IDS_FIELD_NUMBER
public static final int INCLUDE_IDS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
INCLUDE_REPORT_PROPERTIES_FIELD_NUMBER
public static final int INCLUDE_REPORT_PROPERTIES_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
INCLUDE_TOTALS_ROW_FIELD_NUMBER
public static final int INCLUDE_TOTALS_ROW_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
REPORT_FIELD_NUMBER
public static final int REPORT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ExportSavedReportRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ExportSavedReportRequest.Builder newBuilder()
newBuilder(ExportSavedReportRequest prototype)
public static ExportSavedReportRequest.Builder newBuilder(ExportSavedReportRequest prototype)
public static ExportSavedReportRequest parseDelimitedFrom(InputStream input)
public static ExportSavedReportRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ExportSavedReportRequest parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExportSavedReportRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ExportSavedReportRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportSavedReportRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportSavedReportRequest parseFrom(CodedInputStream input)
public static ExportSavedReportRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportSavedReportRequest parseFrom(InputStream input)
public static ExportSavedReportRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ExportSavedReportRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExportSavedReportRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ExportSavedReportRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ExportSavedReportRequest getDefaultInstanceForType()
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.
|
public ExportSavedReportRequest.Format getFormat()
Required. The export format requested.
.google.ads.admanager.v1.ExportSavedReportRequest.Format format = 2 [(.google.api.field_behavior) = REQUIRED];
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.
|
getParserForType()
public Parser<ExportSavedReportRequest> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ExportSavedReportRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExportSavedReportRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public ExportSavedReportRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides