Class ExportSavedReportRequest (0.4.0)

public final class ExportSavedReportRequest extends GeneratedMessageV3 implements ExportSavedReportRequestOrBuilder

Request proto for the configuration of a report run.

Protobuf type google.ads.admanager.v1.ExportSavedReportRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExportSavedReportRequest

Implements

ExportSavedReportRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FILE_NAME_FIELD_NUMBER

public static final int FILE_NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

FORMAT_FIELD_NUMBER

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()

Returns
Type	Description
`ExportSavedReportRequest`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static ExportSavedReportRequest.Builder newBuilder()

Returns
Type	Description
`ExportSavedReportRequest.Builder`

newBuilder(ExportSavedReportRequest prototype)

public static ExportSavedReportRequest.Builder newBuilder(ExportSavedReportRequest prototype)

Parameter
Name	Description
`prototype`	`ExportSavedReportRequest`

Returns
Type	Description
`ExportSavedReportRequest.Builder`

parseDelimitedFrom(InputStream input)

public static ExportSavedReportRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportSavedReportRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static ExportSavedReportRequest parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportSavedReportRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static ExportSavedReportRequest parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportSavedReportRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static ExportSavedReportRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportSavedReportRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static ExportSavedReportRequest parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportSavedReportRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static ExportSavedReportRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportSavedReportRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportSavedReportRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<ExportSavedReportRequest> parser()

Returns
Type	Description
`Parser<ExportSavedReportRequest>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public ExportSavedReportRequest getDefaultInstanceForType()

Returns
Type	Description
`ExportSavedReportRequest`

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.

getParserForType()

public Parser<ExportSavedReportRequest> getParserForType()

Returns
Type	Description
`Parser<ExportSavedReportRequest>`

Overrides

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public ExportSavedReportRequest.Builder newBuilderForType()

Returns
Type	Description
`ExportSavedReportRequest.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExportSavedReportRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`ExportSavedReportRequest.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ExportSavedReportRequest.Builder toBuilder()

Returns
Type	Description
`ExportSavedReportRequest.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`