public final class SegmentParameterFilterScoping extends GeneratedMessageV3 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.<ListT>makeMutableCopy(ListT)
Static Fields
IN_ANY_N_DAY_PERIOD_FIELD_NUMBER
public static final int IN_ANY_N_DAY_PERIOD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static SegmentParameterFilterScoping getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SegmentParameterFilterScoping.Builder newBuilder()
newBuilder(SegmentParameterFilterScoping prototype)
public static SegmentParameterFilterScoping.Builder newBuilder(SegmentParameterFilterScoping prototype)
public static SegmentParameterFilterScoping parseDelimitedFrom(InputStream input)
public static SegmentParameterFilterScoping parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SegmentParameterFilterScoping parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SegmentParameterFilterScoping parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SegmentParameterFilterScoping parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SegmentParameterFilterScoping parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SegmentParameterFilterScoping parseFrom(CodedInputStream input)
public static SegmentParameterFilterScoping parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SegmentParameterFilterScoping parseFrom(InputStream input)
public static SegmentParameterFilterScoping parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SegmentParameterFilterScoping parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SegmentParameterFilterScoping parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SegmentParameterFilterScoping> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public SegmentParameterFilterScoping getDefaultInstanceForType()
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 |
|---|
| Type | Description |
long | The inAnyNDayPeriod.
|
getParserForType()
public Parser<SegmentParameterFilterScoping> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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 |
|---|
| Type | Description |
boolean | Whether the inAnyNDayPeriod field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SegmentParameterFilterScoping.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SegmentParameterFilterScoping.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public SegmentParameterFilterScoping.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
