Class FunnelStep.Builder (0.58.0)

public static final class FunnelStep.Builder extends GeneratedMessageV3.Builder<FunnelStep.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FunnelStep.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FunnelStep.Builder
Overrides

build()

public FunnelStep build()
Returns
Type Description
FunnelStep

buildPartial()

public FunnelStep buildPartial()
Returns
Type Description
FunnelStep

clear()

public FunnelStep.Builder clear()
Returns
Type Description
FunnelStep.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public FunnelStep.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FunnelStep.Builder
Overrides

clearFilterExpression()

public FunnelStep.Builder clearFilterExpression()

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
FunnelStep.Builder

clearIsDirectlyFollowedBy()

public FunnelStep.Builder clearIsDirectlyFollowedBy()

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
FunnelStep.Builder

This builder for chaining.

clearName()

public FunnelStep.Builder clearName()

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
FunnelStep.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FunnelStep.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FunnelStep.Builder
Overrides

clearWithinDurationFromPriorStep()

public FunnelStep.Builder clearWithinDurationFromPriorStep()

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
FunnelStep.Builder

clone()

public FunnelStep.Builder clone()
Returns
Type Description
FunnelStep.Builder
Overrides

getDefaultInstanceForType()

public FunnelStep getDefaultInstanceForType()
Returns
Type Description
FunnelStep

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getFilterExpressionBuilder()

public FunnelFilterExpression.Builder getFilterExpressionBuilder()

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.Builder

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.

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.

getWithinDurationFromPriorStepBuilder()

public Duration.Builder getWithinDurationFromPriorStepBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFilterExpression(FunnelFilterExpression value)

public FunnelStep.Builder mergeFilterExpression(FunnelFilterExpression value)

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;

Parameter
Name Description
value FunnelFilterExpression
Returns
Type Description
FunnelStep.Builder

mergeFrom(FunnelStep other)

public FunnelStep.Builder mergeFrom(FunnelStep other)
Parameter
Name Description
other FunnelStep
Returns
Type Description
FunnelStep.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FunnelStep.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunnelStep.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FunnelStep.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FunnelStep.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FunnelStep.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FunnelStep.Builder
Overrides

mergeWithinDurationFromPriorStep(Duration value)

public FunnelStep.Builder mergeWithinDurationFromPriorStep(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
FunnelStep.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FunnelStep.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FunnelStep.Builder
Overrides

setFilterExpression(FunnelFilterExpression value)

public FunnelStep.Builder setFilterExpression(FunnelFilterExpression value)

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;

Parameter
Name Description
value FunnelFilterExpression
Returns
Type Description
FunnelStep.Builder

setFilterExpression(FunnelFilterExpression.Builder builderForValue)

public FunnelStep.Builder setFilterExpression(FunnelFilterExpression.Builder builderForValue)

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;

Parameter
Name Description
builderForValue FunnelFilterExpression.Builder
Returns
Type Description
FunnelStep.Builder

setIsDirectlyFollowedBy(boolean value)

public FunnelStep.Builder setIsDirectlyFollowedBy(boolean value)

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;

Parameter
Name Description
value boolean

The isDirectlyFollowedBy to set.

Returns
Type Description
FunnelStep.Builder

This builder for chaining.

setName(String value)

public FunnelStep.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
FunnelStep.Builder

This builder for chaining.

setNameBytes(ByteString value)

public FunnelStep.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
FunnelStep.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FunnelStep.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FunnelStep.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FunnelStep.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FunnelStep.Builder
Overrides

setWithinDurationFromPriorStep(Duration value)

public FunnelStep.Builder setWithinDurationFromPriorStep(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
FunnelStep.Builder

setWithinDurationFromPriorStep(Duration.Builder builderForValue)

public FunnelStep.Builder setWithinDurationFromPriorStep(Duration.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
FunnelStep.Builder