Class ReportDefinition.Builder (0.11.0)

public static final class ReportDefinition.Builder extends GeneratedMessageV3.Builder<ReportDefinition.Builder> implements ReportDefinitionOrBuilder

The definition of how a report should be run.

Protobuf type google.ads.admanager.v1.ReportDefinition

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReportDefinition.Builder

Implements

ReportDefinitionOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllCreativeCustomFieldIds(Iterable<? extends Long> values)

public ReportDefinition.Builder addAllCreativeCustomFieldIds(Iterable<? extends Long> values)

Optional. Custom field IDs that represent CREATIVE_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, creative_custom_field_ids[0] describes CREATIVE_CUSTOM_FIELD_0_OPTION_ID and CREATIVE_CUSTOM_FIELD_0_VALUE.

repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends java.lang.Long>` The creativeCustomFieldIds to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addAllCustomDimensionKeyIds(Iterable<? extends Long> values)

public ReportDefinition.Builder addAllCustomDimensionKeyIds(Iterable<? extends Long> values)

Optional. Custom Dimension keys that represent CUSTOM_DIMENSION_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, custom_dimension_key_ids[0] describes CUSTOM_DIMENSION_0_VALUE_ID and CUSTOM_DIMENSION_0_VALUE.

repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends java.lang.Long>` The customDimensionKeyIds to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addAllDimensions(Iterable<? extends Report.Dimension> values)

public ReportDefinition.Builder addAllDimensions(Iterable<? extends Report.Dimension> values)

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.ads.admanager.v1.Report.Dimension>` The dimensions to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addAllDimensionsValue(Iterable<Integer> values)

public ReportDefinition.Builder addAllDimensionsValue(Iterable<Integer> values)

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`values`	`Iterable<Integer>` The enum numeric values on the wire for dimensions to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addAllFilters(Iterable<? extends Report.Filter> values)

public ReportDefinition.Builder addAllFilters(Iterable<? extends Report.Filter> values)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.ads.admanager.v1.Report.Filter>`

Returns
Type	Description
`ReportDefinition.Builder`

addAllFlags(Iterable<? extends Report.Flag> values)

public ReportDefinition.Builder addAllFlags(Iterable<? extends Report.Flag> values)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.ads.admanager.v1.Report.Flag>`

Returns
Type	Description
`ReportDefinition.Builder`

addAllLineItemCustomFieldIds(Iterable<? extends Long> values)

public ReportDefinition.Builder addAllLineItemCustomFieldIds(Iterable<? extends Long> values)

Optional. Custom field IDs that represent LINE_ITEM_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, line_item_custom_field_ids[0] describes LINE_ITEM_CUSTOM_FIELD_0_OPTION_ID and LINE_ITEM_CUSTOM_FIELD_0_VALUE.

repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends java.lang.Long>` The lineItemCustomFieldIds to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addAllMetrics(Iterable<? extends Report.Metric> values)

public ReportDefinition.Builder addAllMetrics(Iterable<? extends Report.Metric> values)

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.ads.admanager.v1.Report.Metric>` The metrics to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addAllMetricsValue(Iterable<Integer> values)

public ReportDefinition.Builder addAllMetricsValue(Iterable<Integer> values)

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`values`	`Iterable<Integer>` The enum numeric values on the wire for metrics to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addAllOrderCustomFieldIds(Iterable<? extends Long> values)

public ReportDefinition.Builder addAllOrderCustomFieldIds(Iterable<? extends Long> values)

Optional. Custom field IDs that represent ORDER_CUSTOM_FIELD_* dimensions. The index of this repeated field corresponds to the index on each dimension. For example, order_custom_field_ids[0] describes ORDER_CUSTOM_FIELD_0_OPTION_ID and ORDER_CUSTOM_FIELD_0_VALUE.

repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends java.lang.Long>` The orderCustomFieldIds to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addAllSorts(Iterable<? extends Report.Sort> values)

