Interface AudienceDimensionOrMetricFilterOrBuilder (0.59.0)

public interface AudienceDimensionOrMetricFilterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAtAnyPointInTime()

public abstract boolean getAtAnyPointInTime()

Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them.

This can only be set when Audience scope is ACROSS_ALL_SESSIONS.

bool at_any_point_in_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The atAnyPointInTime.

getBetweenFilter()

public abstract AudienceDimensionOrMetricFilter.BetweenFilter getBetweenFilter()

A filter for numeric or date values between certain values on a dimension or metric.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;

Returns
Type	Description
`AudienceDimensionOrMetricFilter.BetweenFilter`	The betweenFilter.

getBetweenFilterOrBuilder()

public abstract AudienceDimensionOrMetricFilter.BetweenFilterOrBuilder getBetweenFilterOrBuilder()

A filter for numeric or date values between certain values on a dimension or metric.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;

Returns
Type	Description
`AudienceDimensionOrMetricFilter.BetweenFilterOrBuilder`

getFieldName()

public abstract String getFieldName()

Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the Google Analytics Data API documentation.

string field_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`String`	The fieldName.

getFieldNameBytes()

public abstract ByteString getFieldNameBytes()

string field_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`ByteString`	The bytes for fieldName.

getInAnyNDayPeriod()

public abstract int getInAnyNDayPeriod()

Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window).

For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false.

It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.

int32 in_any_n_day_period = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The inAnyNDayPeriod.

getInListFilter()

public abstract AudienceDimensionOrMetricFilter.InListFilter getInListFilter()

A filter for a string dimension that matches a particular list of options.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;

Returns
Type	Description
`AudienceDimensionOrMetricFilter.InListFilter`	The inListFilter.

getInListFilterOrBuilder()

public abstract AudienceDimensionOrMetricFilter.InListFilterOrBuilder getInListFilterOrBuilder()

A filter for a string dimension that matches a particular list of options.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;

Returns
Type	Description
`AudienceDimensionOrMetricFilter.InListFilterOrBuilder`

getNumericFilter()

public abstract AudienceDimensionOrMetricFilter.NumericFilter getNumericFilter()

A filter for numeric or date values on a dimension or metric.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;

Returns
Type	Description
`AudienceDimensionOrMetricFilter.NumericFilter`	The numericFilter.

getNumericFilterOrBuilder()

public abstract AudienceDimensionOrMetricFilter.NumericFilterOrBuilder getNumericFilterOrBuilder()

A filter for numeric or date values on a dimension or metric.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;

Returns
Type	Description
`AudienceDimensionOrMetricFilter.NumericFilterOrBuilder`

getOneFilterCase()

public abstract AudienceDimensionOrMetricFilter.OneFilterCase getOneFilterCase()

Returns
Type	Description
`AudienceDimensionOrMetricFilter.OneFilterCase`

getStringFilter()

public abstract AudienceDimensionOrMetricFilter.StringFilter getStringFilter()

A filter for a string-type dimension that matches a particular pattern.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;

Returns
Type	Description
`AudienceDimensionOrMetricFilter.StringFilter`	The stringFilter.

getStringFilterOrBuilder()

public abstract AudienceDimensionOrMetricFilter.StringFilterOrBuilder getStringFilterOrBuilder()

A filter for a string-type dimension that matches a particular pattern.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;

Returns
Type	Description
`AudienceDimensionOrMetricFilter.StringFilterOrBuilder`

hasBetweenFilter()

public abstract boolean hasBetweenFilter()

A filter for numeric or date values between certain values on a dimension or metric.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;

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

hasInListFilter()

public abstract boolean hasInListFilter()

A filter for a string dimension that matches a particular list of options.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;

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

hasNumericFilter()

public abstract boolean hasNumericFilter()

A filter for numeric or date values on a dimension or metric.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;

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

hasStringFilter()

public abstract boolean hasStringFilter()

A filter for a string-type dimension that matches a particular pattern.

.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;

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