com.google.analytics.data.v1alpha

Class SegmentParameterFilterScoping

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1alpha.SegmentParameterFilterScoping

All Implemented Interfaces:

SegmentParameterFilterScopingOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class SegmentParameterFilterScoping
extends com.google.protobuf.GeneratedMessageV3
implements SegmentParameterFilterScopingOrBuilder

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

Protobuf type google.analytics.data.v1alpha.SegmentParameterFilterScoping

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SegmentParameterFilterScoping.Builder Scopings specify how multiple events should be considered when evaluating a segment parameter filter.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	IN_ANY_N_DAY_PERIOD_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static SegmentParameterFilterScoping	getDefaultInstance()
SegmentParameterFilterScoping	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
long	getInAnyNDayPeriod() Accumulates the parameter over the specified period of days before applying the filter.
com.google.protobuf.Parser<SegmentParameterFilterScoping>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasInAnyNDayPeriod() Accumulates the parameter over the specified period of days before applying the filter.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SegmentParameterFilterScoping.Builder	newBuilder()
static SegmentParameterFilterScoping.Builder	newBuilder(SegmentParameterFilterScoping prototype)
SegmentParameterFilterScoping.Builder	newBuilderForType()
protected SegmentParameterFilterScoping.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SegmentParameterFilterScoping	parseDelimitedFrom(InputStream input)
static SegmentParameterFilterScoping	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SegmentParameterFilterScoping	parseFrom(byte[] data)
static SegmentParameterFilterScoping	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SegmentParameterFilterScoping	parseFrom(ByteBuffer data)
static SegmentParameterFilterScoping	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SegmentParameterFilterScoping	parseFrom(com.google.protobuf.ByteString data)
static SegmentParameterFilterScoping	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SegmentParameterFilterScoping	parseFrom(com.google.protobuf.CodedInputStream input)
static SegmentParameterFilterScoping	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SegmentParameterFilterScoping	parseFrom(InputStream input)
static SegmentParameterFilterScoping	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SegmentParameterFilterScoping>	parser()
SegmentParameterFilterScoping.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

IN_ANY_N_DAY_PERIOD_FIELD_NUMBER

public static final int IN_ANY_N_DAY_PERIOD_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

hasInAnyNDayPeriod in interface SegmentParameterFilterScopingOrBuilder

Returns:

Whether the inAnyNDayPeriod field is set.

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;

Specified by:

getInAnyNDayPeriod in interface SegmentParameterFilterScopingOrBuilder

Returns:

The inAnyNDayPeriod.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SegmentParameterFilterScoping parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentParameterFilterScoping parseFrom(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentParameterFilterScoping parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentParameterFilterScoping parseFrom(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentParameterFilterScoping parseFrom(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentParameterFilterScoping parseFrom(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SegmentParameterFilterScoping parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static SegmentParameterFilterScoping parseFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static SegmentParameterFilterScoping parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static SegmentParameterFilterScoping parseDelimitedFrom(InputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static SegmentParameterFilterScoping parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static SegmentParameterFilterScoping parseFrom(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

newBuilderForType

public SegmentParameterFilterScoping.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SegmentParameterFilterScoping.Builder newBuilder()

newBuilder

public static SegmentParameterFilterScoping.Builder newBuilder(SegmentParameterFilterScoping prototype)

toBuilder

public SegmentParameterFilterScoping.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SegmentParameterFilterScoping.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SegmentParameterFilterScoping getDefaultInstance()

parser

public static com.google.protobuf.Parser<SegmentParameterFilterScoping> parser()

getParserForType

public com.google.protobuf.Parser<SegmentParameterFilterScoping> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SegmentParameterFilterScoping getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder