Class Funnel.Builder (0.55.0)

public static final class Funnel.Builder extends GeneratedMessageV3.Builder<Funnel.Builder> implements FunnelOrBuilder

Configures the funnel in a funnel report request. A funnel reports on users as they pass through a sequence of steps.

Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abandoned customer journeys.

Protobuf type google.analytics.data.v1alpha.Funnel

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Funnel.Builder

Implements

FunnelOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllSteps(Iterable<? extends FunnelStep> values)

public Funnel.Builder addAllSteps(Iterable<? extends FunnelStep> values)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.analytics.data.v1alpha.FunnelStep>`

Returns
Type	Description
`Funnel.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Funnel.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Funnel.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSteps(FunnelStep value)

public Funnel.Builder addSteps(FunnelStep value)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameter
Name	Description
`value`	`FunnelStep`

Returns
Type	Description
`Funnel.Builder`

addSteps(FunnelStep.Builder builderForValue)

public Funnel.Builder addSteps(FunnelStep.Builder builderForValue)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameter
Name	Description
`builderForValue`	`FunnelStep.Builder`

Returns
Type	Description
`Funnel.Builder`

addSteps(int index, FunnelStep value)

public Funnel.Builder addSteps(int index, FunnelStep value)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameters
Name	Description
`index`	`int`
`value`	`FunnelStep`

Returns
Type	Description
`Funnel.Builder`

addSteps(int index, FunnelStep.Builder builderForValue)

public Funnel.Builder addSteps(int index, FunnelStep.Builder builderForValue)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`FunnelStep.Builder`

Returns
Type	Description
`Funnel.Builder`

addStepsBuilder()

public FunnelStep.Builder addStepsBuilder()

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Returns
Type	Description
`FunnelStep.Builder`

addStepsBuilder(int index)

public FunnelStep.Builder addStepsBuilder(int index)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`FunnelStep.Builder`

build()

public Funnel build()

Returns
Type	Description
`Funnel`

buildPartial()

public Funnel buildPartial()

Returns
Type	Description
`Funnel`

clear()

public Funnel.Builder clear()

Returns
Type	Description
`Funnel.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Funnel.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Funnel.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIsOpenFunnel()

public Funnel.Builder clearIsOpenFunnel()

In an open funnel, users can enter the funnel in any step, and in a closed funnel, users must enter the funnel in the first step. Optional. If unspecified, a closed funnel is used.

bool is_open_funnel = 1;

Returns
Type	Description
`Funnel.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Funnel.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Funnel.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSteps()

public Funnel.Builder clearSteps()

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Returns
Type	Description
`Funnel.Builder`

clone()

public Funnel.Builder clone()

Returns
Type	Description
`Funnel.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Funnel getDefaultInstanceForType()

Returns
Type	Description
`Funnel`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getIsOpenFunnel()

public boolean getIsOpenFunnel()

In an open funnel, users can enter the funnel in any step, and in a closed funnel, users must enter the funnel in the first step. Optional. If unspecified, a closed funnel is used.

bool is_open_funnel = 1;

Returns
Type	Description
`boolean`	The isOpenFunnel.

getSteps(int index)

public FunnelStep getSteps(int index)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`FunnelStep`

getStepsBuilder(int index)

public FunnelStep.Builder getStepsBuilder(int index)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`FunnelStep.Builder`

getStepsBuilderList()

public List<FunnelStep.Builder> getStepsBuilderList()

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Returns
Type	Description
`List<Builder>`

getStepsCount()

public int getStepsCount()

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Returns
Type	Description
`int`

getStepsList()

public List<FunnelStep> getStepsList()

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Returns
Type	Description
`List<FunnelStep>`

getStepsOrBuilder(int index)

public FunnelStepOrBuilder getStepsOrBuilder(int index)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`FunnelStepOrBuilder`

getStepsOrBuilderList()

public List<? extends FunnelStepOrBuilder> getStepsOrBuilderList()

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Returns
Type	Description
`List<? extends com.google.analytics.data.v1alpha.FunnelStepOrBuilder>`

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Funnel other)

public Funnel.Builder mergeFrom(Funnel other)

Parameter
Name	Description
`other`	`Funnel`

Returns
Type	Description
`Funnel.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Funnel.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Funnel.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Funnel.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Funnel.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Funnel.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Funnel.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeSteps(int index)

public Funnel.Builder removeSteps(int index)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Funnel.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public Funnel.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Funnel.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setIsOpenFunnel(boolean value)

public Funnel.Builder setIsOpenFunnel(boolean value)

In an open funnel, users can enter the funnel in any step, and in a closed funnel, users must enter the funnel in the first step. Optional. If unspecified, a closed funnel is used.

bool is_open_funnel = 1;

Parameter
Name	Description
`value`	`boolean` The isOpenFunnel to set.

Returns
Type	Description
`Funnel.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Funnel.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSteps(int index, FunnelStep value)

public Funnel.Builder setSteps(int index, FunnelStep value)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameters
Name	Description
`index`	`int`
`value`	`FunnelStep`

Returns
Type	Description
`Funnel.Builder`

setSteps(int index, FunnelStep.Builder builderForValue)

public Funnel.Builder setSteps(int index, FunnelStep.Builder builderForValue)

The sequential steps of this funnel.

repeated .google.analytics.data.v1alpha.FunnelStep steps = 2;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`FunnelStep.Builder`

Returns
Type	Description
`Funnel.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final Funnel.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Funnel.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)