Class SegmentParameterFilterScoping.Builder (0.41.0)

public static final class SegmentParameterFilterScoping.Builder extends GeneratedMessageV3.Builder<SegmentParameterFilterScoping.Builder> implements SegmentParameterFilterScopingOrBuilder

Scopings specify how multiple events should be considered when evaluating a segment parameter filter.

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilterScoping

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SegmentParameterFilterScoping.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides

build()

public SegmentParameterFilterScoping build()
Returns
TypeDescription
SegmentParameterFilterScoping

buildPartial()

public SegmentParameterFilterScoping buildPartial()
Returns
TypeDescription
SegmentParameterFilterScoping

clear()

public SegmentParameterFilterScoping.Builder clear()
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SegmentParameterFilterScoping.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides

clearInAnyNDayPeriod()

public SegmentParameterFilterScoping.Builder clearInAnyNDayPeriod()

Accumulates the parameter over the specified period of days before applying the filter. Only supported if criteria scoping is ACROSS_ALL_SESSIONS or WITHIN_SAME_SESSION. Only supported if the parameter is event_count.

For example if inAnyNDayPeriod is 3, the event_name is "purchase", the event parameter is "event_count", and the Filter's criteria is greater than 5, this filter will accumulate the event count of purchase events over every 3 consecutive day period in the report's date range; a user will pass this Filter's criteria to be included in this segment if their count of purchase events exceeds 5 in any 3 consecutive day period. For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.

The date range is not extended for the purpose of having a full N day window near the start of the date range. For example if a report is for 2021-11-01 to 2021-11-10 and inAnyNDayPeriod = 3, the first two day period will be effectively shortened because no event data outside the report's date range will be read. For example, the first four periods will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02, 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.

inAnyNDayPeriod is optional. If not specified, the segmentParameterFilter is applied to each event individually.

optional int64 in_any_n_day_period = 1;

Returns
TypeDescription
SegmentParameterFilterScoping.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SegmentParameterFilterScoping.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides

clone()

public SegmentParameterFilterScoping.Builder clone()
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides

getDefaultInstanceForType()

public SegmentParameterFilterScoping getDefaultInstanceForType()
Returns
TypeDescription
SegmentParameterFilterScoping

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getInAnyNDayPeriod()

public long getInAnyNDayPeriod()

Accumulates the parameter over the specified period of days before applying the filter. Only supported if criteria scoping is ACROSS_ALL_SESSIONS or WITHIN_SAME_SESSION. Only supported if the parameter is event_count.

For example if inAnyNDayPeriod is 3, the event_name is "purchase", the event parameter is "event_count", and the Filter's criteria is greater than 5, this filter will accumulate the event count of purchase events over every 3 consecutive day period in the report's date range; a user will pass this Filter's criteria to be included in this segment if their count of purchase events exceeds 5 in any 3 consecutive day period. For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.

The date range is not extended for the purpose of having a full N day window near the start of the date range. For example if a report is for 2021-11-01 to 2021-11-10 and inAnyNDayPeriod = 3, the first two day period will be effectively shortened because no event data outside the report's date range will be read. For example, the first four periods will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02, 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.

inAnyNDayPeriod is optional. If not specified, the segmentParameterFilter is applied to each event individually.

optional int64 in_any_n_day_period = 1;

Returns
TypeDescription
long

The inAnyNDayPeriod.

hasInAnyNDayPeriod()

public boolean hasInAnyNDayPeriod()

Accumulates the parameter over the specified period of days before applying the filter. Only supported if criteria scoping is ACROSS_ALL_SESSIONS or WITHIN_SAME_SESSION. Only supported if the parameter is event_count.

For example if inAnyNDayPeriod is 3, the event_name is "purchase", the event parameter is "event_count", and the Filter's criteria is greater than 5, this filter will accumulate the event count of purchase events over every 3 consecutive day period in the report's date range; a user will pass this Filter's criteria to be included in this segment if their count of purchase events exceeds 5 in any 3 consecutive day period. For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.

The date range is not extended for the purpose of having a full N day window near the start of the date range. For example if a report is for 2021-11-01 to 2021-11-10 and inAnyNDayPeriod = 3, the first two day period will be effectively shortened because no event data outside the report's date range will be read. For example, the first four periods will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02, 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.

inAnyNDayPeriod is optional. If not specified, the segmentParameterFilter is applied to each event individually.

optional int64 in_any_n_day_period = 1;

Returns
TypeDescription
boolean

Whether the inAnyNDayPeriod field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SegmentParameterFilterScoping other)

public SegmentParameterFilterScoping.Builder mergeFrom(SegmentParameterFilterScoping other)
Parameter
NameDescription
otherSegmentParameterFilterScoping
Returns
TypeDescription
SegmentParameterFilterScoping.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SegmentParameterFilterScoping.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SegmentParameterFilterScoping.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SegmentParameterFilterScoping.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SegmentParameterFilterScoping.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides

setInAnyNDayPeriod(long value)

public SegmentParameterFilterScoping.Builder setInAnyNDayPeriod(long value)

Accumulates the parameter over the specified period of days before applying the filter. Only supported if criteria scoping is ACROSS_ALL_SESSIONS or WITHIN_SAME_SESSION. Only supported if the parameter is event_count.

For example if inAnyNDayPeriod is 3, the event_name is "purchase", the event parameter is "event_count", and the Filter's criteria is greater than 5, this filter will accumulate the event count of purchase events over every 3 consecutive day period in the report's date range; a user will pass this Filter's criteria to be included in this segment if their count of purchase events exceeds 5 in any 3 consecutive day period. For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered.

The date range is not extended for the purpose of having a full N day window near the start of the date range. For example if a report is for 2021-11-01 to 2021-11-10 and inAnyNDayPeriod = 3, the first two day period will be effectively shortened because no event data outside the report's date range will be read. For example, the first four periods will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02, 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04.

inAnyNDayPeriod is optional. If not specified, the segmentParameterFilter is applied to each event individually.

optional int64 in_any_n_day_period = 1;

Parameter
NameDescription
valuelong

The inAnyNDayPeriod to set.

Returns
TypeDescription
SegmentParameterFilterScoping.Builder

This builder for chaining.

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

public SegmentParameterFilterScoping.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SegmentParameterFilterScoping.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SegmentParameterFilterScoping.Builder
Overrides