Interface ReportDefinition.Filter.FieldFilterOrBuilder (0.39.0)

Version latest

• 0.39.0 (latest)
• 0.37.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.29.0
• 0.27.0
• 0.26.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static interface ReportDefinition.Filter.FieldFilterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getField()

public abstract ReportDefinition.Field getField()

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ReportDefinition.Field	The field.

getFieldOrBuilder()

public abstract ReportDefinition.FieldOrBuilder getFieldOrBuilder()

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ReportDefinition.FieldOrBuilder

getMetricValueType()

public abstract ReportDefinition.MetricValueType getMetricValueType()

Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.MetricValueType	The metricValueType.

getMetricValueTypeValue()

public abstract int getMetricValueTypeValue()

Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];

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

getOperation()

public abstract ReportDefinition.Filter.Operation getOperation()

Required. The operation of this filter.

.google.ads.admanager.v1.ReportDefinition.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ReportDefinition.Filter.Operation	The operation.

getOperationValue()

public abstract int getOperationValue()

Required. The operation of this filter.

.google.ads.admanager.v1.ReportDefinition.Filter.Operation operation = 2 [(.google.api.field_behavior) = REQUIRED];

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

getSlice()

public abstract ReportDefinition.Slice getSlice()

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.Slice	The slice.

getSliceOrBuilder()

public abstract ReportDefinition.SliceOrBuilder getSliceOrBuilder()

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ReportDefinition.SliceOrBuilder

getTimePeriodIndex()

public abstract int getTimePeriodIndex()

Optional. When using time period columns, use this to filter on a specific column.

optional int32 time_period_index = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The timePeriodIndex.

getValues(int index)

public abstract ReportValue getValues(int index)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
ReportValue

getValuesCount()

public abstract int getValuesCount()

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

getValuesList()

public abstract List<ReportValue> getValuesList()

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<ReportValue>

getValuesOrBuilder(int index)

public abstract ReportValueOrBuilder getValuesOrBuilder(int index)

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
ReportValueOrBuilder

getValuesOrBuilderList()

public abstract List<? extends ReportValueOrBuilder> getValuesOrBuilderList()

Required. Values to filter to.

repeated .google.ads.admanager.v1.ReportValue values = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<? extends com.google.ads.admanager.v1.ReportValueOrBuilder>

hasField()

public abstract boolean hasField()

Required. The field to filter on.

.google.ads.admanager.v1.ReportDefinition.Field field = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the field field is set.

hasMetricValueType()

public abstract boolean hasMetricValueType()

Optional. Use to specify which metric value type to filter on. Defaults to PRIMARY.

optional .google.ads.admanager.v1.ReportDefinition.MetricValueType metric_value_type = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the metricValueType field is set.

hasSlice()

public abstract boolean hasSlice()

Optional. Use to filter on a specific slice of data.

optional .google.ads.admanager.v1.ReportDefinition.Slice slice = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the slice field is set.

hasTimePeriodIndex()

public abstract boolean hasTimePeriodIndex()

Optional. When using time period columns, use this to filter on a specific column.

optional int32 time_period_index = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the timePeriodIndex field is set.