public static final class FunnelStep.Builder extends com.google.protobuf.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| Modifier and Type | Method and Description |
|---|---|
FunnelStep.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
FunnelStep |
build() |
FunnelStep |
buildPartial() |
FunnelStep.Builder |
clear() |
FunnelStep.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
FunnelStep.Builder |
clearFilterExpression()
The condition that your users must meet to be included in this step of
the funnel journey.
|
FunnelStep.Builder |
clearIsDirectlyFollowedBy()
If true, this step must directly follow the previous step.
|
FunnelStep.Builder |
clearName()
The distinctive name for this step.
|
FunnelStep.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
FunnelStep.Builder |
clearWithinDurationFromPriorStep()
If specified, this step must complete within this duration of the
completion of the prior step.
|
FunnelStep.Builder |
clone() |
FunnelStep |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
FunnelFilterExpression |
getFilterExpression()
The condition that your users must meet to be included in this step of
the funnel journey.
|
FunnelFilterExpression.Builder |
getFilterExpressionBuilder()
The condition that your users must meet to be included in this step of
the funnel journey.
|
FunnelFilterExpressionOrBuilder |
getFilterExpressionOrBuilder()
The condition that your users must meet to be included in this step of
the funnel journey.
|
boolean |
getIsDirectlyFollowedBy()
If true, this step must directly follow the previous step.
|
String |
getName()
The distinctive name for this step.
|
com.google.protobuf.ByteString |
getNameBytes()
The distinctive name for this step.
|
com.google.protobuf.Duration |
getWithinDurationFromPriorStep()
If specified, this step must complete within this duration of the
completion of the prior step.
|
com.google.protobuf.Duration.Builder |
getWithinDurationFromPriorStepBuilder()
If specified, this step must complete within this duration of the
completion of the prior step.
|
com.google.protobuf.DurationOrBuilder |
getWithinDurationFromPriorStepOrBuilder()
If specified, this step must complete within this duration of the
completion of the prior step.
|
boolean |
hasFilterExpression()
The condition that your users must meet to be included in this step of
the funnel journey.
|
boolean |
hasWithinDurationFromPriorStep()
If specified, this step must complete within this duration of the
completion of the prior step.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
FunnelStep.Builder |
mergeFilterExpression(FunnelFilterExpression value)
The condition that your users must meet to be included in this step of
the funnel journey.
|
FunnelStep.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
FunnelStep.Builder |
mergeFrom(FunnelStep other) |
FunnelStep.Builder |
mergeFrom(com.google.protobuf.Message other) |
FunnelStep.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
FunnelStep.Builder |
mergeWithinDurationFromPriorStep(com.google.protobuf.Duration value)
If specified, this step must complete within this duration of the
completion of the prior step.
|
FunnelStep.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
FunnelStep.Builder |
setFilterExpression(FunnelFilterExpression.Builder builderForValue)
The condition that your users must meet to be included in this step of
the funnel journey.
|
FunnelStep.Builder |
setFilterExpression(FunnelFilterExpression value)
The condition that your users must meet to be included in this step of
the funnel journey.
|
FunnelStep.Builder |
setIsDirectlyFollowedBy(boolean value)
If true, this step must directly follow the previous step.
|
FunnelStep.Builder |
setName(String value)
The distinctive name for this step.
|
FunnelStep.Builder |
setNameBytes(com.google.protobuf.ByteString value)
The distinctive name for this step.
|
FunnelStep.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
FunnelStep.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
FunnelStep.Builder |
setWithinDurationFromPriorStep(com.google.protobuf.Duration.Builder builderForValue)
If specified, this step must complete within this duration of the
completion of the prior step.
|
FunnelStep.Builder |
setWithinDurationFromPriorStep(com.google.protobuf.Duration value)
If specified, this step must complete within this duration of the
completion of the prior step.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public FunnelStep.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public FunnelStep getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic FunnelStep build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic FunnelStep buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic FunnelStep.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public FunnelStep.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public FunnelStep.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public FunnelStep.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public FunnelStep.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public FunnelStep.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public FunnelStep.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<FunnelStep.Builder>public FunnelStep.Builder mergeFrom(FunnelStep other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public FunnelStep.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<FunnelStep.Builder>IOExceptionpublic 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;getName in interface FunnelStepOrBuilderpublic com.google.protobuf.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;getNameBytes in interface FunnelStepOrBuilderpublic FunnelStep.Builder setName(String value)
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;value - The name to set.public FunnelStep.Builder clearName()
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;public FunnelStep.Builder setNameBytes(com.google.protobuf.ByteString value)
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;value - The bytes for name to set.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;getIsDirectlyFollowedBy in interface FunnelStepOrBuilderpublic 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;value - The isDirectlyFollowedBy to set.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;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;hasWithinDurationFromPriorStep in interface FunnelStepOrBuilderpublic com.google.protobuf.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;getWithinDurationFromPriorStep in interface FunnelStepOrBuilderpublic FunnelStep.Builder setWithinDurationFromPriorStep(com.google.protobuf.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;public FunnelStep.Builder setWithinDurationFromPriorStep(com.google.protobuf.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;public FunnelStep.Builder mergeWithinDurationFromPriorStep(com.google.protobuf.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;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;public com.google.protobuf.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;public com.google.protobuf.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;getWithinDurationFromPriorStepOrBuilder in interface FunnelStepOrBuilderpublic 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;hasFilterExpression in interface FunnelStepOrBuilderpublic 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;getFilterExpression in interface FunnelStepOrBuilderpublic 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;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;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;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;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;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;getFilterExpressionOrBuilder in interface FunnelStepOrBuilderpublic final FunnelStep.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>public final FunnelStep.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FunnelStep.Builder>Copyright © 2023 Google LLC. All rights reserved.