public ReportDefinition.Builder addAllSorts(Iterable<? extends Report.Sort> values)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Iterable<? extends com.google.ads.admanager.v1.Report.Sort>`

Returns
Type	Description
`ReportDefinition.Builder`

addCreativeCustomFieldIds(long value)

public ReportDefinition.Builder addCreativeCustomFieldIds(long value)

repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`long` The creativeCustomFieldIds to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addCustomDimensionKeyIds(long value)

public ReportDefinition.Builder addCustomDimensionKeyIds(long value)

repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`long` The customDimensionKeyIds to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addDimensions(Report.Dimension value)

public ReportDefinition.Builder addDimensions(Report.Dimension value)

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`Report.Dimension` The dimensions to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addDimensionsValue(int value)

public ReportDefinition.Builder addDimensionsValue(int value)

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for dimensions to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addFilters(Report.Filter value)

public ReportDefinition.Builder addFilters(Report.Filter value)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Report.Filter`

Returns
Type	Description
`ReportDefinition.Builder`

addFilters(Report.Filter.Builder builderForValue)

public ReportDefinition.Builder addFilters(Report.Filter.Builder builderForValue)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Report.Filter.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

addFilters(int index, Report.Filter value)

public ReportDefinition.Builder addFilters(int index, Report.Filter value)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Report.Filter`

Returns
Type	Description
`ReportDefinition.Builder`

addFilters(int index, Report.Filter.Builder builderForValue)

public ReportDefinition.Builder addFilters(int index, Report.Filter.Builder builderForValue)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Report.Filter.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

addFiltersBuilder()

public Report.Filter.Builder addFiltersBuilder()

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Report.Filter.Builder`

addFiltersBuilder(int index)

public Report.Filter.Builder addFiltersBuilder(int index)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.Filter.Builder`

addFlags(Report.Flag value)

public ReportDefinition.Builder addFlags(Report.Flag value)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Report.Flag`

Returns
Type	Description
`ReportDefinition.Builder`

addFlags(Report.Flag.Builder builderForValue)

public ReportDefinition.Builder addFlags(Report.Flag.Builder builderForValue)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Report.Flag.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

addFlags(int index, Report.Flag value)

public ReportDefinition.Builder addFlags(int index, Report.Flag value)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Report.Flag`

Returns
Type	Description
`ReportDefinition.Builder`

addFlags(int index, Report.Flag.Builder builderForValue)

public ReportDefinition.Builder addFlags(int index, Report.Flag.Builder builderForValue)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Report.Flag.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

addFlagsBuilder()

public Report.Flag.Builder addFlagsBuilder()

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Report.Flag.Builder`

addFlagsBuilder(int index)

public Report.Flag.Builder addFlagsBuilder(int index)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.Flag.Builder`

addLineItemCustomFieldIds(long value)

public ReportDefinition.Builder addLineItemCustomFieldIds(long value)

repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`long` The lineItemCustomFieldIds to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addMetrics(Report.Metric value)

public ReportDefinition.Builder addMetrics(Report.Metric value)

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`Report.Metric` The metrics to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addMetricsValue(int value)

public ReportDefinition.Builder addMetricsValue(int value)

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for metrics to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addOrderCustomFieldIds(long value)

public ReportDefinition.Builder addOrderCustomFieldIds(long value)

repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`long` The orderCustomFieldIds to add.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReportDefinition.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSorts(Report.Sort value)

public ReportDefinition.Builder addSorts(Report.Sort value)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Report.Sort`

Returns
Type	Description
`ReportDefinition.Builder`

addSorts(Report.Sort.Builder builderForValue)

public ReportDefinition.Builder addSorts(Report.Sort.Builder builderForValue)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Report.Sort.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

addSorts(int index, Report.Sort value)

public ReportDefinition.Builder addSorts(int index, Report.Sort value)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Report.Sort`

Returns
Type	Description
`ReportDefinition.Builder`

addSorts(int index, Report.Sort.Builder builderForValue)

public ReportDefinition.Builder addSorts(int index, Report.Sort.Builder builderForValue)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Report.Sort.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

addSortsBuilder()

public Report.Sort.Builder addSortsBuilder()

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Report.Sort.Builder`

addSortsBuilder(int index)

public Report.Sort.Builder addSortsBuilder(int index)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.Sort.Builder`

build()

public ReportDefinition build()

Returns
Type	Description
`ReportDefinition`

buildPartial()

public ReportDefinition buildPartial()

Returns
Type	Description
`ReportDefinition`

clear()

public ReportDefinition.Builder clear()

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearComparisonDateRange()

public ReportDefinition.Builder clearComparisonDateRange()

Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.

optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`

