Class FunnelBreakdown (0.63.0)

public final class FunnelBreakdown extends GeneratedMessageV3 implements FunnelBreakdownOrBuilder

Breakdowns add a dimension to the funnel table sub report response.

Protobuf type google.analytics.data.v1alpha.FunnelBreakdown

Static Fields

BREAKDOWN_DIMENSION_FIELD_NUMBER

public static final int BREAKDOWN_DIMENSION_FIELD_NUMBER
Field Value
Type Description
int

LIMIT_FIELD_NUMBER

public static final int LIMIT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FunnelBreakdown getDefaultInstance()
Returns
Type Description
FunnelBreakdown

getDescriptor()

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

newBuilder()

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

newBuilder(FunnelBreakdown prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBreakdownDimension()

public Dimension getBreakdownDimension()

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Returns
Type Description
Dimension

The breakdownDimension.

getBreakdownDimensionOrBuilder()

public DimensionOrBuilder getBreakdownDimensionOrBuilder()

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Returns
Type Description
DimensionOrBuilder

getDefaultInstanceForType()

public FunnelBreakdown getDefaultInstanceForType()
Returns
Type Description
FunnelBreakdown

getLimit()

public long getLimit()

The maximum number of distinct values of the breakdown dimension to return in the response. A limit of 5 is used if limit is not specified. Limit must exceed zero and cannot exceed 15.

optional int64 limit = 2;

Returns
Type Description
long

The limit.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasBreakdownDimension()

public boolean hasBreakdownDimension()

The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid breakdownDimension is required if funnelBreakdown is specified.

.google.analytics.data.v1alpha.Dimension breakdown_dimension = 1;

Returns
Type Description
boolean

Whether the breakdownDimension field is set.

hasLimit()

public boolean hasLimit()

The maximum number of distinct values of the breakdown dimension to return in the response. A limit of 5 is used if limit is not specified. Limit must exceed zero and cannot exceed 15.

optional int64 limit = 2;

Returns
Type Description
boolean

Whether the limit 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 FunnelBreakdown.Builder newBuilderForType()
Returns
Type Description
FunnelBreakdown.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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