Class Funnel (0.48.0)

public final class Funnel extends GeneratedMessageV3 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

Implements

FunnelOrBuilder

Static Fields

IS_OPEN_FUNNEL_FIELD_NUMBER

public static final int IS_OPEN_FUNNEL_FIELD_NUMBER
Field Value
TypeDescription
int

STEPS_FIELD_NUMBER

public static final int STEPS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Funnel getDefaultInstance()
Returns
TypeDescription
Funnel

getDescriptor()

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

newBuilder()

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

newBuilder(Funnel prototype)

public static Funnel.Builder newBuilder(Funnel prototype)
Parameter
NameDescription
prototypeFunnel
Returns
TypeDescription
Funnel.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Funnel getDefaultInstanceForType()
Returns
TypeDescription
Funnel

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
TypeDescription
boolean

The isOpenFunnel.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSteps(int index)

public FunnelStep getSteps(int index)

The sequential steps of this funnel.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
FunnelStep

getStepsCount()

public int getStepsCount()

The sequential steps of this funnel.

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

Returns
TypeDescription
int

getStepsList()

public List<FunnelStep> getStepsList()

The sequential steps of this funnel.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
FunnelStepOrBuilder

getStepsOrBuilderList()

public List<? extends FunnelStepOrBuilder> getStepsOrBuilderList()

The sequential steps of this funnel.

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

Returns
TypeDescription
List<? extends com.google.analytics.data.v1alpha.FunnelStepOrBuilder>

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 Funnel.Builder newBuilderForType()
Returns
TypeDescription
Funnel.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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