clearCreativeCustomFieldIds()

public ReportDefinition.Builder clearCreativeCustomFieldIds()

repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

clearCurrencyCode()

public ReportDefinition.Builder clearCurrencyCode()

Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.

string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

clearCustomDimensionKeyIds()

public ReportDefinition.Builder clearCustomDimensionKeyIds()

repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

clearDateRange()

public ReportDefinition.Builder clearDateRange()

Required. The primary date range of this report.

.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ReportDefinition.Builder`

clearDimensions()

public ReportDefinition.Builder clearDimensions()

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ReportDefinition.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilters()

public ReportDefinition.Builder clearFilters()

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`

clearFlags()

public ReportDefinition.Builder clearFlags()

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`

clearLineItemCustomFieldIds()

public ReportDefinition.Builder clearLineItemCustomFieldIds()

repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

clearMetrics()

public ReportDefinition.Builder clearMetrics()

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ReportDefinition.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrderCustomFieldIds()

public ReportDefinition.Builder clearOrderCustomFieldIds()

repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

clearReportType()

public ReportDefinition.Builder clearReportType()

Required. The type of this report.

.google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

clearSorts()

public ReportDefinition.Builder clearSorts()

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`

clearTimePeriodColumn()

public ReportDefinition.Builder clearTimePeriodColumn()

Optional. Include a time period column to introduce comparison columns in the report for each generated period. For example, set to "QUARTERS" here to have a column for each quarter present in the primary date range. If "PREVIOUS PERIOD" is specified in comparison_date_range, then each quarter column will also include comparison values for its relative previous quarter.

.google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

clearTimeZone()

public ReportDefinition.Builder clearTimeZone()

Optional. The time zone the date range is defined in for this report. Defaults to publisher's time zone if not specified. Time zone in IANA format. Acceptable values depend on the report type. Publisher time zone is always accepted. Use "America/Los_Angeles" for pacific time, or "Etc/UTC" for UTC.

string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

clone()

public ReportDefinition.Builder clone()

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getComparisonDateRange()

public Report.DateRange getComparisonDateRange()

Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.

optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Report.DateRange`	The comparisonDateRange.

getComparisonDateRangeBuilder()

public Report.DateRange.Builder getComparisonDateRangeBuilder()

Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.

optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Report.DateRange.Builder`

getComparisonDateRangeOrBuilder()

public Report.DateRangeOrBuilder getComparisonDateRangeOrBuilder()

Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.

optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Report.DateRangeOrBuilder`

getCreativeCustomFieldIds(int index)

public long getCreativeCustomFieldIds(int index)

repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`long`	The creativeCustomFieldIds at the given index.

getCreativeCustomFieldIdsCount()

public int getCreativeCustomFieldIdsCount()

repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of creativeCustomFieldIds.

getCreativeCustomFieldIdsList()

public List<Long> getCreativeCustomFieldIdsList()

repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Long>`	A list containing the creativeCustomFieldIds.

getCurrencyCode()

public String getCurrencyCode()

Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.

string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The currencyCode.

getCurrencyCodeBytes()

public ByteString getCurrencyCodeBytes()

Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.

string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for currencyCode.

getCustomDimensionKeyIds(int index)

public long getCustomDimensionKeyIds(int index)

repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`long`	The customDimensionKeyIds at the given index.

getCustomDimensionKeyIdsCount()

public int getCustomDimensionKeyIdsCount()

repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of customDimensionKeyIds.

getCustomDimensionKeyIdsList()

public List<Long> getCustomDimensionKeyIdsList()

repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Long>`	A list containing the customDimensionKeyIds.

getDateRange()

public Report.DateRange getDateRange()

Required. The primary date range of this report.

.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Report.DateRange`	The dateRange.

getDateRangeBuilder()

public Report.DateRange.Builder getDateRangeBuilder()

Required. The primary date range of this report.

.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Report.DateRange.Builder`

getDateRangeOrBuilder()

public Report.DateRangeOrBuilder getDateRangeOrBuilder()

Required. The primary date range of this report.

.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Report.DateRangeOrBuilder`

getDefaultInstanceForType()

