Class AudienceDimensionOrMetricFilter.Builder (0.31.0)

Version 0.31.0

• 0.62.0 (latest)
• 0.61.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0

public static final class AudienceDimensionOrMetricFilter.Builder extends GeneratedMessageV3.Builder<AudienceDimensionOrMetricFilter.Builder> implements AudienceDimensionOrMetricFilterOrBuilder

A specific filter for a single dimension or metric.

Protobuf type google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter

Inheritance

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

Implements

AudienceDimensionOrMetricFilterOrBuilder

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

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

build()

public AudienceDimensionOrMetricFilter build()

Returns
Type	Description
AudienceDimensionOrMetricFilter

buildPartial()

public AudienceDimensionOrMetricFilter buildPartial()

Returns
Type	Description
AudienceDimensionOrMetricFilter

clear()

public AudienceDimensionOrMetricFilter.Builder clear()

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAtAnyPointInTime()

public AudienceDimensionOrMetricFilter.Builder clearAtAnyPointInTime()

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
AudienceDimensionOrMetricFilter.Builder	This builder for chaining.

clearBetweenFilter()

public AudienceDimensionOrMetricFilter.Builder clearBetweenFilter()

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.Builder

clearField(Descriptors.FieldDescriptor field)

public AudienceDimensionOrMetricFilter.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

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

clearFieldName()

public AudienceDimensionOrMetricFilter.Builder clearFieldName()

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
AudienceDimensionOrMetricFilter.Builder	This builder for chaining.

clearInAnyNDayPeriod()

public AudienceDimensionOrMetricFilter.Builder clearInAnyNDayPeriod()

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
AudienceDimensionOrMetricFilter.Builder	This builder for chaining.

clearInListFilter()

public AudienceDimensionOrMetricFilter.Builder clearInListFilter()

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.Builder

clearNumericFilter()

public AudienceDimensionOrMetricFilter.Builder clearNumericFilter()

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.Builder

clearOneFilter()

public AudienceDimensionOrMetricFilter.Builder clearOneFilter()

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AudienceDimensionOrMetricFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

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

clearStringFilter()

public AudienceDimensionOrMetricFilter.Builder clearStringFilter()

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.Builder

clone()

public AudienceDimensionOrMetricFilter.Builder clone()

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAtAnyPointInTime()

public 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 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.

getBetweenFilterBuilder()

public AudienceDimensionOrMetricFilter.BetweenFilter.Builder getBetweenFilterBuilder()

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.Builder

getBetweenFilterOrBuilder()

public 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

getDefaultInstanceForType()

public AudienceDimensionOrMetricFilter getDefaultInstanceForType()

Returns
Type	Description
AudienceDimensionOrMetricFilter

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFieldName()

public 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 ByteString getFieldNameBytes()

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
ByteString	The bytes for fieldName.

getInAnyNDayPeriod()

public 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 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.

getInListFilterBuilder()

public AudienceDimensionOrMetricFilter.InListFilter.Builder getInListFilterBuilder()

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.Builder

getInListFilterOrBuilder()

public 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 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.

getNumericFilterBuilder()

public AudienceDimensionOrMetricFilter.NumericFilter.Builder getNumericFilterBuilder()

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.Builder

getNumericFilterOrBuilder()

public 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 AudienceDimensionOrMetricFilter.OneFilterCase getOneFilterCase()

Returns
Type	Description
AudienceDimensionOrMetricFilter.OneFilterCase

getStringFilter()

public 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.

getStringFilterBuilder()

public AudienceDimensionOrMetricFilter.StringFilter.Builder getStringFilterBuilder()

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.Builder

getStringFilterOrBuilder()

public 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 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 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 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 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.

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

mergeBetweenFilter(AudienceDimensionOrMetricFilter.BetweenFilter value)

public AudienceDimensionOrMetricFilter.Builder mergeBetweenFilter(AudienceDimensionOrMetricFilter.BetweenFilter value)

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

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

Parameter
Name	Description
value	AudienceDimensionOrMetricFilter.BetweenFilter

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

mergeFrom(AudienceDimensionOrMetricFilter other)

public AudienceDimensionOrMetricFilter.Builder mergeFrom(AudienceDimensionOrMetricFilter other)

Parameter
Name	Description
other	AudienceDimensionOrMetricFilter

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public AudienceDimensionOrMetricFilter.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

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

mergeInListFilter(AudienceDimensionOrMetricFilter.InListFilter value)

