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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SegmentParameterFilterScoping.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public SegmentParameterFilterScoping build()
Returns
buildPartial()
public SegmentParameterFilterScoping buildPartial()
Returns
clear()
public SegmentParameterFilterScoping.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public SegmentParameterFilterScoping.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public SegmentParameterFilterScoping.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public SegmentParameterFilterScoping.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public SegmentParameterFilterScoping getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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;
| Type | Description |
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;
| Type | Description |
boolean | Whether the inAnyNDayPeriod field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(SegmentParameterFilterScoping other)
public SegmentParameterFilterScoping.Builder mergeFrom(SegmentParameterFilterScoping other)
Parameter
Returns
public SegmentParameterFilterScoping.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public SegmentParameterFilterScoping.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SegmentParameterFilterScoping.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public SegmentParameterFilterScoping.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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;
| Name | Description |
value | long
The inAnyNDayPeriod to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SegmentParameterFilterScoping.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final SegmentParameterFilterScoping.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