public ReportDefinition getDefaultInstanceForType()

Returns
Type	Description
`ReportDefinition`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDimensions(int index)

public Report.Dimension getDimensions(int index)

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`Report.Dimension`	The dimensions at the given index.

getDimensionsCount()

public int getDimensionsCount()

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The count of dimensions.

getDimensionsList()

public List<Report.Dimension> getDimensionsList()

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<Dimension>`	A list containing the dimensions.

getDimensionsValue(int index)

public int getDimensionsValue(int index)

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`int`	The enum numeric value on the wire of dimensions at the given index.

getDimensionsValueList()

public List<Integer> getDimensionsValueList()

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<Integer>`	A list containing the enum numeric values on the wire for dimensions.

getFilters(int index)

public Report.Filter getFilters(int index)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.Filter`

getFiltersBuilder(int index)

public Report.Filter.Builder getFiltersBuilder(int index)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.Filter.Builder`

getFiltersBuilderList()

public List<Report.Filter.Builder> getFiltersBuilderList()

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Builder>`

getFiltersCount()

public int getFiltersCount()

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getFiltersList()

public List<Report.Filter> getFiltersList()

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Filter>`

getFiltersOrBuilder(int index)

public Report.FilterOrBuilder getFiltersOrBuilder(int index)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.FilterOrBuilder`

getFiltersOrBuilderList()

public List<? extends Report.FilterOrBuilder> getFiltersOrBuilderList()

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.ads.admanager.v1.Report.FilterOrBuilder>`

getFlags(int index)

public Report.Flag getFlags(int index)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.Flag`

getFlagsBuilder(int index)

public Report.Flag.Builder getFlagsBuilder(int index)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.Flag.Builder`

getFlagsBuilderList()

public List<Report.Flag.Builder> getFlagsBuilderList()

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Builder>`

getFlagsCount()

public int getFlagsCount()

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getFlagsList()

public List<Report.Flag> getFlagsList()

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Flag>`

getFlagsOrBuilder(int index)

public Report.FlagOrBuilder getFlagsOrBuilder(int index)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.FlagOrBuilder`

getFlagsOrBuilderList()

public List<? extends Report.FlagOrBuilder> getFlagsOrBuilderList()

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.ads.admanager.v1.Report.FlagOrBuilder>`

getLineItemCustomFieldIds(int index)

public long getLineItemCustomFieldIds(int index)

repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`long`	The lineItemCustomFieldIds at the given index.

getLineItemCustomFieldIdsCount()

public int getLineItemCustomFieldIdsCount()

repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of lineItemCustomFieldIds.

getLineItemCustomFieldIdsList()

public List<Long> getLineItemCustomFieldIdsList()

repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Long>`	A list containing the lineItemCustomFieldIds.

getMetrics(int index)

public Report.Metric getMetrics(int index)

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`Report.Metric`	The metrics at the given index.

getMetricsCount()

public int getMetricsCount()

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The count of metrics.

getMetricsList()

public List<Report.Metric> getMetricsList()

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<Metric>`	A list containing the metrics.

getMetricsValue(int index)

public int getMetricsValue(int index)

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`int`	The enum numeric value on the wire of metrics at the given index.

getMetricsValueList()

public List<Integer> getMetricsValueList()

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`List<Integer>`	A list containing the enum numeric values on the wire for metrics.

getOrderCustomFieldIds(int index)

public long getOrderCustomFieldIds(int index)

repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`long`	The orderCustomFieldIds at the given index.

getOrderCustomFieldIdsCount()

public int getOrderCustomFieldIdsCount()

repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of orderCustomFieldIds.

getOrderCustomFieldIdsList()

public List<Long> getOrderCustomFieldIdsList()

repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Long>`	A list containing the orderCustomFieldIds.

getReportType()

public Report.ReportType getReportType()

Required. The type of this report.

.google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Report.ReportType`	The reportType.

getReportTypeValue()

public int getReportTypeValue()

Required. The type of this report.

.google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The enum numeric value on the wire for reportType.

getSorts(int index)

public Report.Sort getSorts(int index)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.Sort`

getSortsBuilder(int index)

public Report.Sort.Builder getSortsBuilder(int index)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.Sort.Builder`

getSortsBuilderList()

public List<Report.Sort.Builder> getSortsBuilderList()

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Builder>`

getSortsCount()

public int getSortsCount()

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getSortsList()

public List<Report.Sort> getSortsList()

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<Sort>`

getSortsOrBuilder(int index)

public Report.SortOrBuilder getSortsOrBuilder(int index)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Report.SortOrBuilder`

getSortsOrBuilderList()

public List<? extends Report.SortOrBuilder> getSortsOrBuilderList()

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<? extends com.google.ads.admanager.v1.Report.SortOrBuilder>`

getTimePeriodColumn()

public Report.TimePeriodColumn getTimePeriodColumn()

.google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Report.TimePeriodColumn`	The timePeriodColumn.

getTimePeriodColumnValue()

public int getTimePeriodColumnValue()

.google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The enum numeric value on the wire for timePeriodColumn.

getTimeZone()

public String getTimeZone()

string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The timeZone.

getTimeZoneBytes()

public ByteString getTimeZoneBytes()

string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for timeZone.

hasComparisonDateRange()

public boolean hasComparisonDateRange()

Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.

optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the comparisonDateRange field is set.

hasDateRange()

public boolean hasDateRange()

Required. The primary date range of this report.

.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the dateRange field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeComparisonDateRange(Report.DateRange value)

public ReportDefinition.Builder mergeComparisonDateRange(Report.DateRange value)

Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.

optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Report.DateRange`

Returns
Type	Description
`ReportDefinition.Builder`

mergeDateRange(Report.DateRange value)

public ReportDefinition.Builder mergeDateRange(Report.DateRange value)

Required. The primary date range of this report.

.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`Report.DateRange`

Returns
Type	Description
`ReportDefinition.Builder`

mergeFrom(ReportDefinition other)

public ReportDefinition.Builder mergeFrom(ReportDefinition other)

Parameter
Name	Description
`other`	`ReportDefinition`

Returns
Type	Description
`ReportDefinition.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ReportDefinition.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ReportDefinition.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReportDefinition.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeFilters(int index)

public ReportDefinition.Builder removeFilters(int index)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ReportDefinition.Builder`

removeFlags(int index)

public ReportDefinition.Builder removeFlags(int index)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ReportDefinition.Builder`

removeSorts(int index)

public ReportDefinition.Builder removeSorts(int index)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ReportDefinition.Builder`

setComparisonDateRange(Report.DateRange value)

public ReportDefinition.Builder setComparisonDateRange(Report.DateRange value)

Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.

optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Report.DateRange`

Returns
Type	Description
`ReportDefinition.Builder`

setComparisonDateRange(Report.DateRange.Builder builderForValue)

public ReportDefinition.Builder setComparisonDateRange(Report.DateRange.Builder builderForValue)

Optional. The comparison date range of this report. If unspecified, the report will not have any comparison metrics.

optional .google.ads.admanager.v1.Report.DateRange comparison_date_range = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`builderForValue`	`Report.DateRange.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

setCreativeCustomFieldIds(int index, long value)

public ReportDefinition.Builder setCreativeCustomFieldIds(int index, long value)

repeated int64 creative_custom_field_ids = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`long` The creativeCustomFieldIds to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setCurrencyCode(String value)

public ReportDefinition.Builder setCurrencyCode(String value)

Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.

string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The currencyCode to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setCurrencyCodeBytes(ByteString value)

public ReportDefinition.Builder setCurrencyCodeBytes(ByteString value)

Optional. The ISO 4217 currency code for this report. Defaults to publisher currency code if not specified.

string currency_code = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for currencyCode to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setCustomDimensionKeyIds(int index, long value)

public ReportDefinition.Builder setCustomDimensionKeyIds(int index, long value)

repeated int64 custom_dimension_key_ids = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`long` The customDimensionKeyIds to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setDateRange(Report.DateRange value)

public ReportDefinition.Builder setDateRange(Report.DateRange value)

Required. The primary date range of this report.

.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`Report.DateRange`

Returns
Type	Description
`ReportDefinition.Builder`

setDateRange(Report.DateRange.Builder builderForValue)

public ReportDefinition.Builder setDateRange(Report.DateRange.Builder builderForValue)

Required. The primary date range of this report.

.google.ads.admanager.v1.Report.DateRange date_range = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`builderForValue`	`Report.DateRange.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

setDimensions(int index, Report.Dimension value)

public ReportDefinition.Builder setDimensions(int index, Report.Dimension value)

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`Report.Dimension` The dimensions to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setDimensionsValue(int index, int value)

public ReportDefinition.Builder setDimensionsValue(int index, int value)

Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.

repeated .google.ads.admanager.v1.Report.Dimension dimensions = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`int` The enum numeric value on the wire for dimensions to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ReportDefinition.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilters(int index, Report.Filter value)

public ReportDefinition.Builder setFilters(int index, Report.Filter value)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Report.Filter`

Returns
Type	Description
`ReportDefinition.Builder`

setFilters(int index, Report.Filter.Builder builderForValue)

public ReportDefinition.Builder setFilters(int index, Report.Filter.Builder builderForValue)

Optional. The filters for this report.

repeated .google.ads.admanager.v1.Report.Filter filters = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Report.Filter.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

setFlags(int index, Report.Flag value)

public ReportDefinition.Builder setFlags(int index, Report.Flag value)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Report.Flag`

Returns
Type	Description
`ReportDefinition.Builder`

setFlags(int index, Report.Flag.Builder builderForValue)

public ReportDefinition.Builder setFlags(int index, Report.Flag.Builder builderForValue)

Optional. List of flags for this report. Used to flag rows in a result set based on a set of defined filters.

repeated .google.ads.admanager.v1.Report.Flag flags = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Report.Flag.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

setLineItemCustomFieldIds(int index, long value)

public ReportDefinition.Builder setLineItemCustomFieldIds(int index, long value)

repeated int64 line_item_custom_field_ids = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`long` The lineItemCustomFieldIds to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setMetrics(int index, Report.Metric value)

public ReportDefinition.Builder setMetrics(int index, Report.Metric value)

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`Report.Metric` The metrics to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setMetricsValue(int index, int value)

public ReportDefinition.Builder setMetricsValue(int index, int value)

Required. The list of metrics to report on. If empty, the report will have no metrics.

repeated .google.ads.admanager.v1.Report.Metric metrics = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`int` The enum numeric value on the wire for metrics to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setOrderCustomFieldIds(int index, long value)

public ReportDefinition.Builder setOrderCustomFieldIds(int index, long value)

repeated int64 order_custom_field_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`long` The orderCustomFieldIds to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReportDefinition.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setReportType(Report.ReportType value)

public ReportDefinition.Builder setReportType(Report.ReportType value)

Required. The type of this report.

.google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`Report.ReportType` The reportType to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setReportTypeValue(int value)

public ReportDefinition.Builder setReportTypeValue(int value)

Required. The type of this report.

.google.ads.admanager.v1.Report.ReportType report_type = 8 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for reportType to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setSorts(int index, Report.Sort value)

public ReportDefinition.Builder setSorts(int index, Report.Sort value)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`value`	`Report.Sort`

Returns
Type	Description
`ReportDefinition.Builder`

setSorts(int index, Report.Sort.Builder builderForValue)

public ReportDefinition.Builder setSorts(int index, Report.Sort.Builder builderForValue)

Optional. Default sorts to apply to this report.

repeated .google.ads.admanager.v1.Report.Sort sorts = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Report.Sort.Builder`

Returns
Type	Description
`ReportDefinition.Builder`

setTimePeriodColumn(Report.TimePeriodColumn value)

public ReportDefinition.Builder setTimePeriodColumn(Report.TimePeriodColumn value)

.google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Report.TimePeriodColumn` The timePeriodColumn to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setTimePeriodColumnValue(int value)

public ReportDefinition.Builder setTimePeriodColumnValue(int value)

.google.ads.admanager.v1.Report.TimePeriodColumn time_period_column = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for timePeriodColumn to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setTimeZone(String value)

public ReportDefinition.Builder setTimeZone(String value)

string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`String` The timeZone to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setTimeZoneBytes(ByteString value)

public ReportDefinition.Builder setTimeZoneBytes(ByteString value)

string time_zone = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`ByteString` The bytes for timeZone to set.

Returns
Type	Description
`ReportDefinition.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReportDefinition.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ReportDefinition.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)