public AudienceDimensionOrMetricFilter.Builder mergeInListFilter(AudienceDimensionOrMetricFilter.InListFilter value)

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

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

Parameter
Name	Description
value	AudienceDimensionOrMetricFilter.InListFilter

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

mergeNumericFilter(AudienceDimensionOrMetricFilter.NumericFilter value)

public AudienceDimensionOrMetricFilter.Builder mergeNumericFilter(AudienceDimensionOrMetricFilter.NumericFilter value)

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

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

Parameter
Name	Description
value	AudienceDimensionOrMetricFilter.NumericFilter

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

mergeStringFilter(AudienceDimensionOrMetricFilter.StringFilter value)

public AudienceDimensionOrMetricFilter.Builder mergeStringFilter(AudienceDimensionOrMetricFilter.StringFilter value)

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

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

Parameter
Name	Description
value	AudienceDimensionOrMetricFilter.StringFilter

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AudienceDimensionOrMetricFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

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

setAtAnyPointInTime(boolean value)

public AudienceDimensionOrMetricFilter.Builder setAtAnyPointInTime(boolean value)

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];

Parameter
Name	Description
value	boolean The atAnyPointInTime to set.

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder	This builder for chaining.

setBetweenFilter(AudienceDimensionOrMetricFilter.BetweenFilter value)

public AudienceDimensionOrMetricFilter.Builder setBetweenFilter(AudienceDimensionOrMetricFilter.BetweenFilter value)

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

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

Parameter
Name	Description
value	AudienceDimensionOrMetricFilter.BetweenFilter

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

setBetweenFilter(AudienceDimensionOrMetricFilter.BetweenFilter.Builder builderForValue)

public AudienceDimensionOrMetricFilter.Builder setBetweenFilter(AudienceDimensionOrMetricFilter.BetweenFilter.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	AudienceDimensionOrMetricFilter.BetweenFilter.Builder

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

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

setFieldName(String value)

public AudienceDimensionOrMetricFilter.Builder setFieldName(String value)

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];

Parameter
Name	Description
value	String The fieldName to set.

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder	This builder for chaining.

setFieldNameBytes(ByteString value)

public AudienceDimensionOrMetricFilter.Builder setFieldNameBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for fieldName to set.

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder	This builder for chaining.

setInAnyNDayPeriod(int value)

public AudienceDimensionOrMetricFilter.Builder setInAnyNDayPeriod(int value)

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];

Parameter
Name	Description
value	int The inAnyNDayPeriod to set.

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder	This builder for chaining.

setInListFilter(AudienceDimensionOrMetricFilter.InListFilter value)

public AudienceDimensionOrMetricFilter.Builder setInListFilter(AudienceDimensionOrMetricFilter.InListFilter value)

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

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

Parameter
Name	Description
value	AudienceDimensionOrMetricFilter.InListFilter

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

setInListFilter(AudienceDimensionOrMetricFilter.InListFilter.Builder builderForValue)

public AudienceDimensionOrMetricFilter.Builder setInListFilter(AudienceDimensionOrMetricFilter.InListFilter.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	AudienceDimensionOrMetricFilter.InListFilter.Builder

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

setNumericFilter(AudienceDimensionOrMetricFilter.NumericFilter value)

public AudienceDimensionOrMetricFilter.Builder setNumericFilter(AudienceDimensionOrMetricFilter.NumericFilter value)

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

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

Parameter
Name	Description
value	AudienceDimensionOrMetricFilter.NumericFilter

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

setNumericFilter(AudienceDimensionOrMetricFilter.NumericFilter.Builder builderForValue)

public AudienceDimensionOrMetricFilter.Builder setNumericFilter(AudienceDimensionOrMetricFilter.NumericFilter.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	AudienceDimensionOrMetricFilter.NumericFilter.Builder

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

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

setStringFilter(AudienceDimensionOrMetricFilter.StringFilter value)

public AudienceDimensionOrMetricFilter.Builder setStringFilter(AudienceDimensionOrMetricFilter.StringFilter value)

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

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

Parameter
Name	Description
value	AudienceDimensionOrMetricFilter.StringFilter

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

setStringFilter(AudienceDimensionOrMetricFilter.StringFilter.Builder builderForValue)

public AudienceDimensionOrMetricFilter.Builder setStringFilter(AudienceDimensionOrMetricFilter.StringFilter.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	AudienceDimensionOrMetricFilter.StringFilter.Builder

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final AudienceDimensionOrMetricFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

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