Class FunnelStep (0.57.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
Type Description
int

IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER

public static final int IS_DIRECTLY_FOLLOWED_BY_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

WITHIN_DURATION_FROM_PRIOR_STEP_FIELD_NUMBER

public static final int WITHIN_DURATION_FROM_PRIOR_STEP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FunnelStep getDefaultInstance()
Returns
Type Description
FunnelStep

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FunnelStep.Builder newBuilder()
Returns
Type Description
FunnelStep.Builder

newBuilder(FunnelStep prototype)

public static FunnelStep.Builder newBuilder(FunnelStep prototype)
Parameter
Name Description
prototype FunnelStep
Returns
Type Description
FunnelStep.Builder

parseDelimitedFrom(InputStream input)

public static FunnelStep parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FunnelStep
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunnelStep
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FunnelStep parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FunnelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunnelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FunnelStep parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FunnelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunnelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FunnelStep parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FunnelStep
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunnelStep
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FunnelStep parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FunnelStep
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunnelStep
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FunnelStep parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FunnelStep
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FunnelStep parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunnelStep
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FunnelStep> parser()
Returns
Type Description
Parser<FunnelStep>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public FunnelStep getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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 (for example "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
Type Description
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 (for example "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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<FunnelStep> getParserForType()
Returns
Type Description
Parser<FunnelStep>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the withinDurationFromPriorStep field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FunnelStep.Builder newBuilderForType()
Returns
Type Description
FunnelStep.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FunnelStep.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FunnelStep.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FunnelStep.Builder toBuilder()
Returns
Type Description
FunnelStep.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException