Class FunnelStep (0.18.0)

public final class FunnelStep extends GeneratedMessageV3 implements FunnelStepOrBuilder

Steps define the user journey you want to measure. Steps contain one or more conditions that your users must meet to be included in that step of the funnel journey.

Protobuf type google.analytics.data.v1alpha.FunnelStep

Implements

FunnelStepOrBuilder

Static Fields

FILTER_EXPRESSION_FIELD_NUMBER

public static final int FILTER_EXPRESSION_FIELD_NUMBER
Field Value
TypeDescription
int

IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER

public static final int IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

WITHIN_DURATION_FROM_PRIOR_STEP_FIELD_NUMBER

public static final int WITHIN_DURATION_FROM_PRIOR_STEP_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FunnelStep getDefaultInstance()
Returns
TypeDescription
FunnelStep

getDescriptor()

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

newBuilder()

public static FunnelStep.Builder newBuilder()
Returns
TypeDescription
FunnelStep.Builder

newBuilder(FunnelStep prototype)

public static FunnelStep.Builder newBuilder(FunnelStep prototype)
Parameter
NameDescription
prototypeFunnelStep
Returns
TypeDescription
FunnelStep.Builder

parseDelimitedFrom(InputStream input)

public static FunnelStep parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FunnelStep parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FunnelStep parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FunnelStep parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FunnelStep parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FunnelStep parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunnelStep
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FunnelStep> parser()
Returns
TypeDescription
Parser<FunnelStep>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public FunnelStep getDefaultInstanceForType()
Returns
TypeDescription
FunnelStep

getFilterExpression()

public FunnelFilterExpression getFilterExpression()

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Returns
TypeDescription
FunnelFilterExpression

The filterExpression.

getFilterExpressionOrBuilder()

public FunnelFilterExpressionOrBuilder getFilterExpressionOrBuilder()

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Returns
TypeDescription
FunnelFilterExpressionOrBuilder

getIsDirectlyFollowedBy()

public boolean getIsDirectlyFollowedBy()

If true, this step must directly follow the previous step. If false, there can be events between the previous step and this step. If unspecified, isDirectlyFollowedBy is treated as false.

bool is_directly_followed_by = 2;

Returns
TypeDescription
boolean

The isDirectlyFollowedBy.

getName()

public String getName()

The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (i.e. "0. ", "1. ", etc.). This name defines string value returned by the funnelStepName dimension. For example, specifying name = Purchase in the request's third funnel step will produce 3. Purchase in the funnel report response.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (i.e. "0. ", "1. ", etc.). This name defines string value returned by the funnelStepName dimension. For example, specifying name = Purchase in the request's third funnel step will produce 3. Purchase in the funnel report response.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<FunnelStep> getParserForType()
Returns
TypeDescription
Parser<FunnelStep>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getWithinDurationFromPriorStep()

public Duration getWithinDurationFromPriorStep()

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond. withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Returns
TypeDescription
Duration

The withinDurationFromPriorStep.

getWithinDurationFromPriorStepOrBuilder()

public DurationOrBuilder getWithinDurationFromPriorStepOrBuilder()

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond. withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Returns
TypeDescription
DurationOrBuilder

hasFilterExpression()

public boolean hasFilterExpression()

The condition that your users must meet to be included in this step of the funnel journey.

.google.analytics.data.v1alpha.FunnelFilterExpression filter_expression = 4;

Returns
TypeDescription
boolean

Whether the filterExpression field is set.

hasWithinDurationFromPriorStep()

public boolean hasWithinDurationFromPriorStep()

If specified, this step must complete within this duration of the completion of the prior step. withinDurationFromPriorStep is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond. withinDurationFromPriorStep is optional, and if unspecified, steps may be separated by any time duration.

optional .google.protobuf.Duration within_duration_from_prior_step = 3;

Returns
TypeDescription
boolean

Whether the withinDurationFromPriorStep field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FunnelStep.Builder newBuilderForType()
Returns
TypeDescription
FunnelStep.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FunnelStep.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FunnelStep.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FunnelStep.Builder toBuilder()
Returns
TypeDescription
FunnelStep.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException