Interface Report.Filter.FieldFilterOrBuilder (0.12.0)

public static interface Report.Filter.FieldFilterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getField()

public abstract Report.Field getField()

Required. The field to filter on.

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

Returns
Type Description
Report.Field

The field.

getFieldOrBuilder()

public abstract Report.FieldOrBuilder getFieldOrBuilder()

Required. The field to filter on.

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

Returns
Type Description
Report.FieldOrBuilder

getMetricValueType()

public abstract Report.MetricValueType getMetricValueType()

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

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

Returns
Type Description
Report.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.Report.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 Report.Filter.Operation getOperation()

Required. The operation of this filter.

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

Returns
Type Description
Report.Filter.Operation

The operation.

getOperationValue()

public abstract int getOperationValue()

Required. The operation of this filter.

.google.ads.admanager.v1.Report.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 Report.Slice getSlice()

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

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

Returns
Type Description
Report.Slice

The slice.

getSliceOrBuilder()

public abstract Report.SliceOrBuilder getSliceOrBuilder()

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

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

Returns
Type Description
Report.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 Report.Value getValues(int index)

Required. Values to filter to.

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

Parameter
Name Description
index int
Returns
Type Description
Report.Value

getValuesCount()

public abstract int getValuesCount()

Required. Values to filter to.

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

Returns
Type Description
int

getValuesList()

public abstract List<Report.Value> getValuesList()

Required. Values to filter to.

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

Returns
Type Description
List<Value>

getValuesOrBuilder(int index)

public abstract Report.ValueOrBuilder getValuesOrBuilder(int index)

Required. Values to filter to.

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

Parameter
Name Description
index int
Returns
Type Description
Report.ValueOrBuilder

getValuesOrBuilderList()

public abstract List<? extends Report.ValueOrBuilder> getValuesOrBuilderList()

Required. Values to filter to.

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

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

hasField()

public abstract boolean hasField()

Required. The field to filter on.

.google.ads.admanager.v1.Report.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.Report.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.Report.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.